sprockets-svg 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc803303d0b7589ee6a223b66943829369763e2d
-  data.tar.gz: 99cc9b849a270e98fedd58d51436d53f969c155a
+  metadata.gz: b586a285d7659583918ac48a90a7e03ae09cbdbb
+  data.tar.gz: 5f582344fde414f8a5ec3005b7694e9b0a85bf58
 SHA512:
-  metadata.gz: 14c328cc5f480d9714002fc756ac2513202c1ba79237f874d859c63490f9241c58ca77a05599a3e9bcef48aedcd0de20dd05c5a2482fcacf552e9143767a6b0b
-  data.tar.gz: 4cac1740330bb335efd7e64606ca894ada311f468e190419725094a87e6818a19c7b908f0c7e027e289e51d7a2e64f1de877d3d5aea7de348bb66f391f3e3846
+  metadata.gz: b2bef4d6f33651aa2cb7cfccc06ec89aac8a9b06d14794030b84fff2c0af408e396d7e6e59f1ba05dd4a1167de3027e93b7f74ab75289457330ecbc0db2e2b40
+  data.tar.gz: 7a1c248d2a2e82b125987c08f7c51c863d1119db9dfba072343191ce40f81b3a4fa8e8444f1825acba2e8973957734a04585b7723a08aecbf0a4abce17169352

data/.travis.yml

@@ -1,4 +1,3 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.0
+  - 2.1

data/Gemfile

@@ -8,4 +8,7 @@ gem 'rspec'
 gem 'rspec-rails'
 gem 'sass-rails'
 gem 'rails'
-gem 'byebug'
+
+if RUBY_VERSION >= '2'
+  gem 'byebug'
+end

data/lib/sprockets/svg.rb

@@ -22,6 +22,14 @@ module Sprockets
       svg.attribute('height') && svg.attribute('width')
     end
 
+    def self.png_path(svg_path)
+      if svg_path =~ /^(.*)\-([0-9a-f]{32})\.svg$/
+        "#{$1}.svg-#{$2}.png"
+      else
+        "#{svg_path}.png"
+      end
+    end
+
     def install(assets)
       assets.register_preprocessor 'image/svg+xml', :svg_min do |context, data|
         Sprockets::Svg::Cleaner.process(data)
@@ -33,6 +41,7 @@ end
 
 require_relative 'svg/cleaner'
 require_relative 'svg/proxy_asset'
+require_relative 'svg/sass_functions'
 require_relative 'svg/server'
 
 Sprockets::Environment.send(:include, Sprockets::Svg::Server)

data/lib/sprockets/svg/proxy_asset.rb

@@ -7,13 +7,24 @@ module Sprockets
       end
 
       def digest_path
-        png_path(@original_asset.digest_path)
+        ::Sprockets::Svg.png_path(@original_asset.digest_path)
       end
 
       def logical_path
         @original_asset.logical_path + '.png'
       end
 
+      def length
+        # If length isn't already set we default to original asset length.
+        # It is most certainly wrong, but at least it will be bigger than the real size, so it is unlikely to create any issue.
+        # And most importantly it prevent useless on the fly compilation
+        @length || @original_asset.length
+      end
+
+      def content_type
+        'image/png'
+      end
+
       def write_to(filename, options = {})
         # Gzip contents if filename has '.gz'
         options[:compress] ||= File.extname(filename) == '.gz'
@@ -50,6 +61,8 @@ module Sprockets
         # Set mtime correctly
         File.utime(mtime, mtime, filename)
 
+        @length = File.stat(filename).size
+
         nil
       ensure
         # Ensure tmp file gets cleaned up
@@ -57,21 +70,15 @@ module Sprockets
       end
 
       def to_s
-        tmp_path = Tempfile.new(['png-cache', '.png']).path
-        write_to(tmp_path)
-        File.read(tmp_path)
+        @source ||= begin
+          tmp_path = Tempfile.new(['png-cache', '.png']).path
+          write_to(tmp_path)
+          File.read(tmp_path)
+        end
       end
 
       private
 
