relevance-grit 0.8.1

data/lib/grit/repo.rb

@@ -0,0 +1,318 @@
+module Grit
+  
+  class Repo
+    DAEMON_EXPORT_FILE = 'git-daemon-export-ok'
+    
+    # The path of the git repo as a String
+    attr_accessor :path
+    attr_reader :bare
+    
+    # The git command line interface object
+    attr_accessor :git
+    
+    # Create a new Repo instance
+    #   +path+ is the path to either the root git directory or the bare git repo
+    #
+    # Examples
+    #   g = Repo.new("/Users/tom/dev/grit")
+    #   g = Repo.new("/Users/tom/public/grit.git")
+    #
+    # Returns Grit::Repo
+    def initialize(path)
+      epath = File.expand_path(path)
+      
+      if File.exist?(File.join(epath, '.git'))
+        self.path = File.join(epath, '.git')
+        @bare = false
+      elsif File.exist?(epath) && epath =~ /\.git$/
+        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
+    
+    # The project's description. Taken verbatim from GIT_REPO/description
+    #
+    # Returns String
+    def description
+      File.open(File.join(self.path, 'description')).read.chomp
+    end
+    
+    # An array of Head objects representing the branch heads in
+    # this repo
+    #
+    # Returns Grit::Head[] (baked)
+    def heads
+      Head.find_all(self)
+    end
+    
+    alias_method :branches, :heads
+
+    # Object reprsenting the current repo head.
+    #
+    # Returns Grit::Head (baked)
+    def head
+      Head.current(self)
+    end
+
+    # An array of Tag objects that are available in this repo
+    #
+    # Returns Grit::Tag[] (baked)
+    def tags
+      Tag.find_all(self)
+    end
+    
+    # An array of Remote objects representing the remote branches in
+    # this repo
+    #
+    # Returns Grit::Remote[] (baked)
+    def remotes
+      Remote.find_all(self)
+    end
+
+    # An array of Ref objects representing the refs in
+    # this repo
+    #
+    # Returns Grit::Ref[] (baked)
+    def refs
+      [ Head.find_all(self), Tag.find_all(self), Remote.find_all(self) ].flatten
+    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)
+    #   +skip+ is the number of commits to skip (default 0)
+    #
+    # Returns Grit::Commit[] (baked)
+    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)
+    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)
+    def commits_since(start = 'master', since = '1970-01-01', extra_options = {})
+      options = {:since => since}.merge(extra_options)
+      
+      Commit.find_all(self, start, options)
+    end
+    
+    # The number of commits reachable by the given branch/commit
+    #   +start+ is the branch/commit name (default 'master')
+    #
+    # Returns Integer
+    def commit_count(start = 'master')
+      Commit.count(self, start)
+    end
+    
+    # The Commit object for the specified id
+    #   +id+ is the SHA1 identifier of the commit
+    #
+    # Returns Grit::Commit (baked)
+    def commit(id)
+      options = {:max_count => 1}
+      
+      Commit.find_all(self, id, options).first
+    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)
+    def tree(treeish = 'master', paths = [])
+      Tree.construct(self, treeish, paths)
+    end
+    
+    # The Blob object for the given id
+    #   +id+ is the SHA1 id of the blob
+    #
+    # Returns Grit::Blob (unbaked)
+    def blob(id)
+      Blob.create(self, :id => id)
+    end
+
+    # The commit log for a treeish
+    #
+    # Returns Grit::Commit[]
+    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
+    
+    # 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
+    def diff(a, b, *paths)
+      self.git.diff({}, a, b, '--', *paths)
+    end
+    
+    # The commit diff for the given commit
+    #   +commit+ is the commit name/id
+    #
+    # Returns Grit::Diff[]
+    def commit_diff(commit)
+      Commit.diff(self, commit)
+    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)
+    def self.init_bare(path, options = {})
+      git = Git.new(path)
+      git.init(options)
+      self.new(path)
+    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
+    #
+    # Returns Grit::Repo (the newly forked repo)
+    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
+    
+    # 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)
+    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)
+    def archive_tar_gz(treeish = 'master', prefix = nil)
+      options = {}
+      options[:prefix] = prefix if prefix
+      self.git.archive(options, treeish, "| gzip")
+    end
+    
+    # Enable git-daemon serving of this repository by writing the
+    # git-daemon-export-ok file to its git directory
+    #
+    # Returns nothing
+    def enable_daemon_serve
+      FileUtils.touch(File.join(self.path, DAEMON_EXPORT_FILE))
+    end
+    
+    # Disable git-daemon serving of this repository by ensuring there is no
+    # git-daemon-export-ok file in its git directory
+    #
+    # Returns nothing
+    def disable_daemon_serve
+      FileUtils.rm_f(File.join(self.path, DAEMON_EXPORT_FILE))
+    end
+    
+    # The list of alternates for this repo
+    #
+    # Returns Array[String] (pathnames of alternates)
+    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
+    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.delete(File.join(self.path, *%w{objects info alternates}))
+      else
+        File.open(File.join(self.path, *%w{objects info alternates}), 'w') do |f|
+          f.write alts.join("\n")
+        end
+      end
+    end
+    
+    def config
+      @config ||= Config.new(self)
+    end
+    
+    def index
+      Index.new(self)
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Repo "#{@path}">}
+    end
+  end # Repo
+  
+end # Grit

