Class Grit::Repo
In: lib/grit/repo.rb
Parent: Object

Methods

Constants

DAEMON_EXPORT_FILE = 'git-daemon-export-ok'

Attributes

bare  [R] 
git  [RW]  The git command line interface object
path  [RW]  The path of the git repo as a String
working_dir  [RW] 

Public Class methods

Does nothing yet…

[Source]

# File lib/grit/repo.rb, line 43
    def self.init(path)
      # !! TODO !!
      # create directory
      # generate initial git directory
      # create new Grit::Repo on that dir, return it
    end

Initialize a bare git repository at the given path

  +path+ is the full path to the repo (traditionally ends with /<name>.git)
  +options+ is any additional options to the git init command

Examples

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

Returns Grit::Repo (the newly created repo)

[Source]

# File lib/grit/repo.rb, line 281
    def self.init_bare(path, git_options = {}, repo_options = {})
      git = Git.new(path)
      git.init(git_options)
      self.new(path, repo_options)
    end

Create a new Repo instance

  +path+ is the path to either the root git directory or the bare git repo
  +options+ :is_bare force to load a bare repo

Examples

  g = Repo.new("/Users/tom/dev/grit")
  g = Repo.new("/Users/tom/public/grit.git")

Returns Grit::Repo

[Source]

# File lib/grit/repo.rb, line 23
    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

Adds files to the index

[Source]

# File lib/grit/repo.rb, line 103
    def add(*files)
      self.git.add({}, *files.flatten)
    end

The list of alternates for this repo

Returns Array[String] (pathnames of alternates)

[Source]

# File lib/grit/repo.rb, line 379
    def alternates
      alternates_path = File.join(self.path, *%w{objects info alternates})
      
      if File.exist?(alternates_path)
        File.read(alternates_path).strip.split("\n")
      else
        []
      end
    end

Sets the alternates

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

Returns nothing

[Source]

# File lib/grit/repo.rb, line 393
    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?
        File.open(File.join(self.path, *%w{objects info alternates}), 'w') do |f|
          f.write ''
        end
      else
        File.open(File.join(self.path, *%w{objects info alternates}), 'w') do |f|
          f.write alts.join("\n")
        end
      end
    end

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)

[Source]

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

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)

[Source]

# File lib/grit/repo.rb, line 335
    def archive_tar_gz(treeish = 'master', prefix = nil)
      options = {}
      options[:prefix] = prefix if prefix
      self.git.archive(options, treeish, "| gzip")
    end

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

[Source]

# File lib/grit/repo.rb, line 349
    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

[Source]

# File lib/grit/repo.rb, line 57
    def blame(file, commit = nil)
      Blame.new(self, file, commit)
    end

[Source]

# File lib/grit/repo.rb, line 113
    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

The Blob object for the given id

  +id+ is the SHA1 id of the blob

Returns Grit::Blob (unbaked)

[Source]

# File lib/grit/repo.rb, line 242
    def blob(id)
      Blob.create(self, :id => id)
    end
branches()

Alias for heads

The Commit object for the specified id

  +id+ is the SHA1 identifier of the commit

Returns Grit::Commit (baked)

[Source]

# File lib/grit/repo.rb, line 206
    def commit(id)
      options = {:max_count => 1}
      
      Commit.find_all(self, id, options).first
    end

Commits all tracked and modified files

Returns true/false if commit worked

[Source]

# File lib/grit/repo.rb, line 98
    def commit_all(message)
      self.git.commit({}, '-a', '-m', message)
    end

The number of commits reachable by the given branch/commit

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

Returns Integer

[Source]

# File lib/grit/repo.rb, line 198
    def commit_count(start = 'master')
      Commit.count(self, start)
    end

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

Returns Grit::Commit[]

[Source]

# File lib/grit/repo.rb, line 215
    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

The commit diff for the given commit

  +commit+ is the commit name/id

Returns Grit::Diff[]

[Source]

# File lib/grit/repo.rb, line 269
    def commit_diff(commit)
      Commit.diff(self, commit)
    end

Commits current index

Returns true/false if commit worked

[Source]

# File lib/grit/repo.rb, line 91
    def commit_index(message)
      self.git.commit({}, '-m', message)
    end

[Source]

