grit 2.2.0 → 2.3.0

data/History.txt

@@ -1,4 +1,15 @@
-== HEAD
+== 2.3.0 / 2010-09-29
+  * Minor Enhancements
+    * Add Grit::Repo.init.
+  * Bug Fixes
+    * Fix Ruby 1.9 compatibility (#24).
+
+== 2.2.1 / 2010-08-23
+  * Bug Fixes
+    * Fix minor regression due to the changed default values in
+      Grit::Index#commit.
+
+== 2.2.0 / 2010-08-19
   * Minor Enhancements
     * Add Grit::Index#delete to allow deletions of files from the index.
 
@@ -30,7 +41,8 @@
     * 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]
+    * Fix RubyGit's diff to detect additions and deletions
+      [github.com/defunkt]
 
 == 1.1.1 / 2009-03-31
   * Changes
@@ -44,17 +56,25 @@
   * Minor Enhancements
     * Convert readme to markdown
     * Added a shortcut for commit_stats as Commit#stats [github.com/js]
-    * Add a #basename method to Submodule, Blob and Tree for retrieving the name [github.com/js]
-    * Make Grit::Submodule grasp the concept of non-unix lineendings [github.com/js]
+    * Add a #basename method to Submodule, Blob and Tree for retrieving the
+      name [github.com/js]
+    * Make Grit::Submodule grasp the concept of non-unix lineendings
+      [github.com/js]
     * Added Repo#commit_deltas_from [github.com/js]
     * do some mild shell escaping when running commands [github.com/js]
-    * Added two shortcut methods to Tree, for picking trees/blobs only [github.com/Voker57]
+    * Added two shortcut methods to Tree, for picking trees/blobs only
+      [github.com/Voker57]
     * Added <=> method to Blob, needed for sorting tree [github.com/Voker57]
-    * Make the number of bytes to be read from git's stdout configurable [github.com/josb]
-    * Repo.archive_to_file accepts extra parameters making plain zipping possible [github.com/darwin]
-    * Handle commit stats that summarize commits with binary changes [github.com/therealadam]
-    * Add a DiffStat class for easy access to diff stats [github.com/therealadam]
-    * Don't split git logs that contain blank lines into two CommitStats [github.com/therealadam]
+    * Make the number of bytes to be read from git's stdout configurable
+      [github.com/josb]
+    * Repo.archive_to_file accepts extra parameters making plain zipping
+      possible [github.com/darwin]
+    * Handle commit stats that summarize commits with binary changes
+      [github.com/therealadam]
+    * Add a DiffStat class for easy access to diff stats
+      [github.com/therealadam]
+    * Don't split git logs that contain blank lines into two CommitStats
+      [github.com/therealadam]
     * Add DiffStat#net for total change count [github.com/therealadam]
 
 == 1.0.3 / 2009-02-13
@@ -76,10 +96,10 @@
 
 == 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
 

data/README.md

@@ -15,22 +15,22 @@ correctness.
 Grit is maintained by Tom Preston-Werner, Scott Chacon, Chris Wanstrath, and
 PJ Hyett.
 
-This documentation is accurate as of Grit 2.0.
+This documentation is accurate as of Grit 2.3.
 
 
-## Requirements #############################################################
+## Requirements
 