data/lib/grit/tree.rb

@@ -0,0 +1,99 @@
+module Grit
+  
+  class Tree
+    lazy_reader :contents
+    attr_reader :id
+    attr_reader :mode
+    attr_reader :name
+    
+    # Construct the contents of the tree
+    #   +repo+ is the Repo
+    #   +treeish+ is the reference
+    #   +paths+ is an optional Array of directory paths to restrict the tree
+    #
+    # Returns Grit::Tree (baked)
+    def self.construct(repo, treeish, paths = [])
+      output = repo.git.ls_tree({}, treeish, *paths)
+      
+      self.allocate.construct_initialize(repo, treeish, output)
+    end
+    
+    def construct_initialize(repo, id, text)
+      @repo = repo
+      @id = id
+      @contents = []
+      
+      text.split("\n").each do |line|
+        @contents << content_from_string(repo, line)
+      end
+      @contents.compact!
+
+      self
+    end
+    
+    def lazy_source
+      Tree.construct(@repo, @id, [])
+    end
+    
+    # Create an unbaked Tree containing just the specified attributes
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Tree (unbaked)
+    def self.create(repo, atts)
+      self.allocate.create_initialize(repo, atts)
+    end
+    
+    # Initializer for Tree.create
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Tree (unbaked)
+    def create_initialize(repo, atts)
+      @repo = repo
+      
+      atts.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+      self
+    end
+    
+    # Parse a content item and create the appropriate object
+    #   +repo+ is the Repo
+    #   +text+ is the single line containing the items data in `git ls-tree` format
+    #
+    # Returns Grit::Blob or Grit::Tree
+    def content_from_string(repo, text)
+      mode, type, id, name = text.split(" ", 4)
+      case type
+        when "tree"
+          Tree.create(repo, :id => id, :mode => mode, :name => name)
+        when "blob"
+          Blob.create(repo, :id => id, :mode => mode, :name => name)
+        when "commit"
+          nil
+        else
+          raise "Invalid type: #{type}"
+      end
+    end
+    
+    # Find the named object in this tree's contents
+    #
+    # Examples
+    #   Repo.new('/path/to/grit').tree/'lib'
+    #   # => #<Grit::Tree "6cc23ee138be09ff8c28b07162720018b244e95e">
+    #   Repo.new('/path/to/grit').tree/'README.txt'
+    #   # => #<Grit::Blob "8b1e02c0fb554eed2ce2ef737a68bb369d7527df">
+    #
+    # Returns Grit::Blob or Grit::Tree or nil if not found
+    def /(file)
+      self.contents.select { |c| c.name == file }.first
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Tree "#{@id}">}
+    end
+  end # Tree
+  
+end # Grit

data/lib/grit.rb

@@ -0,0 +1,42 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# core
+require 'fileutils'
+require 'time'
+
+# stdlib
+require 'timeout'
+require 'logger'
+
+# third party
+require 'rubygems'
+require 'mime/types'
+require 'open4'
+
+# internal requires
+require 'grit/lazy'
+require 'grit/errors'
+require 'grit/git'
+require 'grit/ref'
+require 'grit/commit'
+require 'grit/tree'
+require 'grit/blob'
+require 'grit/actor'
+require 'grit/diff'
+require 'grit/config'
+require 'grit/repo'
+require 'grit/index'
+
+module Grit
+  class << self
+    attr_accessor :debug
+    attr_accessor :logger
+    def log(str)
+      logger.debug { str }
+    end
+  end
+  self.debug = false
+  @logger ||= ::Logger.new(STDOUT)
+  
+  VERSION = '0.8.1'
+end

