sprite-factory-custom 1.6.0

data/test/library_test.rb

@@ -0,0 +1,58 @@
+require File.expand_path('test_case', File.dirname(__FILE__))
+
+class SpriteFactory::LibraryTest < SpriteFactory::TestCase
+
+  #--------------------------------------------------------------------------
+
+  LIBRARIES = {
+    :rmagick      => SpriteFactory::Library::RMagick,
+    :chunkypng    => SpriteFactory::Library::ChunkyPng,
+    :image_magick => SpriteFactory::Library::ImageMagick
+  }
+
+  #--------------------------------------------------------------------------
+
+  LIBRARIES.each do |name, library| # use metaprogramming to define independent tests for each library
+
+    define_method "test_load_regular_using_#{name}" do
+      assert_images(REGULAR_INFO, library.load(REGULAR))
+    end
+
+    define_method "test_load_irregular_using_#{name}" do
+      assert_images(IRREGULAR_INFO,  library.load(IRREGULAR))
+    end
+
+    define_method "test_create_using_#{name}" do
+      with_clean_output do
+        images = library.load(REGULAR)
+        x = 0
+        images.each do |image|
+          image[:x] = x
+          image[:y] = 0
+          x = x + image[:width]
+        end
+        width  = images.map{|i| i[:width]}.inject(0){|n,w| n = n + w }
+        height = images.map{|i| i[:height]}.max
+        library.create(output_path('regular.horizontal.png'), images, width, height)
+        assert_reference_image('regular.horizontal.png')
+      end
+    end
+
+  end
+
+  #--------------------------------------------------------------------------
+
+  private
+
+  def assert_images(expected, actual, msg = nil)
+    assert_equal(expected.length, actual.length, "#{msg} - expected the same number of images")
+    expected.length.times do |n|
+      assert_equal(expected[n][:filename], actual[n][:filename], "#{msg} - unexpected filename at index #{n}")
+      assert_equal(expected[n][:width],    actual[n][:width],    "#{msg} - unexpected width at index #{n}")
+      assert_equal(expected[n][:height],   actual[n][:height],   "#{msg} - unexpected height at index #{n}")
+    end
+  end
+
+  #----------------------------------------------------------------------------
+
+end

data/test/runner_test.rb

