titanous-git 1.1.0

data/History.txt

@@ -0,0 +1,21 @@
+== 1.0.4
+
+* added camping/gitweb.rb frontend
+* added a number of speed-ups
+
+== 1.0.3
+
+* Sped up most of the operations
+* Added some predicate functions (commit?, tree?, etc)
+* Added a number of lower level operations (read-tree, write-tree, checkout-index, etc)
+* Fixed a bug with using bare repositories
+* Updated a good amount of the documentation
+
+== 1.0.2
+
+* Added methods to the git objects that might be helpful
+
+== 1.0.1
+
+* Initial version
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 Scott Chacon
+
+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/README

@@ -0,0 +1,244 @@
+== Git Library for Ruby
+
+Library for using Git in Ruby. Test.
+
+= Homepage
+
+The Ruby/Git homepage is currently at : 
+
+http://jointheconversation.org/rubygit
+
+Git public hosting of the project source code is at:
+
+http://github/schacon/ruby-git
+
+= Install
+
+You can install Ruby/Git like this:
+
+$ sudo gem install schacon-git --source=http://gems.github.com
+
+= Major Objects
+
+Git::Base - this is the object returned from a Git.open or Git.clone.  
+Most major actions are called from this object.
+
+Git::Object - this is the base object for your tree, blob and commit objects,
+returned from @git.gtree or @git.object calls.  the Git::AbstractObject will
+have most of the calls in common for all those objects.
+
+Git::Diff - returns from a @git.diff command.  It is an Enumerable that returns
+Git::Diff:DiffFile objects from which you can get per file patches and insertion/deletion
+statistics.  You can also get total statistics from the Git::Diff object directly.
+
+Git::Status - returns from a @git.status command.  It is an Enumerable that returns
+Git:Status::StatusFile objects for each object in git, which includes files in the working
+directory, in the index and in the repository.  Similar to running 'git status' on the command
+line to determine untracked and changed files.
+
+Git::Branches - Enumerable object that holds Git::Branch objects.  You can call .local or .remote
+on it to filter to just your local or remote branches.
+
+Git::Remote - A reference to a remote repository that is tracked by this repository.
+
+Git::Log - An Enumerable object that references all the Git::Object::Commit objects that encompass
+your log query, which can be constructed through methods on the Git::Log object, like:
+
+ @git.log(20).object("some_file").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] } 
+
+= 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, :log => Logger.new(STDOUT))
+   
+   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)
+   
+   
+   commit = g.gcommit('1cc8667014381')
+    commit.gtree
+    commit.parent.sha
+    commit.parents.size
+    commit.author.name
+    commit.author.email
+    commit.author.date.strftime("%m-%d-%y")
+    commit.committer.name
+    commit.date.strftime("%m-%d-%y")
+    commit.message
+   
+  tree = g.gtree("HEAD^{tree}")
+    tree.blobs
+    tree.subtrees
+    tree.children # blobs and subtrees
+   
+   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'))
+
+
+Some examples of more low-level index and tree operations
+
+   g.with_temp_index do 
+
+     g.read_tree(tree3) # calls self.index.read_tree
+     g.read_tree(tree1, :prefix => 'hi/')
+
+     c = g.commit_tree('message')
+     # or #
+     t = g.write_tree
+     c = g.commit_tree(t, :message => 'message', :parents => [sha1, sha2])
+
+     g.branch('branch_name').update_ref(c)
+     g.update_ref(branch, c)
+
+     g.with_temp_working do # new blank working directory
+       g.checkout
+       g.checkout(another_index)
+       g.commit # commits to temp_index
+     end    
+   end
+
+   g.set_index('/path/to/index')
+   
+   
+   g.with_index(path) do 
+     # calls set_index, then switches back after
+   end
+   
+   g.with_working(dir) do
+   # calls set_working, then switches back after
+   end
+   
+   g.with_temp_working(dir) do
+     g.checkout_index(:prefix => dir, :path_limiter => path)
+     # do file work
+     g.commit # commits to index
+   end
+   

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+require 'rcov/rcovtask'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "git"
+    s.author = "Scott Chacon"
+    s.email = "schacon@gmail.com"
+    s.summary = "A package for using Git in Ruby code."
+    s.description = "A package for using Git in Ruby code."
+    s.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'tests/**/*'].to_a
+    s.require_path = "lib"
+    s.autorequire = "git"
+    s.test_files = FileList['tests/units/test_*.rb'].to_a
+    s.has_rdoc = true
+    s.extra_rdoc_files = ["README"]
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'ruby-git'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Upload docs"
+task :upload_docs do |t|
+  Rake::Task['rdoc'].invoke
+  system('rsync -rv --delete doc/ git.rubyforge.org:/var/www/gforge-projects/git')
+end
+
+desc 'Run all tests with rcov'
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList['tests/units/test_*.rb']
+  t.rcov_opts = ['--exclude', 'tests']
+  t.verbose = true
+end
+
+task :default => :rcov

