grit 2.0.0 → 2.1.0

data/History.txt

@@ -1,3 +1,24 @@
+== 2.1.0 / 2010-08-04
+  * Major Enhancements
+    * Add support for parsing annotated tag objects.
+    * Add Grit::Repo#recent_tag_name for getting the latest tag name that is
+      reachable in a commit.
+    * Grit::Diff tracks renames properly if given the :M option.
+    * Grit::Commit#diffs and Grit::Commit.diffs both take a git options hash
+      that is passed to `git diff`.
+  * Minor Enhancements
+    * Allow diff to only take one sha
+    * Add merge commit diff support
+    * Pass along the options to Real Git on a rev-parse miss
+    * Raise NoSuchPath with no tree in ls_tree_path
+    * Make pure-ruby `ls-tree -r` work with commits
+    * Implement select_existing_objects
+    * Switch to RakeGem for build management
+  * Bug Fixes
+    * Add no_quote option for fixing tag listings.
+    * Raise custom exceptions on invalid tree objects.
+    * Fix Repo#diff (was throwing an error).
+
 == 2.0.0 / 2009-10-27
   * Major Enhancements
     * All filesystem calls have been moved into Grit::Git to allow proxying

data/PURE_TODO

@@ -0,0 +1,35 @@
+This is a listing of all the places I can find that Grit actually does a
+'git' system call.  My goal is to add native Ruby versions of all of them.
+
+Completed
+===========================
+** lib/grit/blob.rb:36:      @size ||= @repo.git.cat_file({:s => true}, id).chomp.to_i
+** lib/grit/blob.rb:43:      @data ||= @repo.git.cat_file({:p => true}, id)
+** lib/grit/tree.rb:16:      output = repo.git.ls_tree({}, treeish, *paths)
+
+
+
+lib/grit/commit.rb:74:      repo.git.rev_list({}, ref).strip.split("\n").size
+lib/grit/commit.rb:92:      output = repo.git.rev_list(actual_options, ref)
+lib/grit/commit.rb:94:      output = repo.git.rev_list(actual_options.merge(:all => true))
+
+
+Next to do
+===========================
+lib/grit/tag.rb:28:      output = repo.git.for_each_ref(actual_options, "refs/tags")
+lib/grit/head.rb:37:      output = repo.git.for_each_ref(actual_options, HEAD_PREFIX)
+lib/grit/head.rb:50:        self.new($1, repo.git.rev_parse(options, 'HEAD'))
+lib/grit/config.rb:9:      @repo.git.config({}, key, value)
+lib/grit/config.rb:40:        @repo.git.config(:list => true).split(/\n/)
+
+
+May not be fast enough
+=============================
+lib/grit/blob.rb:58:      data = repo.git.blame({:p => true}, commit, '--', file)
+
+
+More Difficult
+===========================
+lib/grit/commit.rb:39:      @id_abbrev ||= @repo.git.rev_parse({:short => true}, self.id).chomp
+lib/grit/commit.rb:150:      text = repo.git.diff({:full_index => true}, *paths)
+lib/grit/commit.rb:156:        diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id)

data/Rakefile

@@ -0,0 +1,149 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+desc "Upload site to Rubyforge"
+task :site do
+  sh "scp -r doc/* mojombo@grit.rubyforge.org:/var/www/gforge-projects/grit"
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|test)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/{test/bench/benchmarks.rb → benchmarks.rb}

@@ -5,17 +5,20 @@ require 'ruby-prof'
 require 'memcache'
 require 'pp'
 
-gem 'grit', '=0.7.0' 
-#require '../../lib/grit'
+
+#require 'grit'
+require 'lib/grit'
 
 def main
-  @wbare = File.expand_path(File.join('../../', 'test', 'dot_git'))
+  @wbare = File.expand_path(File.join('test', 'dot_git'))
   
   in_temp_dir do
     #result = RubyProf.profile do
 
       git = Grit::Repo.new('.')
       puts Grit::VERSION
+      
+      Grit::GitRuby.use_commit_db = true
       #Grit::GitRuby.cache_client = MemCache.new 'localhost:11211', :namespace => 'grit'
       #Grit.debug = true
     

data/benchmarks.txt

@@ -0,0 +1,21 @@
+Grit : 
+              user     system      total        real
+packobj       0.030000   0.270000   1.380000 (  1.507250)
+commits 1     0.030000   0.070000   0.390000 (  0.409931)
+commits 2     0.110000   0.170000   0.860000 (  0.896371)
+log           0.350000   0.130000   0.850000 (  0.875035)
+diff          0.190000   0.140000   1.940000 (  2.031911)
+commit-diff   0.540000   0.220000   1.390000 (  1.463839)
+heads         0.010000   0.070000   0.390000 (  0.413918)
+
+
+Grit (with GitRuby) : 
+
+              user     system      total        real
+packobj       0.050000   0.010000   0.060000 (  0.078318)
+commits 1     0.150000   0.010000   0.160000 (  0.174296)
+commits 2     0.440000   0.040000   0.480000 (  0.522310)
+log           0.490000   0.040000   0.530000 (  0.538128)
+diff          0.370000   0.230000   2.250000 (  2.255974)
+commit-diff   0.580000   0.260000   1.500000 (  1.553000)
+heads         0.020000   0.100000   0.430000 (  0.455464)

data/examples/ex_index.rb

@@ -9,6 +9,13 @@ Dir.chdir("/Users/schacon/projects/atest") do
     i.add(fname, 'hello ' + fname)
     count += 1
   end
