git-trip 0.0.3

data/spec/git_trip_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe GitTrip do
+  it "should return version string" do
+    GitTrip::VERSION.should be_a_kind_of(String)
+  end
+
+  it "should include Grit" do
+    Grit.should be_a_kind_of(Module)
+  end
+
+  it "should include Magick" do
+    Magick.should be_a_kind_of(Module)
+  end
+
+  it "should include Errors" do
+    GitTrip::Errors.should be_a_kind_of(Module)
+  end
+
+  it "should include Gitter" do
+    GitTrip::Gitter.should be_a_kind_of(Module)
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*,gems/*"

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'spec'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/git-trip')
+include GitTrip
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end

data/tasks/ditz.rake

@@ -0,0 +1,42 @@
+# Tasks that make it easier to deal with ditz.
+
+DOC_ROOT  = File.join(APP_ROOT, 'doc') unless defined? DOC_ROOT
+ISSUE_DIR = "#{DOC_ROOT}/issues"
+
+# 'rake issues' will just list them.
+desc 'List current issues'
+task :issues do
+  Rake::Task['issues:list'].invoke
+end
+
+namespace :issues do
+  desc 'Add an issue'
+  task :add do
+    sh 'ditz add'
+  end
+
+  task :list do
+    # Use back-tick execution to prevent output of command being run.
+    # Returns a string of the command output.
+    puts `ditz todo`
+  end
+
+  # 'rake issues:report' will just generate the report.
+  desc 'Generate issue report'
+  task :report do
+    Rake::Task['issues:report:generate'].invoke
+  end
+
+  namespace :report do
+    task :generate => [ 'issues:report:clear' ] do
+      header "Generating issue report in #{ISSUE_DIR}"
+      sh "ditz html #{ISSUE_DIR}"
+    end
+
+    desc 'Clear the issue report'
+    task :clear do
+      header "Removing issue report from #{ISSUE_DIR}"
+      sh "rm -rf #{ISSUE_DIR}"
+    end
+  end
+end

data/tasks/docs.rake

@@ -0,0 +1,68 @@
+# Tasks to handle application docs.
+DOC_TITLE = "GitTrip v#{GitTrip::VERSION} Documentation"
+DOC_ROOT  = File.join(APP_ROOT, 'doc') unless defined? DOC_ROOT
+API_DOCS  = File.join(DOC_ROOT, 'api')
+
+# Remove the default Hoe documentation tasks.
+remove_task 'clobber_docs'
+remove_task 'docs'
+remove_task 'docs/index.html'
+remove_task 'publish_docs'
+remove_task 'redocs'
+remove_task 'ridocs'
+
+# Override the default clobber_docs task.
+task :clobber_docs do
+  Rake::Task['docs:clear'].invoke
+end
+
+desc 'Generate the GitTrip API docs'
+task :docs do
+  Rake::Task['docs:api'].invoke
+end
+
+namespace :docs do
+  task :setup_rdoc do
+    @file_list = FileList[ "#{APP_ROOT}/README.txt",
+                           "#{APP_ROOT}/doc/USAGE.txt",
+                           "#{APP_ROOT}/lib/**/*.rb" ]
+    # Substitute APP_ROOT with a dot.  Makes for a better index in the generated docs.
+    @files = @file_list.collect  {|f| f.gsub(/#{APP_ROOT}/, '.')}
+    @options = %W[
+      --all
+      --inline-source
+      --line-numbers
+      --main README.txt
+      --op #{API_DOCS}
+      --title '#{DOC_TITLE}'
+    ]
+    # Generate a diagram, yes/no?
+    @options << '-d' if RUBY_PLATFORM !~ /win32/ && `which dot` =~ /\/dot/ && !ENV['NODOT']
+  end
+
+  task :api => [ :setup_rdoc ] do
+    run_rdoc(@options, @files)
+  end
+
+  desc 'Remove the GitTrip API docs'
+  task :clear do
+    header("Removing documentation from #{API_DOCS}")
+    system("rm -rf #{API_DOCS}")
+  end
+
+  desc 'Remove and rebuild the GitTrip API docs'
+  task :rebuild do
+    Rake::Task['docs:clear'].invoke
+    Rake::Task['docs:api'].invoke
+  end
+end
+
+private
+
+# Runs rdoc with the given +options+ and +files+.
+# Both arguments should be an Array, which is joined with a space.
+def run_rdoc(options, files)
+  options = options.join(' ') if options.is_a? Array
+  files   = files.join(' ')   if files.is_a? Array
+  system("rdoc #{options} #{files}")
+end

data/tasks/gittrip.rake

@@ -0,0 +1,63 @@
+# Comma seperated list of image formats.
+FORMATS = ENV['FORMATS'] ? ENV['FORMATS'].split(',') : %w{ gif jpg png }
+# Output directory.
+IMG_DIR = ENV['IMG_DIR']  || File.join(APP_ROOT, 'sandbox/git-trip')
+# Repository to use in image generation.
+IMG_REPO = ENV['IMG_REPO'] || APP_ROOT
+
+namespace :gittrip do
+  desc 'Clean up dynamically generated files'
+  task :cleanup do
+    %w{
+      docs:clear
+      gittrip:site:clear_local
+      gittrip:test:images:clear
+      issues:report:clear
+    }.each do |cleaner|
+      Rake::Task[cleaner].invoke
+    end
+  end
+
+  namespace :test do
+    desc 'Generate test images in sandbox/git-trip'
+    task :images => 'gittrip:test:images:generate'
+
+    namespace :images do
+      task :generate do
+        gen_test_images(IMG_DIR, IMG_REPO)
+      end
+
+      desc 'Remove the generated test images'
+      task :clear do
+        FORMATS.each do |format|
+          dir = File.join(IMG_DIR, format)
+          header("Removing images in #{dir}")
+          sh "rm -rf #{dir}/*" if File.exists?(dir)
+        end
+      end
+
+      desc 'Regenerate the test images'
+      task :rebuild do
+        Rake::Task['gittrip:test:images:clear'].invoke
+        Rake::Task['gittrip:test:images:generate'].invoke
+      end
+    end
+  end
+end
+
+# Generate test images in the given directory.
+def gen_test_images(dir, repo_dir)
+  repo = GitTrip::Gitter::Dir.new(repo_dir)
+  FORMATS.each do |format|
+    base_dir = "#{dir}/#{format}"
+    FileUtils.mkpath(base_dir) unless File.exists?(base_dir)
+    repo.commits.each_with_index do |commit, index|
+      painter = GitTrip::Painter.new(commit)
+      painter.paint!
+      painter.picture.write("#{base_dir}/#{index}.#{format}")
+      cool_pic = GitTrip::PaintMode.new(painter.picture, :radial).picture
+      cool_pic.write("#{base_dir}/#{index}-pretty.#{format}")
+    end
+    header("Images written to #{base_dir}")
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,22 @@
+require 'spec/rake/spectask'
+
+desc 'Run all specs in spec directory with RCov'
+task :rcov => 'spec:rcov'
+
+desc 'Run all specs in spec directory'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc 'Run all specs in spec directory with RCov'
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', 'spec/spec.opts']
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = lambda do
+      IO.readlines('spec/rcov.opts').map {|l| l.chomp.split ' '}.flatten
+    end
+  end
+end

data/tasks/site.rake

@@ -0,0 +1,48 @@
+# Tasks for dealing with the RubyForge site.
+
+# The local directories to store the website files.
+DOC_ROOT      = File.join(APP_ROOT, 'doc') unless defined? DOC_ROOT
+LOCAL_SITE    = File.join(DOC_ROOT, 'rubyforge.site')
+SITE_API      = File.join(LOCAL_SITE, 'api')
+SITE_ISSUES   = File.join(LOCAL_SITE, 'issues')
+
+# The remote directory the files will be scp'ed to.
+REMOTE_SITE = 'git-trip.rubyforge.org:/var/www/gforge-projects/git-trip'
+
+# A list of static pages to upload.
+PAGES = %w{
+  index.html
+  robots.txt
+}
+
+namespace :gittrip do
+  namespace :site do
+    desc 'Clear the local site directory of dynamic files'
+    task :clear_local do
+      header("Clearing local site directory: #{LOCAL_SITE}")
+      sh "rm -rf #{SITE_API}"      if File.exists? SITE_API
+      sh "rm -rf #{SITE_ISSUES}"   if File.exists? SITE_ISSUES
+    end
+
+    # Copies the issue and docs to the site directory.
+    task :setup_dir => [ :clear_local, :run_external_tasks ] do
+      header('Copying issues and API docs to the site directory.')
+      FileUtils.cp_r(API_DOCS, LOCAL_SITE)
+      FileUtils.cp_r(ISSUE_DIR, LOCAL_SITE)
+    end
+
+    desc 'Upload the issues and docs to the website'
+    task :upload => :setup_dir do
+      header('Uploading local site to remote site.')
+      sh "cd #{LOCAL_SITE} && scp -r ./* #{REMOTE_SITE}"
+    end
+
+    private
+
+    # Used to shorten the setup_site_dir task definition.
+    task :run_external_tasks do
+      Rake::Task['docs:rebuild'].invoke
+      Rake::Task['issues:report'].invoke
+    end
+  end
+end

data/tasks/util.rake

@@ -0,0 +1,44 @@
+# OverrideRakeTask - http://tools.assembla.com/svn/rails_plugins/override_rake_task/
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+def remove_task(task_name)
+  Rake.application.remove_task(task_name)
+end
+
+def override_task(args, &block)
+  name, deps = Rake.application.resolve_args(args)
+  remove_task Rake.application[name].name
+  task(args, &block)
+end
+
+
+#
+# Utility methods.
+#
+# Ask for confirmation.  Returns true/false
+def confirm(message, options = {})
+  confirm_message = options[:confirm_message] || 'Are you sure?'
+  banner = options[:banner] || false
+  banner ? header(message) : puts("\n#{message}")
+  print "#{confirm_message} (yes/no) "
+  choice = STDIN.gets.chomp
+
+  case choice
+  when 'yes'
+    return true
+  else
+    puts 'Aborted'
+  end
+end
+
+# Displays +message+ inside a formatted header.
+def header(message)
+  puts "\n"
+  puts '+---'
+  puts "| #{message}"
+  puts '+---'
+end

data/vendor/grit/History.txt

@@ -0,0 +1,6 @@
+== 0.8.0 / 2008-04-24
+  * Lots of fixes and additions
+
+== 0.7.0 / 2008-01-07
+  * First public release!
+

data/vendor/grit/Manifest.txt

@@ -0,0 +1,53 @@
+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/config.rb
+lib/grit/diff.rb
+lib/grit/errors.rb
+lib/grit/git.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_head.rb
+test/test_reality.rb
+test/test_repo.rb
+test/test_tag.rb
+test/test_tree.rb

data/vendor/grit/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.