In Files

Parent

Files

Grit::Repo

Attributes

bare[R]

Public: The Boolean of whether or not the repo is bare.

git[RW]

Public: The Grit::Git command line interface object.

path[RW]

Public: The String path of the Git repo.

working_dir[RW]

Public: The String path to the working directory of the repo, or nil if there is no working directory.

Public Class Methods

init(path, git_options = {}, repo_options = {}) click to toggle source

Public: Initialize a git repository (create it on the filesystem). By default, the newly created repository will contain a working directory. If you would like to create a bare repo, use Grit::Repo.init_bare.

path - The String full path to the repo. Traditionally ends with

"/<name>.git".

git_options - A Hash of additional options to the git init command

(default: {}).

repo_options - A Hash of additional options to the Grit::Repo.new call

(default: {}).

Examples

Grit::Repo.init('/var/git/myrepo.git')

Returns the newly created Grit::Repo.

# File lib/grit/repo.rb, line 75
def self.init(path, git_options = {}, repo_options = {})
  git_options = {:base => false}.merge(git_options)
  git = Git.new(path)
  git.fs_mkdir('..')
  git.init(git_options, path)
  self.new(path, repo_options)
end
init_bare(path, git_options = {}, repo_options = {}) click to toggle source

Public: Initialize a bare git repository (create it on the filesystem).

path - The String full path to the repo. Traditionally ends with

"/<name>.git".

git_options - A Hash of additional options to the git init command

(default: {}).

repo_options - A Hash of additional options to the Grit::Repo.new call

(default: {}).

Examples

Grit::Repo.init_bare('/var/git/myrepo.git')

Returns the newly created Grit::Repo.

# File lib/grit/repo.rb, line 97
def self.init_bare(path, git_options = {}, repo_options = {})
  git_options = {:bare => true}.merge(git_options)
  git = Git.new(path)
  git.fs_mkdir('..')
  git.init(git_options)
  repo_options = {:is_bare => true}.merge(repo_options)
  self.new(path, repo_options)
end
init_bare_or_open(path, git_options = {}, repo_options = {}) click to toggle source

Public: Initialize a bare Git repository (create it on the filesystem) or, if the repo already exists, simply return it.

path - The String full path to the repo. Traditionally ends with

"/<name>.git".

git_options - A Hash of additional options to the git init command

(default: {}).

repo_options - A Hash of additional options to the Grit::Repo.new call

(default: {}).

Returns the new or existing Grit::Repo.

# File lib/grit/repo.rb, line 117
def self.init_bare_or_open(path, git_options = {}, repo_options = {})
  git = Git.new(path)

  unless git.exist?
    git.fs_mkdir(path)
    git.init(git_options)
  end

  self.new(path, repo_options)
end
new(path, options = {}) click to toggle source

Public: Create a new Repo instance.

path - The String path to either the root git directory or the bare

git repo. Bare repos are expected to end with ".git".

options - A Hash of options (default: {}):

:is_bare - Boolean whether to consider the repo as bare even
           if the repo name does not end with ".git".

Examples

r = Repo.new("/Users/tom/dev/normal")
r = Repo.new("/Users/tom/public/bare.git")
r = Repo.new("/Users/tom/public/bare", {:is_bare => true})

Returns a newly initialized Grit::Repo. Raises Grit::InvalidGitRepositoryError if the path exists but is not

a Git repository.

Raises Grit::NoSuchPathError if the path does not exist.

# File lib/grit/repo.rb, line 40
def initialize(path, options = {})
  epath = File.expand_path(path)

  if File.exist?(File.join(epath, '.git'))
    self.working_dir = epath
    self.path = File.join(epath, '.git')
    @bare = false
  elsif File.exist?(epath) && (epath =~ /\.git$/ || options[:is_bare])
    self.path = epath
    @bare = true
  elsif File.exist?(epath)
    raise InvalidGitRepositoryError.new(epath)
  else
    raise NoSuchPathError.new(epath)
  end

  self.git = Git.new(self.path)
end

Public Instance Methods

add(*files) click to toggle source

Adds files to the index

# File lib/grit/repo.rb, line 248
def add(*files)
  self.git.add({}, *files.flatten)
end
alternates() click to toggle source

The list of alternates for this repo

Returns Array (pathnames of alternates)

# File lib/grit/repo.rb, line 598
def alternates
  alternates_path = "objects/info/alternates"
  self.git.fs_read(alternates_path).strip.split("\n")
rescue Errno::ENOENT
  []
end
alternates=(alts) click to toggle source

