sprite-factory 1.7 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8eaae33fa1ece6b170c111201b49c9c43aedf9a
-  data.tar.gz: 61a3998645237d26ded4d57c98970182ed1b9a85
+  metadata.gz: cb0f2314f328570697404a534cda489ed35c3c43
+  data.tar.gz: ad014967a8ecb4679f66e9f46ac4de2bf8c8d9ff
 SHA512:
-  metadata.gz: 75b2b7092d6c87cde70180776c04a6e0fa6ec10f6c12244b8163f1749634875ed871274101f70449b830d3ee4451c58fe9de18cead42059aea204d673d941eb1
-  data.tar.gz: e2145ffe3b32229049d3ab9929e4c3f3da8e65b2417f731cb58913760a4075179881f9941c60b63fc5660a7dac7db14e949ef79418f3d919e01865f96e839867
+  metadata.gz: ce72a68481f25969e2eb9b4295176af0f4981ba67df6cc3d76a61aeb04bb9623d718a1dff078baf25173ec026c4c5514da000d759d0a95dbf19a0a4bc2e461e2
+  data.tar.gz: fb87c0cd93acd937fa422a76992dc3f4261f41609acd19efd72384946d2e14093cad27d8e5f1bb9ba0497be4b48661317dc41567ec1c3a3d8d50dc80debc6b35

data/README.md

@@ -1,4 +1,4 @@
-Sprite Factory (v1.7)
+Sprite Factory (v1.7.1)
 =======================
 
 The sprite factory is a ruby library that can be used to generate

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+September 9th 2015 - v1.7.1
+---------------------------
+
+ * added `exclude` option to ignore select images in source directory (courtesy of @AlexanderRD)
+
 August 15th 2015 - v1.7
 -----------------------
 

data/lib/sprite_factory.rb

@@ -2,7 +2,7 @@ module SpriteFactory
 
   #----------------------------------------------------------------------------
 
-  VERSION     = "1.7"
+  VERSION     = "1.7.1"
   SUMMARY     = "Automatic CSS sprite generator"
   DESCRIPTION = "Combines individual images from a directory into a single sprite image file and creates an appropriate CSS stylesheet"
   LIB         = File.dirname(__FILE__)
@@ -30,6 +30,7 @@ module SpriteFactory
     attr_accessor :separator
     attr_accessor :glob
     attr_accessor :sanitizer
+    attr_accessor :exclude
   end
 
   #----------------------------------------------------------------------------
@@ -85,4 +86,3 @@ module SpriteFactory
   #----------------------------------------------------------------------------
 
 end
-

data/lib/sprite_factory/runner.rb

@@ -27,6 +27,7 @@ module SpriteFactory
       @config[:separator]  ||= SpriteFactory.separator || '_'
       @config[:glob]       ||= SpriteFactory.glob      || '*'
       @config[:sanitizer]  ||= SpriteFactory.sanitizer
+      @config[:exclude]    ||= SpriteFactory.exclude   || []
     end
 
     #----------------------------------------------------------------------------
@@ -149,6 +150,14 @@ module SpriteFactory
       config[:sanitizer]
     end
 
+    def exclude
+      config[:exclude]
+    end
+
+    def exclude?(file)
+      Array(exclude).any? { |name| file.include?(name) }
+    end
+
     def custom_style_file
       File.join(input, File.basename(input) + ".#{style_name}")
     end
@@ -169,11 +178,15 @@ module SpriteFactory
       end
     end
 
+    #----------------------------------------------------------------------------
+
     def image_files
       return [] if input.nil?
       valid_extensions = library::VALID_EXTENSIONS
       expansions = Array(valid_extensions).map{|ext| File.join(input, "**", "#{config[:glob]}.#{ext}")}
-      SpriteFactory.find_files(*expansions)
+      files = SpriteFactory.find_files(*expansions)
+      files = files.reject{ |file| exclude?(file) }
+      files
     end
 
     #----------------------------------------------------------------------------

data/test/images/reference/irregular.filtered.css

@@ -0,0 +1,20 @@
+/*
+
+        Creating a sprite from following images:
+        
+        test/images/irregular/irregular2.png (16x16)
+        test/images/irregular/irregular3.png (48x48)
+        test/images/irregular/irregular4.png (34x14)
+
+        Output files:
+          test/images/irregular.filtered.png
+          test/images/irregular.filtered.css
+
+        Output size:
+          98x48
+
+
+*/
+img.filtered_irregular2 { width: 16px; height: 16px; background: url(irregular.filtered.png) 0px -16px no-repeat; }
+img.filtered_irregular3 { width: 48px; height: 48px; background: url(irregular.filtered.png) -16px 0px no-repeat; }
+img.filtered_irregular4 { width: 34px; height: 14px; background: url(irregular.filtered.png) -64px -17px no-repeat; }

data/test/images/reference/regular.filtered.css

