git-trip 0.0.3

data/History.txt

@@ -0,0 +1,21 @@
+=== 0.0.3 / 2008-07-08
+
+Many nice changes, including (but not limited to):
+
+* Better handling of internal images.
+* Smarter defaults.
+* More options to GitTrip::Painter
+* GitTrip::Painter#save
+* All new GitTrip::PaintMode, which makes your images pretty!
+* Documentation updates.
+
+=== 0.0.2 / 2008-07-04
+
+* Actually functioning!
+
+=== 0.0.1 / 2008-07-02
+
+* 1 major enhancement
+
+  * New project.
+

data/Manifest.txt

@@ -0,0 +1,89 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/git-trip
+doc/USAGE.txt
+lib/core_ext/hash.rb
+lib/git-trip.rb
+lib/git-trip/errors.rb
+lib/git-trip/gitter.rb
+lib/git-trip/gitter/base.rb
+lib/git-trip/gitter/dir.rb
+lib/git-trip/gitter/uri.rb
+lib/git-trip/paint_mode.rb
+lib/git-trip/painter.rb
+spec/core_ext/hash_spec.rb
+spec/git-trip/errors_spec.rb
+spec/git-trip/gitter/base_spec.rb
+spec/git-trip/gitter/dir_spec.rb
+spec/git-trip/gitter/uri_spec.rb
+spec/git-trip/gitter_spec.rb
+spec/git-trip/paint_mode_spec.rb
+spec/git-trip/painter_spec.rb
+spec/git_trip_spec.rb
+spec/rcov.opts
+spec/spec.opts
+spec/spec_helper.rb
+tasks/ditz.rake
+tasks/docs.rake
+tasks/gittrip.rake
+tasks/rspec.rake
+tasks/site.rake
+tasks/util.rake
+vendor/grit/History.txt
+vendor/grit/Manifest.txt
+vendor/grit/README.txt
+vendor/grit/Rakefile
+vendor/grit/grit.gemspec
+vendor/grit/lib/grit.rb
+vendor/grit/lib/grit/actor.rb
+vendor/grit/lib/grit/blob.rb
+vendor/grit/lib/grit/commit.rb
+vendor/grit/lib/grit/config.rb
+vendor/grit/lib/grit/diff.rb
+vendor/grit/lib/grit/errors.rb
+vendor/grit/lib/grit/git.rb
+vendor/grit/lib/grit/index.rb
+vendor/grit/lib/grit/lazy.rb
+vendor/grit/lib/grit/ref.rb
+vendor/grit/lib/grit/repo.rb
+vendor/grit/lib/grit/tree.rb
+vendor/grit/test/fixtures/blame
+vendor/grit/test/fixtures/cat_file_blob
+vendor/grit/test/fixtures/cat_file_blob_size
+vendor/grit/test/fixtures/diff_2
+vendor/grit/test/fixtures/diff_2f
+vendor/grit/test/fixtures/diff_f
+vendor/grit/test/fixtures/diff_i
+vendor/grit/test/fixtures/diff_mode_only
+vendor/grit/test/fixtures/diff_new_mode
+vendor/grit/test/fixtures/diff_p
+vendor/grit/test/fixtures/for_each_ref
+vendor/grit/test/fixtures/for_each_ref_remotes
+vendor/grit/test/fixtures/for_each_ref_tags
+vendor/grit/test/fixtures/ls_tree_a
+vendor/grit/test/fixtures/ls_tree_b
+vendor/grit/test/fixtures/ls_tree_commit
+vendor/grit/test/fixtures/rev_list
+vendor/grit/test/fixtures/rev_list_count
+vendor/grit/test/fixtures/rev_list_single
+vendor/grit/test/fixtures/rev_parse
+vendor/grit/test/fixtures/show_empty_commit
+vendor/grit/test/fixtures/simple_config
+vendor/grit/test/helper.rb
+vendor/grit/test/profile.rb
+vendor/grit/test/suite.rb
+vendor/grit/test/test_actor.rb
+vendor/grit/test/test_blob.rb
+vendor/grit/test/test_commit.rb
+vendor/grit/test/test_config.rb
+vendor/grit/test/test_diff.rb
+vendor/grit/test/test_git.rb
+vendor/grit/test/test_head.rb
+vendor/grit/test/test_real.rb
+vendor/grit/test/test_reality.rb
+vendor/grit/test/test_remote.rb
+vendor/grit/test/test_repo.rb
+vendor/grit/test/test_tag.rb
+vendor/grit/test/test_tree.rb

