sprite-factory 1.4.1 → 1.4.2

data/README.md

@@ -1,4 +1,4 @@
-Sprite Factory (v1.4.1)
+Sprite Factory (v1.4.2)
 =======================
 
 The sprite factory is a ruby library that can be used to generate
@@ -54,11 +54,18 @@ You can also use the SpriteFactory class directly from your own code:
 
     SpriteFactory.run!('images/icons')
 
-The original image name is used for the CSS class to show that image in HTML:
+The original image file name is used for the CSS class to show that image in HTML:
 
-    <img src='s.gif' class='high'>
-    <img src='s.gif' class='medium'>
-    <img src='s.gif' class='low'>
+    <img src='s.gif' class='high'>         # e.g. original image was high.png
+    <img src='s.gif' class='medium'>       # e.g. original image was medium.png
+    <img src='s.gif' class='low'>          # e.g. original image was low.png
+
+If original image files are included in sub-folders, the relative path
+name will be used for the CSS class to show that image in HTML:
+
+    <img src='s.gif' class='other_high'>   # e.g. original image was other/high.png
+    <img src='s.gif' class='other_medium'> # e.g. original image was other/medium.png
+    <img src='s.gif' class='other_low'>    # e.g. original image was other/low.png
 
 When using a framework such as Rails, you would usually DRY this up with a helper method:
 
@@ -87,7 +94,8 @@ Much of the behavior can be customized by overriding the following options:
  - `:padding`      - add padding to each sprite
  - `:width`        - fix width of each sprite to a specific size
  - `:height`       - fix height of each sprite to a specific size
- - `:nocss`        - suppress generation of output style file (`run!` returns css content as a string instead)
+ - `:nocss`        - suppress generation of output stylesheet (`run!` returns css content as a string instead)
+ - `:nocomments`   - suppress generation of comments in output stylesheet
 
 Options can be passed as command line arguments to the `sf` script:
 

data/RELEASE_NOTES.md

@@ -1,4 +1,9 @@
 