# File lib/grit/repo.rb, line 151
    def commit_stats(start = 'master', max_count = 10, skip = 0)
      options = {:max_count => max_count,
                 :skip => skip}
      
      CommitStats.find_all(self, start, options)
    end

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)

[Source]

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

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)

[Source]

# File lib/grit/repo.rb, line 177
    def commits_between(from, to)
      Commit.find_all(self, "#{from}..#{to}").reverse
    end

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)

[Source]

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

[Source]

# File lib/grit/repo.rb, line 411
    def config
      @config ||= Config.new(self)
    end

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

Returns String

[Source]

# File lib/grit/repo.rb, line 53
    def description
      File.open(File.join(self.path, 'description')).read.chomp
    end

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

[Source]

# File lib/grit/repo.rb, line 261
    def diff(a, b, *paths)
      self.git.diff({}, a, b, '--', *paths)
    end

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

Returns nothing

[Source]

# File lib/grit/repo.rb, line 368
    def disable_daemon_serve
      FileUtils.rm_f(File.join(self.path, DAEMON_EXPORT_FILE))
    end

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

Returns nothing

[Source]

# File lib/grit/repo.rb, line 360
    def enable_daemon_serve
      FileUtils.touch(File.join(self.path, DAEMON_EXPORT_FILE))
    end

Fork a bare git repository from this repo

  +path+ is the full path of the new repo (traditionally ends with /<name>.git)
  +options+ is any additional options to the git clone command (:bare and :shared are true by default)

Returns Grit::Repo (the newly forked repo)

[Source]

# File lib/grit/repo.rb, line 292
    def fork_bare(path, options = {})
      default_options = {:bare => true, :shared => true}
      real_options = default_options.merge(options)
      self.git.clone(real_options, self.path, path)
      Repo.new(path)
    end

[Source]

# File lib/grit/repo.rb, line 372
    def gc_auto
      self.git.gc({:auto => true})
    end

[Source]

# File lib/grit/repo.rb, line 72
    def get_head(head_name)
      heads.find { |h| h.name == head_name }
    end

Object reprsenting the current repo head.

Returns Grit::Head (baked)

[Source]

# File lib/grit/repo.rb, line 83
    def head
      Head.current(self)
    end

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

Returns Grit::Head[] (baked)

[Source]

# File lib/grit/repo.rb, line 66
    def heads
      Head.find_all(self)
    end

[Source]

# File lib/grit/repo.rb, line 415
    def index
      Index.new(self)
    end

Pretty object inspection

[Source]

# File lib/grit/repo.rb, line 432
    def inspect
      %Q{#<Grit::Repo "#{@path}">}
    end

[Source]

# File lib/grit/repo.rb, line 76
    def is_head?(head_name)
      get_head(head_name)
    end

The commit log for a treeish

Returns Grit::Commit[]

[Source]

# File lib/grit/repo.rb, line 249
    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

An array of Ref objects representing the refs in this repo

Returns Grit::Ref[] (baked)

[Source]

# File lib/grit/repo.rb, line 147
    def refs
      [ Head.find_all(self), Tag.find_all(self), Remote.find_all(self) ].flatten
    end

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

Returns Grit::Remote[] (baked)

[Source]

# File lib/grit/repo.rb, line 139
    def remotes
      Remote.find_all(self)
    end

Remove files from the index

[Source]

# File lib/grit/repo.rb, line 108
    def remove(*files)
      self.git.rm({}, *files.flatten)
    end

[Source]

# File lib/grit/repo.rb, line 123
    def status
      Status.new(self)
    end

An array of Tag objects that are available in this repo

Returns Grit::Tag[] (baked)

[Source]

# File lib/grit/repo.rb, line 131
    def tags
      Tag.find_all(self)
    end

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)

[Source]

# File lib/grit/repo.rb, line 234
    def tree(treeish = 'master', paths = [])
      Tree.construct(self, treeish, paths)
    end

[Source]

# File lib/grit/repo.rb, line 419
    def update_ref(head, commit_sha)
      return nil if !commit_sha || (commit_sha.size != 40)
   
      ref_heads = File.join(self.path, 'refs', 'heads')
      FileUtils.mkdir_p(ref_heads)
      File.open(File.join(ref_heads, head), 'w') do |f|
        f.write(commit_sha)
      end
      commit_sha

    end

[Validate]