@@ -0,0 +1,229 @@
+require File.expand_path('test_case', File.dirname(__FILE__))
+
+module SpriteFactory
+  class RunnerTest < SpriteFactory::TestCase
+
+    #----------------------------------------------------------------------------
+
+    def test_defaults
+
+      Runner.publicize_methods do
+
+        r = Runner.new(REGULAR_PATH) 
+        assert_equal(REGULAR_PATH,            r.input)
+        assert_equal(REGULAR_PATH,            r.output)
+        assert_equal(REGULAR_PATH + ".png",   r.output_image_file)
+        assert_equal(REGULAR_PATH + ".css",   r.output_style_file)
+        assert_equal(REGULAR,                 r.image_files)
+        assert_equal(:horizontal,             r.layout_name)
+        assert_equal(:css,                    r.style_name)
+        assert_equal(:rmagick,                r.library_name)
+
+        r = Runner.new(IRREGULAR_PATH)
+        assert_equal(IRREGULAR_PATH,          r.input)
+        assert_equal(IRREGULAR_PATH,          r.output)
+        assert_equal(IRREGULAR_PATH + ".png", r.output_image_file)
+        assert_equal(IRREGULAR_PATH + ".css", r.output_style_file)
+        assert_equal(IRREGULAR,               r.image_files)
+        assert_equal(:horizontal,             r.layout_name)
+        assert_equal(:css,                    r.style_name)
+        assert_equal(:rmagick,                r.library_name)
+
+        r = Runner.new(REGULAR_PATH, :output => IRREGULAR_PATH)
+        assert_equal(REGULAR_PATH,            r.input)
+        assert_equal(IRREGULAR_PATH,          r.output)
+        assert_equal(IRREGULAR_PATH + ".png", r.output_image_file)
+        assert_equal(IRREGULAR_PATH + ".css", r.output_style_file)
+        assert_equal(REGULAR,                 r.image_files)
+        assert_equal(:horizontal,             r.layout_name)
+        assert_equal(:css,                    r.style_name)
+        assert_equal(:rmagick,                r.library_name)
+
+        r = Runner.new(REGULAR_PATH, :output_image => "foo.png", :output_style => "bar.css.sass.erb")
+        assert_equal(REGULAR_PATH,            r.input)
+        assert_equal(REGULAR_PATH,            r.output)
+        assert_equal("foo.png",               r.output_image_file)
+        assert_equal("bar.css.sass.erb",      r.output_style_file)
+        assert_equal(REGULAR,                 r.image_files)
+        assert_equal(:horizontal,             r.layout_name)
+        assert_equal(:css,                    r.style_name)
+        assert_equal(:rmagick,                r.library_name)
+
+        r = Runner.new(REGULAR_PATH, :layout => :vertical, :library => :chunkypng, :style => :sass)
+        assert_equal(REGULAR_PATH,            r.input)
+        assert_equal(REGULAR_PATH,            r.output)
+        assert_equal(REGULAR_PATH + ".png",   r.output_image_file)
+        assert_equal(REGULAR_PATH + ".sass",  r.output_style_file)
+        assert_equal(REGULAR,                 r.image_files)
+        assert_equal(:vertical,               r.layout_name)
+        assert_equal(:sass,                   r.style_name)
+        assert_equal(:chunkypng,              r.library_name)
+
+      end
+    
+    end
+
+    #----------------------------------------------------------------------------
+
+    def test_default_padding
+      Runner.publicize_methods do
+        r = Runner.new(REGULAR_PATH)
+        assert_equal(0, r.hpadding)
+        assert_equal(0, r.vpadding)
+
+        r = Runner.new(REGULAR_PATH, :padding => 10)
+        assert_equal(10, r.hpadding)
+        assert_equal(10, r.vpadding)
+
+        r = Runner.new(REGULAR_PATH, :hpadding => 10, :vpadding => 20)
+        assert_equal(10, r.hpadding)
+        assert_equal(20, r.vpadding)
+      end
+    end
+
+    def test_default_margin
+      Runner.publicize_methods do
+        r = Runner.new(REGULAR_PATH)
+        assert_equal(0, r.hmargin)
+        assert_equal(0, r.vmargin)
+
+        r = Runner.new(REGULAR_PATH, :margin => 10)
+        assert_equal(10, r.hmargin)
+        assert_equal(10, r.vmargin)
+
+        r = Runner.new(REGULAR_PATH, :hmargin => 10, :vmargin => 20)
+        assert_equal(10, r.hmargin)
+        assert_equal(20, r.vmargin)
+      end
+    end
+
+    #----------------------------------------------------------------------------
+
+    def test_default_css_url
+      Runner.publicize_methods do
+        r1 = Runner.new(REGULAR_PATH)
+        r2 = Runner.new(REGULAR_PATH, :cssurl => "http://s3.amazonaws.com/sf")
+        r3 = Runner.new(REGULAR_PATH, :cssurl => "foo(<%= image_path('$IMAGE') %>)")
+        r4 = Runner.new(REGULAR_PATH, :cssurl => lambda{|image| "foo(/very/dynamic/path/#{image})" })
+
+        assert_equal("url(regular.png)",                            r1.css_url, "by default, css_url should be basename of the generated sprite image")
+        assert_equal("url(http://s3.amazonaws.com/sf/regular.png)", r2.css_url, "allow customization by prepending to basename of the generated sprite image")
+        assert_equal("foo(<%= image_path('regular.png') %>)",       r3.css_url, "allow customization by providing custom format string with $IMAGE token to be replaced with basename of the generated sprite image")
+        assert_equal("foo(/very/dynamic/path/regular.png)",         r4.css_url, "allow customization by lambda function - allow caller to decide how to generate css url to sprite image")
+      end
+    end
+
+    #----------------------------------------------------------------------------
+
+    def test_trailing_slash_on_input_is_ignored
+      Runner.publicize_methods do
+        r = Runner.new("#{REGULAR_PATH}/")
+        assert_equal(REGULAR_PATH,          r.input)
+        assert_equal(REGULAR_PATH,          r.output)
+        assert_equal(REGULAR_PATH + ".png", r.output_image_file)
+        assert_equal(REGULAR_PATH + ".css", r.output_style_file)
+        assert_equal(REGULAR,               r.image_files)
+      end
+    end
+
+    #----------------------------------------------------------------------------
+
+    def test_invalid_config
+
+      assert_runtime_error "input must be a single directory" do
+        SpriteFactory.run!("")
+      end
+
+      assert_runtime_error "input must be a single directory" do
+        SpriteFactory.run!(REGULAR.first)
+      end
+
+      assert_runtime_error "no output file specified" do
+        SpriteFactory.run!(REGULAR_PATH, :output => "")
+      end
+
+      assert_runtime_error "no image files found" do
+        SpriteFactory.run!(EMPTY_PATH)
+      end
+
+      assert_runtime_error "unknown layout diagonal" do
+        SpriteFactory.run!(REGULAR_PATH, :layout => :diagonal)
+      end
+
+      assert_runtime_error "unknown style funky" do
+        SpriteFactory.run!(REGULAR_PATH, :style => :funky)
+      end
+
+      assert_runtime_error "unknown library hogwarts" do
+        SpriteFactory.run!(REGULAR_PATH, :library => :hogwarts)
+      end
+
+      assert_runtime_error "set :width for fixed width, or :hpadding for horizontal padding, but not both." do
+        SpriteFactory.run!(REGULAR_PATH, :width => 50, :padding => 10)
+      end
+
+      assert_runtime_error "set :height for fixed height, or :vpadding for vertical padding, but not both." do
+        SpriteFactory.run!(REGULAR_PATH, :height => 50, :padding => 10)
+      end
+
+      assert_runtime_error "set :width for fixed width, or :hmargin for horizontal margin, but not both." do
+        SpriteFactory.run!(REGULAR_PATH, :width => 50, :margin => 10)
+      end
+
+      assert_runtime_error "set :height for fixed height, or :vmargin for vertical margin, but not both." do
+        SpriteFactory.run!(REGULAR_PATH, :height => 50, :margin => 10)
+      end
+
+      assert_runtime_error "image regular1 does not fit within a fixed width of 10" do
+        SpriteFactory.run!(REGULAR_PATH, :width => 10)
+      end
+
+      assert_runtime_error "image regular1 does not fit within a fixed height of 10" do
+        SpriteFactory.run!(REGULAR_PATH, :height => 10)
+      end
+
+    end
+
+    #----------------------------------------------------------------------------
+
+    def test_images_are_sorted_in_classname_order
+      Runner.publicize_methods do
+        expected = [
+          "alice",
+          "codeincomplete",
+          "github",
+          "monkey",
+          "spies",
+          "stackoverflow",
+          "thief"
+        ]
+        actual = Runner.new(FORMATS_PATH).load_images.map{|i| i[:name]}
+        assert_equal(expected, actual)
+      end
+    end
+
+    def test_images_are_secondary_sorted_on_psuedoclass
+      Runner.publicize_methods do
+        expected = [
+          "div.bar img.icon",
+          "div.bar img.icon:link",
+          "div.bar img.icon:visited",
+          "div.bar img.icon:focus",
+          "div.bar img.icon:hover",
+          "div.bar img.icon:active",
+          "div.foo img.icon",
+          "div.foo img.icon:link",
+          "div.foo img.icon:visited",
+          "div.foo img.icon:focus",
+          "div.foo img.icon:hover",
+          "div.foo img.icon:active",
+        ]
+        actual = Runner.new(HOVER_PATH).load_images.map{|i| i[:name]}
+        assert_equal(expected, actual)
+      end
+    end
+
+    #----------------------------------------------------------------------------
+
+  end
+end

