sprite-factory 1.6.2 → 1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 097ca4bb60eba921f4f50b9aa01f4637f76aac8d
-  data.tar.gz: f4270a2b011d8abe87e92ad99146766aad37eee8
+  metadata.gz: b8eaae33fa1ece6b170c111201b49c9c43aedf9a
+  data.tar.gz: 61a3998645237d26ded4d57c98970182ed1b9a85
 SHA512:
-  metadata.gz: b23043b30ce92ee88cc2450fa88934ae7e26f2bc9e62ddc7f0bbf77fa9c6e5858816bacd55da3ff2e4d2d303c9f11548cfe8e99d0d89fe6eb093584248744f63
-  data.tar.gz: 4fb30bc756f357ace50ea35ec3a584c2e0b33daee1a5d5ab0d54901be2cdb9ba04490ee6d8840e93d05b2a8fd09f3d0073423e370b7192307007183d20bbc7cc
+  metadata.gz: 75b2b7092d6c87cde70180776c04a6e0fa6ec10f6c12244b8163f1749634875ed871274101f70449b830d3ee4451c58fe9de18cead42059aea204d673d941eb1
+  data.tar.gz: e2145ffe3b32229049d3ab9929e4c3f3da8e65b2417f731cb58913760a4075179881f9941c60b63fc5660a7dac7db14e949ef79418f3d919e01865f96e839867

data/Gemfile

@@ -8,5 +8,5 @@ source "http://rubygems.org"
 
 group :development do
   gem "chunky_png", "1.3.0"
-  gem "rmagick",    "2.13.2"
+  gem "rmagick",    "2.13.4"
 end

data/README.md

@@ -1,4 +1,4 @@
-Sprite Factory (v1.6.2)
+Sprite Factory (v1.7)
 =======================
 
 The sprite factory is a ruby library that can be used to generate
@@ -98,6 +98,7 @@ Much of the behavior can be customized by overriding the following options:
  - `:height`       - fix height of each sprite to a specific size
  - `:nocss`        - suppress generation of output stylesheet (`run!` returns css content as a string instead)
  - `:nocomments`   - suppress generation of comments in output stylesheet
+ - `:sanitizer`    - strip non-word characters from image filenames when generating css selectors
 
 Options can be passed as command line arguments to the `sf` script:
 
@@ -183,7 +184,6 @@ image filename. For example:
     div.example div.foo span.icon_alert { ... first file   ... }
     div.example div.bar span.icon_alert { ... second file  ... }
     
-
 If you want to specify a psuedo class such as `:hover` for some of your images, the library will also
 map '--' (double dash) to a colon ':' in any source image filename. For example:
 
@@ -199,6 +199,40 @@ map '--' (double dash) to a colon ':' in any source image filename. For example:
     span.icon_alert       { ... first file  ... }
     span.icon_alert:hover { ... second file ... }
 
+Sanitizing the CSS Selector
+===========================
+
+If your image filenames contain non-word characters that would otherwise invalidate your css selector you
+can sanitize these characters using the `:sanitizer` option. For example:
+
+    images/icons/has & ampersand.png
+    images/icons/odd.period.png
+    images/icons/ends with bang!.png
+
+... when run with:
+
+    SpriteFactory.run!('images/icons', :sanitizer => true)
+
+... will generate:
+
+    span.icon_hasampersand { ... first file  ... }
+    span.icon_oddperiod    { ... second file ... }
+    span.icon_endswithbang { ... third file  ... }
+
+If you want **full control** over the filename-to-selector sanitization process you can provide a custom `:sanitizer`. For example:
+
+    images/icons/foo.png
+    images/icons/bar.png
+
+... when run with:
+
+    SpriteFactory.run!('images/icons', :sanitizer => lamda { |name| name.reverse })  # pointless, but amusing
+
+... will generate
+
+    span.icon_oof { ... first file  ... }
+    span.icon_rab { ... second file ... }
+
 Customizing the CSS Image Url
 =============================
 

data/RELEASE_NOTES.md

@@ -1,3 +1,12 @@
+August 15th 2015 - v1.7
+-----------------------
+
+ * added `sanitizer` option to give more control over converting non-standard filenames to css selectors (hattip to @MentalPower)
+ * rename `directory_separator` option to simpler `separator`
+ * switch to minitest 
+ * replace deprecated require 'RMagick' with require 'rmagick' (courtesy of @warrenguy)
+ * added `:glob` option to override default globbing behavior (courtsey of @jdlich)
+
 January 17th 2015 - v1.6.2
 --------------------------
 

data/Rakefile