data/test/fixtures/blame

@@ -0,0 +1,131 @@
+634396b2f541a9f2d58b00be1a07f0c358b999b3 1 1 7
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1191997100
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1191997100
+committer-tz -0700
+filename lib/grit.rb
+summary initial grit setup
+boundary
+	$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+634396b2f541a9f2d58b00be1a07f0c358b999b3 2 2
+	
+634396b2f541a9f2d58b00be1a07f0c358b999b3 3 3
+	# core
+634396b2f541a9f2d58b00be1a07f0c358b999b3 4 4
+	
+634396b2f541a9f2d58b00be1a07f0c358b999b3 5 5
+	# stdlib
+634396b2f541a9f2d58b00be1a07f0c358b999b3 6 6
+	
+634396b2f541a9f2d58b00be1a07f0c358b999b3 7 7
+	# internal requires
+3b1930208a82457747d76729ae088e90edca4673 8 8 1
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1192267241
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1192267241
+committer-tz -0700
+filename lib/grit.rb
+summary big refactor to do lazy loading
+	require 'grit/lazy'
+4c8124ffcf4039d292442eeccabdeca5af5c5017 8 9 1
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1191999972
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1191999972
+committer-tz -0700
+filename lib/grit.rb
+summary implement Grit#heads
+	require 'grit/errors'
+d01a4cfad6ea50285c4710243e3cbe019d381eba 9 10 1
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1192032303
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1192032303
+committer-tz -0700
+filename lib/grit.rb
+summary convert to Grit module, refactor to be more OO
+	require 'grit/git'
+4c8124ffcf4039d292442eeccabdeca5af5c5017 9 11 1
+	require 'grit/head'
+a47fd41f3aa4610ea527dcc1669dfdb9c15c5425 10 12 1
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1192002639
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1192002639
+committer-tz -0700
+filename lib/grit.rb
+summary add more comments throughout
+	require 'grit/commit'
+b17b974691f0a26f26908495d24d9c4c718920f8 13 13 1
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1192271832
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1192271832
+committer-tz -0700
+filename lib/grit.rb
+summary started implementing Tree
+	require 'grit/tree'
+74fd66519e983a0f29e16a342a6059dbffe36020 14 14 1
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1192317005
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1192317005
+committer-tz -0700
+filename lib/grit.rb
+summary add Blob
+	require 'grit/blob'
+d01a4cfad6ea50285c4710243e3cbe019d381eba 12 15 1
+	require 'grit/repo'
+634396b2f541a9f2d58b00be1a07f0c358b999b3 9 16 1
+	
+d01a4cfad6ea50285c4710243e3cbe019d381eba 14 17 1
+	module Grit
+b6e1b765e0c15586a2c5b9832854f95defd71e1f 18 18 6
+author Tom Preston-Werner
+author-mail <tom@mojombo.com>
+author-time 1192860483
+author-tz -0700
+committer Tom Preston-Werner
+committer-mail <tom@mojombo.com>
+committer-time 1192860483
+committer-tz -0700
+filename lib/grit.rb
+summary implement Repo.init_bare
+	  class << self
+b6e1b765e0c15586a2c5b9832854f95defd71e1f 19 19
+	    attr_accessor :debug
+b6e1b765e0c15586a2c5b9832854f95defd71e1f 20 20
+	  end
+b6e1b765e0c15586a2c5b9832854f95defd71e1f 21 21
+	  
+b6e1b765e0c15586a2c5b9832854f95defd71e1f 22 22
+	  self.debug = false
+b6e1b765e0c15586a2c5b9832854f95defd71e1f 23 23
+	  
+634396b2f541a9f2d58b00be1a07f0c358b999b3 11 24 2
+	  VERSION = '1.0.0'
+634396b2f541a9f2d58b00be1a07f0c358b999b3 12 25
+	end

data/test/fixtures/cat_file_blob

@@ -0,0 +1 @@
+Hello world

data/test/fixtures/cat_file_blob_size

@@ -0,0 +1 @@
+11