data/test/style_test.rb

@@ -0,0 +1,72 @@
+require File.expand_path('test_case', File.dirname(__FILE__))
+
+module SpriteFactory
+  class StyleTest < SpriteFactory::TestCase
+
+    TEST_ATTRIBUTES = [
+      "width: 30px",
+      "height: 40px",
+      "background: url(path/to/image.png) -10px -20px no-repeat"
+    ]
+
+    #--------------------------------------------------------------------------
+
+    def test_css
+      expected = "img.foo { width: 30px; height: 40px; background: url(path/to/image.png) -10px -20px no-repeat; }"
+      actual   = Style.css("img.", "foo", TEST_ATTRIBUTES)
+      assert_equal(expected, actual)
+    end
+
+    #--------------------------------------------------------------------------
+
+    def test_scss
+      expected = "img.foo { width: 30px; height: 40px; background: url(path/to/image.png) -10px -20px no-repeat; }"
+      actual   = Style.scss("img.", "foo", TEST_ATTRIBUTES)
+      assert_equal(expected, actual)
+    end
+
+    #--------------------------------------------------------------------------
+
+    def test_sass
+      expected = "img.foo\n  width: 30px\n  height: 40px\n  background: url(path/to/image.png) -10px -20px no-repeat\n"
+      actual   = Style.sass("img.", "foo", TEST_ATTRIBUTES)
+      assert_equal(expected, actual)
+    end
+
+    #--------------------------------------------------------------------------
+
+    def test_generate
+
+      style    = :css
+      selector = 'img.'
+      url      = 'url(/path/to/sprite.png)'
+      images   = [
+        {:filename => '/path/to/sprite1.png', :name => 'sprite1', :cssx => 1, :cssy => 10, :cssw => 100, :cssh => 1000},
+        {:filename => '/path/to/sprite2.png', :name => 'sprite2', :cssx => 2, :cssy => 20, :cssw => 200, :cssh => 2000},
+        {:filename => '/path/to/sprite3.png', :name => 'sprite3', :cssx => 3, :cssy => 30, :cssw => 300, :cssh => 3000},
+        {:filename => '/path/to/sprite4.png', :name => 'sprite4', :cssx => 4, :cssy => 40, :cssw => 400, :cssh => 4000},
+        {:filename => '/path/to/sprite5.png', :name => 'sprite5', :cssx => 5, :cssy => 50, :cssw => 500, :cssh => 5000}
+      ]
+
+      lines = Style.generate(style, selector, url, images).split("\n")
+
+      assert_equal("width: 100px; height: 1000px; background: url(/path/to/sprite.png) -1px -10px no-repeat", images[0][:style], "pure style should have been stashed away in image[:style] for use by custom rule builders")
+      assert_equal("width: 200px; height: 2000px; background: url(/path/to/sprite.png) -2px -20px no-repeat", images[1][:style], "pure style should have been stashed away in image[:style] for use by custom rule builders")
+      assert_equal("width: 300px; height: 3000px; background: url(/path/to/sprite.png) -3px -30px no-repeat", images[2][:style], "pure style should have been stashed away in image[:style] for use by custom rule builders")
+      assert_equal("width: 400px; height: 4000px; background: url(/path/to/sprite.png) -4px -40px no-repeat", images[3][:style], "pure style should have been stashed away in image[:style] for use by custom rule builders")
+      assert_equal("width: 500px; height: 5000px; background: url(/path/to/sprite.png) -5px -50px no-repeat", images[4][:style], "pure style should have been stashed away in image[:style] for use by custom rule builders")
+
+      assert_equal("img.sprite1 { #{images[0][:style]}; }", lines[0], "appropriate rule should have been generated using the pure style stashed away in image[:style]")
+      assert_equal("img.sprite2 { #{images[1][:style]}; }", lines[1], "appropriate rule should have been generated using the pure style stashed away in image[:style]")
+      assert_equal("img.sprite3 { #{images[2][:style]}; }", lines[2], "appropriate rule should have been generated using the pure style stashed away in image[:style]")
+      assert_equal("img.sprite4 { #{images[3][:style]}; }", lines[3], "appropriate rule should have been generated using the pure style stashed away in image[:style]")
+      assert_equal("img.sprite5 { #{images[4][:style]}; }", lines[4], "appropriate rule should have been generated using the pure style stashed away in image[:style]")
+
+    end
+
+    #--------------------------------------------------------------------------
+
+  end
+end
+
+

