spriteful 0.1.1 → 0.1.2

checksums.yaml

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

data/README.md

@@ -127,7 +127,8 @@ 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
 .images.update-icon {
@@ -154,6 +155,7 @@ Future versions of Spriteful could have support for generating composed images a
 * `--horizontal` - Changes the sprite orientation to horizontal, since all sprites are combined vertically by default.
 * `--save` - Saves the provided arguments for later use.
 * `--spacing` - Add some spacing between the images in the sprite.
+* `--no-optimize` - Skip optimizing SVG images.
 
 You can add a `.spritefulrc` file with default options to your home directory or the current one that they will
 be picked up whenever you run the `spriteful` command.

data/lib/spriteful/cli.rb

@@ -20,6 +20,7 @@ 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.'
     # Public: Gets the CLI banner for the Thor help message.
     #
     # Returns a String.
@@ -100,7 +101,8 @@ module Spriteful
     def sprite_options
       {
         horizontal: options.horizontal?,
-        spacing: options.spacing
+        spacing: options.spacing,
+        optimize: options.optimize
       }
     end
 

data/lib/spriteful/image.rb

@@ -30,12 +30,13 @@ module Spriteful
     # object that was initialized from the real image blob.
     #
     # magick_image - an 'Magick::Image' object.
-    def initialize(magick_image)
+    def initialize(magick_image, optimize=true)
       @source = magick_image
-      @path   = magick_image.filename
+      @path   = magick_image.base_filename
       @name   = File.basename(@path)
       @width  = magick_image.columns
       @height = magick_image.rows
+      @optimize = optimize
 
       @top    = 0
       @left   = 0
@@ -45,7 +46,7 @@ module Spriteful
     #
     # Returns a String.
     def blob
-      @blob ||= SvgOptimizer.optimize(File.read(path))
+      @blob ||= read_blob
     end
 
     # Public: detects if the source is a SVG image
@@ -55,5 +56,16 @@ module Spriteful
     def svg?
       File.extname(@path) == '.svg'
     end
+
+    private
+
+    def read_blob
+      contents = File.read(path)
+      if @optimize
+        SvgOptimizer.optimize(contents)
+      else
+        contents
+      end
+    end
   end
 end

data/lib/spriteful/sprite.rb

@@ -39,6 +39,7 @@ module Spriteful
     #                             orientation.
     #               :spacing - spacing in pixels that should be placed between
     #                          the images in the sprite. Defaults to 0.
+    #               :optimize - flag to optimize SVG to be inlined
     def initialize(source_dir, destination, options = {})
       source_pattern = File.join(source_dir, '*{.png,.svg}')
       sources = Dir[source_pattern].sort
@@ -49,11 +50,12 @@ module Spriteful
 
       @vertical    = !options[:horizontal]
       @spacing     = options[:spacing] || 0
+      @optimize    = options[:optimize]
 
       @name     = File.basename(source_dir)
       @filename = "#{name}.png"
       @path     = File.expand_path(File.join(destination, @filename))
-      @list     = Magick::ImageList.new(*sources)
+      @list     = Magick::ImageList.new(*sources) { self.background_color = 'none' }
       @images   = initialize_images(@list)
 
       @height, @width = detect_dimensions
@@ -118,7 +120,7 @@ module Spriteful
       images = []
 
       list.to_a.each_with_index do |magick_image, index|
-        image = Image.new(magick_image)
+        image = Image.new(magick_image, @optimize)
 
         if vertical?
           image.top = sprite_position

data/lib/spriteful/stylesheet.rb

@@ -1,5 +1,6 @@
 require 'erb'
 require 'pathname'
+require 'base64'
 
 module Spriteful
   # Public: class responsible for putting together the CSS code
@@ -129,7 +130,7 @@ module Spriteful
     # Returns a String.
     def data_uri(image)
       if image.svg?
-        %['data:image/svg+xml;utf8,#{image.blob.gsub(/\r?\n/, "")}']
+        %['data:image/svg+xml;base64,#{Base64.encode64(image.blob).gsub(/\r?\n/, '')}']
       end
     end
   end

data/lib/spriteful/version.rb

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

data/spec/image_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
 describe Spriteful::Image do
-  let(:source_image) { double('Magick Image', filename: 'path/to/image.png', columns: 10, rows: 5) }
-  subject(:image) { Spriteful::Image.new(source_image) }
+  let(:filename) { 'path/to/image.png' }
+  let(:source_image) { double('Magick Image', base_filename: filename, columns: 10, rows: 5) }
+  let(:optimize) { true }
+  subject(:image) { Spriteful::Image.new(source_image, optimize) }
 
   it { expect(image.name).to eq('image.png') }
   it { expect(image.path).to eq('path/to/image.png') }
@@ -12,15 +14,22 @@ describe Spriteful::Image do
   it { expect(image).to_not be_svg }
 
   context 'SVG images' do
-    before do
-      source_image.stub(filename: 'spec/fixtures/svg/green.svg')
-    end
+    let(:filename) { 'spec/fixtures/svg/green.svg' }
 
     it { expect(image).to be_svg }
 
-    it 'returns the SVG XML as the #blob' do
-      xml = SvgOptimizer.optimize(File.read(source_image.filename))
+    it 'returns the optimized SVG XML as the #blob' do
+      xml = SvgOptimizer.optimize(File.read(source_image.base_filename))
       expect(image.blob).to eq(xml)
     end
+
+    context 'skiping svg optimize' do
+      let(:optimize) { false }
+
+      it 'returns the unoptimized SVG XML as the #blob' do
+        xml = File.read(source_image.base_filename)
+        expect(image.blob).to eq(xml)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,6 @@
 require 'spriteful'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
   config.order = 'random'
 
   config.after do

metadata

@@ -1,116 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: spriteful
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.2
 - !ruby/object:Gem::Dependency
   name: svg_optimizer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.0.0.beta2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A sprite generation tool
@@ -123,6 +110,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/spriteful
+- lib/spriteful.rb
 - lib/spriteful/cli.rb
 - lib/spriteful/image.rb
 - lib/spriteful/sprite.rb
@@ -130,7 +119,6 @@ files:
 - lib/spriteful/stylesheets/template.css.erb
 - lib/spriteful/stylesheets/template.scss.erb
 - lib/spriteful/version.rb
-- lib/spriteful.rb
 - spec/fixtures/simple/blue.png
 - spec/fixtures/simple/red.png
 - spec/fixtures/svg/green.svg
@@ -139,31 +127,29 @@ files:
 - spec/spec_helper.rb
 - spec/sprite_spec.rb
 - spec/stylesheet_spec.rb
-- bin/spriteful
 homepage: https://github.com/lucasmazza/spriteful
 licenses:
 - Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ''
 test_files:
 - spec/fixtures/simple/blue.png
@@ -174,4 +160,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/sprite_spec.rb
 - spec/stylesheet_spec.rb
-has_rdoc: