sprite-factory 1.0.0

data/test/style_test.rb

@@ -0,0 +1,64 @@
+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_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.'
+      path     = '/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, path, 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,127 @@
+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'
+
+    REGULAR   = Dir[File.join(REGULAR_PATH,   '*.png')].sort
+    IRREGULAR = Dir[File.join(IRREGULAR_PATH, '*.png')].sort
+
+    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
+      Dir[File.join(IMAGES_PATH, "*.png"),
+          File.join(IMAGES_PATH, "*.css"),
+          File.join(IMAGES_PATH, "*.sass"),
+          File.join(IMAGES_PATH, "*.scss")].each {|f| File.delete(f)}
+    end
+
+    #----------------------------------------------------------------------------
+
+    def assert_runtime_error(msg = nil)
+      e = assert_raise RuntimeError 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
+
+#==============================================================================
+
+

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification 
+name: sprite-factory
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jake Gordon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: chunky_png
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Combines individual images from a directory into a single sprite image file and creates an appropriate CSS stylesheet
+email: 
+- jake@codeincomplete.com
+executables: 
+- sf
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- bin/sf
+- lib/sprite_factory.rb
+- lib/sprite_factory/layout.rb
+- lib/sprite_factory/library/chunky_png.rb
+- lib/sprite_factory/library/rmagick.rb
+- lib/sprite_factory/runner.rb
+- lib/sprite_factory/style.rb
+- sprite_factory.gemspec
+- test/images/custom/custom.css
+- test/images/custom/running.png
+- test/images/custom/stopped.png
+- test/images/empty/readme.txt
+- test/images/formats/alice.gif
+- test/images/formats/monkey.gif
+- test/images/formats/spies.jpg
+- test/images/formats/thief.png
+- test/images/irregular/irregular1.png
+- test/images/irregular/irregular2.png
+- test/images/irregular/irregular3.png
+- test/images/irregular/irregular4.png
+- test/images/irregular/irregular5.png
+- test/images/irregular/readme.txt
+- test/images/reference/custom.css
+- test/images/reference/custom.png
+- test/images/reference/formats.css
+- test/images/reference/formats.png
+- test/images/reference/index.html
+- test/images/reference/irregular.css
+- test/images/reference/irregular.fixed.css
+- test/images/reference/irregular.fixed.png
+- test/images/reference/irregular.horizontal.css
+- test/images/reference/irregular.horizontal.png
+- test/images/reference/irregular.padded.css
+- test/images/reference/irregular.padded.png
+- test/images/reference/irregular.png
+- test/images/reference/irregular.sassy.css
+- test/images/reference/irregular.sassy.png
+- test/images/reference/irregular.sassy.sass
+- test/images/reference/irregular.vertical.css
+- test/images/reference/irregular.vertical.png
+- test/images/reference/regular.css
+- test/images/reference/regular.custom.css
+- test/images/reference/regular.custom.png
+- test/images/reference/regular.fixed.css
+- test/images/reference/regular.fixed.png
+- test/images/reference/regular.horizontal.css
+- test/images/reference/regular.horizontal.png
+- test/images/reference/regular.padded.css
+- test/images/reference/regular.padded.png
+- test/images/reference/regular.png
+- test/images/reference/regular.sassy.css
+- test/images/reference/regular.sassy.png
+- test/images/reference/regular.sassy.sass
+- test/images/reference/regular.vertical.css
+- test/images/reference/regular.vertical.png
+- test/images/reference/s.gif
+- test/images/regular/regular1.png
+- test/images/regular/regular2.png
+- test/images/regular/regular3.png
+- test/images/regular/regular4.png
+- test/images/regular/regular5.png
+- test/integration_test.rb
+- test/layout_test.rb
+- test/library_test.rb
+- test/runner_test.rb
+- test/style_test.rb
+- test/test_case.rb
+has_rdoc: true
+homepage: https://github.com/jakesgordon/sprite-factory
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Automatic CSS sprite generator
+test_files: []
+