@@ -0,0 +1,20 @@
+/*
+
+        Creating a sprite from following images:
+        
+        test/images/regular/regular2.PNG (64x64)
+        test/images/regular/regular3.PNG (64x64)
+        test/images/regular/regular4.PNG (64x64)
+
+        Output files:
+          test/images/regular.filtered.png
+          test/images/regular.filtered.css
+
+        Output size:
+          192x64
+
+
+*/
+img.filtered_regular2 { width: 64px; height: 64px; background: url(regular.filtered.png) 0px 0px no-repeat; }
+img.filtered_regular3 { width: 64px; height: 64px; background: url(regular.filtered.png) -64px 0px no-repeat; }
+img.filtered_regular4 { width: 64px; height: 64px; background: url(regular.filtered.png) -128px 0px no-repeat; }

data/test/integration_test.rb

@@ -60,6 +60,12 @@ module SpriteFactory
                                      :nocomments => true)
     end
 
+    def test_generate_regular_sprite_with_exclude_array
+      integration_test(REGULAR_PATH, :output   => output_path('regular.filtered'),
+                                     :selector => 'img.filtered_',
+                                     :exclude  => ['regular1.PNG', 'regular5.PNG'])
+    end
+
     #----------------------------------------------------------------------------
 
     def test_generate_irregular_sprite
@@ -111,6 +117,12 @@ module SpriteFactory
                                        :style    => :sass)
     end
 
+    def test_generate_irregular_sprite_with_exclude_array
+      integration_test(IRREGULAR_PATH, :output   => output_path('irregular.filtered'),
+                                       :selector => 'img.filtered_',
+                                       :exclude  => ['irregular1.png', 'irregular5.png'])
+    end
+
     #----------------------------------------------------------------------------
 
     def test_generate_custom_sprite

data/test/runner_test.rb

@@ -19,6 +19,7 @@ module SpriteFactory
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
         assert_equal(SEPARATOR,               r.separator)
+        assert_equal([],                      r.exclude)
 
         r = Runner.new(IRREGULAR_PATH)
         assert_equal(IRREGULAR_PATH,          r.input)
@@ -30,6 +31,7 @@ module SpriteFactory
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
         assert_equal(SEPARATOR,               r.separator)
+        assert_equal([],                      r.exclude)
 
         r = Runner.new(IRREGULAR_PATH, :separator => '.')
         assert_equal(IRREGULAR_PATH,          r.input)
@@ -52,6 +54,19 @@ module SpriteFactory
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
         assert_equal(SEPARATOR,               r.separator)
+        assert_equal([],                      r.exclude)
+
+        r = Runner.new(REGULAR_PATH, :exclude => ['foo.png']) 
+        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)
+        assert_equal(SEPARATOR,               r.separator)
+        assert_equal(['foo.png'],             r.exclude)
 
         r = Runner.new(REGULAR_PATH, :output_image => "foo.png", :output_style => "bar.css.sass.erb")
         assert_equal(REGULAR_PATH,            r.input)
@@ -63,6 +78,7 @@ module SpriteFactory
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
         assert_equal(SEPARATOR,               r.separator)
+        assert_equal([],                      r.exclude)
 
         r = Runner.new(REGULAR_PATH, :layout => :vertical, :library => :chunkypng, :style => :sass)
         assert_equal(REGULAR_PATH,            r.input)
@@ -74,9 +90,8 @@ module SpriteFactory
         assert_equal(:sass,                   r.style_name)
         assert_equal(:chunkypng,              r.library_name)
         assert_equal(SEPARATOR,               r.separator)
-
-      end
-    
+        assert_equal([],                      r.exclude)        
+      end    
     end
 
     #----------------------------------------------------------------------------
@@ -202,6 +217,15 @@ module SpriteFactory
 
     #----------------------------------------------------------------------------
 
+    def test_images_are_filtered_correctly
+      Runner.publicize_methods do
+        expected = REGULAR_INFO.map{ |i| i[:filename] }
+        excluded = expected.pop(2)
+        actual = Runner.new(REGULAR_PATH, :exclude => excluded).image_files
+        assert_equal(expected, actual)
+      end
+    end
+
     def test_images_are_sorted_in_classname_order
       Runner.publicize_methods do
         expected = [

data/test/test_case.rb

@@ -107,7 +107,7 @@ module SpriteFactory
       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}")
+      assert_in_delta(0.0, val, 1e-7, "generated image does not match pregenerated reference:\n actual:   #{actual}\n expected: #{expected}\n expected: #{expected}")
     end
 
     def assert_reference_style(name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprite-factory
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: 1.7.1
 platform: ruby
 authors:
 - Jake Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-15 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -112,6 +112,8 @@ files:
 - test/images/reference/hover.png
 - test/images/reference/index.html
 - test/images/reference/irregular.css
+- test/images/reference/irregular.filtered.css
+- test/images/reference/irregular.filtered.png
 - test/images/reference/irregular.fixed.css
 - test/images/reference/irregular.fixed.png
 - test/images/reference/irregular.horizontal.css
@@ -131,6 +133,8 @@ files:
 - test/images/reference/regular.css
 - test/images/reference/regular.custom.css
 - test/images/reference/regular.custom.png
+- test/images/reference/regular.filtered.css
+- test/images/reference/regular.filtered.png
 - test/images/reference/regular.fixed.css
 - test/images/reference/regular.fixed.png
 - test/images/reference/regular.horizontal.css