mojombo-grit 0.8.1 → 0.9.3

data/History.txt

@@ -1,6 +1,13 @@
+== 0.8.3 / 2008-07-07
+  * Capture stderr and log if debug is true (rsanheim)
+  
+== 0.8.2 / 2008-06-27
+  * Allow user provided logger (rsanheim)
+  
 == 0.8.0 / 2008-04-24
   * Lots of fixes and additions
 
 == 0.7.0 / 2008-01-07
   * First public release!
 
+ 

data/Manifest.txt

@@ -3,19 +3,33 @@ Manifest.txt
 README.txt
 Rakefile
 grit.gemspec
-lib/grit.rb
 lib/grit/actor.rb
 lib/grit/blob.rb
 lib/grit/commit.rb
+lib/grit/commit_stats.rb
 lib/grit/config.rb
 lib/grit/diff.rb
 lib/grit/errors.rb
+lib/grit/git-ruby/commit_db.rb
+lib/grit/git-ruby/file_index.rb
+lib/grit/git-ruby/git_object.rb
+lib/grit/git-ruby/internal/loose.rb
+lib/grit/git-ruby/internal/mmap.rb
+lib/grit/git-ruby/internal/pack.rb
+lib/grit/git-ruby/internal/raw_object.rb
+lib/grit/git-ruby/object.rb
+lib/grit/git-ruby/repository.rb
+lib/grit/git-ruby.rb
 lib/grit/git.rb
 lib/grit/head.rb
+lib/grit/index.rb
 lib/grit/lazy.rb
+lib/grit/ref.rb
 lib/grit/repo.rb
+lib/grit/status.rb
 lib/grit/tag.rb
 lib/grit/tree.rb
+lib/grit.rb
 test/fixtures/blame
 test/fixtures/cat_file_blob
 test/fixtures/cat_file_blob_size
@@ -27,6 +41,7 @@ test/fixtures/diff_mode_only
 test/fixtures/diff_new_mode
 test/fixtures/diff_p
 test/fixtures/for_each_ref
+test/fixtures/for_each_ref_remotes
 test/fixtures/for_each_ref_tags
 test/fixtures/ls_tree_a
 test/fixtures/ls_tree_b
@@ -46,8 +61,10 @@ test/test_commit.rb
 test/test_config.rb
 test/test_diff.rb
 test/test_git.rb
+test/test_grit.rb
 test/test_head.rb
 test/test_reality.rb
+test/test_remote.rb
 test/test_repo.rb
 test/test_tag.rb
 test/test_tree.rb

data/grit.gemspec

@@ -1,16 +1,62 @@
 Gem::Specification.new do |s|
-  s.name = "grit"
-  s.version = "0.8.1"
-  s.date = "2008-04-24"
-  s.summary = "Object model interface to a git repo"
-  s.email = "tom@rubyisawesome.com"
-  s.homepage = "http://github.com/mojombo/grit"
+  s.name     = "grit"
+  s.version  = "0.9.3"
+  s.date     = "2008-04-24"
+  s.summary  = "Object model interface to a git repo"
+  s.email    = "tom@rubyisawesome.com"
+  s.homepage = "http://github.com/schacon/grit"
   s.description = "Grit is a Ruby library for extracting information from a git repository in and object oriented manner."
   s.has_rdoc = true
