sprite_generator 0.2.5 → 0.3.0

data/lib/sprites.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+require "bundler"
+Bundler.setup(:default)
+require 'yaml'
+require 'ostruct'
+require 'RMagick'
+require 'liquid'
+
+require File.expand_path('../sprites/generator', __FILE__)
+require File.expand_path('../sprites/batch', __FILE__)
+
+module Sprites
+  class Config
+    class << self  
+      def root=(root = nil)
+        @root = root
+      end
+      
+      def root
+        @root || File.expand_path('../../', __FILE__)
+      end
+    end
+  end
+end

data/lib/sprites/batch.rb

@@ -0,0 +1,34 @@
+module Sprites
+  class Batch
+    attr_reader :batches
+
+    def initialize(filename)
+      config = YAML.load(File.read(filename))
+      @batches = config.inject([]) do |arr, pair|
+        if !!defined?(RAILS_ROOT)
+          pair.last.merge!(:config_root => RAILS_ROOT)
+        elsif pair.last[:root]
+          root = File.expand_path(pair.last[:root], file_name)
+          pair.last.merge!(:config_root => root)
+        end
+        arr.push OpenStruct.new(pair.last)
+        arr
+      end
+    end
+
+    def generate
+      @batches.each do |batch|
+        generator = Sprites::Generator.new(batch.files, batch.output, batch.config_root, batch.options || {})
+        css       = generator.create
+        # only write output if css_output is specified
+        unless css.nil? || css.empty? || batch.css_output.nil?
+          output = batch.css_template.nil? ? css : Liquid::Template.parse(File.open(batch.css_template).read).render('css' => css)
+          File.open(batch.css_output, 'w+'){|f| f.puts output }
+        end
+      end
+    end
+  end
+  
+end
+
+  

data/lib/sprites/generator.rb

