grit 1.1.1 → 2.0.0

data/History.txt

@@ -1,3 +1,12 @@
+== 2.0.0 / 2009-10-27
+  * Major Enhancements
+    * All filesystem calls have been moved into Grit::Git to allow proxying
+  * Non-code changes
+    * Removed all trailing whitespace in code files
+  * Bug Fixes
+    * Repo.archive_tar_gz now passes -n option to gzip to be idempotent
+    * Fix RubyGit's diff to detect additions and deletions [github.com/defunkt]
+
 == 1.1.1 / 2009-03-31
   * Changes
     * Don't include test directory in gem package (it's too big)

data/README.md

@@ -9,12 +9,13 @@ reimplementations of core Git functionality. This choice, however, is
 transparent to end users, and you need not know which method is being used.
 
 This software was developed to power GitHub, and should be considered
-production ready. An extensive test suite is provided to verify its correctness.
+production ready. An extensive test suite is provided to verify its
+correctness.
 
 Grit is maintained by Tom Preston-Werner, Scott Chacon, Chris Wanstrath, and
 PJ Hyett.
 
-This documentation is accurate as of Grit 1.0.2.
+This documentation is accurate as of Grit 2.0.
 
 
 ## Requirements #############################################################
@@ -26,15 +27,7 @@ This documentation is accurate as of Grit 1.0.2.
 
 Easiest install is via RubyGems:
 
-    $ gem install grit
-
-or
-
-    $ gem sources -a http://gems.github.com/ (you only need to do this once)
-    $ gem install mojombo-grit
-
-The gem from GitHub will generally be available sooner than the gem from
-Rubyforge. Both sources will eventually contain the same releases.
+    $ gem install grit -s http://gemcutter.org
 
 
 ## Source ###################################################################
@@ -48,12 +41,29 @@ and cloned with:
     git clone git://github.com/mojombo/grit.git
 
 
+### Development
+
+You will need these gems to get tests to pass:
+
+* jeweler
+* mocha
+
+
+### Contributing
+
+If you'd like to contribute to Grit, we ask that you fork mojombo/grit on
+GitHub, and push up a topic branch for each feature you add or bug you fix.
+Then create an issue and link to the topic branch and explain what the code
+does. This allows us to discuss and merge each change separately.
+
+
 ## Usage ####################################################################
 
 Grit gives you object model access to your Git repositories. Once you have
 created a `Repo` object, you can traverse it to find parent commits,
 trees, blobs, etc.
 
+
 ### Initialize a Repo object
 
 The first step is to create a `Grit::Repo` object to represent your repo. In
@@ -69,6 +79,7 @@ a bare repo.
 
     repo = Repo.new("/var/git/grit.git")
 
+
 ### Getting a list of commits
 
 From the `Repo` object, you can get a list of commits as an array of `Commit`
@@ -99,6 +110,7 @@ If you need paging, you can specify a number of commits to skip.
 
 The above will return commits 21-30 from the commit list.
 
+
 ### The Commit object
 
 `Commit` objects contain information about that commit.
@@ -135,6 +147,7 @@ You can traverse a commit's ancestry by chaining calls to `#parents`.
 
 The above corresponds to **master^^^** or **master~3** in Git parlance.
 
+
 ### The Tree object
 
 A tree records pointers to the contents of a directory. Let's say you want
@@ -178,6 +191,7 @@ You can also get a tree directly from the repo if you know its name.
     repo.tree("91169e1f5fa4de2eaea3f176461f5dc784796769")
     # => #<Grit::Tree "91169e1f5fa4de2eaea3f176461f5dc784796769">
 
+
 ### The Blob object
 
 A blob represents a file. Trees often contain blobs.
@@ -208,3 +222,15 @@ You can also get a blob directly from the repo if you know its name.
 
     repo.blob("4ebc8aea50e0a67e000ba29a30809d0a7b9b2666")
     # => #<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">
+
+
+### Other
+
+There are many more API methods available that are not documented here. Please
+reference the code for more functionality.
+
+
+Copyright
+---------
+
+Copyright (c) 2008 Tom Preston-Werner. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:major: 1
-:minor: 1
-:patch: 1
+:major: 2
+:minor: 0
+:patch: 0

data/examples/ex_add_commit.rb

@@ -0,0 +1,13 @@
+require '../lib/grit'
+
+count = 1
+Dir.chdir("/Users/schacon/projects/atest") do
+  r = Grit::Repo.new('.')
+  while(count < 10) do
+    fname = Time.now.to_i.to_s + count.to_s
+    File.open(fname, 'w') { |f| f.write('hellor ' + fname) }
+    r.add(fname)
+    count += 1
+  end
+  r.commit_index('my commit')
+end

data/examples/ex_index.rb

@@ -0,0 +1,14 @@
+require '../lib/grit'
+
+count = 1
+Dir.chdir("/Users/schacon/projects/atest") do
+  r = Grit::Repo.new('.')
+  i = r.index
+  while(count < 10) do
+    fname = Time.now.to_i.to_s + count.to_s
+    i.add(fname, 'hello ' + fname)
+    count += 1
+  end
+  puts i.commit('my commit')
+  puts i.inspect
+end

data/lib/grit.rb

@@ -9,16 +9,23 @@ 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'
 end
 
 # third party
 require 'rubygems'
-gem "mime-types", ">=0"
-require 'mime/types'
+begin
+  gem "mime-types", ">=0"
+  require 'mime/types'
+rescue Gem::LoadError => e
+  puts "WARNING: Gem LoadError: #{e.message}"
+end
 
 # ruby 1.9 compatibility
 require 'grit/ruby1.9'
@@ -27,7 +34,7 @@ require 'grit/ruby1.9'
 require 'grit/lazy'
 require 'grit/errors'
 require 'grit/git-ruby'
-require 'grit/git'
+require 'grit/git' unless defined? Grit::Git
 require 'grit/ref'
 require 'grit/tag'
 require 'grit/commit'

data/lib/grit/actor.rb

@@ -1,15 +1,15 @@
 module Grit
-  
+
   class Actor
     attr_reader :name
     attr_reader :email
-    
+
     def initialize(name, email)
       @name = name
       @email = email
     end
     alias_method :to_s, :name
-    
+
     # Create an Actor from a string.
     #   +str+ is the string, which is expected to be in regular git format
     #
@@ -26,11 +26,11 @@ module Grit
           return self.new(str, nil)
       end
     end
-    
+
     # Pretty object inspection
     def inspect
       %Q{#<Grit::Actor "#{@name} <#{@email}>">}
     end
   end # Actor
-  
+
 end # Grit

data/lib/grit/blob.rb

@@ -1,12 +1,12 @@
 module Grit
-  
+
   class Blob
     DEFAULT_MIME_TYPE = "text/plain"
-    
+
     attr_reader :id
     attr_reader :mode
     attr_reader :name
-    
+
     # Create an unbaked Blob containing just the specified attributes
     #   +repo+ is the Repo
     #   +atts+ is a Hash of instance variable data
@@ -15,7 +15,7 @@ module Grit
     def self.create(repo, atts)
       self.allocate.create_initialize(repo, atts)
     end
-    
+
     # Initializer for Blob.create
     #   +repo+ is the Repo
     #   +atts+ is a Hash of instance variable data
@@ -28,21 +28,21 @@ module Grit
       end
       self
     end
-    
+
     # The size of this blob in bytes
     #
     # Returns Integer
     def size
       @size ||= @repo.git.cat_file({:s => true}, id).chomp.to_i
     end
-    
+
     # The binary contents of this blob.
     #
     # Returns String
     def data
       @data ||= @repo.git.cat_file({:p => true}, id)
     end
-    
+
     # The mime type of this file (based on the filename)
     #
     # Returns String
@@ -50,17 +50,17 @@ module Grit
       guesses = MIME::Types.type_for(self.name) rescue []
       guesses.first ? guesses.first.simplified : DEFAULT_MIME_TYPE
     end
-    
+
     # The blame information for the given file at the given commit
     #
     # Returns Array: [Grit::Commit, Array: [<line>]]
     def self.blame(repo, commit, file)
       data = repo.git.blame({:p => true}, commit, '--', file)
-      
+
       commits = {}
       blames = []
       info = nil
-      
+
       data.split("\n").each do |line|
         parts = line.split(/\s+/, 2)
         case parts.first
@@ -107,11 +107,11 @@ module Grit
 
       blames
     end
-    
+
     def basename
       File.basename(name)
     end
-    
+
     # Pretty object inspection
     def inspect
       %Q{#<Grit::Blob "#{@id}">}

data/lib/grit/commit.rb

@@ -33,7 +33,7 @@ module Grit
       @committer = committer
       @committed_date = committed_date
       @message = message.join("\n")
-      @short_message = message[0] || ''
+      @short_message = message.select { |x| !x.strip.empty? }[0] || ''
     end
 
     def id_abbrev
@@ -178,11 +178,11 @@ module Grit
         self.class.diff(@repo, parents.first.id, @id)
       end
     end
-    
+
     def stats
       stats = @repo.commit_stats(self.sha, 1)[0][-1]
     end
-    
+
     # Convert this Commit to a String which is just the SHA1 id
     def to_s
       @id

data/lib/grit/commit_stats.rb

@@ -1,9 +1,9 @@
 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 :
@@ -16,11 +16,11 @@ module Grit
       @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] } 
+      @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
@@ -31,19 +31,19 @@ module Grit
     # 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)
@@ -51,19 +51,19 @@ module Grit
     # 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.first == ''
-        
+
         lines.shift while lines.first && lines.first.empty?
 
         files = []
@@ -74,29 +74,29 @@ module Grit
           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
-    
+
     # Convert to an easy-to-traverse structure
     def to_diffstat
       files.map do |metadata|
         DiffStat.new(*metadata)
       end
     end
-    
+
     # private
-    
+
     def to_hash
       {
         'id'        => id,
@@ -106,16 +106,16 @@ module Grit
         'total'     => total
       }
     end
-    
+
   end # CommitStats
-  
+
   class DiffStat
     attr_reader :filename, :additions, :deletions
 
     def initialize(filename, additions, deletions, total=nil)
       @filename, @additions, @deletions = filename, additions, deletions
     end
-    
+
     def net
       additions - deletions
     end
@@ -124,5 +124,5 @@ module Grit
       "#{filename}: +#{additions} -#{deletions}"
     end
   end
-  
+
 end # Grit