Sets the alternates

+alts+ is the Array of String paths representing the alternates

Returns nothing

# File lib/grit/repo.rb, line 609
def alternates=(alts)
  alts.each do |alt|
    unless File.exist?(alt)
      raise "Could not set alternates. Alternate path #{alt} must exist"
    end
  end

  if alts.empty?
    self.git.fs_write('objects/info/alternates', '')
  else
    self.git.fs_write('objects/info/alternates', alts.join("\n"))
  end
end
archive_tar(treeish = 'master', prefix = nil) click to toggle source

Archive the given treeish

+treeish+ is the treeish name/id (default 'master')
+prefix+ is the optional prefix

Examples

repo.archive_tar
# => <String containing tar archive>

repo.archive_tar('a87ff14')
# => <String containing tar archive for commit a87ff14>

repo.archive_tar('master', 'myproject/')
# => <String containing tar archive and prefixed with 'myproject/'>

Returns String (containing tar archive)

# File lib/grit/repo.rb, line 533
def archive_tar(treeish = 'master', prefix = nil)
  options = {}
  options[:prefix] = prefix if prefix
  self.git.archive(options, treeish)
end
archive_tar_gz(treeish = 'master', prefix = nil) click to toggle source

Archive and gzip the given treeish

+treeish+ is the treeish name/id (default 'master')
+prefix+ is the optional prefix

Examples

repo.archive_tar_gz
# => <String containing tar.gz archive>

repo.archive_tar_gz('a87ff14')
# => <String containing tar.gz archive for commit a87ff14>

repo.archive_tar_gz('master', 'myproject/')
# => <String containing tar.gz archive and prefixed with 'myproject/'>

Returns String (containing tar.gz archive)

# File lib/grit/repo.rb, line 554
def archive_tar_gz(treeish = 'master', prefix = nil)
  options = {}
  options[:prefix] = prefix if prefix
  self.git.archive(options, treeish, "| gzip -n")
end
archive_to_file(treeish = 'master', prefix = nil, filename = 'archive.tar.gz', format = nil, pipe = "gzip") click to toggle source

Write an archive directly to a file

+treeish+ is the treeish name/id (default 'master')
+prefix+ is the optional prefix (default nil)
+filename+ is the name of the file (default 'archive.tar.gz')
+format+ is the optional format (default nil)
+pipe+ is the command to run the output through (default 'gzip')

Returns nothing

# File lib/grit/repo.rb, line 568
def archive_to_file(treeish = 'master', prefix = nil, filename = 'archive.tar.gz', format = nil, pipe = "gzip")
  options = {}
  options[:prefix] = prefix if prefix
  options[:format] = format if format
  self.git.archive(options, treeish, "| #{pipe} > #{filename}")
end
batch(*shas) click to toggle source

Public: Return the full Git objects from the given SHAs. Only Commit objects are parsed for now.

*shas - Array of String SHAs.

Returns an Array of Grit objects (Grit::Commit).

# File lib/grit/repo.rb, line 168
def batch(*shas)
  shas.flatten!
  text = git.native(:cat_file, {:batch => true, :input => (shas * "\n")})
  parse_batch(text)
end
blame(file, commit = nil) click to toggle source
# File lib/grit/repo.rb, line 203
def blame(file, commit = nil)
  Blame.new(self, file, commit)
end
blame_tree(commit, path = nil) click to toggle source
# File lib/grit/repo.rb, line 258
def blame_tree(commit, path = nil)
  commit_array = self.git.blame_tree(commit, path)

  final_array = {}
  commit_array.each do |file, sha|
    final_array[file] = commit(sha)
  end
  final_array
end
blob(id) click to toggle source

The Blob object for the given id

+id+ is the SHA1 id of the blob

Returns Grit::Blob (unbaked)

# File lib/grit/repo.rb, line 480
def blob(id)
  Blob.create(self, :id => id)
end
branches() click to toggle source
Alias for: heads
commit(id) click to toggle source

The Commit object for the specified id

+id+ is the SHA1 identifier of the commit

Returns Grit::Commit (baked)

# File lib/grit/repo.rb, line 403
def commit(id)
  options = {:max_count => 1}

  Commit.find_all(self, id, options).first
end
commit_all(message) click to toggle source

Commits all tracked and modified files

Returns true/false if commit worked

# File lib/grit/repo.rb, line 243
def commit_all(message)
  self.git.commit({}, '-a', '-m', message)
end
commit_count(start = 'master') click to toggle source

The number of commits reachable by the given branch/commit