-  s.authors = ["Tom Preston-Werner"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "grit.gemspec", "lib/grit.rb", "lib/grit/actor.rb", "lib/grit/blob.rb", "lib/grit/commit.rb", "lib/grit/config.rb", "lib/grit/diff.rb", "lib/grit/errors.rb", "lib/grit/git.rb", "lib/grit/head.rb", "lib/grit/lazy.rb", "lib/grit/repo.rb", "lib/grit/tag.rb", "lib/grit/tree.rb", "test/fixtures/blame", "test/fixtures/cat_file_blob", "test/fixtures/cat_file_blob_size", "test/fixtures/diff_2", "test/fixtures/diff_2f", "test/fixtures/diff_f", "test/fixtures/diff_i", "test/fixtures/diff_mode_only", "test/fixtures/diff_new_mode", "test/fixtures/diff_p", "test/fixtures/for_each_ref", "test/fixtures/for_each_ref_tags", "test/fixtures/ls_tree_a", "test/fixtures/ls_tree_b", "test/fixtures/ls_tree_commit", "test/fixtures/rev_list", "test/fixtures/rev_list_count", "test/fixtures/rev_list_single", "test/fixtures/rev_parse", "test/fixtures/show_empty_commit", "test/fixtures/simple_config", "test/helper.rb", "test/profile.rb", "test/suite.rb", "test/test_actor.rb", "test/test_blob.rb", "test/test_commit.rb", "test/test_config.rb", "test/test_diff.rb", "test/test_git.rb", "test/test_head.rb", "test/test_reality.rb", "test/test_repo.rb", "test/test_tag.rb", "test/test_tree.rb", "test/test_real.rb"]
-  s.test_files = ["test/test_actor.rb", "test/test_blob.rb", "test/test_commit.rb", "test/test_config.rb", "test/test_diff.rb", "test/test_git.rb", "test/test_head.rb", "test/test_real.rb", "test/test_reality.rb", "test/test_repo.rb", "test/test_tag.rb", "test/test_tree.rb"]
+  s.authors  = ["Tom Preston-Werner", "Scott Chacon"]
+  s.files    = ["History.txt", 
+		"Manifest.txt", 
+		"README.txt", 
+		"Rakefile", 
+		"grit.gemspec", 
+		"lib/grit/actor.rb", 
+		"lib/grit/blob.rb", 
+		"lib/grit/commit.rb", 
+		"lib/grit/commit_stats.rb", 
+		"lib/grit/config.rb", 
+		"lib/grit/diff.rb", 
+		"lib/grit/errors.rb", 
+		"lib/grit/git-ruby/commit_db.rb", 
+		"lib/grit/git-ruby/file_index.rb", 
+		"lib/grit/git-ruby/git_object.rb", 
+		"lib/grit/git-ruby/internal", 
+		"lib/grit/git-ruby/internal/loose.rb", 
+		"lib/grit/git-ruby/internal/mmap.rb", 
+		"lib/grit/git-ruby/internal/pack.rb", 
+		"lib/grit/git-ruby/internal/raw_object.rb", 
+		"lib/grit/git-ruby/object.rb", 
+		"lib/grit/git-ruby/repository.rb", 
+		"lib/grit/git-ruby.rb", 
+		"lib/grit/git.rb", 
+		"lib/grit/head.rb", 
+		"lib/grit/index.rb", 
+		"lib/grit/lazy.rb", 
+		"lib/grit/ref.rb", 
+		"lib/grit/repo.rb", 
+		"lib/grit/status.rb", 
+		"lib/grit/tag.rb", 
+		"lib/grit/tree.rb", 
+		"lib/grit.rb"]
+  s.test_files = ["test/test_actor.rb", 
+      "test/test_blob.rb", "test/test_commit.rb", 
+      "test/test_config.rb", 
+      "test/test_diff.rb", 
+      "test/test_git.rb", 
+      "test/test_grit.rb", 
+      "test/test_head.rb", 
+      "test/test_real.rb", 
+      "test/test_reality.rb",
+      "test/test_remote.rb", 
+      "test/test_repo.rb", 
+      "test/test_tag.rb", 
+      "test/test_tree.rb"]
   s.rdoc_options = ["--main", "README.txt"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency("diff-lcs", ["> 0.0.0"])
   s.add_dependency("mime-types", ["> 0.0.0"])
-end
+  s.add_dependency("open4", ["> 0.0.0"])
+end

data/lib/{mojombo-grit.rb → grit.rb}

@@ -6,32 +6,48 @@ require 'time'
 
 # stdlib
 require 'timeout'
+require 'logger'
 
 # third party
 require 'rubygems'
 require 'mime/types'
 require 'open4'
+require 'digest/sha1'
 
 # internal requires
 require 'grit/lazy'
 require 'grit/errors'
+require 'grit/git-ruby'
 require 'grit/git'
-require 'grit/head'
-require 'grit/tag'
+require 'grit/ref'
 require 'grit/commit'
+require 'grit/commit_stats'
 require 'grit/tree'
 require 'grit/blob'
 require 'grit/actor'
 require 'grit/diff'
 require 'grit/config'
 require 'grit/repo'
+require 'grit/index'
+require 'grit/status'
+
 
 module Grit
+  
   class << self
+    # Set +debug+ to true to log all git calls and responses
     attr_accessor :debug
+    attr_accessor :use_git_ruby
+    # The standard +logger+ for debugging git calls - this defaults to a plain STDOUT logger
+    attr_accessor :logger
+    def log(str)
+      logger.debug { str }
+    end
   end
-  
   self.debug = false
+  self.use_git_ruby = true
+  
+  @logger ||= ::Logger.new(STDOUT)
   
-  VERSION = '0.8.1'
+  VERSION = '0.9.1'
 end

data/lib/grit/commit.rb

@@ -36,7 +36,7 @@ module Grit
     end
     
     def id_abbrev
-      @id_abbrev ||= @repo.git.rev_parse({:short => true}, self.id).chomp
+      @id_abbrev ||= @repo.git.rev_parse({}, self.id).chomp[0, 7]
     end
     
     # Create an unbaked Commit containing just the specified attributes
@@ -84,7 +84,7 @@ module Grit
     # Returns Grit::Commit[] (baked)
     def self.find_all(repo, ref, options = {})
       allowed_options = [:max_count, :skip, :since]
-      
+          
       default_options = {:pretty => "raw"}
       actual_options = default_options.merge(options)
       
@@ -93,8 +93,10 @@ module Grit
       else
         output = repo.git.rev_list(actual_options.merge(:all => true))
       end
-      
+            
       self.list_from_string(repo, output)
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+      []
     end
     
     # Parse out commit information into an array of baked Commit objects
@@ -102,11 +104,15 @@ module Grit
     #   +text+ is the text output from the git command (raw format)
     #
     # Returns Grit::Commit[] (baked)
+    #
+    # really should re-write this to be more accepting of non-standard commit messages
+    # - it broke when 'encoding' was introduced - not sure what else might show up
+    #
     def self.list_from_string(repo, text)
       lines = text.split("\n")
       
       commits = []
-      
+            
       while !lines.empty?
         id = lines.shift.split.last
         tree = lines.shift.split.last
@@ -117,6 +123,9 @@ module Grit
         author, authored_date = self.actor(lines.shift)
         committer, committed_date = self.actor(lines.shift)
         
+        # not doing anything with this yet, but it's sometimes there
+        encoding = lines.shift.split.last if lines.first =~ /^encoding/
+        
         lines.shift
         
         message_lines = []
@@ -151,15 +160,19 @@ module Grit
       Diff.list_from_string(repo, text)
     end
 
+    def show
+      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.list_from_string(@repo, diff)
+    end
+
     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.list_from_string(@repo, diff)
+        show
       else
         self.class.diff(@repo, parents.first.id, @id) 
       end
@@ -169,6 +182,14 @@ module Grit
     def to_s
       @id
     end
+
+    def sha
+      @id
+    end
+    
+    def date
+      @committed_date
+    end
     
     # Pretty object inspection
     def inspect

data/lib/grit/commit_stats.rb

@@ -0,0 +1,104 @@
+module Grit
+  
+  class CommitStats
+    
+    attr_reader :id, :files, :additions, :deletions, :total
+    
+    # Instantiate a new CommitStats
+    #   +id+ is the id of the commit
+    #   +files+ is an array of :
+    #     [ [filename, adds, deletes, total],
+    #       [filename, adds, deletes, total],
+    #       [filename, adds, deletes, total] ]
+    #
+    # Returns Grit::CommitStats (baked)
+    def initialize(repo, id, files)
+      @repo = repo
+      @id = id
+      @files = files
+      @additions  = files.inject(0) { |total, a| total += a[1] } 
+      @deletions  = files.inject(0) { |total, a| total += a[2] } 
+      @total  = files.inject(0) { |total, a| total += a[3] } 
+    end
+    
+    # Find all commit stats matching the given criteria.
+    #   +repo+ is the Repo
+    #   +ref+ is the ref from which to begin (SHA1 or name) or nil for --all
+    #   +options+ is a Hash of optional arguments to git
+    #     :max_count is the maximum number of commits to fetch
+    #     :skip is the number of commits to skip
+    #
+    # Returns assoc array [sha, Grit::Commit[] (baked)]
+    def self.find_all(repo, ref, options = {})
+      allowed_options = [:max_count, :skip, :since]
+            
+      default_options = {:numstat => true}
+      actual_options = default_options.merge(options)
+      
+      if ref
+        output = repo.git.log(actual_options, ref)
+      else
+        output = repo.git.log(actual_options.merge(:all => true))
+      end
+      
+      self.list_from_string(repo, output)
+    end
+    
+    # Parse out commit information into an array of baked Commit objects
+    #   +repo+ is the Repo
+    #   +text+ is the text output from the git command (raw format)
+    #
+    # Returns assoc array [sha, Grit::Commit[] (baked)]
+    def self.list_from_string(repo, text)
+      lines = text.split("\n")
+      
+      commits = []
+
+      while !lines.empty?
+        id = lines.shift.split.last
+        
+        lines.shift
+        lines.shift
+        lines.shift
+        
+        message_lines = []
+        message_lines << lines.shift[4..-1] while lines.first =~ /^ {4}/
+        
+        lines.shift while lines.first && lines.first.empty?
+
+        files = []
+        while lines.first =~ /^(\d+)\s+(\d+)\s+(.+)/
+          (additions, deletions, filename) = lines.shift.split
+          additions = additions.to_i
+          deletions = deletions.to_i
+          total = additions + deletions
+          files << [filename, additions, deletions, total]
+        end
+        
+        lines.shift while lines.first && lines.first.empty?
+        
+        commits << [id, CommitStats.new(repo, id, files)]
+      end
+      
+      commits
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::CommitStats "#{@id}">}
+    end
+    
+    # private
+    
+    def to_hash
+      {
+        'id'        => id,
+        'files'     => files,
+        'additions' => additions,
+        'deletions' => deletions,
+        'total'     => total
+      }
+    end
+  end # CommitStats
+  
+end # Grit

data/lib/grit/git-ruby.rb

@@ -0,0 +1,182 @@
+require 'grit/git-ruby/repository'
+require 'grit/git-ruby/file_index'
+
+module Grit
+  
+  # the functions in this module intercept the calls to git binary
+  # made buy the grit objects and attempts to run them in pure ruby
+  # if it will be faster, or if the git binary is not available (!!TODO!!)
+  module GitRuby
+    
+    attr_accessor :ruby_git_repo, :git_file_index
+    
+    def init(options)
+      if options.size == 0
+        Grit::GitRuby::Repository.init(@git_dir)
+      else
+        method_missing('init', options) 
+      end
+    end
+    
+    def cat_file(options, ref)
+      if options[:t]
+        file_type(ref)
+      elsif options[:s]
+        file_size(ref)
+      elsif options[:p]
+        try_run { ruby_git.cat_file(ref) }
+      end
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+      ''
+    end
+    
+    # lib/grit/tree.rb:16:      output = repo.git.ls_tree({}, treeish, *paths)
+    def ls_tree(options, treeish, *paths)
+      sha = rev_parse({}, treeish)
+      ruby_git.ls_tree(sha, paths.flatten)
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+      ''
+    end
+
+    # git diff --full-index 'ec037431382e83c3e95d4f2b3d145afbac8ea55d' 'f1ec1aea10986159456846b8a05615b87828d6c6'
+    def diff(options, sha1, sha2)
+      try_run { ruby_git.diff(sha1, sha2, options) }
+    end
+    
+    def rev_list(options, ref = 'master')
+      options.delete(:skip) if options[:skip].to_i == 0
+      allowed_options = [:max_count, :since, :until, :pretty]  # this is all I can do right now
+      if ((options.keys - allowed_options).size > 0)
+        return method_missing('rev-list', options, ref)
+      elsif (options.size == 0)
+        # pure rev-list
+        begin
+          return file_index.commits_from(rev_parse({}, ref)).join("\n")
+        rescue
+          return method_missing('rev-list', options, ref) 
+        end
+      else
+        aref = rev_parse({}, ref)
+        if aref.is_a? Array
+          return method_missing('rev-list', options, ref) 
+        else
+          return try_run { ruby_git.rev_list(aref, options) }
+        end
+      end
+    end
+    
+    def rev_parse(options, string)      
+      if string =~ /\.\./
+        (sha1, sha2) = string.split('..')
+        return [rev_parse({}, sha1), rev_parse({}, sha2)]
+      end
+      
+      if /\w{40}/.match(string)  # passing in a sha - just no-op it
+        return string.chomp
+      end
+
+      head = File.join(@git_dir, 'refs', 'heads', string)
+      return File.read(head).chomp if File.file?(head)
+
+      head = File.join(@git_dir, 'refs', 'remotes', string)
+      return File.read(head).chomp if File.file?(head)
+      
+      head = File.join(@git_dir, 'refs', 'tags', string)
+      return File.read(head).chomp if File.file?(head)
+      
+      ## check packed-refs file, too 
+      packref = File.join(@git_dir, 'packed-refs')
+      if File.file?(packref)
+        File.readlines(packref).each do |line|
+          if m = /^(\w{40}) refs\/.+?\/(.*?)$/.match(line)
+            next if !Regexp.new(string + '$').match(m[3])
+            return m[1].chomp
+          end
+        end
+      end
+      
+      ## !! more - partials and such !!
+      
+      # revert to calling git - grr
+      return method_missing('rev-parse', {}, string).chomp
+    end
+    
+    def file_size(ref)
+      try_run { ruby_git.cat_file_size(ref).to_s }
+    end
+    
+    def file_type(ref)
+      try_run { ruby_git.cat_file_type(ref).to_s }
+    end
+    
+    def blame_tree(commit, path = nil)
+      begin
+        commits = file_index.last_commits(rev_parse({}, commit), looking_for(commit, path))
+        clean_paths(commits)
+      rescue FileIndex::IndexFileNotFound
+        {}
+      end
+    end
+    
+    def file_index
+      @git_file_index ||= FileIndex.new(@git_dir)
+    end
+    
+    def ruby_git
+      @ruby_git_repo ||= Repository.new(@git_dir)
+    end
+    
+    private
+    
+      def try_run
+        ret = ''
+        Timeout.timeout(self.class.git_timeout) do
+          ret = yield
+        end
+        @bytes_read += ret.size
+
+        #if @bytes_read > 5242880 # 5.megabytes
+        #  bytes = @bytes_read
+        #  @bytes_read = 0
+        #  raise Grit::Git::GitTimeout.new(command, bytes) 
+        #end
+
+        ret
+      rescue Timeout::Error => e
+        bytes = @bytes_read
+        @bytes_read = 0
+        raise Grit::Git::GitTimeout.new(command, bytes)
+      end
+    
+      def looking_for(commit, path = nil)
+        tree_sha = ruby_git.get_subtree(rev_parse({}, commit), path)
+
+        looking_for = []
+        ruby_git.get_object_by_sha1(tree_sha).entry.each do |e|
+          if path && !(path == '' || path == '.' || path == './')
+            file = File.join(path, e.name)
+          else
+            file = e.name
+          end
+          file += '/' if e.type == :directory
+          looking_for << file
+        end
+        looking_for
+      end
+    
+      def clean_paths(commit_array)
+        new_commits = {}
+        commit_array.each do |file, sha|
+          file = file.chop if file[file.size - 1 , 1] == '/'
+          new_commits[file] = sha
+        end
+        new_commits
+      end
+
+    # TODO     
+    # git grep -n 'foo' 'master'
+    # git log --pretty='raw' --max-count='1' 'master' -- 'LICENSE'
+    # git log --pretty='raw' --max-count='1' 'master' -- 'test'
+    
+  end
+end