spriteful 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24c0ddd742490c912291926301cc0872049e1286
-  data.tar.gz: 0c2015c6fd3dcce48037df20ae06a6e42f12182f
+  metadata.gz: 0368a10d14e6885315939bf705b93a6ee52da147
+  data.tar.gz: b1a79824842c4dd6d94ff7ac061d3344ee813684
 SHA512:
-  metadata.gz: 4da9e340c10c380d934281d131051a22a3659cff93952e115b80d0c656d91f0876b8154890db8e770bfcf97cea396f61b694b3bf095cbe2077b5a54746ff72a8
-  data.tar.gz: 266ce80cbacfe0ba5e09e2f3f013f647f2d69923814e4fda9debde4bdca6d66ea479089633ffff72fc1516ddb40f78d47ef9039a02b379aa15e31ca06d7e8768
+  metadata.gz: ce91faa1f865bc71bcd786fa376e609b62ea86fa147392ca9bca188e1e58af331e9f5fcfb58709345496ac31361156f70e18eba480eebf90efe36bfbabb394b1
+  data.tar.gz: 7e0e39fe26e733430c32e844bb5af0a99df132e3f1914be0ae3498fbaa666f8bc5f4dd50a3a9ee33207b2036a995e88d077fe5505aa18c951f2133695bcb882d

data/README.md

@@ -127,7 +127,7 @@ Spriteful has a basic support for dealing with SVG images (and not only PNGs). S
 will be combined along the rest of your images and will be embedded directly on the final
 Stylesheet in the data URI format. Using the `svg` root class (based on Modernizr), the
 data URI will be used for browsers that support SVG images and the composed PNG will work
-as a fallback for legacy browsers. 
+as a fallback for legacy browsers.
 We recommend that you install librsvg to improve ImageMagick support for SVG images.
 
 ```css
@@ -145,6 +145,16 @@ We recommend that you install librsvg to improve ImageMagick support for SVG ima
 Future versions of Spriteful could have support for generating composed images as SVG files
 (and not only PNG), so feel free to send a contribution improving the feature.
 
+
+## Image Optimization
+
+Spriteful supports PNG optimization through the [image_optim](https://github.com/toy/image_optim)
+gem. You should have one of the following utilities present on your system: `pngcrush`, `pngout`,
+`optipng` or `advpng`. If none can be found, the optimization will be skipped.
+
+If you are using SVG images, the embedded SVG as data URI will be optimized with the
+[svg_optimizer](https://github.com/fnando/svg_optimizer)  gem.
+
 ## Available options
 
 * `--stylesheets` (`-s`) - Directory to save the generated stylesheet(s), instead of copying them to the clipboard.

data/lib/spriteful.rb

@@ -2,6 +2,7 @@ require 'thor/error'
 
 require 'spriteful/version'
 require 'spriteful/image'
+require 'spriteful/optimizer'
 require 'spriteful/sprite'
 require 'spriteful/stylesheet'
 

data/lib/spriteful/cli.rb

@@ -20,7 +20,8 @@ module Spriteful
     class_option :spacing, type: :numeric, desc: 'Add spacing between the images in the sprite.'
 
     class_option :version, type: :boolean, aliases: '-v'
-    class_option :optimize, type: :boolean, default: true, desc: 'Optimize SVG source before generating CSS.'
+    class_option :optimize, type: :boolean, default: true, desc: 'Optimizes the combined PNG and inline SVG images.'
+
     # Public: Gets the CLI banner for the Thor help message.
     #
     # Returns a String.
@@ -61,6 +62,11 @@ module Spriteful
     end
 
     private
+    # Internal: Gets an instance of `Spriteful::Optimizer`.
+    def optimizer
+      @optimizer ||= Optimizer.new
+    end
+
     # Internal: create a sprite image and stylesheet from a given source.
     #
     # Returns nothing.
@@ -71,6 +77,14 @@ module Spriteful
       sprite.combine!
       create_file sprite.path, sprite.blob
       create_file stylesheet.path, stylesheet.render
+      if options.optimize?
+        if optimizer.enabled?
+          say_status :optimizing, relative_to_original_destination_root(sprite.path)
+          optimizer.optimize!(sprite.path)
+        else
+          say_status :optimizing, "No optimizer found. Please install at least one of the following: #{optimizer.optimizers.join(', ')}.", :yellow
+        end
+      end
     end
 
     # Internal: Saves the existing options on 'ARGV' to the '.spritefulrc'

data/lib/spriteful/optimizer.rb

@@ -0,0 +1,56 @@
+require 'image_optim'
+
+module Spriteful
+  # Internal: Wrapper class for the `ImageOptim` gem that can
+  # optimize PNG images and won't crash if no PNG optimizer is
+  # presented.
+  class Optimizer
+    # Public: Initializes the Optimizer, checking for missing
+    # optimizers that should be ignored when optimizing the image.
+    def initialize
+      @optimizer = ImageOptim.new(optimization_options)
+    end
+
+    # Public: Optimizes and replaces the given path.
+    #
+    # Returns nothing.
+    def optimize!(path)
+      @optimizer.optimize_image!(path)
+    end
+
+    # Public: Returns true if any optimization can be executed
+    # of if the `optimize!` will be a no-op.
+    #
+    # Returns true or false.
+    def enabled?
+      optimization_options.values.any?
+    end
+
+    # Public: Gets a list of supported optimizers.
+    def optimizers
+      %w(pngcrush pngout optipng advpng)
+    end
+
+    private
+    # Internal: Maps which optimizers (or 'workers') that
+    # are missing from the system and should be ignored by
+    # the `ImageOptim` optimizer.
+    #
+    # Returns a Hash.
+    def optimization_options
+      @options ||= optimizers.each_with_object({}) do |key, hash|
+        hash[key.to_sym] = command_exists?(key)
+      end
+    end
+
+    # Internal: Checks if a command exists.
+    #
+    # Returns true or false.
+    def command_exists?(command)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |root|
+        path = File.join(root, command)
+        File.executable?(path) && File.file?(path)
+      end
+    end
+  end
+end

data/lib/spriteful/version.rb

@@ -1,3 +1,3 @@
 module Spriteful
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spriteful
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_optim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,7 @@ files:
 - lib/spriteful.rb
 - lib/spriteful/cli.rb
 - lib/spriteful/image.rb
+- lib/spriteful/optimizer.rb
 - lib/spriteful/sprite.rb
 - lib/spriteful/stylesheet.rb
 - lib/spriteful/stylesheets/template.css.erb