data/README.txt

@@ -0,0 +1,60 @@
+= GitTrip
+
+Author:: Dale Campbell <dale@save-state.net>
+Code:: http://github.com/Oshuma/git-trip/
+Site:: http://git-trip.rubyforge.org/
+
+=== DESCRIPTION:
+
+Visualize git commit SHAs.  It's nerd acid!
+
+=== SYNOPSIS:
+
+GitTrip is a unique, completely useless, way of visualizing git commit SHA
+strings.  Since a single SHA is 40 characters (0-9a-f), you can (for example)
+derive 6 RGB colors from each git object.  (40/6 == 6 with 4 characters left over)
+With these 6 colors comes a wide range of possibilities.  GitTrip::Painter will
+support multiple 'rendering modes' which will determine what the resulting
+commit image will look like.
+
+If you find bugs, or have suggestions, post them on the RubyForge tracker and
+forums, respectively.
+
+Tracker:: http://rubyforge.org/tracker/?group_id=6594
+Forums:: http://rubyforge.org/forum/?group_id=6594
+
+=== REQUIREMENTS:
+
+* RMagick - http://rmagick.rubyforge.org/
+* Grit - http://grit.rubyforge.org/
+* JSON - http://json.rubyforge.org/
+* mime-types - http://mime-types.rubyforge.org/
+* open4 - http://raa.ruby-lang.org/project/open4/
+
+=== INSTALL:
+
+ # From Github:
+ $ gem sources -a http://gems.github.com/ # (You only need to do this once.)
+ $ gem install Oshuma-git-trip
+
+=== USAGE:
+
+See doc/USAGE.txt.
+
+=== LICENSE:
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+             	   http://sam.zoy.org/wtfpl/
+
+
+ Copyright (C) 2008 Dale Campbell <dale@save-state.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'hoe'
+require './lib/git-trip.rb'
+
+APP_ROOT = File.dirname(__FILE__) unless defined?(APP_ROOT)
+
+task :default => [ :spec ]
+
+Hoe.new('git-trip', GitTrip::VERSION) do |p|
+  p.developer('Dale Campbell', 'dale@save-state.net')
+end
+
+# Load any rakefiles in tasks/
+custom_tasks = FileList['tasks/**/*.rake'].sort
+# Load util.rake before any others...
+load custom_tasks.delete('tasks/util.rake')
+# ...now load the rest.
+custom_tasks.each { |task| load task }
+
+# Remove un-needed tasks.
+remove_task 'audit'
+remove_task 'generate_key'
+remove_task 'multi'
+remove_task 'post_blog'
+remove_task 'test'
+remove_task 'test_deps'
+
+desc 'Start an irb session with Ridge loaded'
+task :console do
+  sh "irb -d -I ./lib -r 'git-trip'"
+end

data/doc/USAGE.txt

