git-trip 0.0.3

data/lib/git-trip/painter.rb

@@ -0,0 +1,167 @@
+module GitTrip
+
+  # This does the work of creating a commit specific image.
+  class Painter
+    DEFAULTS = {
+      :format => 'png',
+      :header => false,
+      :label  => false,
+      :style  => 'horizontal',
+      :width  => 50,
+      :height => 50
+    }
+
+    STYLES = %w{
+      montage
+      horizontal
+      vertical
+    }
+
+    attr_reader :canvas, :colors, :name, :picture
+
+    # Takes a single 40 character +sha+ string and an (optional)
+    # hash of +options+ (see DEFAULTS).
+    #
+    # +options+ can contain:
+    # * <tt>format</tt>: Image format; anything Magick::Image.new supports (ex. 'png', 'gif', etc).
+    # * <tt>header</tt>: If true, prints a header above the image, defaults to true; see +name+.
+    # * <tt>label</tt>: If true, the commit SHA will be included in the image; defaults to false.
+    # * <tt>name</tt>: The text to use above the commit image; only used if +header+ is true.
+    # * <tt>style</tt>: Generated image style; see STYLES.
+    # * <tt>width</tt>: Generated commit image width.
+    # * <tt>height</tt>: Generated commit image height.
+    def initialize(sha, options = {})
+      @options = DEFAULTS.merge(options)
+      raise Errors::RTFM unless sha.is_a?(String)
+      raise Errors::InvalidFormat unless Magick.formats.include?(@options[:format].upcase)
+      raise Errors::InvalidSHA if invalid_sha?(sha)
+      raise Errors::InvalidStyle if invalid_style?(@options[:style])
+      @sha     = sha
+      @colors, @remainder = split_colors
+      @name = (@options[:name] || create_name)
+      @canvas  = build_canvas
+      @picture = nil
+    end
+
+    # Paint a <tt>@picture</tt> based on <tt>@canvas</tt> and <tt>@options[:style]</tt>.
+    # Returns true or false based on the success of assigning <tt>@picture</tt>.
+    def paint!
+      # Need to set these locally, since <tt>Magick::ImageList#montage</tt>
+      # can't access instance variables in it's block, for some reason.
+      name   = @name
+      header = @options[:header]
+      width  = @options[:width]
+      height = @options[:height]
+      size = get_dimensions
+
+      montage = @canvas.montage do
+        self.geometry = Magick::Geometry.new(width, height)
+        self.title = name if header
+        self.tile = Magick::Geometry.new(size.first, size.last) if size
+      end
+
+      @picture = montage.flatten_images
+      @picture.format = @options[:format]
+      return (@picture ? true : false)
+    end
+
+    # Saves <tt>@picture</tt> to +location+ as '<tt>name</tt>.<tt>format</tt>'.
+    # Returns the <tt>@picture</tt> or nil upon failure.
+    #
+    # Example:
+    #   painter = GitTrip::Painter.new(commit, :format => 'png')
+    #   painter.paint!
+    #   painter.save('/tmp', 'my_repo')
+    #
+    # Which would save the image as '/tmp/my_repo.png'
+    def save(location, name)
+      raise Errors::NoPicture unless @picture
+      full_path = File.expand_path(location)
+      FileUtils.mkpath(full_path) unless File.exists?(full_path)
+      @picture.write("#{location}/#{name}.#{@options[:format]}")
+    end
+
+    private
+
+    # Applies a +text+ string to a given +image+.
+    def apply_label(text, image)
+      image.composite(build_label(text),
+        Magick::CenterGravity,
+        Magick::HardLightCompositeOp)
+    end
+
+    # Builds a Magick::ImageList canvas for the <tt>@colors</tt>.
+    # This is also where the label is conditionally applied.
+    def build_canvas
+      canvas = Magick::ImageList.new
+      @colors.each do |color|
+        image = Magick::Image.new(@options[:width], @options[:height]) do
+          self.background_color = "\##{color}"
+        end
+        canvas << (@options[:label] ? apply_label(color, image) : image)
+      end
+      return canvas
+    end # of build_canvas
+
+    # Builds an image with the given +text+.
+    # TODO: Find a sane way of setting the pointsize.
+    # TODO: Allow custom font options.
+    def build_label(text)
+      shading = false
+
+      label = Magick::Image.new(@options[:width], @options[:height])
+      image = Magick::Draw.new
+      image.gravity = Magick::CenterGravity
+      image.pointsize = @options[:width] / 4
+      image.font = 'Helvetica'
+      image.font_weight = Magick::NormalWeight
+      image.stroke = 'none'
+      image.annotate(label, 0, 0, 0, 0, text)
+      label = label.shade(shading, 310, 30)
+
+      return label
+    end
+
+    # Generate a name based on the remaining 4 characters of the SHA.
+    # Returns the created name.
+    # Only called if <tt>@options[:name]</tt> is not given.
+    def create_name
+      colors = @colors
+      first = colors.sort_by{rand}.first.split('')[0..2].sort_by{rand}.to_s
+      last  = colors.sort_by{rand}.last.split('')[0..2].sort_by{rand}.to_s
+      return "--- #{first}.#{@remainder}.#{last} ---"
+    end
+
+    # Returns an array of dimensions to be used in an ImageList#montage block.
+    # (ex. [4, 3])
+    def get_dimensions
+      case @options[:style]
+      when 'horizontal'
+        [@colors.size, 1]
+      when 'vertical'
+        [1, @colors.size]
+      end
+    end
+
+    # Returns true if +sha+ is invalid.
+    # TODO: Probably a better way of validating a SHA.
+    def invalid_sha?(sha)
+      sha.size != 40
+    end
+
+    # Returns true if +style+ is not in STYLES.
+    def invalid_style?(style)
+      return true unless STYLES.include?(style)
+    end
+
+    # Returns a 6 element array of RGB color codes, and the
+    # remaining 4 characters (as a string).
+    def split_colors
+      array     = []
+      remainder = @sha.split('') # Yes, it's not the remainder now, but it will be at the return statement.
+      6.times { array << remainder.slice!(0, 6).to_s }
+      return array, remainder.to_s
+    end
+  end # of Painter
+
+end