@@ -47,6 +47,9 @@ task :reference do
   regenerate.call('test/images/irregular', :output => 'test/images/irregular.sassy',      :selector => 'img.sassy_',      :style => :sass)
 
   regenerate.call('test/images/hover', :output => 'test/images/hover', :selector => 'div.hover ', :style => :css)
+  regenerate.call('test/images/glob',  :output => 'test/images/glob', :glob => "included*")
+  regenerate.call('test/images/names', :output => 'test/images/sanitized', :sanitizer => true)
+  regenerate.call('test/images/names', :output => 'test/images/sanitized.custom', :sanitizer => lambda {|name| name.gsub(/[^\w]/, '_').downcase })
 
   regenerate.call('test/images/custom', :output => 'test/images/custom') do |images|
     rules = []

data/bin/sf

@@ -29,7 +29,9 @@ output_style_help = "specify output location for generated stylesheet ( default:
 pngcrush_help     = "use pngcrush to optimize generated image"
 padding_help      = "add padding to each sprite"
 margin_help       = "add margin to each sprite"
+glob_help         = "specify glob pattern used to find images ( default: '*' )"
 nocomments_help   = "suppress comments in generated stylesheet"
+sanitizer_help    = "strip non-word characters out of filenames when converting to css selector"
 
 op.on("--layout       [ORIENTATION]", layout_help)       {|value| options[:layout]       = value }
 op.on("--style        [STYLE]",       style_help)        {|value| options[:style]        = value }