@@ -0,0 +1,54 @@
+See the individual class docs for more options and specific examples.
+
+ # Load it up!
+ require 'git-trip'
+
+ # Grab repository information.
+ repo = GitTrip::Gitter::Dir.new('/path/to/repo')
+ # .. or ..
+ repo = GitTrip::Gitter::URI.new('http://domain.com/path/to/repo')
+
+ # Now that you have a repository, you can do cool shit.
+ repo.commits.each do |commit|
+   # GitTrip::Painter requires a commit SHA (string).
+   painter = GitTrip::Painter.new(commit)
+
+   # This does the work of creating a commit specific image.
+   painter.paint!
+
+   # painter's +picture+ now holds a Magick::Image, so all of it's methods are supported.
+   painter.picture.display
+
+   # From this point, you can do something pretty with the image.
+   # GitTrip::PaintMode takes a Magick::Image and a mode type.
+   pretty = GitTrip::PaintMode.new(painter.picture, :pixel)
+
+   # Just as with GitTrip::Painter, pretty's +picture+ now holds a Magick::Image.
+   pretty.picture.display
+ end
+
+
+If you wanted to use GitTrip in a Rails application, here's an example controller ##create method.
+
+ # app/controllers/trip_controller.rb
+ class TripController < ApplicationController
+   def create
+     painter = GitTrip::Painter.new(params[:hash])
+     painter.paint!
+     pretty = GitTrip::PaintMode.new(painter.picture, :blend)
+     pretty.picture.format = 'PNG'
+     send_data pretty.picture.to_blob,
+       :filename => 'trip.png',
+       :type => 'image/png',
+       :disposition => 'inline'
+   end
+ end
+
+ # config/routes.rb
+ map.trip 'trip/:hash', :controller => 'trip', :action => 'create'
+
+Then use it like so:
+
+ <img src="http://domain.com/trip/103d8734bd5fb0958ea0b6fa3fe59de7ada96df7" />
+
+Slick.  Thanks goes to Scott Barron <http://rubyi.st> for that tip.

data/lib/core_ext/hash.rb

@@ -0,0 +1,15 @@
+# Extensions to the core Hash class.
+class Hash
+  # Turn all string keys into symbols.  Returns the modified hash.
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_sym || key] = value
+      options
+    end
+  end
+
+  # Destructive version of symbolize_keys.
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+end

data/lib/git-trip.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# Third-party libraries...
+require 'rubygems'
+require 'digest/sha1'
+require 'json'
+require 'open-uri'
+require 'RMagick'
+
+# ...in ./vendor/
+require 'vendor/grit/lib/grit'
+
+# GitTrip libraries.
+require 'core_ext/hash'
+require 'git-trip/errors'
+require 'git-trip/gitter'
+require 'git-trip/paint_mode'
+require 'git-trip/painter'
+
+module GitTrip
+  VERSION = '0.0.3'
+  include GitTrip::Errors
+end

data/lib/git-trip/errors.rb

@@ -0,0 +1,22 @@
+module GitTrip
+
+  # Holds Errors (Exceptions) specific to GitTrip.
+  module Errors
+    %w{
+      DirNotFound
+      InvalidFormat
+      InvalidGitRepo
+      InvalidMode
+      InvalidPicture
+      InvalidSHA
+      InvalidStyle
+      InvalidURI
+      NoCommits
+      NoPicture
+      RTFM
+    }.each do |problem|
+      eval("class #{problem} < Exception; end")
+    end
+  end # of Errors
+
+end

data/lib/git-trip/gitter.rb

@@ -0,0 +1,10 @@
+module GitTrip
+
+  require 'git-trip/gitter/base'
+  require 'git-trip/gitter/dir'
+  require 'git-trip/gitter/uri'
+
+  module Gitter
+  end # of Gitter
+
+end

data/lib/git-trip/gitter/base.rb

@@ -0,0 +1,18 @@
+module GitTrip
+  module Gitter
+
+    # Provides common git functionality to it's children.
+    class Base
+      # Returns an array containing each commit SHA.
+      def commits
+        @data[:commits]
+      end
+
+      # Iterator for the commits.
+      def each_commit(&block)
+        @data[:commits].each { |commit| yield commit }
+      end
+    end # of Base
+
+  end
+end

data/lib/git-trip/gitter/dir.rb