data/spec/core_ext/hash_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Hash, 'core extensions' do
+  before(:each) do
+    @hash = {
+      'key1' => 'val1',
+      'key2' => [1, 2, 3],
+      'key3' => {:a => 1, :b => 2}
+    }
+  end
+
+  it "should symbolize keys" do
+    symbol_keys = @hash.symbolize_keys
+    symbol_keys.each_key do |key|
+      key.should be_a_kind_of(Symbol)
+    end
+  end
+  
+  it "should symbolize keys destructively" do
+    @hash.symbolize_keys!
+    @hash.each_key do |key|
+      key.should be_a_kind_of(Symbol)
+    end
+  end
+end

data/spec/git-trip/errors_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Errors do
+  it "should define DirNotFound" do
+    Errors::DirNotFound.should be_a_kind_of(Class)
+  end
+
+  it "should define InvalidFormat" do
+    Errors::InvalidFormat.should be_a_kind_of(Class)
+  end
+
+  it "should define InvalidGitRepo" do
+    Errors::InvalidGitRepo.should be_a_kind_of(Class)
+  end
+
+  it "should define InvalidMode" do
+    Errors::InvalidMode.should be_a_kind_of(Class)
+  end
+
+  it "should define InvalidPicture" do
+    Errors::InvalidPicture.should be_a_kind_of(Class)
+  end
+
+  it "should define InvalidSHA" do
+    Errors::InvalidSHA.should be_a_kind_of(Class)
+  end
+
+  it "should define InvalidStyle" do
+    Errors::InvalidStyle.should be_a_kind_of(Class)
+  end
+
+  it "should define NoCommits" do
+    Errors::NoCommits.should be_a_kind_of(Class)
+  end
+
+  it "should define NoPicture" do
+    Errors::NoPicture.should be_a_kind_of(Class)
+  end
+
+  it "should define RTFM" do
+    Errors::RTFM.should be_a_kind_of(Class)
+  end
+end

data/spec/git-trip/gitter/base_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Gitter::Base do
+  before(:each) do
+    @commits = %w{
+      ruby is fucking awesome word to your mother
+    }.map { |text| Digest::SHA1.hexdigest(text) }
+    @repo = mock(Gitter::Base)
+    @repo.stub!(:commits).and_return(@commits)
+  end
+
+  it "should return an array of commit SHAs" do
+    @repo.commits.should be_instance_of(Array)
+  end
+end

