inline_svg 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 529e4c1b0bd2b16b4684a2cd241bdb707cd14e74
-  data.tar.gz: 86d782dd377e342b750e245001cbd50bba50dc71
+  metadata.gz: 76c4c056778276bacd69cc27ec4c982566f99f4b
+  data.tar.gz: e3678d7bf16c59dd3922d358265721e2fa05151a
 SHA512:
-  metadata.gz: 46dba646464d60a3df6cc59f27767a58ef482faee661a15bd93841f5c32aeb405a30b77fc0dc53bf3f12e74ab12edb2dac9b0bc3c35505388432701010263dec
-  data.tar.gz: 9ee8d699f27cd417bcdef5c42fc0036b7797d5fb5394c38fa7cfca576f1a16b3e3ee950f4cb082015d184ea0eebfedd26fd0c373777989e8e414b94326b9ad62
+  metadata.gz: a883fe5008e571a78008f94e8196ba84feb846bd25086bc127573c142a2e5232c90278e7002adbd0609dbf3be9dec25758743acd1f86e98280abec3a8df23f64
+  data.tar.gz: 3fa071d1f1e307cb3bffab9e7144dcf681aa32e5549fb950b350fe55a2eb4bc16438db2eebe508d3fd79b0b7022ade27bcb1b499a47498b9a42da389ff2be9ec

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-*

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+Nothing.
+
+## [0.3.0] - 2015-03-20
+### Added
+- Use Sprockets to find canonical asset paths (fingerprinted, post asset-pipeline).
+
+## [0.2.0] - 2014-12-31
+### Added
+- Optionally remove comments from SVG files. Thanks, @jmarceli.
+
+## [0.1.0] - 2014-12-15
+### Added
+- Optionally add a title and description to a document. Thanks, ludwig.schubert@qlearning.de.
+- Add integration tests for main view helper. Thanks, ludwig.schubert@qlearning.de.
+
+## 0.0.1 - 2014-11-24
+### Added
+- Basic Railtie and view helper to inline SVG documents to Rails views.
+
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/jamesmartin/inline_svg/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/jamesmartin/inline_svg/compare/v0.0.1...v0.1.0

data/README.md

