sassc-inline-svg 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe1125b1aeeb7871aac174f657357fcc5f7e446156d03cb9449f59bd8961dea
-  data.tar.gz: a000f33cd15b2c92ccde94018233ec2e3c108939b6adb9f26d79f83e12edf336
+  metadata.gz: 45fab522fafd72280e5c32a70f46201cf31cb3936c931b73e53609e6b81f68ab
+  data.tar.gz: ec172364ac155f64c36c922859493e7228790fb3bf12b6db55fc6954cdc497b3
 SHA512:
-  metadata.gz: 8acff27ee03b575862006c77173f50f8348121e419da224855e747828c54c91ace3df19ee4d1891c747b18ce3da0898d5ace0b580424b599a2ec336378702a2b
-  data.tar.gz: 3fd6893203dfec9ce69066f312c2ff8d6501634601e57b7bbc524f8923a70954206ae6debed1202d1780842d14a45a0795a303b3aaca6301131bd8b9f2fa96b9
+  metadata.gz: 48d62ecf4fa8c9e1ae0602b408954a5727971379863b5a3ed56a46a03c25a24d33088214d5020aca707c98b257907dbcd2859c98d2b2c988a92d54d3a81aa01a
+  data.tar.gz: bd9631d10eac751d06bc82c46d7a529a75d1f58285b580824bf06fb6ce009c12465d58f2e8875d6ac21b29d2676dac1288b70a2076d69d3b71fe56378dd95e1d

data/.gitignore