data/test/test_case.rb

@@ -0,0 +1,138 @@
+require File.expand_path('../lib/sprite_factory', File.dirname(__FILE__))
+require 'test/unit'
+
+module SpriteFactory
+  class TestCase < Test::Unit::TestCase
+
+    #----------------------------------------------------------------------------
+
+    IMAGES_PATH    = 'test/images'
+
+    REFERENCE_PATH  = 'test/images/reference'
+    REGULAR_PATH    = 'test/images/regular'
+    IRREGULAR_PATH  = 'test/images/irregular'
+    CUSTOM_PATH     = 'test/images/custom'
+    FORMATS_PATH    = 'test/images/formats'
+    EMPTY_PATH      = 'test/images/empty'
+    SUBFOLDERS_PATH = 'test/images/subfolders'
+    HOVER_PATH      = 'test/images/hover'
+
+    REGULAR   = SpriteFactory.find_files(File.join(REGULAR_PATH,   '*.png'))
+    IRREGULAR = SpriteFactory.find_files(File.join(IRREGULAR_PATH, '*.png'))
+
+    REGULAR_INFO = [
+      { :filename => REGULAR[0], :width => 64, :height => 64 },
+      { :filename => REGULAR[1], :width => 64, :height => 64 },
+      { :filename => REGULAR[2], :width => 64, :height => 64 },
+      { :filename => REGULAR[3], :width => 64, :height => 64 },
+      { :filename => REGULAR[4], :width => 64, :height => 64 }
+    ]
+
+    IRREGULAR_INFO = [
+      { :filename => IRREGULAR[0], :width => 60, :height => 60 },
+      { :filename => IRREGULAR[1], :width => 16, :height => 16 },
+      { :filename => IRREGULAR[2], :width => 48, :height => 48 },
+      { :filename => IRREGULAR[3], :width => 34, :height => 14 },
+      { :filename => IRREGULAR[4], :width => 46, :height => 25 }
+    ]
+
+    def output_path(name)
+      File.join(IMAGES_PATH, name)
+    end
+
+    def reference_path(name)
+      File.join(REFERENCE_PATH, name)
+    end
+
+    #----------------------------------------------------------------------------
+
+    def integration_test(input, options = {}, &block)
+      output = options[:output] || input
+      with_clean_output do 
+        SpriteFactory.run!(input, options, &block)
+        assert_reference_image(File.basename(output) + "." + (                   :png).to_s)
+        assert_reference_style(File.basename(output) + "." + (options[:style] || :css).to_s)
+      end
+    end
+
+    #----------------------------------------------------------------------------
+
+    def with_clean_output
+      begin
+        clean_output
+        yield
+      ensure
+        clean_output
+      end
+    end
+
+    def clean_output
+      SpriteFactory.find_files(File.join(IMAGES_PATH, "*.png"),
+                               File.join(IMAGES_PATH, "*.css"),
+                               File.join(IMAGES_PATH, "*.sass"),
+                               File.join(IMAGES_PATH, "*.scss")).each do |f|
+        File.delete(f)
+      end
+    end
+
+    #----------------------------------------------------------------------------
+
+    def assert_runtime_error(msg = nil)
+      e = assert_raise RuntimeError do
+        yield
+      end
+      assert_match(msg, e.message) if msg
+    end
+
+    def assert_not_implemented(msg = nil)
+      e = assert_raise NotImplementedError do
+        yield
+      end
+      assert_match(msg, e.message) if msg
+    end
+
+    #----------------------------------------------------------------------------
+
+    def assert_reference_image(name)
+      #
+      # images generated with different libraries (or different versions of same library)
+      # might have different headers, so use rmagick to actually compare image bytes
+      #
+      actual         = output_path(name)
+      expected       = reference_path(name)
+      actual_image   = Magick::Image.read(actual)[0]
+      expected_image = Magick::Image.read(expected)[0]
+      img, val       = expected_image.compare_channel(actual_image, Magick::MeanAbsoluteErrorMetric)
+      assert_equal(0.0, val, "generated image does not match pregenerated reference:\n actual:   #{actual}\n expected: #{expected}")
+    end
+
+    def assert_reference_style(name)
+      actual   = output_path(name)
+      expected = reference_path(name)
+      diff = `cmp #{expected} #{actual}`
+      assert(diff.empty?, "generated styles do not match pregenerated reference:\n#{diff}")
+    end
+
+    #----------------------------------------------------------------------------
+
+  end # class TestCase
+end # module SpriteFactory
+
+
+#==============================================================================
+
+class Class
+
+  # allow tests to call private methods without ugly #send syntax
+  def publicize_methods
+    methods = private_instance_methods
+    send(:public, *methods)
+    yield
+    send(:private, *methods) 
+  end
+
+end
+
+#==============================================================================
+
+