+start+ is the branch/commit name (default 'master')

Returns Integer

# File lib/grit/repo.rb, line 395
def commit_count(start = 'master')
  Commit.count(self, start)
end
commit_deltas_from(other_repo, ref = "master", other_ref = "master") click to toggle source

Returns a list of commits that is in other_repo but not in self

Returns Grit::Commit[]

# File lib/grit/repo.rb, line 412
def commit_deltas_from(other_repo, ref = "master", other_ref = "master")
  # TODO: we should be able to figure out the branch point, rather than
  # rev-list'ing the whole thing
  repo_refs       = self.git.rev_list({}, ref).strip.split("\n")
  other_repo_refs = other_repo.git.rev_list({}, other_ref).strip.split("\n")

  (other_repo_refs - repo_refs).map do |ref|
    Commit.find_all(other_repo, ref, {:max_count => 1}).first
  end
end
commit_diff(commit) click to toggle source

The commit diff for the given commit

+commit+ is the commit name/id

Returns Grit::Diff[]

# File lib/grit/repo.rb, line 514
def commit_diff(commit)
  Commit.diff(self, commit)
end
commit_index(message) click to toggle source

Commits current index

Returns true/false if commit worked

# File lib/grit/repo.rb, line 236
def commit_index(message)
  self.git.commit({}, '-m', message)
end
commit_objects(refs) click to toggle source
# File lib/grit/repo.rb, line 430
def commit_objects(refs)
  Grit.no_quote = true
  obj = self.git.rev_list({:timeout => false}, refs).split("\n").map { |a| a[0, 40] }
  Grit.no_quote = false
  obj
end
commit_stats(start = 'master', max_count = 10, skip = 0) click to toggle source
# File lib/grit/repo.rb, line 348
def commit_stats(start = 'master', max_count = 10, skip = 0)
  options = {:max_count => max_count,
             :skip => skip}

  CommitStats.find_all(self, start, options)
end
commits(start = 'master', max_count = 10, skip = 0) click to toggle source

An array of Commit objects representing the history of a given ref/commit

+start+ is the branch/commit name (default 'master')
+max_count+ is the maximum number of commits to return (default 10, use +false+ for all)
+skip+ is the number of commits to skip (default 0)

Returns Grit::Commit[] (baked)

# File lib/grit/repo.rb, line 361
def commits(start = 'master', max_count = 10, skip = 0)
  options = {:max_count => max_count,
             :skip => skip}

  Commit.find_all(self, start, options)
end
commits_between(from, to) click to toggle source

The Commits objects that are reachable via to but not via from Commits are returned in chronological order.

+from+ is the branch/commit name of the younger item
+to+ is the branch/commit name of the older item

Returns Grit::Commit[] (baked)

# File lib/grit/repo.rb, line 374
def commits_between(from, to)
  Commit.find_all(self, "#{from}..#{to}").reverse
end
commits_since(start = 'master', since = '1970-01-01', extra_options = {}) click to toggle source

The Commits objects that are newer than the specified date. Commits are returned in chronological order.

+start+ is the branch/commit name (default 'master')
+since+ is a string represeting a date/time
+extra_options+ is a hash of extra options

Returns Grit::Commit[] (baked)

# File lib/grit/repo.rb, line 385
def commits_since(start = 'master', since = '1970-01-01', extra_options = {})
  options = {:since => since}.merge(extra_options)

  Commit.find_all(self, start, options)
end
config() click to toggle source
# File lib/grit/repo.rb, line 623
def config
  @config ||= Config.new(self)
end
description() click to toggle source

The project’s description. Taken verbatim from GIT_REPO/description

Returns String

# File lib/grit/repo.rb, line 199
def description
  self.git.fs_read('description').chomp
end
diff(a, b, *paths) click to toggle source

The diff from commit a to commit b, optionally restricted to the given file(s)

+a+ is the base commit
+b+ is the other commit
+paths+ is an optional list of file paths on which to restrict the diff
# File lib/grit/repo.rb, line 499
def diff(a, b, *paths)
  diff = self.git.native('diff', {}, a, b, '--', *paths)

  if diff =~ /diff --git a/
    diff = diff.sub(/.*?(diff --git a)/, '\1')
  else
    diff = ''
  end
  Diff.list_from_string(self, diff)
