sprockets-svg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 637ef504757d5585190afec174fce8a7000d9dd1
+  data.tar.gz: 9b96ee0e1a7ce01abca2ca5c85c66e869a002ff0
+SHA512:
+  metadata.gz: 2b66f14048832b1da4a1478348aa10316b53952b8eaa12b127fec90a1f57d1e794ff081951d3e34ba633156078f7fe59354544310b0df65c7fb905a75e4c1670
+  data.tar.gz: 30c4176c3f48a590bf85f890f863765e4b7d4537cef6278c1350d71f6abfe49e0da7f5922dcc1652a52448a42b0eba7ef93738b8dcc611815f97202b6544157b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sprockets-svg.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jean Boussier
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,67 @@
+# Sprockets::Svg
+
+SVG toolchain for sprockets
+
+## Installation
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sprockets-svg
+
+## Usage
+
+### Ruby on Rails
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sprockets-svg'
+```
+
+From now on, svg files will be automatically optimised.
+
+To link the png version of `picture.svg` from scss:
+
+```scss
+#id {
+  background-image: image-url(picture.svg.png)
+}
+```
+
+or from a view:
+
+```erb
+<%= image_tag 'picture.svg.png' %>
+```
+
+### Standalone Sprockets
+
+If you are using sprockets outside of Rails, to setup `sprockets-svg` you just need:
+
+```ruby
+assets = Sprockets::Environment.new do |env|
+  # Your assets settings
+end
+
+require "sprockets-svg"
+Sprockets::Svg.install(assets)
+```
+
+## Optimizations
+
+For now the only optimization performed is to remove hidden elements.
+
+In the future I'd like to rely on the [`svgo` toolchain](https://github.com/svg/svgo).
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/sprockets-svg/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sprockets-svg.rb

@@ -0,0 +1,2 @@
+require 'sprockets'
+require 'sprockets/svg'

data/lib/sprockets/svg.rb

@@ -0,0 +1,23 @@
+require 'sprockets/svg/version'
+
+module Sprockets
+  module Svg
+    extend self
+
+    def install(assets)
+      assets.register_preprocessor 'image/svg+xml', :svg_min do |context, data|
+        Sprockets::Svg::Cleaner.process(data)
+      end
+    end
+
+  end
+end
+
+require_relative 'svg/cleaner'
+require_relative 'svg/png'
+require_relative 'svg/server'
+
+Sprockets::Asset.send(:include, Sprockets::Svg::Png)
+Sprockets::Environment.send(:include, Sprockets::Svg::Server)
+
+require_relative 'svg/railtie' if defined?(Rails)

data/lib/sprockets/svg/cleaner.rb

@@ -0,0 +1,16 @@
+require 'nokogiri'
+
+module Sprockets
+  module Svg
+    class Cleaner
+      # TODO: integrate svgo instead: https://github.com/svg/svgo
+      # See https://github.com/lautis/uglifier on how to integrate a npm package as a gem.
+      def self.process(svg)
+        p :preprocess_svg
+        document = Nokogiri::XML(svg)
+        document.css('[display=none]').remove()
+        document.to_s
+      end
+    end
+  end
+end

data/lib/sprockets/svg/png.rb

@@ -0,0 +1,27 @@
+require 'rmagick'
+
+module Sprockets
+  module Svg
+    module Png
+      def self.included(base)
+        base.send(:alias_method, :write_to_without_png_convertion, :write_to)
+        base.send(:alias_method, :write_to, :write_to_with_png_convertion)
+      end
+
+      def write_to_with_png_convertion(path, options={})
+        write_to_without_png_convertion(path, options)
+        if path.ends_with?('.svg')
+          Png.convert(path, path + '.png')
+        end
+        nil
+      end
+
+      # TODO: integrate svgo instead: https://github.com/svg/svgo
+      # See https://github.com/lautis/uglifier on how to integrate a npm package as a gem.
+      def self.convert(svg_path, png_path)
+        image = Magick::ImageList.new(svg_path)
+        image.write(png_path)
+      end
+    end
+  end
+end

data/lib/sprockets/svg/railtie.rb

@@ -0,0 +1,12 @@
+begin
+  require 'sprockets/railtie'
+
+  module Sprockets::Svg
+    class Railtie < ::Rails::Railtie
+      initializer :setup_sprockets_svg, group: :all do |app|
+        Sprockets::Svg.install(app.assets)
+      end
+    end
+  end
+rescue LoadError
+end

data/lib/sprockets/svg/server.rb

@@ -0,0 +1,40 @@
+require 'tempfile'
+require 'pathname'
+
+module Sprockets
+  module Svg
+    module Server
+
+      def self.included(base)
+        base.send(:alias_method, :find_asset_without_convertion, :find_asset)
+        base.send(:alias_method, :find_asset, :find_asset_with_convertion)
+      end
+
+      def find_asset_with_convertion(path, options = {})
+        convert = false
+        if path.ends_with?('.svg.png')
+          path = path.gsub(/\.png/, '')
+          convert = true
+        end
+        asset = find_asset_without_convertion(path, options)
+
+        if convert
+          asset = svg_asset_to_static_png(asset)
+        end
+
+        asset
+      end
+
+      def svg2png_cache_path
+        @cache_path ||= cache.instance_variable_get(:@root).join('svg2png')
+      end
+
+      def svg_asset_to_static_png(svg_asset)
+        tmp = Tempfile.new(['svg2png', '.svg'])
+        svg_asset.write_to(tmp.path)
+        ::Sprockets::StaticAsset.new(self, svg_asset.logical_path + '.png', Pathname.new(tmp.path + '.png'))
+      end
+
+    end
+  end
+end

data/lib/sprockets/svg/version.rb

@@ -0,0 +1,5 @@
+module Sprockets
+  module Svg
+    VERSION = '0.0.1'
+  end
+end

data/sprockets-svg.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sprockets/svg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sprockets-svg'
+  spec.version       = Sprockets::Svg::VERSION
+  spec.authors       = ['Jean Boussier']
+  spec.email         = ['jean.boussier@gmail.com']
+  spec.summary       = %q{SVG toolchain for sprockets}
+  spec.description   = %q{Minify SVG assets, and optionally convert them to PNG for browser compatibility.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_dependency 'sprockets'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'rmagick'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-svg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jean Boussier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  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: nokogiri
+  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: rmagick
+  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'
+description: Minify SVG assets, and optionally convert them to PNG for browser compatibility.
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sprockets-svg.rb
+- lib/sprockets/svg.rb
+- lib/sprockets/svg/cleaner.rb
+- lib/sprockets/svg/png.rb
+- lib/sprockets/svg/railtie.rb
+- lib/sprockets/svg/server.rb
+- lib/sprockets/svg/version.rb
+- sprockets-svg.gemspec
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: SVG toolchain for sprockets
+test_files: []