data/test/fixtures/diff_2

@@ -0,0 +1,54 @@
+diff --git a/lib/grit/commit.rb b/lib/grit/commit.rb
+index a093bb1db8e884cccf396b297259181d1caebed4..80fd3d527f269ecbd570b65b8e21fd85baedb6e9 100644
+--- a/lib/grit/commit.rb
++++ b/lib/grit/commit.rb
+@@ -156,12 +156,8 @@ module Grit
+ 
+     def diffs
+       if parents.empty?
+-        diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id)
+-        if diff =~ /diff --git a/
+-          diff = diff.sub(/.+?(diff --git a)/m, '\1')
+-        else
+-          diff = ''
+-        end
++        diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id) 
++        diff = diff.sub(/.+?(diff --git a)/m, '\1')
+         Diff.list_from_string(@repo, diff)
+       else
+         self.class.diff(@repo, parents.first.id, @id) 
+diff --git a/test/fixtures/show_empty_commit b/test/fixtures/show_empty_commit
+deleted file mode 100644
+index ea25e32a409fdf74c1b9268820108d1c16dcc553..0000000000000000000000000000000000000000
+--- a/test/fixtures/show_empty_commit
++++ /dev/null
+@@ -1,6 +0,0 @@
+-commit 1e3824339762bd48316fe87bfafc853732d43264
+-tree 4b825dc642cb6eb9a060e54bf8d69288fbee4904
+-author Tom Preston-Werner <tom@mojombo.com> 1157392833 +0000
+-committer Tom Preston-Werner <tom@mojombo.com> 1157392833 +0000
+-
+-    initial directory structure
+diff --git a/test/test_commit.rb b/test/test_commit.rb
+index fdeb9000089b052f0b31a845e0173e9b089e06a0..bdbc450e08084d7d611e985cfa12fb424cab29b2 100644
+--- a/test/test_commit.rb
++++ b/test/test_commit.rb
+@@ -98,18 +98,6 @@ class TestCommit < Test::Unit::TestCase
+     assert_equal true, diffs[5].new_file
+   end
+   
+-  def test_diffs_on_initial_import_with_empty_commit
+-    Git.any_instance.expects(:show).with(
+-      {:full_index => true, :pretty => 'raw'}, 
+-      '634396b2f541a9f2d58b00be1a07f0c358b999b3'
+-    ).returns(fixture('show_empty_commit'))
+-    
+-    @c = Commit.create(@r, :id => '634396b2f541a9f2d58b00be1a07f0c358b999b3')
+-    diffs = @c.diffs
+-    
+-    assert_equal [], diffs
+-  end
+-  
+   # to_s
+   
+   def test_to_s

data/test/fixtures/diff_2f

@@ -0,0 +1,19 @@
+diff --git a/lib/grit/commit.rb b/lib/grit/commit.rb
+index a093bb1db8e884cccf396b297259181d1caebed4..80fd3d527f269ecbd570b65b8e21fd85baedb6e9 100644
+--- a/lib/grit/commit.rb
++++ b/lib/grit/commit.rb
+@@ -156,12 +156,8 @@ module Grit
+ 
+     def diffs
+       if parents.empty?
+-        diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id)
+-        if diff =~ /diff --git a/
+-          diff = diff.sub(/.+?(diff --git a)/m, '\1')
+-        else
+-          diff = ''
+-        end
++        diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id) 
++        diff = diff.sub(/.+?(diff --git a)/m, '\1')
+         Diff.list_from_string(@repo, diff)
+       else
+         self.class.diff(@repo, parents.first.id, @id) 

data/test/fixtures/diff_f

@@ -0,0 +1,15 @@
+diff --git a/lib/grit/diff.rb b/lib/grit/diff.rb
+index 537955bb86a8ceaa19aea89e75ccbea5ce6f2698..00b0b4a67eca9242db5f8991e99625acd55f040c 100644
+--- a/lib/grit/diff.rb
++++ b/lib/grit/diff.rb
+@@ -27,6 +27,10 @@ module Grit
+       while !lines.empty?
+         m, a_path, b_path = *lines.shift.match(%r{^diff --git a/(\S+) b/(\S+)$})
+         
++        if lines.first =~ /^old mode/
++          2.times { lines.shift }
++        end
++        
+         new_file = false
+         deleted_file = false
+