end
diff_objects(commit_sha, parents = true) click to toggle source
# File lib/grit/repo.rb, line 446
def diff_objects(commit_sha, parents = true)
  revs = []
  Grit.no_quote = true
  if parents
    # PARENTS:
    cmd = "-r -t -m #{commit_sha}"
    revs = self.git.diff_tree({:timeout => false}, cmd).strip.split("\n").map{ |a| r = a.split(' '); r[3] if r[1] != '160000' }
  else
    # NO PARENTS:
    cmd = "-r -t #{commit_sha}"
    revs = self.git.native(:ls_tree, {:timeout => false, :r => true, :t => true}, commit_sha).
      split("\n").map{ |a| a.split("\t").first.split(' ')[2] }
  end
  revs << self.commit(commit_sha).tree.id
  Grit.no_quote = false
  return revs.uniq.compact
end
disable_daemon_serve() click to toggle source

Disable git-daemon serving of this repository by ensuring there is no git-daemon-export-ok file in its git directory

Returns nothing

# File lib/grit/repo.rb, line 587
def disable_daemon_serve
  self.git.fs_delete(DAEMON_EXPORT_FILE)
end
enable_daemon_serve() click to toggle source

Enable git-daemon serving of this repository by writing the git-daemon-export-ok file to its git directory

Returns nothing

# File lib/grit/repo.rb, line 579
def enable_daemon_serve
  self.git.fs_write(DAEMON_EXPORT_FILE, '')
end
fork_bare(path, options = {}) click to toggle source

Public: Create a bare fork of this repository.

path - The String full path of where to create the new fork.

Traditionally ends with "/<name>.git".

options - The Hash of additional options to the git clone command.

These options will be merged on top of the default Hash:
{:bare => true, :shared => true}.

Returns the newly forked Grit::Repo.

# File lib/grit/repo.rb, line 137
def fork_bare(path, options = {})
  default_options = {:bare => true, :shared => true}
  real_options = default_options.merge(options)
  Git.new(path).fs_mkdir('..')
  self.git.clone(real_options, self.path, path)
  Repo.new(path)
end
fork_bare_from(path, options = {}) click to toggle source

Public: Fork a bare git repository from another repo.

path - The String full path of the repo from which to fork..

Traditionally ends with "/<name>.git".

options - The Hash of additional options to the git clone command.

These options will be merged on top of the default Hash:
{:bare => true, :shared => true}.

Returns the newly forked Grit::Repo.

# File lib/grit/repo.rb, line 154
def fork_bare_from(path, options = {})
  default_options = {:bare => true, :shared => true}
  real_options = default_options.merge(options)
  Git.new(self.path).fs_mkdir('..')
  self.git.clone(real_options, path, self.path)
  Repo.new(self.path)
end
gc_auto() click to toggle source
# File lib/grit/repo.rb, line 591
def gc_auto
  self.git.gc({:auto => true})
end
get_head(head_name) click to toggle source
# File lib/grit/repo.rb, line 217
def get_head(head_name)
  heads.find { |h| h.name == head_name }
end
head() click to toggle source

Object reprsenting the current repo head.

Returns Grit::Head (baked)

# File lib/grit/repo.rb, line 228
def head
  Head.current(self)
end
heads() click to toggle source

An array of Head objects representing the branch heads in this repo

Returns Grit::Head[] (baked)

# File lib/grit/repo.rb, line 211
def heads
  Head.find_all(self)
end
Also aliased as: branches
index() click to toggle source
# File lib/grit/repo.rb, line 627
def index
  Index.new(self)
end
inspect() click to toggle source

Pretty object inspection