@@ -0,0 +1,244 @@
+module Sprites
+  class Generator
+    include Magick
+
+    # parameters:
+    # files_or_path: can be Dir.glob-able paths or an array of filenames 
+    #   ie: ['../images/icons/icon1_out.png', '../images/icons/icon1_over.png'] or '../images/icons/icon*.png' 
+    # output: filename where the generated sprite will be stored
+    #   ie: '../images/sprites/icons.png'
+    # options: set a variety of options
+    #   - delimiter: characters by which multiple variations of images will be found
+    #     ie: '_' for 'icon_hover.png'
+    #     ie: '-' for 'icon-hover.png'
+    #         if icon is the basename
+    #   - align: 
+    #   - sprite_location: will be available as variable in the liquid template, if this is not set, the template will use output as sprite_location
+    #   - tile: if set to ie. '100x100' it will center every image on a 100 by 100 tile
+    #   - template: Liquid template for each sprite, use this to build the css for your sprites
+    #             these variables are available:
+    #             - top: distance to top border of sprite in pixels 
+    #             - left: distance to left border of sprite in pixels 
+    #             - width: width of current image in pixels 
+    #             - height: height of current image in pixels 
+    #             - basename: filename or basename of variations
+    #               ie: with variations: icon_out.png, icon_over.png  => icon
+    #               ie: without variations: icon.png => icon.png
+    #             - file_basename: always the name of the current image without extension
+    #               ie: icon_over
+    #             - filename: icon_over.png
+    #             - full_filename: ../images/icons/icon_over.ong
+    #             - variations: number of variations as number
+    #             - variation: the current variation as zero based number
+    #             - sprite_location: path to sprite
+    def initialize(files_or_paths, output, root, options = {})
+      @files = find_files(files_or_paths)
+      return if @files.nil? || @files.empty?
+      @root             = root || ''
+      @output           = output
+      @delimiter        = options[:delimiter] || '-'
+      @distribution     = (options[:distribution] || :smart).to_sym
+      @analyzed         = find_files_for_mode
+      @template         = Liquid::Template.parse(options[:template] || '')
+      @sprite_location  = options[:sprite_location] || @output
+      @background       = options[:background] || '#FFFFFF00'
+      @tile_size        = options[:tile]
+      @alignment        = options[:alignment] ? Magick.const_get("#{camelize(options[:alignment])}Gravity") : Magick::CenterGravity
+    end
+
+    def create
+      raise 'No files found.' if @files.nil? || @files.empty?
+      build_tile
+      destination = @root.nil? || @root.empty? ? @output : File.join(@root, @output)
+      image, css  = build_sprite_and_css
+      background  = @background
+      image.write(destination){ self.background_color = background }
+      css
+    end
+
+  protected
+
+    def build_sprite_and_css
+      background  = @background
+      @images     = ImageList.new{ self.background_color = background }
+      context     = { 'sprite_location' => @sprite_location }
+      @css        = []
+
+      @analyzed.keys.sort.each do |key|
+        value = @analyzed[key]
+
+        context['top']      = 0
+        context['basename'] = key
+        context['overall']  = @images.length
+        if value.size > 1
+          context = build_image_list(context, value.sort)
+        else
+          context = build_single_image(context, value.flatten.first)
+        end
+        @css << build_css(context)
+      end
+      [@images.append(false), @css.join("\n")]
+    end
+
+    def build_single_image(context, filename)
+      background  = @background
+      image       = Image.read(filename){ self.background_color = background }.flatten.first
+
+      context.merge!(build_context_for_single_image(image, filename, context['basename']))
+      if @tile
+        @images.from_blob(@tile.composite(image, @alignment, Magick::OverCompositeOp).to_blob){ self.background_color = background }
+      else
+        @images.from_blob(image.to_blob){ self.background_color = background }
+      end
+      context
+    end
+
+    def build_context_for_single_image(image, filename, basename)
+      file_basename = File.basename(filename, '.*')
+      {
+        'variations'       => 0,
+        'variation_number' => 0,
+        'full_filename'    => filename,
+        'file_basename'    => file_basename,
+        'variation_name'   => file_basename.gsub("#{basename}#{@delimiter}", ''),
+        'width'            => @tile ? @tile.columns : image.columns,
+        'height'           => @tile ? @tile.rows    : image.rows,
+        'type'             => :image,
+        'left'             => left_value_for_context
+      }
+    end
+
+    def left_value_for_context
+      @tile ? (@images.length * @tile.columns) : (@images.any? ? @images.append(false).columns : 0)
+    end
+
+    def build_image_list(context, image_filenames)
+      background  = @background
+      image_list = ImageList.new(*image_filenames){ self.background_color = background }
+      context.merge!(build_context_for_image_list(image_list, image_filenames))
+      if @tile
+        tiles = ImageList.new{ self.background_color = background }
+        image_list.each do |image|
+          tiles << @tile.composite(image, @alignment, Magick::OverCompositeOp)
+        end
+        append_to_sprite(tiles)
+      else
+        append_to_sprite(image_list)
+      end
+      context
+    end
+
+    def append_to_sprite(images)
+      background  = @background
+      @images.from_blob(images.append(true).to_blob){ self.background_color = background }
+    end
+
+    def build_context_for_image_list(image_list, image_filenames)
+      {
+        'variations' => image_list.length,
+        'type'       => :list,
+        'images'     => image_list,
+        'filenames'  => image_filenames,
+        'left'        => left_value_for_context
+      }
+    end
+
+    def build_tile
+      return if @tile_size.nil?
+      background = @background
+      size_x, size_y = @tile_size.split('x').first(2).map{|dim| dim.to_i}
+      @tile = Magick::Image.new(size_x, size_y){ self.background_color = background }
+      @tile.format = "PNG"
+    end
+
+    def build_css(context = {})
+      type = context['type']
+      case type
+      when :list
+        css = build_css_for_list(context)
+      when :image
+        # render template if there is only one image
+        css = @template.render(context)
+      end
+      css
+    end
+
+    def build_css_for_list(context)
+      new_context = context.dup
+      image_list  = context.delete('images')
+      new_context['type'] = :image
+      css = image_list.inject([]) do |css, image|
+        new_context['width']            = @tile ? @tile.columns : image.columns
+        new_context['height']           = @tile ? @tile.rows : image.rows
+        new_context['variation_number'] = css.size
+        new_context['full_filename']    = context['filenames'].shift
+        new_context['filename']         = File.basename(new_context['full_filename'])
+        new_context['file_basename']    = File.basename(new_context['full_filename'], '.*')
+        new_context['variation_name']   = new_context['file_basename'].gsub(/^#{new_context['basename']}#{@delimiter}/, '')
+        css << build_css(new_context.dup)
+
+        new_context['top'] += @tile ? @tile.rows : new_context['height']
+        css
+      end.join("\n")
+    end
+
+    # gather files that will be used to create the sprite
+    def find_files(*args)
+      args.inject([]) do |files, arg|
+        found_files = Dir.glob(arg)
+        if found_files.empty?
+          files << arg if File.exists?(arg) rescue raise arg.inspect
+        else
+          files << found_files.flatten
+        end
+        files.flatten.compact.uniq
+      end
+    end
+
+    # put filenames in format for each mode
+    def find_files_for_mode
+      case @distribution
+      when :smart
+        smart_distribution
+      when :horizontal
+        horizontal_distribution
+      when :vertical
+        vertical_distribution
+      end
+    end
+
+    # gather information about the selected files
+    # check for variations by using a delimiter as an indicator
+    def smart_distribution
+      @files.inject(Hash.new{|hash, key| hash[key] = Array.new;}) do |h, file|
+        basename          = File.basename(file, '.*')
+        without_variation = basename.split(@delimiter)[0..-2].join(@delimiter)
+        basename          = without_variation.nil? || without_variation == '' ? basename : without_variation
+        h[basename] << file
+        h
+      end
+    end
+
+    def horizontal_distribution
+      @files.inject(Hash.new{|hash, key| hash[key] = Array.new;}) do |h, file|
+        basename = File.basename(file)
+        h[basename] << file
+        h
+      end
+    end
+
+    def vertical_distribution
+      @files.inject(Hash.new{|hash, key| hash[key] = Array.new;}) do |h, file|
+        basename = File.basename(file)
+        h['__all__'] << file
+        h
+      end
+    end
+
+    # simplyfied version of active_support's camelize version
+    def camelize(lower_case_and_underscored_word)
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+require File.expand_path('../../lib/sprites', __FILE__)
+
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+

data/test/units/{test_sprite_batch_generator.rb → batch_test.rb}

@@ -1,10 +1,9 @@
-require 'test/unit'
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/sprite_batch_generator')
+require File.expand_path('../../test_helper', __FILE__)
 
-class SpriteBatchGeneratorTest < Test::Unit::TestCase
+class BatchTest < Test::Unit::TestCase
 
   def setup
-    @config = 'test/config/batch.yml'
+    @config = File.join(Sprites::Config.root, 'test', 'config', 'batch.yml')
   end
   
   def teardown
@@ -12,14 +11,14 @@ class SpriteBatchGeneratorTest < Test::Unit::TestCase
     Dir.glob('test/output/*').each{|f| File.delete f }
   end
   
-  def test_should_read_config_file
-    @batch = SpriteBatchGenerator.new(@config)
+  should "read config file" do
+    @batch = Sprites::Batch.new(@config)
     assert_not_nil @batch
     assert_equal 2, @batch.batches.size
   end
   
-  def test_should_create_files_from_config
-    @batch = SpriteBatchGenerator.new(@config)
+  should "create files from config" do
+    @batch = Sprites::Batch.new(@config)
     css = @batch.generate
     assert_not_nil css
     output_files = Dir.glob('test/output/*')

data/test/units/{test_sprite_generator.rb → generator_test.rb}

@@ -1,24 +1,20 @@
-require 'rubygems'
-require 'liquid'
-require 'test/unit'
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/sprite_generator')
+require File.expand_path('../../test_helper', __FILE__)
+
+class GeneratorTest < Test::Unit::TestCase
 
-class SpriteGeneratorTest < Test::Unit::TestCase
-  
   def setup
     @template = '.{{basename}}_{{variation}}{ background:transparent url({{sprite_location}}) -{{left}}px -{{top}}px no-repeat; width:{{width}}px; height:{{height}}px; }'
-    @all_images_path = 'test/images/*.png'
-    @output = 'test/output/sprite_by_create.png'
-    @page_path = 'test/output/test.html'
+    @all_images_path = File.join(Sprites::Config.root, 'test', 'images', '*.png')
+    @output = File.join(Sprites::Config.root, 'test', 'output', 'sprite_by_create.png')
+    @page_path = File.join(Sprites::Config.root, 'test', 'output', 'test.html')
   end
   
-  
   def teardown
     # delete test output
-    Dir.glob('test/output/*').each{|f| File.delete f }
+    Dir.glob(File.join(Sprites::Config.root, 'test', 'output', '*')).each{|f| File.delete f }
   end
 
-  def test_should_create_correct_sprite_for_tile_with_vertical_distribution
+  should "create correct sprite for tile with vertical distribution" do
     options = {
       :distribution => 'vertical',
       :tile         => '40x300',
@@ -26,7 +22,7 @@ class SpriteGeneratorTest < Test::Unit::TestCase
       :template     => "a.{{file_basename}} { padding-left:2em; background: transparent url(#{this_method}.png) -{{left}}px -{{top}}px no-repeat; }"
     }
     
-    generator = SpriteGenerator.new(@all_images_path, "test/output/#{this_method}.png", nil, options)
+    generator = Sprites::Generator.new(@all_images_path, "test/output/#{this_method}.png", nil, options)
     css = generator.create
     assert css.include?('-4500px')
     
@@ -36,28 +32,7 @@ class SpriteGeneratorTest < Test::Unit::TestCase
     assert File.exists?(output_file)
   end  
   
-  
-  def test_should_create_correct_sprite_for_tile_with_vertical_distribution
-    options = {
-      :distribution => 'vertical',
-      :tile         => '40x300',
-      :alignment    => 'north_west',
-      :template     => "a.{{file_basename}} { padding-left:2em; background: transparent url(#{this_method}.png) -{{left}}px -{{top}}px no-repeat; }"
-    }
-    
-    generator = SpriteGenerator.new(@all_images_path, "test/output/#{this_method}.png", nil, options)
-    css = generator.create
-    assert css.include?('-4500px')
-    
-    page = Liquid::Template.parse(File.open('test/templates/link.html').read).render('css' => css, 'image' => "#{this_method}.png")
-    output_file = File.join('test', 'output', "#{this_method}.html")
-    File.open(output_file, 'w+'){ |f| f.puts page }
-    assert File.exists?(output_file)
-  end
-  
-  
-  
-  def test_should_create_correct_sprite_for_tile_with_horizontal_distribution
+  should "create correct sprite for tile with horizontal distribution" do
     options = {
       :distribution => 'horizontal',
       :tile         => '400x50',
@@ -65,7 +40,7 @@ class SpriteGeneratorTest < Test::Unit::TestCase
       :template     => "a.{{file_basename}} { padding-left:2em; background: transparent url(#{this_method}.png) -{{left}}px -{{top}}px no-repeat; }"
     }
     
-    generator = SpriteGenerator.new(@all_images_path, "test/output/#{this_method}.png", nil, options)
+    generator = Sprites::Generator.new(@all_images_path, "test/output/#{this_method}.png", nil, options)
     css = generator.create
     assert css.include?('-6000px')
     
@@ -76,42 +51,42 @@ class SpriteGeneratorTest < Test::Unit::TestCase
   end
   
   
-  def test_should_user_horizontal_distribution
+  should "use horizontal distribution" do
     template = %q{ {{left}} }
-    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :distribution => 'horizontal' })
+    generator = Sprites::Generator.new(@all_images_path, @output, nil, { :template => template, :distribution => 'horizontal' })
     css = generator.create
     assert css.include?('240')
   end
   