data/spec/git-trip/gitter/dir_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Gitter::Dir do
+  before(:each) do
+    # This is a test git repository.
+    @dir = File.expand_path(File.dirname(__FILE__) + '/../../../sandbox')
+    @repo = Gitter::Dir.new(@dir)
+  end
+
+  it "should read a repository from a directory" do
+    @repo.should be_a_kind_of(Gitter::Dir)
+  end
+
+  it "should raise Errors::DirNotFound" do
+    lambda { Gitter::Dir.new('/not/a/real/dir') }.should raise_error(Errors::DirNotFound)
+  end
+
+  it "should raise Grit::InvalidGitRepositoryError" do
+    lambda do
+      Gitter::Dir.new(File.dirname(__FILE__))
+    end.should raise_error(Grit::InvalidGitRepositoryError)
+  end
+
+  it "should return an array of commit SHAs" do
+    @repo = Gitter::Dir.new(@dir)
+    @repo.commits.should_not be_empty
+  end
+
+  it "should iterate the commits" do
+    @repo.each_commit do |c|
+      c.should be_instance_of(String)
+      c.size.should eql(40) # size of a SHA1
+    end
+  end
+
+  it "should return the author of a commit"
+end

data/spec/git-trip/gitter/uri_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Gitter::URI do
+  before(:each) do
+    @uri    = 'http://github.com/api/v1/json/Oshuma/git-trip/commits/master'
+    @repo   = Gitter::URI.new(@uri)
+  end
+
+  it "should read a repository from a URI" do
+    @repo.should be_a_kind_of(Gitter::URI)
+  end
+
+  it "should raise Errors::InvalidFormat" do
+    lambda do
+      Gitter::URI.new(@uri, :format => 'invalid')
+    end.should raise_error(Errors::InvalidFormat)
+  end
+
+  it "should raise Errors::InvalidURI" do
+    lambda { Gitter::URI.new('bogus URI') }.should raise_error(Errors::InvalidURI)
+  end
+
+  it "should return an array of commit SHAs"
+  it "should return the author of a commit"
+end

data/spec/git-trip/gitter_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Gitter, '(module)' do
+  it "should include Gitter::Dir" do
+    Gitter::Dir.should be_a_kind_of(Class)
+  end
+
+  it "should include Gitter::URI" do
+    Gitter::URI.should be_a_kind_of(Class)
+  end
+end

data/spec/git-trip/paint_mode_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PaintMode do
+  before(:each) do
+    @image = Magick::Image.new(5, 5)
+    @mode  = PaintMode.new(@image, :blend)
+  end
+
+  it "should instantiate" do
+    @mode.should be_instance_of(PaintMode)
+  end
+
+  it "should raise ArgumentError" do
+    lambda { PaintMode.new }.should raise_error(ArgumentError)
+  end
+
+  it "should raise Errors::InvalidPicture" do
+    lambda do
+      PaintMode.new('not a picture', :blend)
+    end.should raise_error(Errors::InvalidPicture)
+  end
+
+  it "should raise Errors::InvalidMode" do
+    lambda do
+      PaintMode.new(@image, :invalid_mode)
+    end.should raise_error(Errors::InvalidMode)
+  end
+
+  it "should allow mode as symbol" do
+    PaintMode.new(@image, :blend).should be_instance_of(PaintMode)
+  end
+
+  it "should allow mode as string" do
+    PaintMode.new(@image, 'blend').should be_instance_of(PaintMode)
+  end
+
+  it "should define MODES" do
+    PaintMode::MODES.should be_instance_of(Array)
+  end
+
+  it "should have a picture accessor" do
+    @mode.picture.should be_instance_of(Magick::Image)
+  end
+  
+  it "should blend" do
+    PaintMode.new(@image, :blend).picture.should be_instance_of(Magick::Image)
+  end
+  
+  it "should pixel" do
+    PaintMode.new(@image, :pixel).picture.should be_instance_of(Magick::Image)
+  end
+
+  it "should radial" do
+    PaintMode.new(@image, :radial).picture.should be_instance_of(Magick::Image)
+  end
+end

data/spec/git-trip/painter_spec.rb

@@ -0,0 +1,173 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Painter do
+  before(:each) do
+    @commit  = Digest::SHA1.hexdigest('ruby')
+    @painter = Painter.new(@commit)
+  end
+
+  it "should instantiate" do
+    @painter.should be_instance_of(Painter)
+  end
+
+  it "should raise Errors::InvalidSHA" do
+    lambda { Painter.new('not a valid sha') }.should raise_error(Errors::InvalidSHA)
+  end
+
+  it "should raise Errors::InvalidStyle" do
+    lambda do
+      Painter.new(@commit, :style => 'invalid')
+    end.should raise_error(Errors::InvalidStyle)
+  end
+
+  it "should raise Errors::RTFM" do
+    lambda { Painter.new(5) }.should raise_error(Errors::RTFM)
+  end
+
+  it "should define DEFAULTS" do
+    Painter::DEFAULTS.should be_instance_of(Hash)
+  end
+
+  it "should define STYLES" do
+    Painter::STYLES.should be_instance_of(Array)
+  end
+
+  it "should build a canvas" do
+    @painter.canvas.should be_instance_of(Magick::ImageList)
+  end
+
+  it "should set default width" do
+    options = @painter.instance_variable_get(:@options)
+    options[:width].should eql(50)
+  end
+
+  it "should allow a custom width" do
+    @painter = Painter.new(@commit, :width => 25)
+    options = @painter.instance_variable_get(:@options)
+    options[:width].should eql(25)
+  end
+
+  it "should set default height" do
+    options = @painter.instance_variable_get(:@options)
+    options[:height].should eql(50)
+  end
+
+  it "should allow a custom height" do
+    @painter = Painter.new(@commit, :height => 25)
+    options = @painter.instance_variable_get(:@options)
+    options[:height].should eql(25)
+  end
+
+  it "should set default style" do
+    options = @painter.instance_variable_get(:@options)
+    options[:style].should_not be_nil
+  end
+
+  it "should allow a horizontal style" do
+    @painter = Painter.new(@commit, :style => 'horizontal')
+    options = @painter.instance_variable_get(:@options)
+    options[:style].should eql('horizontal')
+  end
+
+  it "should allow a vertical style" do
+    @painter = Painter.new(@commit, :style => 'vertical')
+    options = @painter.instance_variable_get(:@options)
+    options[:style].should eql('vertical')
+  end
+
+  it "should allow a montage style" do
+    @painter = Painter.new(@commit, :style => 'montage')
+    options = @painter.instance_variable_get(:@options)
+    options[:style].should eql('montage')
+  end
+
+  it "should return an array of 6 RGB color codes" do
+    @painter.colors.size.should eql(6)
+  end
+
+  it "should have 6 characters per color" do
+    @painter.colors.each do |color|
+      color.size.should eql(6)
+    end
+  end
+
+  it "should have proper colors for it's SHA and remaining 4 characters" do
+    sha = @painter.colors.to_s + @commit[-4, 4]
+    sha.should eql(@commit)
+  end
+
+  it "should accept a custom size" do
+    Painter.new(@commit, :size => [25, 25]).should be_instance_of(Painter)
+  end
+
+  it "should paint a montage image" do
+    @painter.paint!.should_not be_false
+    @painter.picture.should be_instance_of(Magick::Image)
+  end
+
+  it "should paint a horizontal image" do
+    @painter = Painter.new(@commit, :style => 'horizontal')
+    @painter.paint!.should_not be_false
+    @painter.picture.should be_instance_of(Magick::Image)
+  end
+
+  it "should paint a vertical image" do
+    @painter = Painter.new(@commit, :style => 'vertical')
+    @painter.paint!.should_not be_false
+    @painter.picture.should be_instance_of(Magick::Image)
+  end
+
+  it "should create an image with commits color labels" do
+    @painter = Painter.new(@commit, :label => true)
+    @painter.paint!.should_not be_false
+    @painter.picture.should be_instance_of(Magick::Image)
+  end
+
+  it "should have a name" do
+    @painter.name.should_not be_nil
+    @painter.name.should be_instance_of(String)
+  end
+
+  it "should allow a custom name" do
+    @painter = Painter.new(@commit, :name => 'Awesome')
+    @painter.name.should eql('Awesome')
+  end
+
+  it "should allow a custom header option" do
+    @painter = Painter.new(@commit, :header => false)
+    options = @painter.instance_variable_get(:@options)
+    options[:header].should be_false
+  end
+
+  it "should allow custom format option" do
+    @painter = Painter.new(@commit, :format => 'jpg')
+    options = @painter.instance_variable_get(:@options)
+    options[:format].should eql('jpg')
+    @painter.paint!
+    @painter.picture.should be_instance_of(Magick::Image)
+  end
+
+  it "should raise Errors::InvalidFormat" do
+    lambda do
+      @painter = Painter.new(@commit, :format => 'some shit')
+    end.should raise_error(Errors::InvalidFormat)
+  end
+
+  it "should raise Errors::NoPicture" do
+    lambda do
+      @painter.save('/tmp', 'no picture')
+    end.should raise_error(Errors::NoPicture)
+  end
+
+  # Yes, this spec sucks.
+  it "should save the picture" do
+    test_path = File.expand_path('./sandbox/')
+    test_name = 'git-trip-test'
+    test_file = File.join(test_path, "#{test_name}.png")
+    File.delete(test_file) if File.exists?(test_file)
+    @painter.paint!
+    @painter.save(test_path, test_name).should be_instance_of(Magick::Image)
+    File.exists?(test_file).should be_true
+    File.delete(test_file) if File.exists?(test_file)
+  end
+end