sprite-factory 1.5.3 → 1.6.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+#
+# NOTE: rmagick dependencies include:
+#
+#   $ sudo apt-get install imagemagick
+#   $ sudo apt-get install libmagickwand-dev
+
+group :development do
+  gem "chunky_png", "1.3.0"
+  gem "rmagick",    "2.13.2"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011, 2012, 2013 Jake Gordon and contributors
+Copyright (c) 2011, 2012, 2013, 2014 Jake Gordon and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-Sprite Factory (v1.5.3)
+Sprite Factory (v1.6.0)
 =======================
 
 The sprite factory is a ruby library that can be used to generate
@@ -111,7 +111,7 @@ You can see the results of many of these options by viewing the sample page that
 comes with the gem in `test/images/reference/index.html`.
 
 >> NOTE: only the common options are available via the command line script (to keep it simple). Specifically,
-the advanced `width`, `height`, `padding`, `margin` and `nocss` options are only available via the Ruby interface.
+the advanced `width`, `height`, and `nocss` options are only available via the Ruby interface.
 
 >> NOTE: the `width`, `height` and `padding` options are not particularly useful - you would be better off just
 making your source images have the correct dimensions by editing them appropriately in photoshop (or your editor of choice)

data/RELEASE_NOTES.md

@@ -1,3 +1,10 @@
+March 16th 2014 - v1.6.0
+------------------------
+
+ * Added raw ImageMagick driver can be used without RMagick gem (courtesy of @willglynn - Cheers!)
+ * Exposed `padding` and `margin` support to the cli interface (courtesy of @miguelgonz - Cheers!)
+
+
 February 21st 2013 - v1.5.3
 ---------------------------
  * bugfix: added back `:selector` when providing attributes for custom style generators (it was accidentally removed in v1.5.2)

data/bin/sf

@@ -27,6 +27,8 @@ cssurl_help       = "specify custom string to use for css image urls ( default:
 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"
+padding_help      = "add padding to each sprite"
+margin_help       = "add margin to each sprite"
 nocomments_help   = "suppress comments in generated stylesheet"
 
 op.on("--layout       [ORIENTATION]", layout_help)       {|value| options[:layout]       = value }
@@ -37,6 +39,8 @@ 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("--nocomments",                 nocomments_help)   {|value| options[:nocomments]   = true  }
 
 begin

data/lib/sprite_factory.rb

@@ -2,7 +2,7 @@ module SpriteFactory
   
   #----------------------------------------------------------------------------
 
-  VERSION     = "1.5.3"
+  VERSION     = "1.6.0"
   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__)
@@ -55,8 +55,9 @@ module SpriteFactory
 
   module Library # abstract module for using various image libraries
 
-    autoload :RMagick,   File.join(LIB, 'sprite_factory/library/rmagick')    # concrete module for using RMagick   (loaded on demand)
-    autoload :ChunkyPng, File.join(LIB, 'sprite_factory/library/chunky_png') # concrete module for using ChunkyPng (ditto)
+    autoload :RMagick,     File.join(LIB, 'sprite_factory/library/rmagick')      # concrete module for using RMagick     (loaded on demand)
+    autoload :ChunkyPng,   File.join(LIB, 'sprite_factory/library/chunky_png')   # concrete module for using ChunkyPng   (ditto)
+    autoload :ImageMagick, File.join(LIB, 'sprite_factory/library/image_magick') # concrete module for using ImageMagick (ditto)
 
     def self.rmagick
       RMagick
@@ -65,6 +66,10 @@ module SpriteFactory
     def self.chunkypng
       ChunkyPng
     end
+    
+    def self.image_magick
+      ImageMagick
+    end
 
   end
 

data/lib/sprite_factory/library/image_magick.rb

@@ -0,0 +1,74 @@
+module SpriteFactory
+  module Library
+    module ImageMagick
+
+      # Represents an error from an underlying ImageMagick call
+      class Error < RuntimeError
+        attr_reader :command
+        attr_reader :args
+        attr_reader :output
+        
+        def initialize(msg, command, args, output)
+          super(msg)
+          @command = command
+          @args = args
+          @output = output
+        end
+      end
+
+      VALID_EXTENSIONS = [:png, :jpg, :jpeg, :gif, :ico]
+
+      def self.load(files)
+        files.map do |filename|
+          path = "#{filename}[0]"   # layer 0
+          output = run("identify", ['-format', '%wx%h', path])
+          
+          width, height = output.chomp.split(/x/).map(&:to_i)
+          {
+            :filename => filename,
+            :path     => path,
+            :width    => width,
+            :height   => height
+          }
+        end
+      end
+
+      def self.create(filename, images, width, height)
+        # we want to invoke:
+        # convert -size #{width}x#{height} xc:none
+        #   #{input} -geometry +#{x}+#{y} -composite
+        # #{output}
+        
+        args = ["-size", "#{width}x#{height}", "xc:none"]
+        images.each do |image|
+          args +=  [image[:path], "-geometry", "+#{image[:x]}+#{image[:y]}", "-composite"]
+        end
+        args << filename
+        
+        run("convert", args)
+        true
+      end
+      
+      protected
+      def self.run(command, args)
+        full_command = [command] + args.map(&:to_s)
+        
+        r, w = IO.pipe
+        pid = Process.spawn(*full_command, {[:out, :err] => w})
+        
+        w.close
+        output = r.read
+        
+        Process.waitpid(pid)
+        success = $?.exitstatus == 0 ? true : false
+        
+        if !success
+          raise Error.new("error running `#{command}` (check $!.args/$!.output for more information)", command, args, output)
+        end
+        
+        output
+      end
+      
+    end # module ImageMagick
+  end # module Library
+end # module SpriteFactory

data/test/library_test.rb

@@ -5,8 +5,9 @@ class SpriteFactory::LibraryTest < SpriteFactory::TestCase
   #--------------------------------------------------------------------------
 
   LIBRARIES = {
-    :rmagick   => SpriteFactory::Library::RMagick,
-    :chunkypng => SpriteFactory::Library::ChunkyPng
+    :rmagick      => SpriteFactory::Library::RMagick,
+    :chunkypng    => SpriteFactory::Library::ChunkyPng,
+    :image_magick => SpriteFactory::Library::ImageMagick
   }
 
   #--------------------------------------------------------------------------

metadata

@@ -1,59 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sprite-factory
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 5
-  - 3
-  version: 1.5.3
+version: !ruby/object:Gem::Version
+  version: 1.6.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jake Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-21 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rmagick
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: chunky_png
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Combines individual images from a directory into a single sprite image
+  file and creates an appropriate CSS stylesheet
+email:
 - jake@codeincomplete.com
-executables: 
+executables:
 - sf
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - .gitignore
+- Gemfile
 - LICENSE
 - README.md
 - RELEASE_NOTES.md
@@ -64,6 +65,7 @@ files:
 - lib/sprite_factory/layout/packed.rb
 - lib/sprite_factory/layout/vertical.rb
 - lib/sprite_factory/library/chunky_png.rb
+- lib/sprite_factory/library/image_magick.rb
 - lib/sprite_factory/library/rmagick.rb
 - lib/sprite_factory/runner.rb
 - lib/sprite_factory/style.rb
@@ -164,37 +166,29 @@ files:
 - 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: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Automatic CSS sprite generator
 test_files: []
-