@@ -0,0 +1,32 @@
+module GitTrip
+  module Gitter
+
+    # Handles fetching git repository information from a directory.
+    class Dir < Gitter::Base
+      # <tt>dir</tt> should be a path to a git repository (containing a .git/ subdirectory).
+      def initialize(dir, options = {})
+        raise Errors::DirNotFound unless File.exists?(dir)
+        @repo = Grit::Repo.new(dir)
+        @data = {}
+        setup_data_hash
+      end
+
+      private
+
+      # Loads the <tt>@data</tt> hash with repository information.
+      def setup_data_hash
+        load_repo_commits
+      end
+
+      # Loads a hash of commits into <tt>@data[:commits]</tt>.
+      def load_repo_commits
+        commits = []
+        @repo.commits(@repo.head.name, @repo.commit_count).map do |c|
+          commits << c.to_s
+        end
+        @data[:commits] = commits
+      end
+    end # of Dir
+
+  end # of Gitter
+end

data/lib/git-trip/gitter/uri.rb

@@ -0,0 +1,40 @@
+module GitTrip
+  module Gitter
+
+    # Handles fetching git repository information from a remote URI.
+    class URI < Gitter::Base
+      FORMATS   = %w{ json xml yaml }
+      PROTOCOLS = %w{ http https }
+
+      DEFAULTS = {
+        :format => 'json'
+      }
+
+      # Takes a +uri+ that returns information about a repository;
+      # expects JSON data by default (see FORMATS).
+      # The second argument is an optional hash of +options+ (see DEFAULTS).
+      #
+      # <tt>options</tt> can contain:
+      # * <tt>format</tt>: Defaults to 'json'; see FORMATS.
+      def initialize(uri, options = {})
+        raise Errors::InvalidURI if invalid_uri?(uri)
+        @uri = uri
+        @options = DEFAULTS.merge(options)
+        raise Errors::InvalidFormat if invalid_format?(@options[:format])
+      end
+
+      private
+
+      # Returns true if the given +format+ is invalid.
+      def invalid_format?(format)
+        return true unless FORMATS.include?(format)
+      end
+
+      # Returns true if the given +uri+ is invalid.
+      def invalid_uri?(uri)
+        uri.grep(/^(#{PROTOCOLS.join('|')}):\/\/\w/).empty?
+      end
+    end # of URI
+
+  end # of Gitter
+end

data/lib/git-trip/paint_mode.rb

@@ -0,0 +1,52 @@
+module GitTrip
+
+  class PaintMode
+    MODES = [
+      :blend,
+      :pixel,
+      :radial
+    ]
+
+    attr_reader :picture
+
+    # This class takes an +image+ generated from GitTrip::Painter and does
+    # something pretty with it.  +mode+ can be anything listed in MODES, as
+    # a string or symbol.  There's a 'picture' reader that returns the
+    # generated Magick::Image.
+    #
+    # Example:
+    #   painter = GitTrip::Painter.new(commit_sha)
+    #   painter.paint!  # Create the commit specific image.
+    #   pretty = GitTrip::PaintMode.new(painter.picture, :pixel)
+    #   # pretty now holds a Magick::Image.
+    #   pretty.display
+    def initialize(image, mode)
+      raise Errors::InvalidPicture unless image.is_a?(Magick::Image)
+      raise Errors::InvalidMode unless MODES.include?(mode.to_sym)
+      @mode = mode.to_sym
+      @image = image
+
+      @picture = case @mode
+      when :blend:  blend_mode
+      when :pixel:  pixel_mode
+      when :radial: radial_mode
+      end
+    end
+
+    # Blend <tt>@image</tt>.
+    def blend_mode(distance = 35)
+      @image.motion_blur(0, distance, 180)
+    end
+
+    # Pixelize <tt>@image</tt>.
+    def pixel_mode
+      @image.ordered_dither
+    end
+    
+    # Radialize <tt>@image</tt>
+    def radial_mode
+      @image.radial_blur(90)
+    end
+  end # of PaintMode
+
+end