@@ -39,9 +41,11 @@ op.on("--cssurl       [CSSURL]",      cssurl_help)       {|value| options[:cssur
 op.on("--output-image [PATH]",        output_image_help) {|value| options[:output_image] = value }
 op.on("--output-style [PATH]",        output_style_help) {|value| options[:output_style] = value }
 op.on("--pngcrush",                   pngcrush_help)     {|value| options[:pngcrush]     = value }
-op.on("--padding [PIXELS]",           padding_help)      {|value| options[:padding]      = value.to_i }
-op.on("--margin [PIXELS]",            margin_help)       {|value| options[:margin]       = value.to_i }
+op.on("--padding      [PIXELS]",      padding_help)      {|value| options[:padding]      = value.to_i }
+op.on("--margin       [PIXELS]",      margin_help)       {|value| options[:margin]       = value.to_i }
+op.on("--glob         [PATTERN]",     glob_help)         {|value| options[:glob]         = value }
 op.on("--nocomments",                 nocomments_help)   {|value| options[:nocomments]   = true  }
+op.on("--sanitizer",                  sanitizer_help)    {|value| options[:sanitizer]    = true  }
 
 begin
   op.parse!(ARGV)
@@ -51,5 +55,3 @@ rescue Exception => ex
   puts ex.message
   exit
 end
-
-

data/lib/sprite_factory.rb

@@ -1,8 +1,8 @@
 module SpriteFactory
-  
+
   #----------------------------------------------------------------------------
 
-  VERSION     = "1.6.2"
+  VERSION     = "1.7"
   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__)
@@ -27,7 +27,9 @@ module SpriteFactory
     attr_accessor :cssurl
     attr_accessor :pngcrush
     attr_accessor :nocomments
-    attr_accessor :directory_separator
+    attr_accessor :separator
+    attr_accessor :glob
+    attr_accessor :sanitizer
   end
 
   #----------------------------------------------------------------------------
@@ -51,7 +53,7 @@ module SpriteFactory
     end
 
   end
-  
+
   #----------------------------------------------------------------------------
 
   module Library # abstract module for using various image libraries
@@ -67,7 +69,7 @@ module SpriteFactory
     def self.chunkypng
       ChunkyPng
     end
-    
+
     def self.image_magick
       ImageMagick
     end

data/lib/sprite_factory/library/rmagick.rb

@@ -1,4 +1,4 @@
-require 'RMagick'
+require 'rmagick'
 
 module SpriteFactory
   module Library

data/lib/sprite_factory/runner.rb

@@ -12,7 +12,7 @@ module SpriteFactory
 
     attr :input
     attr :config
-  
+
     def initialize(input, config = {})
       @input  = input.to_s[-1] == "/" ? input[0...-1] : input # gracefully ignore trailing slash on input directory name
       @config = config
@@ -24,9 +24,11 @@ module SpriteFactory
       @config[:report]     ||= SpriteFactory.report
       @config[:pngcrush]   ||= SpriteFactory.pngcrush
       @config[:nocomments] ||= SpriteFactory.nocomments
-      @config[:directory_separator] ||= SpriteFactory.directory_separator || '_'
+      @config[:separator]  ||= SpriteFactory.separator || '_'
+      @config[:glob]       ||= SpriteFactory.glob      || '*'
+      @config[:sanitizer]  ||= SpriteFactory.sanitizer
     end
-  
+
     #----------------------------------------------------------------------------
 
     def run!(&block)
@@ -76,7 +78,7 @@ module SpriteFactory
     end
 
     #----------------------------------------------------------------------------
-  
+
     private
 
     def selector
@@ -139,8 +141,12 @@ module SpriteFactory
       config[:nocomments] # set true if you dont want any comments in the output style file
     end
 
-    def directory_separator
-      config[:directory_separator]
+    def separator
+      config[:separator]
+    end
+
+    def sanitizer
+      config[:sanitizer]
     end
 
     def custom_style_file
@@ -166,7 +172,7 @@ module SpriteFactory
     def image_files
       return [] if input.nil?
       valid_extensions = library::VALID_EXTENSIONS
-      expansions = Array(valid_extensions).map{|ext| File.join(input, "**", "*.#{ext}")}
+      expansions = Array(valid_extensions).map{|ext| File.join(input, "**", "#{config[:glob]}.#{ext}")}
       SpriteFactory.find_files(*expansions)
     end
 
@@ -181,22 +187,31 @@ module SpriteFactory
 
       images = library.load(image_files)
       images.each do |i|
-        i[:name], i[:ext] = map_image_filename(i[:filename], input_path)
+        i[:name], i[:ext] = extract_image_filename(i[:filename], input_path)
         raise RuntimeError, "image #{i[:name]} does not fit within a fixed width of #{width}" if width && (width < i[:width])
         raise RuntimeError, "image #{i[:name]} does not fit within a fixed height of #{height}" if height && (height < i[:height])
       end
       images.sort_by {|i| [image_name_without_pseudo_class(i), image_pseudo_class_priority(i)] }
     end
 
-    def map_image_filename(filename, input_path)
-      name = Pathname.new(filename).relative_path_from(input_path).to_s.gsub(File::SEPARATOR, directory_separator)
-      name = name.gsub('--', ':')
-      name = name.gsub('__', ' ')
+    def extract_image_filename(filename, input_path)
+      name = Pathname.new(filename).relative_path_from(input_path).to_s.gsub(File::SEPARATOR, separator)
       ext  = File.extname(name)
       name = name[0...-ext.length] unless ext.empty?
+      name = sanitize_image_filename(name)
       [name, ext]
     end
 
+    def sanitize_image_filename(name)
+      if sanitizer.is_a?(Proc)
+        sanitizer.call(name)                   # custom sanitizer
+      elsif sanitizer
+        name.gsub(/[^\w-]/, '')                # (opt-in) clean all non-word characters
+      else
+        name.gsub('--', ':').gsub('__', ' ')   # legacy behavior
+      end
+    end
+
     def image_name_without_pseudo_class(image)
       image[:name].split(':').first
     end
@@ -249,7 +264,7 @@ module SpriteFactory
       if SUPPORTS_PNGCRUSH && config[:pngcrush]
         crushed = "#{image}.crushed"
         system('pngcrush', '-q', '-rem alla', '-reduce', '-brute', image, crushed)
-        FileUtils.mv(crushed, image) 
+        FileUtils.mv(crushed, image)
       end
     end
 

data/test/images/reference/glob.css

@@ -0,0 +1,20 @@
+/*
+
+        Creating a sprite from following images:
+        
+        test/images/glob/included1.png (64x64)
+        test/images/glob/included2.png (64x64)
+        test/images/glob/included3.png (64x64)
+
+        Output files:
+          test/images/glob.png
+          test/images/glob.css
+
+        Output size:
+          192x64
+
+
+*/
+img.included1 { width: 64px; height: 64px; background: url(glob.png) 0px 0px no-repeat; }
+img.included2 { width: 64px; height: 64px; background: url(glob.png) -64px 0px no-repeat; }
+img.included3 { width: 64px; height: 64px; background: url(glob.png) -128px 0px no-repeat; }

data/test/images/reference/sanitized.css

@@ -0,0 +1,20 @@
+/*
+
+        Creating a sprite from following images:
+        
+        test/images/names/Ends With Bang!.png (64x64)
+        test/images/names/Has & Ampersand.png (64x64)
+        test/images/names/Odd.Period.png (64x64)
+
+        Output files:
+          test/images/sanitized.png
+          test/images/sanitized.css
+
+        Output size:
+          192x64
+
+
+*/
+img.EndsWithBang { width: 64px; height: 64px; background: url(sanitized.png) 0px 0px no-repeat; }
+img.HasAmpersand { width: 64px; height: 64px; background: url(sanitized.png) -64px 0px no-repeat; }
+img.OddPeriod { width: 64px; height: 64px; background: url(sanitized.png) -128px 0px no-repeat; }

data/test/images/reference/sanitized.custom.css

@@ -0,0 +1,20 @@
+/*
+
+        Creating a sprite from following images:
+        
+        test/images/names/Ends With Bang!.png (64x64)
+        test/images/names/Has & Ampersand.png (64x64)
+        test/images/names/Odd.Period.png (64x64)
+
+        Output files:
+          test/images/sanitized.custom.png
+          test/images/sanitized.custom.css
+
+        Output size:
+          192x64
+
+
+*/
+img.ends_with_bang_ { width: 64px; height: 64px; background: url(sanitized.custom.png) 0px 0px no-repeat; }
+img.has___ampersand { width: 64px; height: 64px; background: url(sanitized.custom.png) -64px 0px no-repeat; }
+img.odd_period { width: 64px; height: 64px; background: url(sanitized.custom.png) -128px 0px no-repeat; }

data/test/integration_test.rb

@@ -142,6 +142,26 @@ module SpriteFactory
 
     #----------------------------------------------------------------------------
 
+    def test_generate_with_custom_glob
+      integration_test(GLOB_PATH, :glob => 'included*')
+    end
+
+    #----------------------------------------------------------------------------
+
+    def test_generate_with_sanitizer
+      integration_test(NAMES_PATH, :output   => output_path('sanitized'),
+                                   :sanitizer => true)
+    end
+
+    #----------------------------------------------------------------------------
+
+    def test_generate_with_custom_sanitizer
+      integration_test(NAMES_PATH, :output    => output_path('sanitized.custom'),
+                                   :sanitizer => lambda {|name| name.gsub(/[^\w]/, '_').downcase })
+    end
+
+    #----------------------------------------------------------------------------
+
     def test_generate_sprite_with_nocss
       input  = REGULAR_PATH
       output = File.basename(REGULAR_PATH)

data/test/runner_test.rb

@@ -18,7 +18,7 @@ module SpriteFactory
         assert_equal(:horizontal,             r.layout_name)
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
-        assert_equal(DIRECTORY_SEPARATOR,     r.directory_separator)
+        assert_equal(SEPARATOR,               r.separator)
 
         r = Runner.new(IRREGULAR_PATH)
         assert_equal(IRREGULAR_PATH,          r.input)
@@ -29,9 +29,9 @@ module SpriteFactory
         assert_equal(:horizontal,             r.layout_name)
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
-        assert_equal(DIRECTORY_SEPARATOR,     r.directory_separator)
+        assert_equal(SEPARATOR,               r.separator)
 
-        r = Runner.new(IRREGULAR_PATH, :directory_separator => '.')
+        r = Runner.new(IRREGULAR_PATH, :separator => '.')
         assert_equal(IRREGULAR_PATH,          r.input)
         assert_equal(IRREGULAR_PATH,          r.output)
         assert_equal(IRREGULAR_PATH + ".png", r.output_image_file)
@@ -40,7 +40,7 @@ module SpriteFactory
         assert_equal(:horizontal,             r.layout_name)
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
-        assert_equal('.',     r.directory_separator)
+        assert_equal('.',                     r.separator)
 
         r = Runner.new(REGULAR_PATH, :output => IRREGULAR_PATH)
         assert_equal(REGULAR_PATH,            r.input)
@@ -51,7 +51,7 @@ module SpriteFactory
         assert_equal(:horizontal,             r.layout_name)
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
-        assert_equal(DIRECTORY_SEPARATOR,     r.directory_separator)
+        assert_equal(SEPARATOR,               r.separator)
 
         r = Runner.new(REGULAR_PATH, :output_image => "foo.png", :output_style => "bar.css.sass.erb")
         assert_equal(REGULAR_PATH,            r.input)
@@ -62,7 +62,7 @@ module SpriteFactory
         assert_equal(:horizontal,             r.layout_name)
         assert_equal(:css,                    r.style_name)
         assert_equal(:rmagick,                r.library_name)
-        assert_equal(DIRECTORY_SEPARATOR,     r.directory_separator)
+        assert_equal(SEPARATOR,               r.separator)
 
         r = Runner.new(REGULAR_PATH, :layout => :vertical, :library => :chunkypng, :style => :sass)
         assert_equal(REGULAR_PATH,            r.input)
@@ -73,7 +73,7 @@ module SpriteFactory
         assert_equal(:vertical,               r.layout_name)
         assert_equal(:sass,                   r.style_name)
         assert_equal(:chunkypng,              r.library_name)
-        assert_equal(DIRECTORY_SEPARATOR,     r.directory_separator)
+        assert_equal(SEPARATOR,               r.separator)
 
       end
     
@@ -239,10 +239,10 @@ module SpriteFactory
       end
     end
 
-    def test_use_specified_directory_separator
+    def test_use_specified_separator
       Runner.publicize_methods do
         expected = %w(england.amy england.bob france.bob usa.amy usa.bob)
-        actual = Runner.new(SUBFOLDERS_PATH, :directory_separator => '.').load_images.map{|i| i[:name]}
+        actual = Runner.new(SUBFOLDERS_PATH, :separator => '.').load_images.map{|i| i[:name]}
         assert_equal(expected, actual)
       end
     end

data/test/test_case.rb

@@ -1,8 +1,8 @@
 require File.expand_path('../lib/sprite_factory', File.dirname(__FILE__))
-require 'test/unit'
+require 'minitest/autorun'
 
 module SpriteFactory
-  class TestCase < Test::Unit::TestCase
+  class TestCase < Minitest::Test
 
     #----------------------------------------------------------------------------
 
@@ -16,6 +16,8 @@ module SpriteFactory
     EMPTY_PATH      = 'test/images/empty'
     SUBFOLDERS_PATH = 'test/images/subfolders'
     HOVER_PATH      = 'test/images/hover'
+    GLOB_PATH       = 'test/images/glob'
+    NAMES_PATH      = 'test/images/names'
 
     REGULAR   = SpriteFactory.find_files(File.join(REGULAR_PATH,   '*.png'))
     IRREGULAR = SpriteFactory.find_files(File.join(IRREGULAR_PATH, '*.png'))
@@ -36,7 +38,7 @@ module SpriteFactory
       { :filename => IRREGULAR[4], :width => 46, :height => 25 }
     ]
 
