mojombo-grit 0.8.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.8.0 / 2008-04-24
+  * Lots of fixes and additions
+
+== 0.7.0 / 2008-01-07
+  * First public release!
+

data/Manifest.txt

@@ -0,0 +1,53 @@
+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

data/README.txt

@@ -0,0 +1,213 @@
+grit
+    by Tom Preston-Werner, Chris Wanstrath
+    http://github.com/mojombo/grit
+
+== DESCRIPTION:
+
+Grit is a Ruby library for extracting information from a git repository in and
+object oriented manner.
+
+== REQUIREMENTS:
+
+* git (http://git.or.cz) tested with 1.5.3.4
+
+== INSTALL:
+
+  $ gem sources -a http://gems.github.com/ (you only need to do this once)
+  $ gem install mojombo-grit
+
+== SOURCE:
+
+Grit's git repo is available on GitHub, which can be browsed at:
+
+  http://github.com/mojombo/grit
+
+and cloned from:
+
+  git://github.com/mojombo/grit.git
+
+== USAGE:
+
+Grit gives you object model access to your git repository. Once you have
+created a repository object, you can traverse it to find parent commit(s),
+trees, blobs, etc.
+
+= Initialize a Repo object
+
+The first step is to create a Grit::Repo object to represent your repo. I
+include the Grit module so reduce typing.
+
+  require 'mojombo-grit'
+  include Grit
+  repo = Repo.new("/Users/tom/dev/grit")
+  
+In the above example, the directory /Users/tom/dev/grit is my working
+repo and contains the .git directory. You can also initialize Grit with 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
+objects.
+
+  repo.commits
+  # => [#<Grit::Commit "e80bbd2ce67651aa18e57fb0b43618ad4baf7750">,
+        #<Grit::Commit "91169e1f5fa4de2eaea3f176461f5dc784796769">,
+        #<Grit::Commit "038af8c329ef7c1bae4568b98bd5c58510465493">,
+        #<Grit::Commit "40d3057d09a7a4d61059bca9dca5ae698de58cbe">,
+        #<Grit::Commit "4ea50f4754937bf19461af58ce3b3d24c77311d9">]
+        
+Called without arguments, Repo#commits returns a list of up to ten commits
+reachable by the master branch (starting at the latest commit). You can ask
+for commits beginning at a different branch, commit, tag, etc.
+
+  repo.commits('mybranch')
+  repo.commits('40d3057d09a7a4d61059bca9dca5ae698de58cbe')
+  repo.commits('v0.1')
+  
+You can specify the maximum number of commits to return.
+
+  repo.commits('master', 100)
+  
+If you need paging, you can specify a number of commits to skip.
+
+  repo.commits('master', 10, 20)
+  
+The above will return commits 21-30 from the commit list.
+        
+= The Commit object
+
+Commit objects contain information about that commit.
+
+  head = repo.commits.first
+  
+  head.id
+  # => "e80bbd2ce67651aa18e57fb0b43618ad4baf7750"
+  
+  head.parents
+  # => [#<Grit::Commit "91169e1f5fa4de2eaea3f176461f5dc784796769">]
+  
+  head.tree
+  # => #<Grit::Tree "3536eb9abac69c3e4db583ad38f3d30f8db4771f">
+  
+  head.author
+  # => #<Grit::Actor "Tom Preston-Werner <tom@mojombo.com>">
+  
+  head.authored_date
+  # => Wed Oct 24 22:02:31 -0700 2007
+  
+  head.committer
+  # => #<Grit::Actor "Tom Preston-Werner <tom@mojombo.com>">
+  
+  head.committed_date
+  # => Wed Oct 24 22:02:31 -0700 2007
+  
+  head.message
+  # => "add Actor inspect"
+  
+You can traverse a commit's ancestry by chaining calls to #parents.
+
+  repo.commits.first.parents[0].parents[0].parents[0]
+  
+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
+the root tree of the latest commit on the master branch.
+
+  tree = repo.commits.first.tree
+  # => #<Grit::Tree "3536eb9abac69c3e4db583ad38f3d30f8db4771f">
+  
+  tree.id
+  # => "3536eb9abac69c3e4db583ad38f3d30f8db4771f"
+  
+Once you have a tree, you can get the contents.
+
+  contents = tree.contents
+  # => [#<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">,
+        #<Grit::Blob "81d2c27608b352814cbe979a6acd678d30219678">,
+        #<Grit::Tree "c3d07b0083f01a6e1ac969a0f32b8d06f20c62e5">,
+        #<Grit::Tree "4d00fe177a8407dbbc64a24dbfc564762c0922d8">]
+
+This tree contains two Blob objects and two Tree objects. The trees are
+subdirectories and the blobs are files. Trees below the root have additional
+attributes.
+
+  contents.last.name
+  # => "lib"
+  
+  contents.last.mode
+  # => "040000"
+  
+There is a convenience method that allows you to get a named sub-object
+from a tree.
+
+  tree/"lib"
+  # => #<Grit::Tree "e74893a3d8a25cbb1367cf241cc741bfd503c4b2">
+  
+You can also get a tree directly from the repo if you know its name.
+
+  repo.tree
+  # => #<Grit::Tree "master">
+  
+  repo.tree("91169e1f5fa4de2eaea3f176461f5dc784796769")
+  # => #<Grit::Tree "91169e1f5fa4de2eaea3f176461f5dc784796769">
+  
+= The Blob object
+
+A blob represents a file. Trees often contain blobs.
+
+  blob = tree.contents.first
+  # => #<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">
+  
+A blob has certain attributes.
+
+  blob.id
+  # => "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666"
+  
+  blob.name
+  # => "README.txt"
+  
+  blob.mode
+  # => "100644"
+  
+  blob.size
+  # => 7726
+  
+You can get the data of a blob as a string.
+
+  blob.data
+  # => "Grit is a library to ..."
+  
+You can also get a blob directly from the repo if you know its name.
+
+  repo.blob("4ebc8aea50e0a67e000ba29a30809d0a7b9b2666")
+  # => #<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Tom Preston-Werner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'hoe'
+require './lib/grit.rb'
+
+Hoe.new('grit', Grit::VERSION) do |p|
+  p.author = 'Tom Preston-Werner'
+  p.email = 'tom@rubyisawesome.com'
+  p.summary = 'Object model interface to a git repo'
+  p.description = p.paragraphs_of('README.txt', 2..2).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[2..-1].map { |u| u.strip }
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['mime-types']
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/grit.rb"
+end
+
+task :coverage do
+  system("rm -fr coverage")
+  system("rcov test/test_*.rb")
+  system("open coverage/index.html")
+end
+
+desc "Upload site to Rubyforge"
+task :site do
+  sh "scp -r doc/* mojombo@grit.rubyforge.org:/var/www/gforge-projects/grit"
+end

data/grit.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "grit"
+  s.version = "0.8.0"
+  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.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.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency("mime-types", ["> 0.0.0"])
+end

data/lib/grit/actor.rb

@@ -0,0 +1,36 @@
+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
+    #
+    # Format
+    #   John Doe <jdoe@example.com>
+    #
+    # Returns Actor
+    def self.from_string(str)
+      case str
+        when /<.+>/
+          m, name, email = *str.match(/(.*) <(.+?)>/)
+          return self.new(name, email)
+        else
+          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

@@ -0,0 +1,117 @@
+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
+    #
+    # Returns Grit::Blob (unbaked)
+    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
+    #
+    # Returns Grit::Blob (unbaked)
+    def create_initialize(repo, atts)
+      @repo = repo
+      atts.each do |k, v|
+        instance_variable_set("@#{k}".to_sym, v)
+      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
+    def mime_type
+      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
+          when /^[0-9A-Fa-f]{40}$/
+            case line
+              when /^([0-9A-Fa-f]{40}) (\d+) (\d+) (\d+)$/
+                _, id, origin_line, final_line, group_lines = *line.match(/^([0-9A-Fa-f]{40}) (\d+) (\d+) (\d+)$/)
+                info = {:id => id}
+                blames << [nil, []]
+              when /^([0-9A-Fa-f]{40}) (\d+) (\d+)$/
+                _, id, origin_line, final_line = *line.match(/^([0-9A-Fa-f]{40}) (\d+) (\d+)$/)
+                info = {:id => id}
+            end
+          when /^(author|committer)/
+            case parts.first
+              when /^(.+)-mail$/
+                info["#{$1}_email".intern] = parts.last
+              when /^(.+)-time$/
+                info["#{$1}_date".intern] = Time.at(parts.last.to_i)
+              when /^(author|committer)$/
+                info[$1.intern] = parts.last
+            end
+          when /^filename/
+            info[:filename] = parts.last
+          when /^summary/
+            info[:summary] = parts.last
+          when ''
+            c = commits[info[:id]]
+            unless c
+              c = Commit.create(repo, :id => info[:id],
+                                      :author => Actor.from_string(info[:author] + ' ' + info[:author_email]),
+                                      :authored_date => info[:author_date],
+                                      :committer => Actor.from_string(info[:committer] + ' ' + info[:committer_email]),
+                                      :committed_date => info[:committer_date],
+                                      :message => info[:summary])
+              commits[info[:id]] = c
+            end
+            _, text = *line.match(/^\t(.*)$/)
+            blames.last[0] = c
+            blames.last[1] << text
+            info = nil
+        end
+      end
+      
+      blames
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Blob "#{@id}">}
+    end
+  end # Blob
+  
+end # Grit