+UNRELEASED - v1.4.2
+-------------------
+ * added support for `:nocomments => true` to suppress comments in generated output stylesheet
+ * added support for images in subfolders - fixes [github issue #11](https://github.com/jakesgordon/sprite-factory/issues/11)
+
 August 5th 2011 - v1.4.1
 ------------------------
  * added support for `:style => :scss` to generate .scss file (even though content will be almost exactly same as .css style)

data/bin/sf

@@ -27,6 +27,7 @@ csspath_help      = "specify custom path to use for css image urls ( default: ou
 output_image_help = "specify output location for generated image ( default: <input folder>.png )"
 output_style_help = "specify output location for generated stylesheet ( default: <input folder>.<style>)"
 pngcrush_help     = "use pngcrush to optimize generated image"
+nocomments_help   = "suppress comments in generated stylesheet"
 
 op.on("--layout       [ORIENTATION]", layout_help)       {|value| options[:layout]       = value }
 op.on("--style        [STYLE]",       style_help)        {|value| options[:style]        = value }
@@ -36,6 +37,7 @@ op.on("--csspath      [CSSPATH]",     csspath_help)      {|value| options[:csspa
 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("--nocomments",                 nocomments_help)   {|value| options[:nocomments]   = true  }
 
 begin
   op.parse!(ARGV)

data/lib/sprite_factory.rb

@@ -2,7 +2,7 @@ module SpriteFactory
   
   #----------------------------------------------------------------------------
 
-  VERSION     = "1.4.1"
+  VERSION     = "1.4.2"
   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__)
@@ -26,6 +26,7 @@ module SpriteFactory
     attr_accessor :selector
     attr_accessor :csspath
     attr_accessor :pngcrush
+    attr_accessor :nocomments
   end
 
   #----------------------------------------------------------------------------

data/lib/sprite_factory/runner.rb

@@ -12,13 +12,14 @@ module SpriteFactory
     def initialize(input, config = {})
       @input  = input.to_s[-1] == "/" ? input[0...-1] : input # gracefully ignore trailing slash on input directory name
       @config = config
-      @config[:style]    ||= SpriteFactory.style    || :css
-      @config[:layout]   ||= SpriteFactory.layout   || :horizontal
-      @config[:library]  ||= SpriteFactory.library  || :rmagick
-      @config[:selector] ||= SpriteFactory.selector || 'img.'
-      @config[:csspath]  ||= SpriteFactory.csspath
-      @config[:report]   ||= SpriteFactory.report
-      @config[:pngcrush] ||= SpriteFactory.pngcrush
+      @config[:style]      ||= SpriteFactory.style    || :css
+      @config[:layout]     ||= SpriteFactory.layout   || :horizontal
+      @config[:library]    ||= SpriteFactory.library  || :rmagick
+      @config[:selector]   ||= SpriteFactory.selector || 'img.'
+      @config[:csspath]    ||= SpriteFactory.csspath
+      @config[:report]     ||= SpriteFactory.report
+      @config[:pngcrush]   ||= SpriteFactory.pngcrush
+      @config[:nocomments] ||= SpriteFactory.nocomments
     end
   
     #----------------------------------------------------------------------------
@@ -45,7 +46,7 @@ module SpriteFactory
       report(header)
 
       css = []
-      css << style_comment(header)                                          # header comment
+      css << style_comment(header) unless nocomments?                       # header comment
       css << style(selector, css_path, images, &block)                      # generated styles
       css << IO.read(custom_style_file) if File.exists?(custom_style_file)  # custom styles
       css = css.join("\n")
@@ -114,6 +115,10 @@ module SpriteFactory
       config[:nocss] # set true if you dont want an output style file generated (e.g. you will take the #run! output and store it yourself)
     end
 
+    def nocomments?
+      config[:nocomments] # set true if you dont want any comments in the output style file
+    end
+
     def custom_style_file
       File.join(input, File.basename(input) + ".#{style_name}")
     end
@@ -148,9 +153,10 @@ module SpriteFactory
     end
 
     def load_images
+      input_path = Pathname.new(input)
       images = library.load(image_files)
       images.each do |i|
-        i[:name] = File.basename(i[:filename])
+        i[:name] = Pathname.new(i[:filename]).relative_path_from(input_path).to_s.gsub(File::SEPARATOR, "_")
         i[:ext]  = File.extname(i[:name])
         i[:name] = i[:name][0...-i[:ext].length] unless i[:ext].empty?
 
@@ -192,7 +198,7 @@ module SpriteFactory
 
     #----------------------------------------------------------------------------
 
-    SUPPORTS_PNGCRUSH = !`which pngcrush`.empty?
+    SUPPORTS_PNGCRUSH = !`which pngcrush`.empty? rescue false # rescue on environments without `which` (windows)
 
     def pngcrush(image)
       if SUPPORTS_PNGCRUSH && config[:pngcrush]

data/lib/sprite_factory/style.rb

@@ -26,7 +26,7 @@ module SpriteFactory
     end
 
     def self.scss_comment(comment)
-      css_comment(attributes)
+      css_comment(comment)
     end
 
     #----------------------------------------------------------------------------

data/test/images/reference/index.html

@@ -19,6 +19,7 @@
     <link href='irregular.sassy.css'      rel='stylesheet' type='text/css' media='screen'></link> 
     <link href='custom.css'               rel='stylesheet' type='text/css' media='screen'></link>
     <link href='formats.css'              rel='stylesheet' type='text/css' media='screen'></link>
+    <link href='subfolders.css'           rel='stylesheet' type='text/css' media='screen'></link>
     <style>
       img { border: 1px solid red; }
     </style>
@@ -136,6 +137,13 @@
     <img src='s.gif' class='spies'>
     <img src='s.gif' class='thief'>
 
+    <h1>From Sub Folders</h1>
+    <img src='s.gif' class='england_amy'>
+    <img src='s.gif' class='england_bob'>
+    <img src='s.gif' class='france_bob'>
+    <img src='s.gif' class='usa_amy'>
+    <img src='s.gif' class='usa_bob'>
+
     <script>
       SpriteFactory = {
         toggleTimer: function() {

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

@@ -0,0 +1,5 @@
+img.nocomments_regular1 { width: 64px; height: 64px; background: url(regular.nocomments.png) 0px 0px no-repeat; }
+img.nocomments_regular2 { width: 64px; height: 64px; background: url(regular.nocomments.png) -64px 0px no-repeat; }
+img.nocomments_regular3 { width: 64px; height: 64px; background: url(regular.nocomments.png) -128px 0px no-repeat; }
+img.nocomments_regular4 { width: 64px; height: 64px; background: url(regular.nocomments.png) -192px 0px no-repeat; }
+img.nocomments_regular5 { width: 64px; height: 64px; background: url(regular.nocomments.png) -256px 0px no-repeat; }

data/test/images/reference/subfolders.css

@@ -0,0 +1,24 @@
+/*
+
+        Creating a sprite from following images:
+        
+        test/images/subfolders/england/amy.png (64x64)
+        test/images/subfolders/england/bob.png (64x64)
+        test/images/subfolders/france/bob.png (64x64)
+        test/images/subfolders/usa/amy.png (64x64)
+        test/images/subfolders/usa/bob.png (64x64)
+
+        Output files:
+          test/images/subfolders.png
+          test/images/subfolders.css
+
+        Output size:
+          320x64
+
+
+*/
+img.england_amy { width: 64px; height: 64px; background: url(subfolders.png) 0px 0px no-repeat; }
+img.england_bob { width: 64px; height: 64px; background: url(subfolders.png) -64px 0px no-repeat; }
+img.france_bob { width: 64px; height: 64px; background: url(subfolders.png) -128px 0px no-repeat; }
+img.usa_amy { width: 64px; height: 64px; background: url(subfolders.png) -192px 0px no-repeat; }
+img.usa_bob { width: 64px; height: 64px; background: url(subfolders.png) -256px 0px no-repeat; }

data/test/integration_test.rb

@@ -46,6 +46,12 @@ module SpriteFactory
                                      :style    => :sass)
     end
 
+    def test_generate_regular_with_nocomments
+      integration_test(REGULAR_PATH, :output     => output_path('regular.nocomments'),
+                                     :selector   => 'img.nocomments_',
+                                     :nocomments => true)
+    end
+
     #----------------------------------------------------------------------------
 
     def test_generate_irregular_sprite
@@ -108,6 +114,12 @@ module SpriteFactory
 
     #----------------------------------------------------------------------------
 
+    def test_generate_sprite_using_images_in_subfolders
+      integration_test(SUBFOLDERS_PATH)
+    end
+
+    #----------------------------------------------------------------------------
+
     def test_generate_sprite_with_nocss
       input  = REGULAR_PATH
       output = File.basename(REGULAR_PATH)

data/test/test_case.rb

@@ -8,12 +8,13 @@ module SpriteFactory
 
     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'
+    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'
 
     REGULAR   = SpriteFactory.find_files(File.join(REGULAR_PATH,   '*.png'))
     IRREGULAR = SpriteFactory.find_files(File.join(IRREGULAR_PATH, '*.png'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprite-factory
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-06 00:00:00.000000000Z
+date: 2012-02-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &12869300 !ruby/object:Gem::Requirement
+  requirement: &20623420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12869300
+  version_requirements: *20623420
 - !ruby/object:Gem::Dependency
   name: chunky_png
-  requirement: &12901920 !ruby/object:Gem::Requirement
+  requirement: &20623000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12901920
+  version_requirements: *20623000
 description: Combines individual images from a directory into a single sprite image
   file and creates an appropriate CSS stylesheet
 email:
@@ -99,6 +99,8 @@ files:
 - test/images/reference/regular.fixed.png
 - test/images/reference/regular.horizontal.css
 - test/images/reference/regular.horizontal.png
+- test/images/reference/regular.nocomments.css
+- test/images/reference/regular.nocomments.png
 - test/images/reference/regular.packed.css
 - test/images/reference/regular.packed.png
 - test/images/reference/regular.padded.css
@@ -110,11 +112,18 @@ files:
 - test/images/reference/regular.vertical.css
 - test/images/reference/regular.vertical.png
 - test/images/reference/s.gif
+- test/images/reference/subfolders.css
+- test/images/reference/subfolders.png
 - 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/images/subfolders/england/amy.png
+- test/images/subfolders/england/bob.png
+- test/images/subfolders/france/bob.png
+- test/images/subfolders/usa/amy.png
+- test/images/subfolders/usa/bob.png
 - test/integration_test.rb
 - test/layout/horizontal_test.rb
 - test/layout/packed_test.rb