+  count = 5
+  while(count < 10) do
+    puts "HELLO"
+    fname = Time.now.to_i.to_s + count.to_s
+    i.add('test/' + fname, 'hello ' + fname)
+    count += 1
+  end
   puts i.commit('my commit')
   puts i.inspect
 end

data/grit.gemspec

@@ -0,0 +1,76 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'grit'
+  s.version           = '2.1.0'
+  s.date              = '2010-08-04'
+  s.rubyforge_project = 'grit'
+
+  s.summary     = "Ruby Git bindings."
+  s.description = "Grit is a Ruby library for extracting information from a git repository in an object oriented manner."
+
+  s.authors  = ["Tom Preston-Werner", "Scott Chacon"]
+  s.email    = 'tom@github.com'
+  s.homepage = 'http://github.com/github/gollum'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency('mime-types', "~> 1.15")
+  s.add_dependency('diff-lcs', "~> 1.1")
+
+  s.add_development_dependency('mocha')
+
+  # = MANIFEST =
+  s.files = %w[
+    API.txt
+    History.txt
+    LICENSE
+    PURE_TODO
+    README.md
+    Rakefile
+    benchmarks.rb
+    benchmarks.txt
+    examples/ex_add_commit.rb
+    examples/ex_index.rb
+    grit.gemspec
+    lib/grit.rb
+    lib/grit/actor.rb
+    lib/grit/blame.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.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/file_window.rb
+    lib/grit/git-ruby/internal/loose.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.rb
+    lib/grit/index.rb
+    lib/grit/lazy.rb
+    lib/grit/merge.rb
+    lib/grit/open3_detach.rb
+    lib/grit/ref.rb
+    lib/grit/repo.rb
+    lib/grit/ruby1.9.rb
+    lib/grit/status.rb
+    lib/grit/submodule.rb
+    lib/grit/tag.rb
+    lib/grit/tree.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/grit.rb

@@ -9,13 +9,12 @@ require 'timeout'
 require 'logger'
 require 'digest/sha1'
 
-
 if defined? RUBY_ENGINE && RUBY_ENGINE == 'jruby'
   require 'open3'
 elsif RUBY_PLATFORM.downcase =~ /mswin(?!ce)|mingw|bccwin/
   require 'win32/open3'
 else
-  require 'open3_detach'
+  require 'grit/open3_detach'
 end
 
 # third party
@@ -51,12 +50,15 @@ require 'grit/submodule'
 require 'grit/blame'
 require 'grit/merge'
 
-
 module Grit
+  VERSION = '2.1.0'
+
   class << self
     # Set +debug+ to true to log all git calls and responses
     attr_accessor :debug
     attr_accessor :use_git_ruby
+    attr_accessor :no_quote
+
     # The standard +logger+ for debugging git calls - this defaults to a plain STDOUT logger
     attr_accessor :logger
     def log(str)
@@ -65,11 +67,11 @@ module Grit
   end
   self.debug = false
   self.use_git_ruby = true
+  self.no_quote = false
 
   @logger ||= ::Logger.new(STDOUT)
 
   def self.version
-    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
-    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
+    VERSION
   end
 end

data/lib/grit/commit.rb

@@ -2,6 +2,7 @@ module Grit
 
   class Commit
     attr_reader :id
+    attr_reader :repo
     lazy_reader :parents
     lazy_reader :tree
     lazy_reader :author
@@ -140,16 +141,18 @@ module Grit
       commits
     end
 
-    # Show diffs between two trees:
-    #   +repo+ is the Repo
-    #   +a+ is a named commit
-    #   +b+ is an optional named commit.  Passing an array assumes you
-    #     wish to omit the second named commit and limit the diff to the
-    #     given paths.
-    #   +paths* is an array of paths to limit the diff.
+    # Show diffs between two trees.
+    #
+    # repo    - The current Grit::Repo instance.
+    # a       - A String named commit.
+    # b       - An optional String named commit.  Passing an array assumes you
+    #           wish to omit the second named commit and limit the diff to the
+    #           given paths.
+    # paths   - An optional Array of paths to limit the diff.
+    # options - An optional Hash of options.  Merged into {:full_index => true}.
     #
     # Returns Grit::Diff[] (baked)
-    def self.diff(repo, a, b = nil, paths = [])
+    def self.diff(repo, a, b = nil, paths = [], options = {})
       if b.is_a?(Array)
         paths = b
         b     = nil
@@ -157,12 +160,18 @@ module Grit
       paths.unshift("--") unless paths.empty?
       paths.unshift(b)    unless b.nil?
       paths.unshift(a)
-      text = repo.git.diff({:full_index => true}, *paths)
+      options = {:full_index => true}.update(options)
+      text    = repo.git.diff(options, *paths)
       Diff.list_from_string(repo, text)
     end
 
     def show
-      diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id)
+      if parents.size > 1
+        diff = @repo.git.native("diff #{parents[0].id}...#{parents[1].id}", {:full_index => true})
+      else
+        diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id)
+      end
+
       if diff =~ /diff --git a/
         diff = diff.sub(/.+?(diff --git a)/m, '\1')
       else
@@ -171,11 +180,16 @@ module Grit
       Diff.list_from_string(@repo, diff)
     end
 
-    def diffs
+    # Shows diffs between the commit's parent and the commit.
+    #
+    # options - An optional Hash of options, passed to Grit::Commit.diff.
+    #
+    # Returns Grit::Diff[] (baked)
+    def diffs(options = {})
       if parents.empty?
         show
       else
-        self.class.diff(@repo, parents.first.id, @id)
+        self.class.diff(@repo, parents.first.id, @id, [], options)
       end
     end