compass-svg-polyfill 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c4024f50a1b14b2c583ad7a753b65de5c14e38d
-  data.tar.gz: e00b8ee7b61942bae511af147326443738717090
+  metadata.gz: 30d0df9bf889565d4b9403f296e7a6a14a5a165c
+  data.tar.gz: e328b89948742ad039aec3b5177479c84918df54
 SHA512:
-  metadata.gz: 77c90338b747e003d3c0ea7be8fa9fda00d0d11d21e19765a697efbe7f32d9a2ca7fc055fb81d2e28fdcec6a5c1158b4563840adec44864335ef3ecb1cc2eb72
-  data.tar.gz: b199f209121acf3617b24587700f4cc61ffb996ff0f846e6e0e951971f92c254faa04063e0ce72c80506c17d75a5216b695244a00cc9032bac6116ddbf1c479a
+  metadata.gz: 5d0130cffbe7be74096cea9bffc887e2272cc01520195d353b67ff984eaa8162317622eecf53646669422f34846e2afb9fb91f7878f1be5edd1fd0cfa1dd363a
+  data.tar.gz: 9f881e1858c2460ae772c429d39cbbf1f9e0516b51976145457efe901990fd2df74f3b8f06bb9b76d764f9eb049fb104aa6eb5e1a1f474abd0eeb4a91a0ef0ee

data/README.md

@@ -1,6 +1,6 @@
 # Compass SVG polyfill
 
-Version 1.0.4
+Version 1.0.5
 
 A compass plugin which serves SVG background images to new browsers and 
 provides a PNG fallback to old browsers.
@@ -16,11 +16,23 @@ This script automates the conversion of SVGs to PNGs and provides the CSS for yo
 
 * broken-links.com -- [Using SVG in backgrounds with PNG fallback](http://www.broken-links.com/2010/06/14/using-svg-in-backgrounds-with-png-fallback/)
 
-## Installation
+## Requirements
 
-### Mac OS X (with homebrew)
+In order to use this gem you must have either `ImageMagick` or `librsvg`.
 
-If you don't already have it, download and install `XQuartz`
+ImageMagick is the recommended library.
+
+## Mac OS X Installation
+
+### ImageMagick
+
+Install `ImageMagick`
+
+    brew install imagemagick
+
+### librsvg
+
+Download and install `XQuartz`
 
     https://xquartz.macosforge.org/landing/
 
@@ -28,9 +40,16 @@ Install `librsvg`
 
     brew install librsvg
 
-Install `gem`
+## Linux Installation
 
-    gem install compass-svg-polyfill
+Tested on `Ubuntu 12.04`
+
+### librsvg
+
+Install `librsvg`
+
+    apt-get update
+    apt-get install librsvg2-bin
 
 ## Usage
 
@@ -38,18 +57,25 @@ Install `gem`
 
 The following instructions are for adding the SVG background image code to an existing project. 
 
+Install `gem`
+
+    gem install compass-svg-polyfill
+
 Add the following to the top of your `config.rb`:
 
     require "compass-svg-polyfill"
 
-Run compass
+Run `compass`
 
     compass watch
 
-Edit your stylesheets and add a reference to the mixin:
+Add your stylesheet:
 
     # At the top of your file
-    @import "svg-polyfill/svg";
+    @import "compass-svg-polyfill/svg";
+
+    # Optionally, define the default image converter
+    $default-image-converter: imagemagick;
 
     # Target a specific element
     .element {
@@ -58,7 +84,8 @@ Edit your stylesheets and add a reference to the mixin:
             $height: 433px,                 /* value must be in pixels */
             $svg: "world-map.svg",          /* file must exist */
             $png: "world-map-856x433.png",  /* file to be generated */
-            $inline: false                  /* optional: include svg in css */
+            $inline: false,                 /* optional: include svg in css */
+            $image-converter: librsvg       /* optional: imagemagick or librsvg */
         );
     }
 
@@ -84,6 +111,29 @@ a separate HTTP request
 
 When `false`: both SVG and PNG images are downloaded via a separate HTTP request
 