-  def test_should_user_vertical_distribution
+  should "use vertical distribution" do
     template = %q{ {{top}} }
-    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :distribution => 'vertical' })
+    generator = Sprites::Generator.new(@all_images_path, @output, nil, { :template => template, :distribution => 'vertical' })
     css = generator.create
     assert css.include?('240')
   end
   
-  def test_should_set_correct_context_filebasename_for_images_without_variations
+  should "set correct context filebasename for images without variations" do
     template = %q{ {{file_basename}} }
-    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :delimiter => '_' })
+    generator = Sprites::Generator.new(@all_images_path, @output, nil, { :template => template, :delimiter => '_' })
     css = generator.create
     assert css.include?('emoticon-evilgrin')
   end
   
-  def test_should_set_correct_context_width_for_images_without_variations
+  should "set correct context width for images without variations" do
     template = %q{ {{width}} }
-    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :delimiter => '_' })
+    generator = Sprites::Generator.new(@all_images_path, @output, nil, { :template => template, :delimiter => '_' })
     css = generator.create
     assert css.include?('16')
   end
   
-  def test_should_set_correct_context_top_for_images_without_variations
+  should "set correct context top for images without variations" do
     template = %q{ {{top}} }
-    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :delimiter => '_' })
+    generator = Sprites::Generator.new(@all_images_path, @output, nil, { :template => template, :delimiter => '_' })
     css = generator.create
     assert !css.include?('-16')
   end
   
