schacon-grit 0.9.1

data/History.txt

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

@@ -0,0 +1,57 @@
+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/commit_stats.rb
+lib/grit/config.rb
+lib/grit/diff.rb
+lib/grit/errors.rb
+lib/grit/git.rb
+lib/grit/index.rb
+lib/grit/lazy.rb
+lib/grit/ref.rb
+lib/grit/repo.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_remotes
+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_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/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,60 @@
+Gem::Specification.new do |s|
+  s.name     = "grit"
+  s.version  = "0.9.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/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", "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("mime-types", ["> 0.0.0"])
+end

data/lib/grit.rb

@@ -0,0 +1,53 @@
+$:.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'
+require 'digest/sha1'
+
+# internal requires
+require 'grit/lazy'
+require 'grit/errors'
+require 'grit/git-ruby'
+require 'grit/git'
+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.9.1'
+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