schleyfox-grit 2.3.0

data/API.txt

@@ -0,0 +1,101 @@
+== TODO ==
+
+* Add remote branch references (Grit::Remote)
+* Add status - what is modified, staged
+
+g.checkout('new_branch')
+g.checkout(g.branch('new_branch'))
+
+g.branch(name).merge(branch2)
+g.branch(branch2).merge  # merges HEAD with branch2
+
+g.branch(name).in_branch(message) { # add files }  # auto-commits
+g.merge('new_branch')
+g.merge('origin/remote_branch')
+g.merge(b.branch('master'))
+g.merge([branch1, branch2])
+
+r = g.add_remote(name, uri)  # Git::Remote
+r = g.add_remote(name, Git::Base)  # Git::Remote
+
+g.remotes  # array of Git::Remotes
+g.remote(name).fetch
+g.remote(name).remove
+g.remote(name).merge
+g.remote(name).merge(branch)
+
+g.fetch
+g.fetch(g.remotes.first)
+
+g.pull
+g.pull(Git::Repo, Git::Branch) # fetch and a merge
+
+g.add_tag('tag_name') # returns Git::Tag
+
+g.repack
+
+g.push
+g.push(g.remote('name'))
+   
+g.reset # defaults to HEAD
+g.reset_hard(Git::Commit)
+
+g.branch('new_branch') # creates new or fetches existing
+g.branch('new_branch').checkout
+g.branch('new_branch').delete
+g.branch('existing_branch').checkout
+
+
+
+
+
+require 'mojombo-grit'
+
+include Grit
+Grit.debug
+Grit.use_pure_ruby
+
+repo = Repo.new("/Users/tom/dev/grit")
+
+= Commit Log
+
+repo.commits('mybranch')
+repo.commits('40d3057d09a7a4d61059bca9dca5ae698de58cbe')
+repo.commits('v0.1')
+
+repo.log('mybranch', 100, 20)
+
+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"
+contents = tree.contents
+  # => [#<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">,
+        #<Grit::Blob "81d2c27608b352814cbe979a6acd678d30219678">,
+        #<Grit::Tree "c3d07b0083f01a6e1ac969a0f32b8d06f20c62e5">,
+        #<Grit::Tree "4d00fe177a8407dbbc64a24dbfc564762c0922d8">]
+blob.id
+# => "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666"
+blob.name
+# => "README.txt"
+blob.mode
+# => "100644"
+blob.size
+# => 7726
+blob.data
+
+repo.blob("4ebc8aea50e0a67e000ba29a30809d0a7b9b2666")
+# => #<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">

data/History.txt

@@ -0,0 +1,117 @@
+== git
+  * Major Enhancements
+    * Add support for parsing git notes.
+    * Add `git cat-file --batch` support with Grit::Repo#batch.
+  * Minor Enhancements
+    * Grit::Index#commit supports custom committer/author names and dates.
+    * Performance enhancements with internal command output buffering.
+  * Bug Fixes
+    * Zero-Padding issue in Grit::Index was fixed.
+
+== 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.
+
+== 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
+  * 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)
+
+== 1.1.0 / 2009-03-29
+  * Backwards breaking changes
+    * Diff#a_commit -> Diff#a_blob, Diff#b_commit -> Diff#b_blob
+  * Major Enhancments
+    * Ruby 1.9 compatibility [github.com/chapados, github.com/js]
+  * 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]
+    * 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 <=> 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]
+    * Add DiffStat#net for total change count [github.com/therealadam]
+
+== 1.0.3 / 2009-02-13
+  * Minor Enhancements
+    * Added Grit::Commit#to_patch for plaintext formatted patches.
+    * Fixed Grit::Tag to work with annotated tags.
+
+== 1.0.2 / 2009-02-10
+  * Minor Enhancements
+    * Implement Grit.version to use VERSION.yml file
+
+== 1.0.1 / 2009-02-10
+  * Bug Fixes
+    * Add diff-lcs as a dependency
+
+== 1.0.0 / 2009-01-27
+  * Tons of awesome in here. Also, we suck at updating the history.
+  * Let's do better at that from now on.
+
+== 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/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2007-2009 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/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/README.md

@@ -0,0 +1,242 @@
+Grit
+====
+
+Grit gives you object oriented read/write access to Git repositories via Ruby.
+The main goals are stability and performance. To this end, some of the
+interactions with Git repositories are done by shelling out to the system's
+`git` command, and other interactions are done with pure Ruby
+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.
+
+Grit is maintained by Tom Preston-Werner, Scott Chacon, Chris Wanstrath, and
+PJ Hyett.
+
+This documentation is accurate as of Grit 2.3.
+
+
+## Requirements
+
+* git (http://git-scm.com) tested with 1.7.2.1
+
+
+## Install
+
+Easiest install is via RubyGems:
+
+    $ gem install grit
+
+
+## Source
+
+Grit's Git repo is available on GitHub, which can be browsed at:
+
+    http://github.com/mojombo/grit
+
+and cloned with:
+
+    git clone git://github.com/mojombo/grit.git
+
+
+### Development
+
+You will need these gems to get tests to pass:
+
+* mocha
+
+
+### Contributing
+
+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
+
+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
+this documentation I include the `Grit` module to reduce typing.
+
+    require '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
+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">
+
+
+### Other
+
+There are many more API methods available that are not documented here. Please
+reference the code for more functionality.
+
+
+Copyright
+---------
+
+Copyright (c) 2010 Tom Preston-Werner. See LICENSE for details.