-  def test_should_create_correct_context
+  should "create correct context" do
     template = %q{
       basename: {{basename}}
       variation: {{variation}}
@@ -127,27 +102,27 @@ class SpriteGeneratorTest < Test::Unit::TestCase
       variation_number: {{variation_number}}
       variation_name: {{variation_name}}
     }
-    generator = SpriteGenerator.new(@all_images_path, @output, nil, {:template => template})
+    generator = Sprites::Generator.new(@all_images_path, @output, nil, {:template => template})
     css = generator.create
     assert css.include?('basename: emoticon-evilgrin')
     assert css.include?('variation_name: evilgrin')
     assert css.include?('file_basename: emoticon-evilgrin')
   end
   
-  def test_should_use_alignment_option
+  should "use alignment option" do
     assert_nothing_raised do
-      SpriteGenerator.new(@all_images_path, @output, nil, {:template => @template, :tile => '100x100', :background => '#FFFFFF', :alignment => 'west'})
+      Sprites::Generator.new(@all_images_path, @output, nil, {:template => @template, :tile => '100x100', :background => '#FFFFFF', :alignment => 'west'})
     end
   end
   
-  def test_should_complain_over_unknown_alignment_option
+  should "complain about unknown alignment option" do
     assert_raise NameError do
-      SpriteGenerator.new(@all_images_path, @output, nil, {:template => @template, :tile => '100x100', :background => '#FFFFFF', :alignment => 'somewhere'})
+      Sprites::Generator.new(@all_images_path, @output, nil, {:template => @template, :tile => '100x100', :background => '#FFFFFF', :alignment => 'somewhere'})
     end
   end
   
