the-architect-sprite_generator 0.1.12 → 0.2.0

data/lib/sprite_generator.rb

@@ -39,29 +39,24 @@ class SpriteGenerator
   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] || '-'
-    @analyzed   = analyze_filenames(@files, @delimiter)
-    @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
+    @root             = root || ''
+    @output           = output
+    @delimiter        = options[:delimiter] || '-'
+    @analyzed         = find_files_for_mode(options[:distribution] || :smart)
+    @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?
-    background = @background
-    unless @tile_size.nil?
-      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
+    build_tile
     destination = @root.nil? || @root.empty? ? @output : File.join(@root, @output)
-    image, css = build(tile)
+    image, css  = build_sprite_and_css
+    background  = @background
     image.write(destination){ self.background_color = background }
     css
   end
@@ -69,66 +64,99 @@ class SpriteGenerator
   
 protected
   
-  # simplyfied version of active_supports camelize version
-  def camelize(lower_case_and_underscored_word)
-    lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-  end
-  
-  def build(tile = nil)
-    background = @background
-    images = ImageList.new{ self.background_color = background }
-    context = { 'sprite_location' => @sprite_location, 'tile' => tile }
-    css = []
+  def build_sprite_and_css
+    background  = @background
+    @images     = ImageList.new{ self.background_color = background }
+    context     = { 'sprite_location' => @sprite_location }
+    @css        = []
     
-    @analyzed.each do |key, value|
-      if tile
-        context['left'] = images.length > 0 ? tile.columns : 0
+    @analyzed.keys.sort.each do |key|
+      value = @analyzed[key]
+      if @tile
+        context['left'] = @images.length > 0 ? @tile.columns : 0
       else
-        context['left'] = images.length > 0 ? images.append(false).columns : 0
+        context['left'] = @images.length > 0 ? @images.append(false).columns : 0
       end
-      context['top'] = 0
+      context['top']      = 0
       context['basename'] = key
-      context['overall'] = images.length
+      context['overall']  = @images.length
       
-      if value.size > 1
-        image_list = ImageList.new(*value){ self.background_color = background }
-        if tile
-          tiles = ImageList.new{ self.background_color = background }
-          image_list.each do |image|
-            tiles << tile.composite(image, @alignment, Magick::OverCompositeOp)
-          end
-          images.from_blob(tiles.append(true).to_blob){ self.background_color = background }
-        else
-          images.from_blob(image_list.append(true).to_blob){ self.background_color = background }
-        end
-        context['variations'] = image_list.length
-        context['type'] = :list
-        context['images'] = image_list
-        context['filenames'] = value
-      else
-        
-        filename = value.flatten.first
-        image = Image.read(filename){ self.background_color = background }
-        
-        context['variations'] = 0
-        context['variation_name'] = ''
-        context['variation_number'] = 0
-        context['full_filename'] = filename
-        context['file_basename'] = File.basename(filename, '.*')
-        context['variation_name'] = context['file_basename'].gsub(/^#{context['basename']}#{@delimiter}/, '')
-        
-        context['type'] = :image
-        
-        if tile
-          images.from_blob(tile.composite(image.first, @alignment, Magick::OverCompositeOp).to_blob){ self.background_color = background }
-        else
-          images.from_blob(image.first.to_blob){ self.background_color = background }
-        end
-      end
-      css << build_css(context)
+      value.size > 1 ? build_image_list(context, value.sort) : build_single_image(context, value.flatten.first)
+      @css << build_css(context)
     end
     
-    [images.append(false), css.join("\n")]
+    [@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
+  end
+  
+  
+  def build_context_for_single_image(image, filename, basename)
+    file_basename = File.basename(filename, '.*')
+    {
+      'variations'       => 0,
+      'variation_name'   => '',
+      '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
+    }
+  end
+  
+  
+  def build_image_list(context, image_filenames)
+    background  = @background
+    image_list = ImageList.new(*image_filenames){ self.background_color = background }
+    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.merge!(build_context_for_image_list(image_list, image_filenames))
+  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
+    }
+  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
   
   
@@ -147,21 +175,19 @@ protected
   
   def build_css_for_list(context)
     new_context = context.dup
-    tile = new_context.delete('tile')
-    image_list = context.delete('images')
+    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['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}/, '')
+      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.columns : new_context['height']
+      new_context['top'] += @tile ? @tile.columns : new_context['height']
       css
     end.join("\n")
   end
@@ -181,17 +207,53 @@ protected
   end
   
   
+  # put filenames in format for each mode
+  def find_files_for_mode(mode)
+    case mode
+    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 analyze_filenames(file_names, delimiter = '_')
-    file_names.inject(Hash.new{|hash, key| hash[key] = Array.new;}) do |h, file|
-      basename = File.basename(file).split('.').first
-      without_variation = basename.split(delimiter)[0..-2].join(delimiter)
-      basename = without_variation.nil? || without_variation == '' ? basename : without_variation
+  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

data/test/units/test_sprite_generator.rb

@@ -18,13 +18,42 @@ class SpriteGeneratorTest < Test::Unit::TestCase
     Dir.glob('test/output/*').each{|f| File.delete f }
   end
   
-  def test_should_set_correct_context_for_images_without_variations
+  def test_should_user_horizontal_distribution
+    template = %q{ {{left}} }
+    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :distribution => :horizontal })
+    css = generator.create
+    assert css.include?('240')
+  end
+  
+  def test_should_user_vertical_distribution
+    template = %q{ {{top}} }
+    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :distribution => :vertical })
+    css = generator.create
+    `open #{@output}`
+    sleep 1
+    assert css.include?('240')
+  end
+  
+  def test_should_set_correct_context_filebasename_for_images_without_variations
     template = %q{ {{file_basename}} }
     generator = SpriteGenerator.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
+    template = %q{ {{width}} }
+    generator = SpriteGenerator.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
+    template = %q{ {{top}} }
+    generator = SpriteGenerator.new(@all_images_path, @output, nil, { :template => template, :delimiter => '_' })
+    css = generator.create
+    assert !css.include?('-16')
+  end
   
   def test_should_create_correct_context
     template = %q{

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: the-architect-sprite_generator
 version: !ruby/object:Gem::Version 
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors: 
 - Marcel Scherf