data/TODO

@@ -0,0 +1,27 @@
+* more documentation
+
+* git revert, rebase
+
+* diff additions
+  - annotate, blame
+
+* submodule support
+
+* repository admin
+  - prune, fsck, pack-refs, count-objects, unpack-objects
+
+* email/patch integration
+  - request-pull(email_address), git-am, git-apply
+  
+  
+* compatible with git 1.4
+
+* More Error Examples
+
+* More Git::Status methods
+
+
+* Speed up through pure ruby
+
+* Speed up through C bindings to libgit-thin
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+major: 1
+minor: 1
+patch: 0

data/lib/git.rb

@@ -0,0 +1,110 @@
+
+# Add the directory containing this file to the start of the load path if it
+# isn't there already.
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'git/base'
+require 'git/path'
+require 'git/lib'
+
+require 'git/repository'
+require 'git/index'
+require 'git/working_directory'
+
+require 'git/log'
+require 'git/object'
+
+require 'git/branches'
+require 'git/branch'
+require 'git/remote'
+
+require 'git/diff'
+require 'git/status'
+require 'git/author'
+
+require 'git/stashes'
+require 'git/stash'
+
+
+# Git/Ruby Library
+#
+# This provides bindings for working with git in complex
+# interactions, including branching and merging, object
+# inspection and manipulation, history, patch generation
+# and more.  You should be able to do most fundamental git
+# operations with this library.
+#
+# This module provides the basic functions to open a git 
+# reference to work with. You can open a working directory,
+# open a bare repository, initialize a new repo or clone an
+# existing remote repository.
+#
+# Author::    Scott Chacon (mailto:schacon@gmail.com)
+# License::   MIT License
+module Git
+
+  VERSION = '1.0.4'
+  
+  # open a bare repository
+  #
+  # this takes the path to a bare git repo
+  # it expects not to be able to use a working directory
+  # so you can't checkout stuff, commit things, etc.
+  # but you can do most read operations
+  def self.bare(git_dir, options = {})
+    Base.bare(git_dir, options)
+  end
+    
+  # open an existing git working directory
+  # 
+  # this will most likely be the most common way to create
+  # a git reference, referring to a working directory.
+  # if not provided in the options, the library will assume
+  # your git_dir and index are in the default place (.git/, .git/index)
+  #
+  # options
+  #   :repository => '/path/to/alt_git_dir'
+  #   :index => '/path/to/alt_index_file'
+  def self.open(working_dir, options = {})
+    Base.open(working_dir, options)
+  end
+
+  # initialize a new git repository, defaults to the current working directory
+  #
+  # options
+  #   :repository => '/path/to/alt_git_dir'
+  #   :index => '/path/to/alt_index_file'
+  def self.init(working_dir = '.', options = {})
+    Base.init(working_dir, options)
+  end
+
+  # clones a remote repository
+  #
+  # options
+  #   :bare => true (does a bare clone)
+  #   :repository => '/path/to/alt_git_dir'
+  #   :index => '/path/to/alt_index_file'
+  #
+  # example
+  #  Git.clone('git://repo.or.cz/rubygit.git', 'clone.git', :bare => true)
+  #
+  def self.clone(repository, name, options = {})
+    Base.clone(repository, name, options)
+  end
+  
+  # Export the current HEAD (or a branch, if <tt>options[:branch]</tt>
+  # is specified) into the +name+ directory, then remove all traces of git from the
+  # directory.
+  #
+  # See +clone+ for options.  Does not obey the <tt>:remote</tt> option,
+  # since the .git info will be deleted anyway; always uses the default
+  # remote, 'origin.'
+  def self.export(repository, name, options = {})
+    options.delete(:remote)
+    repo = clone(repository, name, {:depth => 1}.merge(options))
+    repo.checkout("origin/#{options[:branch]}") if options[:branch]
+    Dir.chdir(repo.dir.to_s) { FileUtils.rm_r '.git' }
+  end
+    
+end