-* git (http://git-scm.com) tested with 1.6.0.2
+* git (http://git-scm.com) tested with 1.7.2.1
 
 
-## Install ##################################################################
+## Install
 
 Easiest install is via RubyGems:
 
-    $ gem install grit -s http://gemcutter.org
+    $ gem install grit
 
 
-## Source ###################################################################
+## Source
 
 Grit's Git repo is available on GitHub, which can be browsed at:
 
@@ -45,19 +45,26 @@ and cloned with:
 
 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.
+If you'd like to hack on Grit, follow these instructions. To get all of the dependencies, install the gem first.
 
+1. Fork the project to your own account
+1. Clone down your fork
+1. Create a thoughtfully named topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `rake`
+1. If you are adding new functionality, document it in README.md
+1. Do not change the version number, I will do that on my end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send a pull request for your branch
 
-## Usage ####################################################################
+
+## 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,
@@ -70,8 +77,7 @@ The first step is to create a `Grit::Repo` object to represent your repo. In
 this documentation I include the `Grit` module to reduce typing.
 
     require 'grit'
-    include Grit
-    repo = Repo.new("/Users/tom/dev/grit")
+    repo = Grit::Repo.new("/Users/tom/dev/grit")
 
 In the above example, the directory `/Users/tom/dev/grit` is my working
 directory and contains the `.git` directory. You can also initialize Grit with
@@ -233,4 +239,4 @@ reference the code for more functionality.
 Copyright
 ---------
 
-Copyright (c) 2008 Tom Preston-Werner. See LICENSE for details.
+Copyright (c) 2010 Tom Preston-Werner. See LICENSE for details.

data/Rakefile

@@ -47,7 +47,7 @@ task :default => :test
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
+  test.libs << 'lib' << 'test' << '.'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end

data/grit.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'grit'
-  s.version           = '2.2.0'
-  s.date              = '2010-08-19'
+  s.version           = '2.3.0'
+  s.date              = '2010-09-29'
   s.rubyforge_project = 'grit'
 
   s.summary     = "Ruby Git bindings."
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
 
   s.authors  = ["Tom Preston-Werner", "Scott Chacon"]
   s.email    = 'tom@github.com'
-  s.homepage = 'http://github.com/github/gollum'
+  s.homepage = 'http://github.com/mojombo/grit'
 
   s.require_paths = %w[lib]
 

data/lib/grit.rb

@@ -51,7 +51,7 @@ require 'grit/blame'
 require 'grit/merge'
 
 module Grit
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 
   class << self
     # Set +debug+ to true to log all git calls and responses

data/lib/grit/git-ruby.rb

@@ -10,11 +10,11 @@ module Grit
 
     attr_accessor :ruby_git_repo, :git_file_index
 
-    def init(options)
+    def init(options, *args)
       if options.size == 0
         Grit::GitRuby::Repository.init(@git_dir)
       else
-        method_missing('init', options)
+        method_missing('init', options, *args)
       end
     end
 

data/lib/grit/git-ruby/internal/loose.rb

@@ -29,7 +29,7 @@ module Grit
           begin
             return nil unless sha1[0...2] && sha1[2..39]
             path = @directory + '/' + sha1[0...2] + '/' + sha1[2..39]
-            get_raw_object(File.read(path))
+            get_raw_object(open(path, 'rb') { |f| f.read })
           rescue Errno::ENOENT
             nil
           end

data/lib/grit/git.rb

@@ -232,14 +232,19 @@ module Grit
       timeout  = options.delete(:timeout) rescue nil
       timeout  = true if timeout.nil?
 
+      base     = options.delete(:base) rescue nil
+      base     = true if base.nil?
+
       opt_args = transform_options(options)
 
       if RUBY_PLATFORM.downcase =~ /mswin(?!ce)|mingw|bccwin/
         ext_args = args.reject { |a| a.empty? }.map { |a| (a == '--' || a[0].chr == '|' || Grit.no_quote) ? a : "\"#{e(a)}\"" }
-        call = "#{prefix}#{Git.git_binary} --git-dir=\"#{self.git_dir}\" #{cmd.to_s.gsub(/_/, '-')} #{(opt_args + ext_args).join(' ')}#{e(postfix)}"
+        gitdir = base ? "--git-dir=\"#{self.git_dir}\"" : ""
+        call = "#{prefix}#{Git.git_binary} #{gitdir} #{cmd.to_s.gsub(/_/, '-')} #{(opt_args + ext_args).join(' ')}#{e(postfix)}"
       else
         ext_args = args.reject { |a| a.empty? }.map { |a| (a == '--' || a[0].chr == '|' || Grit.no_quote) ? a : "'#{e(a)}'" }
-        call = "#{prefix}#{Git.git_binary} --git-dir='#{self.git_dir}' #{cmd.to_s.gsub(/_/, '-')} #{(opt_args + ext_args).join(' ')}#{e(postfix)}"
+        gitdir = base ? "--git-dir='#{self.git_dir}'" : ""
+        call = "#{prefix}#{Git.git_binary} #{gitdir} #{cmd.to_s.gsub(/_/, '-')} #{(opt_args + ext_args).join(' ')}#{e(postfix)}"
       end
       Grit.log(call) if Grit.debug
       response, err = timeout ? sh(call) : wild_sh(call)

data/lib/grit/index.rb

@@ -67,7 +67,7 @@ module Grit
     #
     # message   - The String commit message.
     # parents   - Array of String commit SHA1s or Grit::Commit objects to
-    #             attach this commit to to form a new head (default: []).
+    #             attach this commit to to form a new head (default: nil).
     # actor     - The Grit::Actor details of the user making the commit
     #             (default: nil).
     # last_tree - The String SHA1 of a tree to compare with in order to avoid
@@ -76,7 +76,7 @@ module Grit
     #             (default: "master").
     #
     # Returns a String of the SHA1 of the new commit.
-    def commit(message, parents = [], actor = nil, last_tree = nil, head = 'master')
+    def commit(message, parents = nil, actor = nil, last_tree = nil, head = 'master')
       tree_sha1 = write_tree(self.tree, self.current_tree)
 
       # don't write identical commits
@@ -86,15 +86,15 @@ module Grit
       contents << ['tree', tree_sha1].join(' ')
       parents.each do |p|
         contents << ['parent', p].join(' ')
-      end
+      end if parents
 
       if actor
-        name = actor.name
+        name  = actor.name
         email = actor.email
       else
         config = Config.new(self.repo)
-        name = config['user.name']
-        email = config['user.email']
+        name   = config['user.name']
+        email  = config['user.email']
       end
 
       author_string = "#{name} <#{email}> #{Time.now.to_i} -0700" # !! TODO : gotta fix this

data/lib/grit/repo.rb

@@ -3,23 +3,37 @@ module Grit
   class Repo
     DAEMON_EXPORT_FILE = 'git-daemon-export-ok'
 
-    # The path of the git repo as a String
+    # Public: The String path of the Git repo.
     attr_accessor :path
+
+    # Public: The String path to the working directory of the repo, or nil if
+    # there is no working directory.
     attr_accessor :working_dir
+
+    # Public: The Boolean of whether or not the repo is bare.
     attr_reader :bare
 
-    # The git command line interface object
+    # Public: The Grit::Git command line interface object.
     attr_accessor :git
 
-    # Create a new Repo instance
-    #   +path+ is the path to either the root git directory or the bare git repo
-    #   +options+ :is_bare force to load a bare repo
+    # Public: Create a new Repo instance.
+    #
+    # path    - The String path to either the root git directory or the bare
+    #           git repo. Bare repos are expected to end with ".git".
+    # options - A Hash of options (default: {}):
+    #           :is_bare - Boolean whether to consider the repo as bare even
+    #                      if the repo name does not end with ".git".
     #
     # Examples
-    #   g = Repo.new("/Users/tom/dev/grit")
-    #   g = Repo.new("/Users/tom/public/grit.git")
     #
-    # Returns Grit::Repo
+    #   r = Repo.new("/Users/tom/dev/normal")
+    #   r = Repo.new("/Users/tom/public/bare.git")
+    #   r = Repo.new("/Users/tom/public/bare", {:is_bare => true})
+    #
+    # Returns a newly initialized Grit::Repo.
+    # Raises Grit::InvalidGitRepositoryError if the path exists but is not
+    #   a Git repository.
+    # Raises Grit::NoSuchPathError if the path does not exist.
     def initialize(path, options = {})
       epath = File.expand_path(path)
 
@@ -39,12 +53,106 @@ module Grit
       self.git = Git.new(self.path)
     end
 
-    # Does nothing yet...
-    def self.init(path)
-      # !! TODO !!
-      # create directory
-      # generate initial git directory
-      # create new Grit::Repo on that dir, return it
+    # Public: Initialize a git repository (create it on the filesystem). By
+    # default, the newly created repository will contain a working directory.
+    # If you would like to create a bare repo, use Gollum::Repo.init_bare.
+    #
+    # path         - The String full path to the repo. Traditionally ends with
+    #                "/<name>.git".
+    # git_options  - A Hash of additional options to the git init command
+    #                (default: {}).
+    # repo_options - A Hash of additional options to the Grit::Repo.new call
+    #                (default: {}).
+    #
+    # Examples
+    #
+    #   Grit::Repo.init('/var/git/myrepo.git')
+    #
+    # Returns the newly created Grit::Repo.
+    def self.init(path, git_options = {}, repo_options = {})
+      git_options = {:base => false}.merge(git_options)
+      git = Git.new(path)
+      git.fs_mkdir('..')
+      git.init(git_options, path)
+      self.new(path, repo_options)
+    end
+
+    # Public: Initialize a bare git repository (create it on the filesystem).
+    #
+    # path         - The String full path to the repo. Traditionally ends with
+    #                "/<name>.git".
+    # git_options  - A Hash of additional options to the git init command
+    #                (default: {}).
+    # repo_options - A Hash of additional options to the Grit::Repo.new call
+    #                (default: {}).
+    #
+    # Examples
+    #
+    #   Grit::Repo.init_bare('/var/git/myrepo.git')
+    #
+    # Returns the newly created Grit::Repo.
+    def self.init_bare(path, git_options = {}, repo_options = {})
+      git_options = {:bare => true}.merge(git_options)
+      git = Git.new(path)
+      git.fs_mkdir('..')
+      git.init(git_options)
+      self.new(path, repo_options)
+    end
+
+    # Public: Initialize a bare Git repository (create it on the filesystem)
+    # or, if the repo already exists, simply return it.
+    #
+    # path         - The String full path to the repo. Traditionally ends with
+    #                "/<name>.git".
+    # git_options  - A Hash of additional options to the git init command
+    #                (default: {}).
+    # repo_options - A Hash of additional options to the Grit::Repo.new call
+    #                (default: {}).
+    #
+    # Returns the new or existing Grit::Repo.
+    def self.init_bare_or_open(path, git_options = {}, repo_options = {})
+      git = Git.new(path)
+
+      unless git.exist?
+        git.fs_mkdir(path)
+        git.init(git_options)
+      end
+
+      self.new(path, repo_options)
+    end
+
+    # Public: Create a bare fork of this repository.
+    #
+    # path    - The String full path of where to create the new fork.
+    #           Traditionally ends with "/<name>.git".
+    # options - The Hash of additional options to the git clone command.
+    #           These options will be merged on top of the default Hash:
+    #           {:bare => true, :shared => true}.
+    #
+    # Returns the newly forked Grit::Repo.
+    def fork_bare(path, options = {})
+      default_options = {:bare => true, :shared => true}
+      real_options = default_options.merge(options)
+      Git.new(path).fs_mkdir('..')
+      self.git.clone(real_options, self.path, path)
+      Repo.new(path)
+    end
+
+    # Public: Fork a bare git repository from another repo.
+    #
+    # path    - The String full path of the repo from which to fork..
+    #           Traditionally ends with "/<name>.git".
+    # options - The Hash of additional options to the git clone command.
+    #           These options will be merged on top of the default Hash:
+    #           {:bare => true, :shared => true}.
+    #
+    # Returns the newly forked Grit::Repo.
+    def fork_bare_from(path, options = {})
+      default_options = {:bare => true, :shared => true}
+      real_options = default_options.merge(options)
+      Git.new(self.path).fs_mkdir('..')
+      self.git.clone(real_options, path, self.path)
+      Repo.new(self.path)
     end
 
     # The project's description. Taken verbatim from GIT_REPO/description
@@ -58,7 +166,6 @@ module Grit
       Blame.new(self, file, commit)
     end
 
-
     # An array of Head objects representing the branch heads in
     # this repo
     #
@@ -369,57 +476,6 @@ module Grit
       Commit.diff(self, commit)
     end
 
-    # Initialize a bare git repository at the given path
-    #   +path+ is the full path to the repo (traditionally ends with /<name>.git)
-    #   +options+ is any additional options to the git init command
-    #
-    # Examples
-    #   Grit::Repo.init_bare('/var/git/myrepo.git')
-    #
-    # Returns Grit::Repo (the newly created repo)
-    def self.init_bare(path, git_options = {}, repo_options = {})
-      git_options = {:bare => true}.merge(git_options)
-      git = Git.new(path)
-      git.fs_mkdir('..')
-      git.init(git_options)
-      self.new(path, repo_options)
-    end
-
-    def self.init_bare_or_open(path, git_options = {}, repo_options = {})
-      git = Git.new(path)
-      if !git.exist?
-        git.fs_mkdir(path)
-        git.init(git_options)
-      end
-      self.new(path, repo_options)
-    end
-
-    # Fork a bare git repository from this repo
-    #   +path+ is the full path of the new repo (traditionally ends with /<name>.git)
-    #   +options+ is any additional options to the git clone command (:bare and :shared are true by default)
-    #
-    # Returns Grit::Repo (the newly forked repo)
-    def fork_bare(path, options = {})
-      default_options = {:bare => true, :shared => true}
-      real_options = default_options.merge(options)
-      Git.new(path).fs_mkdir('..')
-      self.git.clone(real_options, self.path, path)
-      Repo.new(path)
-    end
-
-    # Fork a bare git repository from another repo
-    #   +path+ is the full path of the new repo (traditionally ends with /<name>.git)
-    #   +options+ is any additional options to the git clone command (:bare and :shared are true by default)
-    #
-    # Returns Grit::Repo (the newly forked repo)
-    def fork_bare_from(path, options = {})
-      default_options = {:bare => true, :shared => true}
-      real_options = default_options.merge(options)
-      Git.new(self.path).fs_mkdir('..')
-      self.git.clone(real_options, path, self.path)
-      Repo.new(self.path)
-    end
-
     # Archive the given treeish
     #   +treeish+ is the treeish name/id (default 'master')
     #   +prefix+ is the optional prefix

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grit
 version: !ruby/object:Gem::Version 
-  version: 2.2.0
+  hash: 3
+  prerelease: false
+  segments: 
+  - 2
+  - 3
+  - 0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -10,39 +16,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-19 00:00:00 -07:00
+date: 2010-09-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mime-types
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 15
         version: "1.15"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: diff-lcs
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
         version: "1.1"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 description: Grit is a Ruby library for extracting information from a git repository in an object oriented manner.
 email: tom@github.com
 executables: []
@@ -96,7 +116,7 @@ files:
 - lib/grit/tag.rb
 - lib/grit/tree.rb
 has_rdoc: true
-homepage: http://github.com/github/gollum
+homepage: http://github.com/mojombo/grit
 licenses: []
 
 post_install_message: 
@@ -105,21 +125,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: grit
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: Ruby Git bindings.