-      def png_path(svg_path)
-        if svg_path =~ /^(.*)\-([0-9a-f]{32})\.svg$/
-          "#{$1}.svg-#{$2}.png"
-        else
-          "#{svg_path}.png"
-        end
-      end
-
       def method_missing(name, *args, &block)
         if @original_asset.respond_to?(name)
           @original_asset.public_send(name, *args, &block)

data/lib/sprockets/svg/sass_functions.rb

@@ -0,0 +1,38 @@
+module Sprockets
+  module Svg
+    module SassFunctions
+
+      def image_path(path)
+        Sass::Script::String.new(svg2png_image_path(path.value), :string)
+      end
+
+      def image_url(path)
+        Sass::Script::String.new("url(" + svg2png_image_path(path.value) + ")")
+      end
+
+      def svg2png_image_path(path)
+        convert = false
+        if path.ends_with?('.svg.png')
+          path = path.gsub(/\.png$/, '')
+          convert = true
+        end
+
+        url = sprockets_context.image_path(path)
+        convert ? ::Sprockets::Svg.png_path(url) : url
+      end
+
+    end
+  end
+end
+
+Sprockets::SassTemplate.class_eval do
+
+  def initialize_engine_with_png_conversion
+    initialize_engine_without_png_conversion
+    ::Sass::Script::Functions.send :include, Sprockets::Svg::SassFunctions
+  end
+
+  alias_method :initialize_engine_without_png_conversion, :initialize_engine
+  alias_method :initialize_engine, :initialize_engine_with_png_conversion
+
+end

data/lib/sprockets/svg/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Svg
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/app/app/assets/stylesheets/application.css.scss

@@ -0,0 +1,4 @@
+.facebook-icon {
+  background-image: image-url('facebook.svg.png');
+  background-image: image-url('facebook.svg'), none;
+}

data/spec/app/app/controllers/assets_controller.rb

@@ -1,7 +1,8 @@
 class AssetsController < ApplicationController
 
   def test
-    render text: Rails.application.assets[params[:file]].to_s
+    asset = Rails.application.assets[params[:file]]
+    send_data asset.to_s, content_type: asset.content_type
   end
 
 end

data/spec/rails_spec.rb

@@ -7,24 +7,17 @@ require 'json'
 COMPILED_ASSETS_PATH = File.expand_path('app/public/assets/', File.dirname(__FILE__))
 ASSETS = Pathname.new(COMPILED_ASSETS_PATH)
 
-describe 'Rake task' do
-  before :each do
-    FileUtils.mkdir_p(COMPILED_ASSETS_PATH)
-  end
-
-  after :each do
-    FileUtils.rm_rf(COMPILED_ASSETS_PATH)
-  end
+describe 'Sprockets::Svg' do
 
-  let(:svg_name) { 'facebook-052e5d3070b50e0b3e60014378ece289.svg' }
+  let(:svg_name) { 'facebook-213385e4d9304ef93b23578fc4c93440.svg' }
 
-  let(:png_name) { 'facebook.svg-052e5d3070b50e0b3e60014378ece289.png' }
+  let(:png_name) { 'facebook.svg-213385e4d9304ef93b23578fc4c93440.png' }
 
   let(:svg_path) { ASSETS.join(svg_name) }
 
   let(:png_path) { ASSETS.join(png_name) }
 
-  let(:font_path) { ASSETS.join('fontawesome-webfont-7534bcc67141208ea7a8c9be3a960f17.svg') }
+  let(:font_path) { ASSETS.join('fontawesome-webfont-040e9dcf8f420c96cbb5f0985fe09185.svg') }
 
   let(:svg_fingerprint) { Digest::MD5.hexdigest(svg_path.read) }
 
@@ -34,34 +27,53 @@ describe 'Rake task' do
 
   let(:png_source) { png_path.read }
 
-  it "generate a PNG from the SVG source" do
-    output = `cd spec/app; bundle exec rake assets:precompile 2>&1`
-    puts output unless $?.success?
-    $?.should be_success
+  describe 'Rake task' do
+    before :each do
+      FileUtils.mkdir_p(COMPILED_ASSETS_PATH)
+    end
+
+    after :each do
+      FileUtils.rm_rf(COMPILED_ASSETS_PATH)
+    end
 