@@ -1,4 +1,4 @@
-# Inline Svg
+# Inline SVG
 
 Styling a SVG document with CSS for use on the web is most reliably achieved by
 [adding classes to the document and
@@ -8,6 +8,11 @@ This gem is a little helper method (`inline_svg`) that reads an SVG document fro
 image directory, applies a CSS class attribute to the root of the document and
 then embeds it into a view.
 
+## Changelog
+
+All notable changes to this project are documented in the
+[CHANGELOG](https://github.com/jamesmartin/inline_svg/blob/master/CHANGELOG.md).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -72,7 +77,7 @@ inline_svg("some-document.svg", class: 'some-class', title: 'Some Title', desc:
 
 ## Contributing
 
-1. Fork it ( [http://github.com/<my-github-username>/inline_svg/fork](http://github.com/<my-github-username>/inline_svg/fork) )
+1. Fork it ( [http://github.com/jamesmartin/inline_svg/fork](http://github.com/jamesmartin/inline_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`)

data/inline_svg.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.6"
-  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rspec", "~> 3.2"
 
+  spec.add_runtime_dependency "activesupport", "~> 4.1.9"
   spec.add_runtime_dependency "nokogiri", "~> 1.6", '~> 1.6'
   spec.add_runtime_dependency "loofah", ">= 2.0"
 end

data/lib/inline_svg/action_view/helpers.rb

@@ -7,28 +7,29 @@ module InlineSvg
   module ActionView
     module Helpers
       def inline_svg(filename, options={})
-        file = File.read(Rails.root.join('app', 'assets', 'images', filename))
-        doc = Nokogiri::HTML::DocumentFragment.parse file
+        begin
+          doc = Loofah::HTML::DocumentFragment.parse(AssetFile.named(filename))
+        rescue InlineSvg::AssetFile::FileNotFound
+          return "<svg><!-- SVG file not found: '#{filename}' --></svg>".html_safe
+        end
 
-        # remove comments from svg file
         if options[:nocomment].present?
-          doc = Loofah.fragment(doc.to_s).scrub!(:strip)
+          doc.scrub!(:strip)
         end
 
         svg = doc.at_css 'svg'
         if options[:class]
           svg['class'] = options[:class]
         end
-        if options[:title].present?
-          title = Nokogiri::XML::Node.new("title", doc)
-          title.content = options[:title]
-          svg.add_child title
-        end
-        if options[:desc].present?
-          desc = Nokogiri::XML::Node.new("desc", doc)
-          desc.content = options[:desc]
-          svg.add_child desc
+
+        %i(title desc).each do |child|
+          if options[child].present?
+            node = Nokogiri::XML::Node.new(child.to_s, doc)
+            node.content = options[child]
+            svg.add_child node
+          end
         end
+
         doc.to_html.html_safe
       end
     end

data/lib/inline_svg/asset_file.rb

@@ -0,0 +1,13 @@
+module InlineSvg
+  class AssetFile
+    class FileNotFound < IOError; end
+    UNREADABLE_PATH = ''
+
+    def self.named(filename)
+      asset_path = FindsAssetPaths.by_filename(filename)
+      File.read(asset_path || UNREADABLE_PATH)
+    rescue Errno::ENOENT
+      raise FileNotFound.new("Asset not found: #{asset_path}")
+    end
+  end
+end

data/lib/inline_svg/finds_asset_paths.rb

@@ -0,0 +1,11 @@
+module InlineSvg
+  class FindsAssetPaths
+    def self.by_filename(filename)
+      configured_asset_finder.find_asset(filename)
+    end
+
+    def self.configured_asset_finder
+      InlineSvg.configuration.asset_finder
+    end
+  end
+end

data/lib/inline_svg/railtie.rb

@@ -5,6 +5,9 @@ module InlineSvg
       ActiveSupport.on_load :action_view do
         require "inline_svg/action_view/helpers"
         include InlineSvg::ActionView::Helpers
+        InlineSvg.configure do |config|
+          config.asset_finder = app.instance_variable_get(:@assets) # In most cases this will be the Sprockets::Environment instance of the Rails app.
+        end
       end
     end
   end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/inline_svg.rb

@@ -1,7 +1,38 @@
 require "inline_svg/version"
 require "inline_svg/action_view/helpers"
+require "inline_svg/finds_asset_paths"
+require "inline_svg/asset_file"
 require "inline_svg/railtie" if defined?(Rails)
+require 'active_support/core_ext'
+require 'nokogiri'
 
 module InlineSvg
-  # Your code goes here...
+  class Configuration
+    class Invalid < ArgumentError; end
+
+    attr_reader :asset_finder
+
+    def asset_finder=(finder)
+      if finder.respond_to?(:find_asset)
+        @asset_finder = finder
+      else
+        raise InlineSvg::Configuration::Invalid.new("Asset Finder should implement the #find_asset method")
+      end
+      asset_finder
+    end
+  end
+
+  @configuration = InlineSvg::Configuration.new
+
+  class << self
+    attr_reader :configuration
+
+    def configure
+      if block_given?
+        yield configuration
+      else
+        raise InlineSvg::Configuration::Invalid.new('Please set configuration options with a block')
+      end
+    end
+  end
 end

data/spec/asset_file_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../lib/inline_svg/finds_asset_paths'
+require_relative '../lib/inline_svg/asset_file'
+
+describe InlineSvg::AssetFile do
+  it "reads data from a file, after qualifying a full path" do
+    example_svg_path = File.expand_path(__FILE__, 'files/example.svg')
+    expect(InlineSvg::FindsAssetPaths).to receive(:by_filename).with('some filename').and_return example_svg_path
+
+    expect(InlineSvg::AssetFile.named('some filename')).to include('This is a test')
+  end
+
+  it "complains when the file cannot be read" do
+    allow(InlineSvg::FindsAssetPaths).to receive(:by_filename).and_return('/this/path/does/not/exist')
+
+    expect do
+      InlineSvg::AssetFile.named('some missing file')
+    end.to raise_error InlineSvg::AssetFile::FileNotFound
+  end
+
+  it "complains when the file path was not found" do
+    allow(InlineSvg::FindsAssetPaths).to receive(:by_filename).and_return(nil)
+
+    expect do
+      InlineSvg::AssetFile.named('some missing file')
+    end.to raise_error InlineSvg::AssetFile::FileNotFound
+  end
+end

data/spec/files/example.svg

@@ -1,3 +1,3 @@
 <svg xmlns="http://www.w3.org/2000/svg"
      xml:lang="en"
-     role="presentation"><!-- This is a comment --></svg>
+     role="presentation"><!-- This is a test comment --></svg>

data/spec/finds_asset_paths_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../lib/inline_svg'
+
+describe InlineSvg::FindsAssetPaths do
+  it "returns fully qualified file paths from Sprockets" do
+    sprockets = double('SprocketsDouble')
+
+    expect(sprockets).to receive(:find_asset).with('some-file').
+      and_return('/full/path/to/some-file')
+
+    InlineSvg.configure do |config|
+      config.asset_finder = sprockets
+    end
+
+    expect(InlineSvg::FindsAssetPaths.by_filename('some-file')).to eq '/full/path/to/some-file'
+  end
+end

data/spec/helpers/inline_svg_spec.rb

@@ -1,62 +1,83 @@
 require 'inline_svg'
-require 'nokogiri'
-require 'active_support/core_ext'
 
 describe InlineSvg::ActionView::Helpers do
 
-  before(:each) do
-    # Mock Rails
-    unless defined?(::Rails)
-      @mocked_rails_class = true
-      class ::Rails
+  let(:helper) { ( Class.new { include InlineSvg::ActionView::Helpers } ).new }
+
+  describe "#inline_svg" do
+    
+    context "when passed the name of an SVG that does not exist" do
+      it "returns an empty, html safe, SVG document as a placeholder" do
+        allow(InlineSvg::AssetFile).to receive(:named).with('some-missing-file').and_raise(InlineSvg::AssetFile::FileNotFound.new)
+        output = helper.inline_svg('some-missing-file')
+        expect(output).to eq "<svg><!-- SVG file not found: 'some-missing-file' --></svg>"
+        expect(output).to be_html_safe
       end
     end
-    # Allow mock Rails to give a path to our SVG
-    path_mocker = double("path_mocker")
-    allow(path_mocker).to receive(:join) { 'spec/files/example.svg' }
-    allow(Rails).to receive(:root) { path_mocker }
-  end
 
-  let(:mock_helper) { ( Class.new { include InlineSvg::ActionView::Helpers } ).new }
+    context "when passed an existing SVG file" do
 
-  describe "#inline_svg" do
-    
-    context 'when passed a SVG file' do
-      
-      subject { mock_helper.inline_svg( 'mocked_path' ).strip }
-      let(:example_svg) {
-<<-SVG.sub(/\n$/, '')
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
+      context "and no options" do
+        it "returns a html safe version of the file's contents" do
+          example_file = <<-SVG.sub(/\n$/, '')
+  <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
+  SVG
+          allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(example_file)
+          expect(helper.inline_svg('some-file')).to eq example_file
+        end
+      end
+
+      context "and the 'title' option" do
+        it "adds the title node to the SVG output" do
+          input_svg = <<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
+SVG
+          expected_output = <<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><title>A title</title></svg>
 SVG
-      }
-      
-      it { is_expected.to eql example_svg }
-      
-      context 'and title and description options' do
-      
-        subject { mock_helper.inline_svg( 'mocked_path', title: 'A title', desc: 'A desc' ).strip }
-        let(:example_svg) {
-<<-SVG.sub(/\n$/, '')
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --><title>A title</title>
-<desc>A desc</desc></svg>
-SVG
-        }
-        
-        it { is_expected.to eql example_svg }
-      
+          allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
+          expect(helper.inline_svg('some-file', title: 'A title')).to eq expected_output
+        end
       end
 
-      context 'and the "nocomment" option' do
+      context "and the 'desc' option" do
+        it "adds the description node to the SVG output" do
+          input_svg = <<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
+SVG
+          expected_output = <<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><desc>A description</desc></svg>
+SVG
+          allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
+          expect(helper.inline_svg('some-file', desc: 'A description')).to eq expected_output
+        end
+      end
 
-        subject { mock_helper.inline_svg( 'mocked_path', nocomment: true).strip }
-        let(:example_svg) {
-<<-SVG.sub(/\n$/, '')
+      context "and the 'nocomment' option" do
+        it "strips comments and other unknown/unsafe nodes from the output" do
+          input_svg = <<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
+SVG
+          expected_output = <<-SVG.sub(/\n$/, '')
 <svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>
 SVG
-        }
-
-        it { is_expected.to eql example_svg }
+          allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
+          expect(helper.inline_svg('some-file', nocomment: true)).to eq expected_output
+        end
+      end
 
+      context "and all options" do
+        it "applies all expected transformations to the output" do
+          input_svg = <<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
+SVG
+          expected_output = <<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><title>A title</title>
+<desc>A description</desc></svg>
+SVG
+          allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
+          expect(helper.inline_svg('some-file', title: 'A title', desc: 'A description', nocomment: true)).to eq expected_output
+        end
       end
     end
   end

data/spec/inline_svg_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../lib/inline_svg'
+
+describe InlineSvg do
+  describe "configuration" do
+    context "when a block is not given" do
+      it "complains" do
+        expect do
+          InlineSvg.configure
+        end.to raise_error(InlineSvg::Configuration::Invalid)
+      end
+    end
+
+    context "asset finder" do
+      it "allows an asset finder to be assigned" do
+        sprockets = double('SomethingLikeSprockets', find_asset: 'some asset')
+        InlineSvg.configure do |config|
+          config.asset_finder = sprockets
+        end
+
+        expect(InlineSvg.configuration.asset_finder).to eq sprockets
+      end
+
+      it "complains when the provided asset finder does not implement #find_asset" do
+        expect do
+          InlineSvg.configure do |config|
+            config.asset_finder = 'Not a real asset finder'
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /asset finder.*find_asset/i)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-31 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 4.1.9
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.9
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,10 +110,15 @@ files:
 - inline_svg.gemspec
 - lib/inline_svg.rb
 - lib/inline_svg/action_view/helpers.rb
+- lib/inline_svg/asset_file.rb
+- lib/inline_svg/finds_asset_paths.rb
 - lib/inline_svg/railtie.rb
 - lib/inline_svg/version.rb
+- spec/asset_file_spec.rb
 - spec/files/example.svg
+- spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
+- spec/inline_svg_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -133,10 +139,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Embeds an SVG document, inline.
 test_files:
+- spec/asset_file_spec.rb
 - spec/files/example.svg
+- spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
+- spec/inline_svg_spec.rb