git 1.0.1

data/README

@@ -0,0 +1,152 @@
+== Git Library for Ruby
+
+Library for using Git in Ruby.
+
+
+= Roadmap
+
+Right now I'm forking calls to the 'git' binary, 
+but eventually I'll replace that with either C bindings
+to libgit or libgit-thin, or I'll write pure ruby
+handlers for at least some of the Git stuff.
+
+
+= Examples
+
+Here are a bunch of examples of how to use the Ruby/Git package. 
+
+First you have to remember to require rubygems if it's not.  Then include the 'git' gem.
+
+   require 'rubygems'
+   require 'git'
+
+Here are the operations that need read permission only.
+      
+   g = Git.open (working_dir = '.')
+ 	  (git_dir, index_file)
+   
+   g.index
+   g.index.readable?
+   g.index.writable?
+   g.repo
+   g.dir
+   
+   g.log   # returns array of Git::Commit objects
+   g.log.since('2 weeks ago')
+   g.log.between('v2.5', 'v2.6')
+   g.log.each {|l| puts l.sha }
+   g.gblob('v2.5:Makefile').log.since('2 weeks ago')
+   
+   g.object('HEAD^').to_s  # git show / git rev-parse
+   g.object('HEAD^').contents
+   g.object('v2.5:Makefile').size
+   g.object('v2.5:Makefile').sha
+   
+   g.gtree(treeish)
+   g.gblob(treeish)
+   g.gcommit(treeish)
+   
+   g.revparse('v2.5:Makefile')
+   
+   g.branches # returns Git::Branch objects
+   g.branches.local
+   g.branches.remote
+   g.branches[:master].gcommit
+   g.branches['origin/master'].gcommit
+   
+   g.grep('hello')  # implies HEAD
+   g.blob('v2.5:Makefile').grep('hello')
+   g.tag('v2.5').grep('hello', 'docs/')
+   
+   g.diff(commit1, commit2).size
+   g.diff(commit1, commit2).stats
+   g.gtree('v2.5').diff('v2.6').insertions
+   g.diff('gitsearch1', 'v2.5').path('lib/')
+   g.diff('gitsearch1', @git.gtree('v2.5'))
+   g.diff('gitsearch1', 'v2.5').path('docs/').patch
+   g.gtree('v2.5').diff('v2.6').patch
+   
+   g.gtree('v2.5').diff('v2.6').each do |file_diff|
+     puts file_diff.path
+     puts file_diff.patch
+     puts file_diff.blob(:src).contents
+   end
+   
+   g.config('user.name')  # returns 'Scott Chacon'
+   g.config # returns whole config hash
+   
+   g.tag # returns array of Git::Tag objects
+   
+   
+   
+And here are the operations that will need to write to your git repository.
+   
+   
+   g = Git.init
+     Git.init('project')
+     Git.init('/home/schacon/proj', 
+	 	  { :git_dir => '/opt/git/proj.git', 
+		     :index_file => '/tmp/index'} )
+ 	  
+   g = Git.clone(URI, :name => 'name', :path => '/tmp/checkout')   
+   g.config('user.name', 'Scott Chacon')
+   g.config('user.email', 'email@email.com')      
+   
+   g.add('.')
+   g.add([file1, file2])
+   
+   g.remove('file.txt')
+   g.remove(['file.txt', 'file2.txt'])
+		     
+   g.commit('message')
+   g.commit_all('message')
+   
+   g = Git.clone(repo, 'myrepo')
+   g.chdir do
+    new_file('test-file', 'blahblahblah')
+    g.status.changed.each do |file|
+     puts file.blob(:index).contents
+    end
+   end
+   
+   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
+   
+   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'))

data/doc/classes/Git.html

@@ -0,0 +1,284 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Git</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Git</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/git/base_rb.html">
+                lib/git/base.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/branch_rb.html">
+                lib/git/branch.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/branches_rb.html">
+                lib/git/branches.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/diff_rb.html">
+                lib/git/diff.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/index_rb.html">
+                lib/git/index.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/lib_rb.html">
+                lib/git/lib.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/log_rb.html">
+                lib/git/log.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/object_rb.html">
+                lib/git/object.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/path_rb.html">
+                lib/git/path.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/remote_rb.html">
+                lib/git/remote.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/repository_rb.html">
+                lib/git/repository.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/status_rb.html">
+                lib/git/status.rb
+                </a>
+        <br />
+                <a href="../files/lib/git/working_directory_rb.html">
+                lib/git/working_directory.rb
+                </a>
+        <br />
+                <a href="../files/lib/git_rb.html">
+                lib/git.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">bare</a>&nbsp;&nbsp;
+      <a href="#M000004">clone</a>&nbsp;&nbsp;
+      <a href="#M000003">init</a>&nbsp;&nbsp;
+      <a href="#M000002">open</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="Git/Base.html" class="link">Git::Base</a><br />
+Class <a href="Git/Branch.html" class="link">Git::Branch</a><br />
+Class <a href="Git/Branches.html" class="link">Git::Branches</a><br />
+Class <a href="Git/Diff.html" class="link">Git::Diff</a><br />
+Class <a href="Git/GitExecuteError.html" class="link">Git::GitExecuteError</a><br />
+Class <a href="Git/GitTagNameDoesNotExist.html" class="link">Git::GitTagNameDoesNotExist</a><br />
+Class <a href="Git/Index.html" class="link">Git::Index</a><br />
+Class <a href="Git/Lib.html" class="link">Git::Lib</a><br />
+Class <a href="Git/Log.html" class="link">Git::Log</a><br />
+Class <a href="Git/Object.html" class="link">Git::Object</a><br />
+Class <a href="Git/Path.html" class="link">Git::Path</a><br />
+Class <a href="Git/Remote.html" class="link">Git::Remote</a><br />
+Class <a href="Git/Repository.html" class="link">Git::Repository</a><br />
+Class <a href="Git/Status.html" class="link">Git::Status</a><br />
+Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">bare</span><span class="method-args">(git_dir)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git.rb, line 34</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
+    <span class="ruby-constant">Base</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">clone</span><span class="method-args">(repository, name, options = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git.rb, line 46</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
+    <span class="ruby-constant">Base</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">init</span><span class="method-args">(working_dir = '.', options = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git.rb, line 42</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span> = <span class="ruby-value str">'.'</span>, <span class="ruby-identifier">options</span> = {})
+    <span class="ruby-constant">Base</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">open</span><span class="method-args">(working_dir, options = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git.rb, line 38</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span> = {})
+    <span class="ruby-constant">Base</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Git.src/M000001.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>bare (Git)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/git.rb, line 34</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
+    <span class="ruby-constant">Base</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>