-    expect(svg_path).to be_exist
-    expect(png_path).to be_exist
+    it "generate a PNG from the SVG source" do
+      output = `cd spec/app; bundle exec rake assets:precompile 2>&1`
+      puts output unless $?.success?
+      expect($?).to be_success
 
-    expect(svg_fingerprint).to be == '85385a2b8357015a4ae6d8ab782d5389'
-    # Metadata etc are kinda time dependant, so this assertion is the best I can do.
-    expect(png_source).to be_starts_with("\x89PNG\r\n")
+      expect(svg_path).to be_exist
+      expect(png_path).to be_exist
 
-    expect(manifest['files'][svg_name]).to be_present
-    expect(manifest['files'][png_name]).to be_present
+      expect(svg_fingerprint).to be == '85385a2b8357015a4ae6d8ab782d5389'
+      # Metadata etc are kinda time dependant, so this assertion is the best I can do.
+      expect(png_source).to be_starts_with("\x89PNG\r\n")
 
-    expect(manifest['assets']['facebook.svg.png']).to be == png_name
+      expect(manifest['files'][svg_name]).to be_present
+      expect(manifest['files'][png_name]).to be_present
 
-    expect(font_path).to be_exist
-    expect(Dir[ASSETS.join('fontawesome-webfont-*.png')]).to be_empty
+      expect(manifest['assets']['facebook.svg.png']).to be == png_name
+
+      expect(font_path).to be_exist
+      expect(Dir[ASSETS.join('fontawesome-webfont-*.png')]).to be_empty
+    end
   end
-end
 
-describe AssetsController, type: :controller do
+  describe AssetsController, type: :controller do
+
+    it 'rack' do
+      get :test, file: 'facebook.svg.png'
+      expect(response).to be_success
+      expect(response.body.force_encoding('utf-8')).to be_starts_with("\x89PNG\r\n".force_encoding('utf-8'))
+      expect(response.headers['Content-Type']).to be == 'image/png'
+    end
+
+    it 'compile scss' do
+      get :test, file: 'application.css'
+      expect(response).to be_success
+      expect(response.body).to include svg_name
+      expect(response.body).to include png_name
+    end
 
-  it 'rack' do
-    get :test, file: 'facebook.svg.png'
-    expect(response).to be_success
-    expect(response.body.force_encoding('utf-8')).to be_starts_with("\x89PNG\r\n")
   end
 
 end

data/spec/spec_helper.rb

@@ -4,15 +4,6 @@ require_relative 'app/config/environment'
 require 'rspec/rails'
 require_relative '../lib/sprockets-svg'
 
-
-RSpec.configure do |c|
-  c.filter_run_excluding not_jruby: RUBY_PLATFORM == 'java'
-end
-
-
 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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-svg
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,12 +85,14 @@ files:
 - lib/sprockets/svg/cleaner.rb
 - lib/sprockets/svg/proxy_asset.rb
 - lib/sprockets/svg/railtie.rb
+- lib/sprockets/svg/sass_functions.rb
 - lib/sprockets/svg/server.rb
 - lib/sprockets/svg/version.rb
 - spec/app/.gitignore
 - spec/app/Rakefile
 - spec/app/app/assets/fonts/fontawesome-webfont.svg
 - spec/app/app/assets/images/facebook.svg
+- spec/app/app/assets/stylesheets/application.css.scss
 - spec/app/app/controllers/application_controller.rb
 - spec/app/app/controllers/assets_controller.rb
 - spec/app/config.ru
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: SVG toolchain for sprockets
@@ -132,6 +134,7 @@ test_files:
 - spec/app/Rakefile
 - spec/app/app/assets/fonts/fontawesome-webfont.svg
 - spec/app/app/assets/images/facebook.svg
+- spec/app/app/assets/stylesheets/application.css.scss
 - spec/app/app/controllers/application_controller.rb
 - spec/app/app/controllers/assets_controller.rb
 - spec/app/config.ru