@@ -0,0 +1,5 @@
+/coverage/
+Gemfile.lock
+
+# IDE
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -1,12 +1,26 @@
-## Adds `inline_svg` as a Sass function.
+# sassс-inline-svg
+
+[![Gem Version](https://badge.fury.io/rb/sassc-inline-svg.svg)](https://badge.fury.io/rb/sassc-inline-svg)
+
+Inline url-encoded SVG with Sassc. Optional variable string replacement included!
+
+Inspired by https://github.com/franzheidl/sass-inline-svg
+
+## Installation
+
+    gem install sassc-inline-svg
+
+Add this line to your application's Gemfile:
+
+    gem 'sassc-inline-svg'
+
 ## Usage
-```sass
+
+Sassc-inline-svg adds a `inline_svg` function you can use with Sass. It url-encodes the contents of the specified file and inlines it in your CSS (Url-encoded SVG is about 30% smaller than base64).
+
+
+```css
 .block {
   background: #0e4573 inline_svg('example.svg', (fillcolor: '#23b3e8')) no-repeat;
 }
 ```
-## Installing gem
-Add to your Gemfile:
-```ruby
-gem 'sassc-inline-svg'
-```

data/lib/sassc-inline-svg.rb

@@ -7,22 +7,17 @@ require 'cgi'
 module SassC::InlineSVG
   module Functions
     def inline_svg(path, options = nil)
-      sprockets_context.depend_on_asset(path.value)
       svg = read_file(path.value.strip)
-      options.value.each_pair { |k, v| svg.gsub!(k.value, v.value) if svg.include?(k.value) } unless options.nil?
-      SassC::Script::Value::String.new(encoded_url(svg))
+      svg = replace_options(svg, options)
+      SassC::Script::Value::String.new(encode_url(svg))
     end
 
     private
 
-    def encoded_url(svg)
-      encoded = CGI::escape(svg).gsub("+", "%20")
-      "url('data:image/svg+xml;charset=utf-8," + encoded + "')"
-    end
-
     def read_file(path)
-      if defined?(Rails)
-        asset = (Rails.application.assets || ::Sprockets::Railtie.build_environment(Rails.application)).find_asset(path).to_s
+      if defined?(Rails) && Rails.application
+        source = Rails.application.assets || ::Sprockets::Railtie.build_environment(Rails.application)
+        asset = source.find_asset(path)
         raise "File not found or cannot be read (Sprockets): #{path}" if asset.nil?
 
         return asset.to_s
@@ -31,6 +26,20 @@ module SassC::InlineSVG
 
       File.open(path, 'rb') { |f| f.read }.strip
     end
+
+    def replace_options(svg, options)
+      return svg if options.nil?
+
+      options.value.each_pair do |k, v|
+        svg.gsub!(k.value, v.value) if svg.include?(k.value)
+      end
+      svg
+    end
+
+    def encode_url(svg)
+      encoded = CGI::escape(svg).gsub("+", "%20")
+      "url('data:image/svg+xml;charset=utf-8," + encoded + "')"
+    end
   end
 end
 

data/lib/sassc-inline-svg/version.rb

@@ -3,6 +3,6 @@
 
 module SassC
   module InlineSVG
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/sassc-inline-svg.gemspec

@@ -18,4 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths   = ['lib']
 
   s.add_dependency 'sassc-rails', '~> 2.0'
+
+  s.add_development_dependency 'rspec', "~> 3.0"
+  s.add_development_dependency 'simplecov', '~> 0.19'
 end

data/spec/sassc-inline-svg/functions_spec.rb

@@ -0,0 +1,79 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+RSpec.describe 'Functions' do
+  let(:dummy_class) { Class.new { extend SassC::InlineSVG::Functions } }
+  let(:options) { nil }
+  let(:path) { OpenStruct.new(value: file_path) }
+
+  subject { dummy_class.inline_svg(path, options) }
+
+  context 'when is this app without rails' do
+    context 'when the file is found' do
+      let(:file_path) { 'spec/support/files/example.svg' }
+
+      context 'without options' do
+        it 'returns encoded url' do
+          expect(subject.value).to eq(File.read('spec/support/files/encoded_svg.txt'))
+        end
+      end
+
+      context 'with options' do
+        let(:options) { OpenStruct.new(value: { OpenStruct.new(value: 'fillcolor') => OpenStruct.new(value: '#0e4573')}) }
+
+        it 'returns encoded url' do
+          expect(subject.value).to eq(File.read('spec/support/files/encoded_svg_with_options.txt'))
+        end
+      end
+    end
+
+    context 'when the file is not found' do
+      let(:file_path) { 'example.svg' }
+
+      context 'when is this app without rails' do
+        it 'returns encoded url' do
+          expect { subject.value }.to raise_error('File not found or cannot be read (native): example.svg')
+        end
+      end
+    end
+  end
+
+  context 'when is this a rails app' do
+    before do
+      stub_const 'Rails', OpenStruct.new(application: OpenStruct.new(assets: Class.new))
+      allow(Rails.application.assets).to receive(:find_asset) { File.read(file_path) }
+    end
+
+    context 'when the file is found' do
+      let(:file_path) { 'spec/support/files/example.svg' }
+
+      context 'without options' do
+        it 'returns encoded url' do
+          expect(subject.value).to eq(File.read('spec/support/files/encoded_svg.txt'))
+        end
+      end
+
+      context 'with options' do
+        let(:options) { OpenStruct.new(value: { OpenStruct.new(value: 'fillcolor') => OpenStruct.new(value: '#0e4573')}) }
+
+        it 'returns encoded url' do
+          expect(subject.value).to eq(File.read('spec/support/files/encoded_svg_with_options.txt'))
+        end
+      end
+    end
+
+    context 'when the file is not found' do
+      let(:file_path) { 'example.svg' }
+
+      before do
+        allow(Rails.application.assets).to receive(:find_asset) { nil }
+      end
+
+      context 'when is this app without rails' do
+        it 'returns encoded url' do
+          expect { subject.value }.to raise_error('File not found or cannot be read (Sprockets): example.svg')
+        end
+      end
+    end
+  end
+end

data/spec/sassc-inline-svg/version_spec.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+RSpec.describe SassC::InlineSVG do
+  it 'has a version number' do
+    expect(SassC::InlineSVG::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sassc-inline-svg'
+
+require 'simplecov'
+SimpleCov.start
+
+RSpec.configure do |config|
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/files/encoded_svg.txt

@@ -0,0 +1 @@
+url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20xmlns%3Axlink%3D%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxlink%22%20viewBox%3D%2235%2025%2030%2050%22%20version%3D%221.1%22%3E%0A%20%20%3Cg%20fill%3D%22fillcolor%22%3E%0A%20%20%20%20%3Cpath%20d%3D%22M67.5251263%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C68.8919613%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2071.1080387%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2072.4748737%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C73.8417088%2C61.1080387%0A%20%20%20%20%20%20%20%20%20%20%20%20%2073.8417088%2C58.8919613%0A%20%20%20%20%20%20%20%20%20%20%20%20%2072.4748737%2C57.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L52.4748737%2C37.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C51.1080387%2C36.1582912%0A%20%20%20%20%20%20%20%20%20%20%20%20%2048.8919613%2C36.1582912%0A%20%20%20%20%20%20%20%20%20%20%20%20%2047.5251263%2C37.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L27.5251263%2C57.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C26.1582912%2C58.8919613%0A%20%20%20%20%20%20%20%20%20%20%20%20%2026.1582912%2C61.1080387%0A%20%20%20%20%20%20%20%20%20%20%20%20%2027.5251263%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C28.8919613%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2031.1080387%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2032.4748737%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L50.0095722%2C44.9401752%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L67.5251263%2C62.4748737%20Z%22%0A%20%20%20%20%20%20%20%20%20%20transform%3D%22translate%2850.000000%2C%2050.000000%29%20rotate%28-90.000000%29%20translate%28-50.000000%2C%20-50.000000%29%20%22%2F%3E%0A%20%20%3C%2Fg%3E%0A%3C%2Fsvg%3E')

data/spec/support/files/encoded_svg_with_options.txt

@@ -0,0 +1 @@
+url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20xmlns%3Axlink%3D%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxlink%22%20viewBox%3D%2235%2025%2030%2050%22%20version%3D%221.1%22%3E%0A%20%20%3Cg%20fill%3D%22%230e4573%22%3E%0A%20%20%20%20%3Cpath%20d%3D%22M67.5251263%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C68.8919613%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2071.1080387%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2072.4748737%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C73.8417088%2C61.1080387%0A%20%20%20%20%20%20%20%20%20%20%20%20%2073.8417088%2C58.8919613%0A%20%20%20%20%20%20%20%20%20%20%20%20%2072.4748737%2C57.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L52.4748737%2C37.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C51.1080387%2C36.1582912%0A%20%20%20%20%20%20%20%20%20%20%20%20%2048.8919613%2C36.1582912%0A%20%20%20%20%20%20%20%20%20%20%20%20%2047.5251263%2C37.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L27.5251263%2C57.5251263%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C26.1582912%2C58.8919613%0A%20%20%20%20%20%20%20%20%20%20%20%20%2026.1582912%2C61.1080387%0A%20%20%20%20%20%20%20%20%20%20%20%20%2027.5251263%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20C28.8919613%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2031.1080387%2C63.8417088%0A%20%20%20%20%20%20%20%20%20%20%20%20%2032.4748737%2C62.4748737%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L50.0095722%2C44.9401752%0A%20%20%20%20%20%20%20%20%20%20%20%20%20L67.5251263%2C62.4748737%20Z%22%0A%20%20%20%20%20%20%20%20%20%20transform%3D%22translate%2850.000000%2C%2050.000000%29%20rotate%28-90.000000%29%20translate%28-50.000000%2C%20-50.000000%29%20%22%2F%3E%0A%20%20%3C%2Fg%3E%0A%3C%2Fsvg%3E')

data/spec/support/files/example.svg

@@ -0,0 +1,25 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="35 25 30 50" version="1.1">
+  <g fill="fillcolor">
+    <path d="M67.5251263,62.4748737
+             C68.8919613,63.8417088
+             71.1080387,63.8417088
+             72.4748737,62.4748737
+             C73.8417088,61.1080387
+             73.8417088,58.8919613
+             72.4748737,57.5251263
+             L52.4748737,37.5251263
+             C51.1080387,36.1582912
+             48.8919613,36.1582912
+             47.5251263,37.5251263
+             L27.5251263,57.5251263
+             C26.1582912,58.8919613
+             26.1582912,61.1080387
+             27.5251263,62.4748737
+             C28.8919613,63.8417088
+             31.1080387,63.8417088
+             32.4748737,62.4748737
+             L50.0095722,44.9401752
+             L67.5251263,62.4748737 Z"
+          transform="translate(50.000000, 50.000000) rotate(-90.000000) translate(-50.000000, -50.000000) "/>
+  </g>
+</svg>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sassc-inline-svg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dmitry Leonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sassc-rails
@@ -24,17 +24,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 description: Adds inline_svg as a Sass function.
 email: ordm67@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - README.md
 - lib/sassc-inline-svg.rb
 - lib/sassc-inline-svg/version.rb
 - sassc-inline-svg.gemspec
+- spec/sassc-inline-svg/functions_spec.rb
+- spec/sassc-inline-svg/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/files/encoded_svg.txt
+- spec/support/files/encoded_svg_with_options.txt
+- spec/support/files/example.svg
 homepage: https://github.com/OrdinaryMagic/sassc-inline-svg
 licenses:
 - MIT