-  def test_should_center_images_on_tiles
-    @generator = SpriteGenerator.new(@all_images_path, @output, nil, {:template => @template, :tile => '100x100', :background => '#FFFFFF00'})
+  should "center images on tiles" do
+    @generator = Sprites::Generator.new(@all_images_path, @output, nil, {:template => @template, :tile => '100x100', :background => '#FFFFFF00'})
     css = @generator.create
     page = Liquid::Template.parse(File.open('test/templates/test.html').read).render('css' => css)
     assert page.include?("{ background:")
@@ -160,8 +135,8 @@ class SpriteGeneratorTest < Test::Unit::TestCase
   end
   
   
-  def test_should_create_correct_css
-    @generator = SpriteGenerator.new(@all_images_path, @output, nil, :template => @template)
+  should "create correct css" do
+    @generator = Sprites::Generator.new(@all_images_path, @output, nil, :template => @template)
     css = @generator.create()
     page = Liquid::Template.parse(File.open('test/templates/test.html').read).render('css' => css)
     assert page.include?("{ background:")
@@ -174,44 +149,44 @@ class SpriteGeneratorTest < Test::Unit::TestCase
   end
   
   
-  def test_should_generate_sprite_file
-    @generator = SpriteGenerator.new(@all_images_path, @output, nil, :template => @template)
+  should "generate sprite file" do
+    @generator = Sprites::Generator.new(@all_images_path, @output, nil, :template => @template)
     css = @generator.create
     assert !(css.nil? || css.empty?)
     assert File.exists?(@output)
   end
   
   # bad, testing internal state
-  def test_should_find_versions_of_emoticons
+  should "find versions of emoticons" do
     files = Dir.glob(@all_images_path)
-    @generator = SpriteGenerator.new(files, @output, nil, {})
+    @generator = Sprites::Generator.new(files, @output, nil, {})
     analyzed = @generator.instance_variable_get(:@analyzed)
     assert_equal 9, analyzed['emoticon'].size
   end
   
   # bad, using internal state