-    DIRECTORY_SEPARATOR = '_'
+    SEPARATOR = '_'
 
     def output_path(name)
       File.join(IMAGES_PATH, name)
@@ -80,14 +82,14 @@ module SpriteFactory
     #----------------------------------------------------------------------------
 
     def assert_runtime_error(msg = nil)
-      e = assert_raise RuntimeError do
+      e = assert_raises RuntimeError do
         yield
       end
       assert_match(msg, e.message) if msg
     end
 
     def assert_not_implemented(msg = nil)
-      e = assert_raise NotImplementedError do
+      e = assert_raises NotImplementedError do
         yield
       end
       assert_match(msg, e.message) if msg

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprite-factory
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: '1.7'
 platform: ruby
 authors:
 - Jake Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -76,6 +76,11 @@ files:
 - test/images/formats/spies.jpg
 - test/images/formats/stackoverflow.ico
 - test/images/formats/thief.png
+- test/images/glob/excluded1.png
+- test/images/glob/excluded2.png
+- test/images/glob/included1.png
+- test/images/glob/included2.png
+- test/images/glob/included3.png
 - test/images/hover/div.bar__img.icon--active.png
 - test/images/hover/div.bar__img.icon--focus.png
 - test/images/hover/div.bar__img.icon--hover.png
@@ -94,10 +99,15 @@ files:
 - test/images/irregular/irregular4.png
 - test/images/irregular/irregular5.png
 - test/images/irregular/readme.txt
+- test/images/names/Ends With Bang!.png
+- test/images/names/Has & Ampersand.png
+- test/images/names/Odd.Period.png
 - test/images/reference/custom.css
 - test/images/reference/custom.png
 - test/images/reference/formats.css
 - test/images/reference/formats.png
+- test/images/reference/glob.css
+- test/images/reference/glob.png
 - test/images/reference/hover.css
 - test/images/reference/hover.png
 - test/images/reference/index.html
@@ -140,6 +150,10 @@ files:
 - test/images/reference/regular.vertical.css
 - test/images/reference/regular.vertical.png
 - test/images/reference/s.gif
+- test/images/reference/sanitized.css
+- test/images/reference/sanitized.custom.css
+- test/images/reference/sanitized.custom.png
+- test/images/reference/sanitized.png
 - test/images/reference/subfolders.css
 - test/images/reference/subfolders.png
 - test/images/regular/regular1.PNG
@@ -181,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Automatic CSS sprite generator