compass-svg-polyfill 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cc5785234656492fd392c981413c1c64b7095fa
+  data.tar.gz: 5b8a38e985899da58ec44d1f93d483bd056501a0
+SHA512:
+  metadata.gz: d7d0447f2e684a2997cf5b9a20dd7e6c187e3bd62ed2907789034dc538e9077cd4ecc2dd00e0d661119728bbb894c84894babf2b885d19cd6e55cfacb89ef66b
+  data.tar.gz: 5fb8c41fcce0feb3519ac0bec8ecefbd5a00b4e7438e8e9e69d0f9bf4481769383530e46956d311b028de7ab567525354df127edaa284bf52b50471968791e3d

data/README.md

@@ -0,0 +1,92 @@
+# Compass SVG polyfill
+
+Version 1.0.2
+
+A compass plugin which serves SVG background images to new browsers and 
+provides a PNG fallback to old browsers.
+
+## Project details
+
+### Use case
+
+SVGs are great as they're a vector format but some browsers don't support them. 
+This script automates the conversion of SVGs to PNGs and provides the CSS for you.
+
+### Problem domain
+
+* 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
+
+### Mac OS X (with homebrew)
+
+If you don't already have it, download and install `XQuartz`
+
+    https://xquartz.macosforge.org/landing/
+
+Install `librsvg`
+
+    brew install librsvg
+
+Install `gem`
+
+    gem install compass-svg-polyfill
+
+## Usage
+
+### Load times
+
+The SVG vector images are base64 encoded and included in the CSS output through 
+a data URI. The fallback PNG images are linked through a URL. This means that 
+on older browsers the load time is slightly slower (because you have to 
+download two files) but on more modern browsers you have limited the number 
+of HTTP requests.
+
+### Instructions
+
+The following instructions are for adding the SVG background image code to an existing project. 
+
+Add the following to the top of your `config.rb`:
+
+    require "compass-svg-polyfill"
+
+Run compass
+
+    compass watch
+
+Edit your stylesheets and add a reference to the mixin:
+
+    # At the top of your file
+    @import "svg-polyfill/svg";
+
+    # Target a specific element
+    .element {
+        @include background-svg(
+            $width: 856,
+            $height: 433,
+            $svg: "world-map.svg",          /* must exist */
+            $png: "world-map-856x433.png"   /* will be generated for you */
+        );
+    }
+
+When using `compass watch` images are regenerated every time you update your 
+CSS files. If you make changes to your SVG images, resave a stylesheet 
+containing the image and the PNG images will be regenerated.
+
+## Licence
+
+Copyright (C) 2013, [Bashkim Isai](http://www.bashkim.com.au)
+
+This script is distributed under the MIT licence.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## Contributors
+
+* @bashaus -- [Bashkim Isai](http://www.bashkim.com.au/)
+
+If you fork this project and create a pull request add your GitHub username, your full name and website to the end of list above.

data/lib/compass-svg-polyfill.rb

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

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

@@ -0,0 +1,37 @@
+module Sass::Script::Functions
+  def svg_polyfill(width, height, svgIn, pngOut)
+    assert_type width, :Number
+    assert_type height, :Number
+    assert_type svgIn, :String
+    assert_type pngOut, :String
+
+    svgPath = File.join Compass.configuration.images_path, svgIn.value
+    pngPath = File.join Compass.configuration.images_path, pngOut.value
+
+    begin
+      if !File.exists? svgPath
+        Compass::Logger.new.record :error, File.join(Compass.configuration.images_dir, svgIn.value)
+        raise "SVG does not exist"
+      end
+
+      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
+
+      system(
+        "rsvg-convert",         # Process
+        "-w", width.to_s,       # Width
+        "-h", height.to_s,      # Height
+        "#{svgPath}",           # Input
+        "-o", "#{pngPath}"      # Output
+      )
+
+      Sass::Script::Number.new 1
+    rescue
+      Sass::Script::Number.new 0
+    end
+  end
+  declare :svg_polyfill, :args => [:Number, :Number, :String, :String]
+end

data/lib/compass-svg-polyfill/stylesheets/svg-polyfill/svg.scss

@@ -0,0 +1,11 @@
+@mixin background-svg($width, $height, $svg, $png) {
+    $converted: svg_polyfill($width, $height, $svg, $png);
+    @if $converted == 1 {
+        width: $width;
+        height: $height;
+        background-size: $width, $height;
+        background-repeat: no-repeat;
+        background-image: image-url($png);
+        background-image: inline-image($svg), none;
+    }
+}

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

@@ -0,0 +1,5 @@
+module Compass
+  module SVGPolyfill
+    VERSION = "1.0.2"
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: compass-svg-polyfill
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Bashkim Isai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+description: 
+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/version.rb
+- lib/compass-svg-polyfill.rb
+- README.md
+homepage: http://github.com/bashaus/compass-svg-polyfill
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Converts SVG images to PNG for use in older browsers
+test_files: []