-  def test_should_find_files_for_glob_path
-    @generator = SpriteGenerator.new(@all_images_path, @output, nil, {})
+  should "find files for glob path" do
+    @generator = Sprites::Generator.new(@all_images_path, @output, nil, {})
     files = @generator.instance_variable_get(:@files)
     assert_equal 16, files.size
   end
   
   # bad, using internal state
-  def test_should_find_files
-    @generator = SpriteGenerator.new(['test/images/emoticon-evilgrin.png', 'test/images/emoticon-grin.png'], @output, nil, {})
+  should "find files" do
+    @generator = Sprites::Generator.new(['test/images/emoticon-evilgrin.png', 'test/images/emoticon-grin.png'], @output, nil, {})
     files = @generator.instance_variable_get(:@files)
     assert_equal 2, files.size
   end
   
   # bad, using internal state
-  def test_should_not_find_anything
-    @generator = SpriteGenerator.new('test/blalala/*.hurz', @output, nil, {})
+  should "not find anything" do
+    @generator = Sprites::Generator.new('test/blalala/*.hurz', @output, nil, {})
     files = @generator.instance_variable_get(:@files)
     assert_equal 0, files.size
   end
 
 protected
-
+  # output filename based on test name for inspection
   def this_method
     caller[0] =~ /`([^']*)'/ and $1
   end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sprite_generator
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marcel Scherf
@@ -9,30 +14,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 00:00:00 +01:00
+date: 2011-01-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: liquid
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rmagick
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: 
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: liquid
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+description: Automatically generate Sprite Images and the corresponding CSS.
 email: marcel.scherf@gmail.com
 executables: []
 
@@ -41,37 +91,46 @@ extensions: []
 extra_rdoc_files: 
 - README.txt
 files: 
-- lib/sprite_batch_generator.rb
-- lib/sprite_generator.rb
+- lib/sprites.rb
+- lib/sprites/batch.rb
+- lib/sprites/generator.rb
 - README.txt
+- test/test_helper.rb
+- test/units/batch_test.rb
+- test/units/generator_test.rb
 has_rdoc: true
 homepage: http://github.com/the-architect/spritegenerator
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Automatically generate Sprite Images and the corresponding CSS using RMagick and Liquid.
 test_files: 
-- test/units/test_sprite_batch_generator.rb
-- test/units/test_sprite_generator.rb
+- test/test_helper.rb
+- test/units/batch_test.rb
+- test/units/generator_test.rb

data/lib/sprite_batch_generator.rb

@@ -1,37 +0,0 @@
-require 'yaml'
-require 'ostruct'
-require 'pathname'
-require File.expand_path(File.dirname(__FILE__) + '/sprite_generator')
-
-class SpriteBatchGenerator
-  attr_reader :batches
-  
-  def initialize(filename)
-    config = YAML.load(File.read(filename))
-    @batches = config.inject([]) do |arr, pair|
-      if !!defined?(RAILS_ROOT)
-        pair.last.merge!(:config_root => RAILS_ROOT)
-      elsif pair.last[:root]
-        root = File.expand_path(pair.last[:root], file_name)
-        pair.last.merge!(:config_root => root)
-      end
-      arr.push OpenStruct.new(pair.last)
-      arr
-    end
-  end
-  
-  
-  def generate
-    @batches.each do |batch|
-      generator = SpriteGenerator.new(batch.files, batch.output, batch.config_root, batch.options || {})
-      css       = generator.create
-      # only write output if css_output is specified
-      unless css.nil? || css.empty? || batch.css_output.nil?
-        output = batch.css_template.nil? ? css : Liquid::Template.parse(File.open(batch.css_template).read).render('css' => css)
-        File.open(batch.css_output, 'w+'){|f| f.puts output }
-      end
-    end
-  end
-  
-  
-end

data/lib/sprite_generator.rb

@@ -1,264 +0,0 @@
-require 'rubygems'
-require 'RMagick'
-require 'liquid'
-
-class SpriteGenerator
-  VERSION = '0.1.10'
-  
-  include Magick
-    
-  # parameters:
-  # files_or_path: can be Dir.glob-able paths or an array of filenames 
-  #   ie: ['../images/icons/icon1_out.png', '../images/icons/icon1_over.png'] or '../images/icons/icon*.png' 
-  # output: filename where the generated sprite will be stored
-  #   ie: '../images/sprites/icons.png'
-  # options: set a variety of options
-  #   - delimiter: characters by which multiple variations of images will be found
-  #     ie: '_' for 'icon_hover.png'
-  #     ie: '-' for 'icon-hover.png'
-  #         if icon is the basename
-  #   - align: 
-  #   - sprite_location: will be available as variable in the liquid template, if this is not set, the template will use output as sprite_location
-  #   - tile: if set to ie. '100x100' it will center every image on a 100 by 100 tile
-  #   - template: Liquid template for each sprite, use this to build the css for your sprites
-  #             these variables are available:
-  #             - top: distance to top border of sprite in pixels 
-  #             - left: distance to left border of sprite in pixels 
-  #             - width: width of current image in pixels 
-  #             - height: height of current image in pixels 
-  #             - basename: filename or basename of variations
-  #               ie: with variations: icon_out.png, icon_over.png  => icon
-  #               ie: without variations: icon.png => icon.png
-  #             - file_basename: always the name of the current image without extension
-  #               ie: icon_over
-  #             - filename: icon_over.png
-  #             - full_filename: ../images/icons/icon_over.ong
-  #             - variations: number of variations as number
-  #             - variation: the current variation as zero based number
-  #             - sprite_location: path to sprite
-  def initialize(files_or_paths, output, root, options = {})
-    @files = find_files(files_or_paths)
-    return if @files.nil? || @files.empty?
-    @root             = root || ''
-    @output           = output
-    @delimiter        = options[:delimiter] || '-'
-    @distribution     = (options[:distribution] || :smart).to_sym
-    @analyzed         = find_files_for_mode
-    @template         = Liquid::Template.parse(options[:template] || '')
-    @sprite_location  = options[:sprite_location] || @output
-    @background       = options[:background] || '#FFFFFF00'
-    @tile_size        = options[:tile]
-    @alignment        = options[:alignment] ? Magick.const_get("#{camelize(options[:alignment])}Gravity") : Magick::CenterGravity
-  end
-  
-  
-  def create
-    raise 'No files found.' if @files.nil? || @files.empty?
-    build_tile
-    destination = @root.nil? || @root.empty? ? @output : File.join(@root, @output)
-    image, css  = build_sprite_and_css
-    background  = @background
-    image.write(destination){ self.background_color = background }
-    css
-  end
-  
-protected
-  
-  def build_sprite_and_css
-    background  = @background
-    @images     = ImageList.new{ self.background_color = background }
-    context     = { 'sprite_location' => @sprite_location }
-    @css        = []
-    
-    @analyzed.keys.sort.each do |key|
-      value = @analyzed[key]
-      
-      context['top']      = 0
-      context['basename'] = key
-      context['overall']  = @images.length
-      if value.size > 1
-        context = build_image_list(context, value.sort)
-      else
-        context = build_single_image(context, value.flatten.first)
-      end
-      @css << build_css(context)
-    end
-    [@images.append(false), @css.join("\n")]
-  end
-  
-  
-  def build_single_image(context, filename)
-    background  = @background
-    image       = Image.read(filename){ self.background_color = background }.flatten.first
-    
-    context.merge!(build_context_for_single_image(image, filename, context['basename']))
-    if @tile
-      @images.from_blob(@tile.composite(image, @alignment, Magick::OverCompositeOp).to_blob){ self.background_color = background }
-    else
-      @images.from_blob(image.to_blob){ self.background_color = background }
-    end
-    context
-  end
-  
-  
-  def build_context_for_single_image(image, filename, basename)
-    file_basename = File.basename(filename, '.*')
-    {
-      'variations'       => 0,
-      'variation_number' => 0,
-      'full_filename'    => filename,
-      'file_basename'    => file_basename,
-      'variation_name'   => file_basename.gsub("#{basename}#{@delimiter}", ''),
-      'width'            => @tile ? @tile.columns : image.columns,
-      'height'           => @tile ? @tile.rows    : image.rows,
-      'type'             => :image,
-      'left'             => left_value_for_context
-    }
-  end
-  
-  
-  def left_value_for_context
-    @tile ? (@images.length * @tile.columns) : (@images.any? ? @images.append(false).columns : 0)
-  end
-  
-  
-  def build_image_list(context, image_filenames)
-    background  = @background
-    image_list = ImageList.new(*image_filenames){ self.background_color = background }
-    context.merge!(build_context_for_image_list(image_list, image_filenames))
-    if @tile
-      tiles = ImageList.new{ self.background_color = background }
-      image_list.each do |image|
-        tiles << @tile.composite(image, @alignment, Magick::OverCompositeOp)
-      end
-      append_to_sprite(tiles)
-    else
-      append_to_sprite(image_list)
-    end
-    context
-  end
-  
-  
-  def append_to_sprite(images)
-    background  = @background
-    @images.from_blob(images.append(true).to_blob){ self.background_color = background }
-  end
-  
-  
-  def build_context_for_image_list(image_list, image_filenames)
-    {
-      'variations' => image_list.length,
-      'type'       => :list,
-      'images'     => image_list,
-      'filenames'  => image_filenames,
-      'left'        => left_value_for_context
-    }
-  end
-  
-  
-  def build_tile
-    return if @tile_size.nil?
-    background = @background
-    size_x, size_y = @tile_size.split('x').first(2).map{|dim| dim.to_i}
-    @tile = Magick::Image.new(size_x, size_y){ self.background_color = background }
-    @tile.format = "PNG"
-  end
-  
-  
-  def build_css(context = {})
-    type = context['type']
-    case type
-    when :list
-      css = build_css_for_list(context)
-    when :image
-      # render template if there is only one image
-      css = @template.render(context)
-    end
-    css
-  end
-  
-  
-  def build_css_for_list(context)
-    new_context = context.dup
-    image_list  = context.delete('images')
-    new_context['type'] = :image
-    css = image_list.inject([]) do |css, image|
-      new_context['width']            = @tile ? @tile.columns : image.columns
-      new_context['height']           = @tile ? @tile.rows : image.rows
-      new_context['variation_number'] = css.size
-      new_context['full_filename']    = context['filenames'].shift
-      new_context['filename']         = File.basename(new_context['full_filename'])
-      new_context['file_basename']    = File.basename(new_context['full_filename'], '.*')
-      new_context['variation_name']   = new_context['file_basename'].gsub(/^#{new_context['basename']}#{@delimiter}/, '')
-      css << build_css(new_context.dup)
-
-      new_context['top'] += @tile ? @tile.rows : new_context['height']
-      css
-    end.join("\n")
-  end
-  
-  
-  # gather files that will be used to create the sprite
-  def find_files(*args)
-    args.inject([]) do |files, arg|
-      found_files = Dir.glob(arg)
-      if found_files.empty?
-        files << arg if File.exists?(arg) rescue raise arg.inspect
-      else
-        files << found_files.flatten
-      end
-      files.flatten.compact.uniq
-    end
-  end
-  
-  
-  # put filenames in format for each mode
-  def find_files_for_mode
-    case @distribution
-    when :smart
-      smart_distribution
-    when :horizontal
-      horizontal_distribution
-    when :vertical
-      vertical_distribution
-    end
-  end
-  
-  
-  # gather information about the selected files
-  # check for variations by using a delimiter as an indicator
-  def smart_distribution
-    @files.inject(Hash.new{|hash, key| hash[key] = Array.new;}) do |h, file|
-      basename          = File.basename(file, '.*')
-      without_variation = basename.split(@delimiter)[0..-2].join(@delimiter)
-      basename          = without_variation.nil? || without_variation == '' ? basename : without_variation
-      h[basename] << file
-      h
-    end
-  end
-  
-  
-  def horizontal_distribution
-    @files.inject(Hash.new{|hash, key| hash[key] = Array.new;}) do |h, file|
-      basename = File.basename(file)
-      h[basename] << file
-      h
-    end
-  end
-  
-  
-  def vertical_distribution
-    @files.inject(Hash.new{|hash, key| hash[key] = Array.new;}) do |h, file|
-      basename = File.basename(file)
-      h['__all__'] << file
-      h
-    end
-  end
-  
-  
-  # simplyfied version of active_support's camelize version
-  def camelize(lower_case_and_underscored_word)
-    lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-  end
-  
-end