# File lib/grit/repo.rb, line 650
def inspect
  %{#<Grit::Repo "#{@path}">}
end
is_head?(head_name) click to toggle source
# File lib/grit/repo.rb, line 221
def is_head?(head_name)
  get_head(head_name)
end
log(commit = 'master', path = nil, options = {}) click to toggle source

The commit log for a treeish

Returns Grit::Commit[]

# File lib/grit/repo.rb, line 487
def log(commit = 'master', path = nil, options = {})
  default_options = {:pretty => "raw"}
  actual_options  = default_options.merge(options)
  arg = path ? [commit, '--', path] : [commit]
  commits = self.git.log(actual_options, *arg)
  Commit.list_from_string(self, commits)
end
objects(refs) click to toggle source
# File lib/grit/repo.rb, line 423
def objects(refs)
  Grit.no_quote = true
  obj = self.git.rev_list({:objects => true, :timeout => false}, refs).split("\n").map { |a| a[0, 40] }
  Grit.no_quote = false
  obj
end
objects_between(ref1, ref2 = nil) click to toggle source
# File lib/grit/repo.rb, line 437
def objects_between(ref1, ref2 = nil)
  if ref2
    refs = "#{ref2}..#{ref1}"
  else
    refs = ref1
  end
  self.objects(refs)
end
parse_batch(text) click to toggle source

Parses `git cat-file –batch` output, returning an array of Grit objects.

text - Raw String output.

Returns an Array of Grit objects (Grit::Commit).

# File lib/grit/repo.rb, line 179
def parse_batch(text)
  io = StringIO.new(text)
  objects = []
  while line = io.gets
    sha, type, size = line.split(" ", 3)
    parser = BATCH_PARSERS[type]
    if type == 'missing' || !parser
      objects << nil
      next
    end

    object   = io.read(size.to_i + 1)
    objects << parser.parse_batch(self, sha, size, object)
  end
  objects
end
recent_tag_name(committish = nil, options = {}) click to toggle source

Finds the most recent annotated tag name that is reachable from a commit.

@repo.recent_tag_name('master')
# => "v1.0-0-abcdef"

committish - optional commit SHA, branch, or tag name. options - optional hash of options to pass to git.

Default: {:always => true}
:tags => true      # use lightweight tags too.
:abbrev => Integer # number of hex digits to form the unique
  name.  Defaults to 7.
:long => true      # always output tag + commit sha
# see `git describe` docs for more options.

Returns the String tag name, or just the commit if no tag is found. If there have been updates since the tag was made, a suffix is added with the number of commits since the tag, and the abbreviated object name of the most recent commit. Returns nil if the committish value is not found.

# File lib/grit/repo.rb, line 299
def recent_tag_name(committish = nil, options = {})
  value = git.describe({:always => true}.update(options), committish.to_s).to_s.strip
  value.size.zero? ? nil : value
end
refs() click to toggle source

An array of Ref objects representing the refs in this repo

Returns Grit::Ref[] (baked)

# File lib/grit/repo.rb, line 344
def refs
  [ Head.find_all(self), Tag.find_all(self), Remote.find_all(self) ].flatten
end
remote_add(name, url) click to toggle source
# File lib/grit/repo.rb, line 316
def remote_add(name, url)
  self.git.remote({}, 'add', name, url)
end
remote_fetch(name) click to toggle source
# File lib/grit/repo.rb, line 320
def remote_fetch(name)
  self.git.fetch({}, name)
end
remote_list() click to toggle source
# File lib/grit/repo.rb, line 312
def remote_list
  self.git.list_remotes
end
remotes() click to toggle source

An array of Remote objects representing the remote branches in this repo

Returns Grit::Remote[] (baked)

# File lib/grit/repo.rb, line 308
def remotes
  Remote.find_all(self)
end
remotes_fetch_needed(remotes) click to toggle source

takes an array of remote names and last pushed dates fetches from all of the remotes where the local fetch date is earlier than the passed date, then records the last fetched date

{ ‘origin’ => date,

'peter => date,

}

# File lib/grit/repo.rb, line 332
def remotes_fetch_needed(remotes)
  remotes.each do |remote, date|
    # TODO: check against date
    self.remote_fetch(remote)
  end
end
remove(*files) click to toggle source

Remove files from the index

# File lib/grit/repo.rb, line 253
def remove(*files)
  self.git.rm({}, *files.flatten)
end
rename(name) click to toggle source

Rename the current repository directory.

+name+ is the new name

Returns nothing

# File lib/grit/repo.rb, line 641
def rename(name)
  if @bare
    self.git.fs_move('/', "../#{name}")
  else
    self.git.fs_move('/', "../../#{name}")
  end
end
status() click to toggle source
# File lib/grit/repo.rb, line 268
def status
  Status.new(self)
end
tags() click to toggle source

An array of Tag objects that are available in this repo

Returns Grit::Tag[] (baked)

# File lib/grit/repo.rb, line 276
def tags
  Tag.find_all(self)
end
tree(treeish = 'master', paths = []) click to toggle source

The Tree object for the given treeish reference

+treeish+ is the reference (default 'master')
+paths+ is an optional Array of directory paths to restrict the tree (deafult [])

Examples

repo.tree('master', ['lib/'])

Returns Grit::Tree (baked)

# File lib/grit/repo.rb, line 472
def tree(treeish = 'master', paths = [])
  Tree.construct(self, treeish, paths)
end
update_ref(head, commit_sha) click to toggle source
# File lib/grit/repo.rb, line 631
def update_ref(head, commit_sha)
  return nil if !commit_sha || (commit_sha.size != 40)
  self.git.fs_write("refs/heads/#{head}", commit_sha)
  commit_sha
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.