+
+### $image-converter
+
+* Optional
+* Default value: imagemagick
+* Valid values: imagemagick, librsvg
+* Available from: 1.0.5
+
+You can select which image converter to use on a case-by-case basis using this 
+parameter.
+
+## Global variables
+
+### $default-image-converter
+
+* Global
+* Optional
+* Default value: imagemagick
+* Valid values: imagemagick, librsvg
+* Available from: 1.0.5
+
+Select which image converter to use globally.
+
 ## Licence
 
 Copyright (C) 2013, [Bashkim Isai](http://www.bashkim.com.au)

data/lib/compass-svg-polyfill.rb

@@ -1,6 +1,6 @@
 require 'compass-svg-polyfill/sass_functions.rb'
 
 Compass::Frameworks.register(
-	'svg-polyfill',
+	'compass-svg-polyfill',
 	:stylesheets_directory => File.join(File.dirname(__FILE__), 'compass-svg-polyfill', 'stylesheets')
 )

data/lib/compass-svg-polyfill/sass_functions.rb

@@ -1,37 +1,52 @@
+require 'RMagick'
+
 module Sass::Script::Functions
-  def svg_polyfill(width, height, svgIn, pngOut)
+  def svg_polyfill(width, height, svgName, pngName, imageConverter)
     assert_type width, :Number
     assert_type height, :Number
-    assert_type svgIn, :String
-    assert_type pngOut, :String
+    assert_type svgName, :String
+    assert_type pngName, :String
+    assert_type imageConverter, :String
+
+    imageConverter = imageConverter.value.to_sym
 
-    svgPath = File.join Compass.configuration.images_path, svgIn.value
-    pngPath = File.join Compass.configuration.images_path, pngOut.value
+    logger = Compass::Logger.new
 
-    begin
-      if !File.exists? svgPath
-        Compass::Logger.new.record :error, File.join(Compass.configuration.images_dir, svgIn.value)
-        raise "SVG does not exist"
-      end
+    svgName = svgName.value.to_s
+    svgPath = File.join Compass.configuration.images_path, svgName
 
-      if File.exists? File.join(Compass.configuration.images_path, pngOut.value)
-        Compass::Logger.new.record :overwrite, File.join(Compass.configuration.images_dir, pngOut.value)
-      else
-        Compass::Logger.new.record :create, File.join(Compass.configuration.images_dir, pngOut.value)
-      end
+    pngName = pngName.value.to_s
+    pngPath = File.join Compass.configuration.images_path, pngName
 
+    if !File.exists? svgPath
+      raise Sass::SyntaxError, "svg does not exist #{svgName}"
+    end
+
+    if File.exists? pngPath
+      logger.record :overwrite, pngName
+    else
+      logger.record :create, pngName
+    end
+
+    case imageConverter
+    when :imagemagick
+      img = Magick::Image.read(svgPath).first
+      img.resize!(width.value.to_i, height.value.to_i)
+      img.write pngPath
+    when :librsvg
       system(
         "rsvg-convert",           # Process
-        "-w", width.value.to_s,   # Width
-        "-h", height.value.to_s,  # Height
+        "-w", "#{width.value}",   # Width
+        "-h", "#{height.value}",  # Height
         "#{svgPath}",             # Input
         "-o", "#{pngPath}"        # Output
       )
-
-      Sass::Script::Bool.new true
-    rescue
-      Sass::Script::Bool.new false
+    else
+      raise Sass::SyntaxError, "Unknown image converter #{imageConverter}"
     end
+
+    Sass::Script::Bool.new true
   end
+
   declare :svg_polyfill, :args => [:Number, :Number, :String, :String]
 end

data/lib/compass-svg-polyfill/stylesheets/{svg-polyfill → compass-svg-polyfill}/svg.scss

@@ -1,6 +1,11 @@
-@mixin background-svg($width, $height, $svg, $png, $inline: false) {
-    $converted: svg_polyfill($width, $height, $svg, $png);
-    @if $converted {
+$default-image-converter: imagemagick !default;
+
+@mixin background-svg($width, $height, $svg, $png, $inline: false, $image-converter: false) {
+    @if not $image-converter {
+        $image-converter: $default-image-converter;
+    }
+
+    @if svg_polyfill($width, $height, $svg, $png, $image-converter) {
         width: $width;
         height: $height;
         background-size: $width, $height;

data/lib/compass-svg-polyfill/version.rb

@@ -1,5 +1,5 @@
 module Compass
   module SVGPolyfill
-    VERSION = "1.0.4"
+    VERSION = "1.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compass-svg-polyfill
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Bashkim Isai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-05 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -38,14 +38,16 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.11.1
-description: 
+description: "    SVG images are a great way to display vector images online; however
+  some \n    older web browsers do not support this format.\n\n    The compass-svg-polyfill
+  gem generates fallback PNG images for these \n    browsers.\n"
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/compass-svg-polyfill/sass_functions.rb
-- lib/compass-svg-polyfill/stylesheets/svg-polyfill/svg.scss
+- lib/compass-svg-polyfill/stylesheets/compass-svg-polyfill/svg.scss
 - lib/compass-svg-polyfill/version.rb
 - lib/compass-svg-polyfill.rb
 - README.md