data/lib/grit/commit.rb

@@ -0,0 +1,208 @@
+module Grit
+  
+  class Commit
+    attr_reader :id
+    lazy_reader :parents
+    lazy_reader :tree
+    lazy_reader :author
+    lazy_reader :authored_date
+    lazy_reader :committer
+    lazy_reader :committed_date
+    lazy_reader :message
+    lazy_reader :short_message
+    
+    # Instantiate a new Commit
+    #   +id+ is the id of the commit
+    #   +parents+ is an array of commit ids (will be converted into Commit instances)
+    #   +tree+ is the correspdonding tree id (will be converted into a Tree object)
+    #   +author+ is the author string
+    #   +authored_date+ is the authored Time
+    #   +committer+ is the committer string
+    #   +committed_date+ is the committed Time
+    #   +message+ is an array of commit message lines
+    #
+    # Returns Grit::Commit (baked)
+    def initialize(repo, id, parents, tree, author, authored_date, committer, committed_date, message)
+      @repo = repo
+      @id = id
+      @parents = parents.map { |p| Commit.create(repo, :id => p) }
+      @tree = Tree.create(repo, :id => tree)
+      @author = author
+      @authored_date = authored_date
+      @committer = committer
+      @committed_date = committed_date
+      @message = message.join("\n")
+      @short_message = message[0] || ''
+    end
+    
+    def id_abbrev
+      @id_abbrev ||= @repo.git.rev_parse({:short => true}, self.id).chomp
+    end
+    
+    # Create an unbaked Commit containing just the specified attributes
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Commit (unbaked)
+    def self.create(repo, atts)
+      self.allocate.create_initialize(repo, atts)
+    end
+    
+    # Initializer for Commit.create
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Commit (unbaked)
+    def create_initialize(repo, atts)
+      @repo = repo
+      atts.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+      self
+    end
+    
+    def lazy_source
+      self.class.find_all(@repo, @id, {:max_count => 1}).first
+    end
+    
+    # Count the number of commits reachable from this ref
+    #   +repo+ is the Repo
+    #   +ref+ is the ref from which to begin (SHA1 or name)
+    #
+    # Returns Integer
+    def self.count(repo, ref)
+      repo.git.rev_list({}, ref).strip.split("\n").size
+    end
+    
+    # Find all commits 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 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)
+      
+      if ref
+        output = repo.git.rev_list(actual_options, ref)
+      else
+        output = repo.git.rev_list(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 Grit::Commit[] (baked)
+    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
+        
+        parents = []
+        parents << lines.shift.split.last while lines.first =~ /^parent/
+        
+        author, authored_date = self.actor(lines.shift)
+        committer, committed_date = self.actor(lines.shift)
+        
+        lines.shift
+        
+        message_lines = []
+        message_lines << lines.shift[4..-1] while lines.first =~ /^ {4}/
+        
+        lines.shift while lines.first && lines.first.empty?
+        
+        commits << Commit.new(repo, id, parents, tree, author, authored_date, committer, committed_date, message_lines)
+      end
+      
+      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.
+    #
+    # Returns Grit::Diff[] (baked)
+    def self.diff(repo, a, b = nil, paths = [])
+      if b.is_a?(Array)
+        paths = b
+        b     = nil
+      end
+      paths.unshift("--") unless paths.empty?
+      paths.unshift(b)    unless b.nil?
+      paths.unshift(a)
+      text = repo.git.diff({:full_index => true}, *paths)
+      Diff.list_from_string(repo, text)
+    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)
+      else
+        self.class.diff(@repo, parents.first.id, @id) 
+      end
+    end
+    
+    # Convert this Commit to a String which is just the SHA1 id
+    def to_s
+      @id
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Commit "#{@id}">}
+    end
+    
+    # private
+    
+    # Parse out the actor (author or committer) info
+    #
+    # Returns [String (actor name and email), Time (acted at time)]
+    def self.actor(line)
+      m, actor, epoch = *line.match(/^.+? (.*) (\d+) .*$/)
+      [Actor.from_string(actor), Time.at(epoch.to_i)]
+    end
+
+    def to_hash
+      {
+        'id'       => id,
+        'parents'  => parents.map { |p| { 'id' => p.id } },
+        'tree'     => tree.id,
+        'message'  => message,
+        'author'   => {
+          'name'  => author.name,
+          'email' => author.email
+        },
+        'committer' => {
+          'name'  => committer.name,
+          'email' => committer.email
+        },
+        'authored_date'  => authored_date.xmlschema,
+        'committed_date' => committed_date.xmlschema,
+      }
+    end
+  end # Commit
+  
+end # Grit