inline_svg 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0744ec1e4d10792a793f1214439367b2d94fd3b
-  data.tar.gz: 23dd2ee7f07558d6c2e27d97da29815bbbdc94d5
+  metadata.gz: 57995dd216d10c2510f21c3dd8c4901eddf3e3e3
+  data.tar.gz: 8a7bde8b778843e483350f3d0ee26ddb8d6d624a
 SHA512:
-  metadata.gz: 85ae8c8c0288d74353a1c6636ab731f0af647204e4c8b59460c9a76f60c872c353a3f7c25a2e6d99e44bf74b9bcb6e87e7e7df7f2c7cec086e88ca6e10e82fa5
-  data.tar.gz: a4a4059fedc579a1321471e249e290d078626a96d4a268e78911db79c496d3e39ed7bf271c04833654bd5a3ea5c3cc4f0e66f0e32a0040fc8448ba9d97dca127
+  metadata.gz: ccfc12998a8e3e64a8a1a338905673259118aaa84c6d67cd0a94ed11d4372102838a92dd4fb7f3d7a0c7e4c1b4475d627df7feb1b84090816a0ffef1fa6b424c
+  data.tar.gz: 90940b65ec989da35c2ccf3e25aaacd5d0cced3f175bb99ce55b6b5d091797a1e78d7c498011cd98427d31f10af54d12e635ed6ba55a983ef0f1529c2945cd74

data/CHANGELOG.md

@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing
 
+## [1.2.2] - 2017-07-06
+### Fixed
+- Handle malformed documents that don't contain a root SVG element
+  [#60](https://github.com/jamesmartin/inline_svg/pull/65)
+### Added
+- Add configurable CSS class to empty SVG document
+  [#67](https://github.com/jamesmartin/inline_svg/pull/67)
+
 ## [1.2.1] - 2017-05-02
 ### Fixed
 - Select most exactly matching cached asset file when multiple files match
@@ -159,7 +167,8 @@ transformations](https://github.com/jamesmartin/inline_svg/blob/master/README.md
 ### Added
 - Basic Railtie and view helper to inline SVG documents to Rails views.
 
-[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v1.2.1...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v1.2.2...HEAD
+[1.2.2]: https://github.com/jamesmartin/inline_svg/compare/v1.2.1...v1.2.2
 [1.2.1]: https://github.com/jamesmartin/inline_svg/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/jamesmartin/inline_svg/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/jamesmartin/inline_svg/compare/v1.0.1...v1.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Inline SVG
 
-[![CircleCI](https://circleci.com/gh/jamesmartin/inline_svg.svg?style=svg)](https://circleci.com/gh/jamesmartin/inline_svg)
+[![Build Status](https://travis-ci.org/jamesmartin/inline_svg.svg?branch=master)](https://travis-ci.org/jamesmartin/inline_svg)
 
 Styling a SVG document with CSS for use on the web is most reliably achieved by
 [adding classes to the document and
@@ -71,10 +71,10 @@ blue:
 }
 ```
 
-## Options 
+## Options
 
 key                     | description
-:---------------------- | :---------- 
+:---------------------- | :----------
 `id`                    | set a ID attribute on the SVG
 `class`                 | set a CSS class attribute on the SVG
 `data`                  | add data attributes to the SVG (supply as a hash)
@@ -133,10 +133,9 @@ For example, inherit from `InlineSvg::CustomTransformation` and implement the `#
 
 class MyCustomTransform < InlineSvg::CustomTransformation
   def transform(doc)
-    doc = Nokogiri::XML::Document.parse(doc.to_html)
-    svg = doc.at_css 'svg'
-    svg['custom'] = value
-    doc
+    with_svg(doc) do |svg|
+      svg["custom"] = value
+    end
   end
 end
 ```
@@ -257,6 +256,31 @@ end
 restricted to as few paths as possible, and using the filter option to further
 restrict assets to only those likely to be used by `inline_svg`.
 
+## Missing SVG Files
+
+If the specified SVG file cannot be found a helpful, empty SVG document is
+embedded into the page instead. The embedded document contains a single comment
+displaying the filename of the SVG image the helper tried to render:
+
+```html
+<svg><!-- SVG file not found: 'some-missing-file.svg' --></svg>
+```
+
+You may apply a class to this empty SVG document by specifying the following
+configuration:
+
+```rb
+InlineSvg.configure do |config|
+  config.svg_not_found_css_class = 'svg-not-found'
+end
+```
+
+Which would instead render:
+
+```html
+<svg class='svg-not-found'><!-- SVG file not found: 'some-missing-file.svg' --></svg>
+```
+
 ## Contributing
 
 1. Fork it ( [http://github.com/jamesmartin/inline_svg/fork](http://github.com/jamesmartin/inline_svg/fork) )

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+  #t.rspec_opts = "--format documentation"
+end
+task :default => :spec

data/lib/inline_svg.rb

@@ -15,11 +15,12 @@ module InlineSvg
   class Configuration
     class Invalid < ArgumentError; end
 
-    attr_reader :asset_file, :asset_finder, :custom_transformations
+    attr_reader :asset_file, :asset_finder, :custom_transformations, :svg_not_found_css_class
 
     def initialize
       @custom_transformations = {}
       @asset_file = InlineSvg::AssetFile
+      @svg_not_found_css_class = nil
     end
 
     def asset_file=(custom_asset_file)
@@ -47,6 +48,12 @@ module InlineSvg
       asset_finder
     end
 
+    def svg_not_found_css_class=(css_class)
+      if css_class.present? && css_class.is_a?(String)
+        @svg_not_found_css_class = css_class
+      end
+    end
+
     def add_custom_transformation(options)
       if incompatible_transformation?(options.fetch(:transform))
         raise InlineSvg::Configuration::Invalid.new("#{options.fetch(:transform)} should implement the .create_with_value and #transform methods")

data/lib/inline_svg/action_view/helpers.rb

@@ -12,7 +12,11 @@ module InlineSvg
             configured_asset_file.named filename
           end
         rescue InlineSvg::AssetFile::FileNotFound
-          return "<svg><!-- SVG file not found: '#{filename}' #{extension_hint(filename)}--></svg>".html_safe
+          if InlineSvg.configuration.svg_not_found_css_class.nil?
+            return "<svg><!-- SVG file not found: '#{filename}' #{extension_hint(filename)}--></svg>".html_safe
+          else
+            return "<svg class='#{InlineSvg.configuration.svg_not_found_css_class}'><!-- SVG file not found: '#{filename}' #{extension_hint(filename)}--></svg>".html_safe
+          end
         end
 
         InlineSvg::TransformPipeline.generate_html_from(svg_file, transform_params).html_safe

data/lib/inline_svg/transform_pipeline/transformations/aria_attributes.rb

@@ -1,34 +1,31 @@
 module InlineSvg::TransformPipeline::Transformations
   class AriaAttributes < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css("svg")
+      with_svg(doc) do |svg|
+        # Add role
+        svg["role"] = "img"
 
-      # Add role
-      svg["role"] = "img"
+        # Build aria-labelledby string
+        aria_elements = []
+        svg.search("title").each do |element|
+          aria_elements << element["id"] = element_id_for("title", element)
+        end
 
-      # Build aria-labelledby string
-      aria_elements = []
-      doc.search("svg title").each do |element|
-        aria_elements << element['id'] = element_id_for("title", element)
-      end
-
-      doc.search("svg desc").each do |element|
-        aria_elements << element['id'] = element_id_for("desc", element)
-      end
+        svg.search("desc").each do |element|
+          aria_elements << element["id"] = element_id_for("desc", element)
+        end
 
-      if aria_elements.any?
-        svg["aria-labelledby"] = aria_elements.join(" ")
+        if aria_elements.any?
+          svg["aria-labelledby"] = aria_elements.join(" ")
+        end
       end
-
-      doc
     end
 
     def element_id_for(base, element)
-      if element['id'].nil?
+      if element["id"].nil?
         InlineSvg::IdGenerator.generate(base, element.text)
       else
-        InlineSvg::IdGenerator.generate(element['id'], element.text)
+        InlineSvg::IdGenerator.generate(element["id"], element.text)
       end
     end
   end

data/lib/inline_svg/transform_pipeline/transformations/class_attribute.rb

@@ -1,12 +1,11 @@
 module InlineSvg::TransformPipeline::Transformations
   class ClassAttribute < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css "svg"
-      classes = (svg["class"] || "").split(" ")
-      classes << value
-      svg["class"] = classes.join(" ")
-      doc
+      with_svg(doc) do |svg|
+        classes = (svg["class"] || "").split(" ")
+        classes << value
+        svg["class"] = classes.join(" ")
+      end
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations/data_attributes.rb

@@ -1,12 +1,11 @@
 module InlineSvg::TransformPipeline::Transformations
   class DataAttributes < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      with_valid_hash_from(self.value).each_pair do |name, data|
-        svg["data-#{dasherize(name)}"] = data
+      with_svg(doc) do |svg|
+        with_valid_hash_from(self.value).each_pair do |name, data|
+          svg["data-#{dasherize(name)}"] = data
+        end
       end
-      doc
     end
 
     private

data/lib/inline_svg/transform_pipeline/transformations/description.rb

@@ -1,12 +1,13 @@
 module InlineSvg::TransformPipeline::Transformations
   class Description < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      node = Nokogiri::XML::Node.new('desc', doc)
-      node.content = value
-      doc.search('svg desc').each { |node| node.remove }
-      doc.at_css('svg').prepend_child(node)
-      doc
+      with_svg(doc) do |svg|
+        node = Nokogiri::XML::Node.new("desc", doc)
+        node.content = value
+
+        svg.search("desc").each { |node| node.remove }
+        svg.prepend_child(node)
+      end
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations/height.rb

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class Height < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['height'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["height"] = self.value
+      end
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations/id_attribute.rb

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class IdAttribute < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['id'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["id"] = self.value
+      end
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations/no_comment.rb

@@ -2,11 +2,11 @@ module InlineSvg::TransformPipeline
   module Transformations
     class NoComment < Transformation
       def transform(doc)
-        doc = Nokogiri::XML::Document.parse(doc.to_html)
-        doc.xpath("//comment()").each do |comment|
-          comment.remove
+        with_svg(doc) do |svg|
+          svg.xpath("//comment()").each do |comment|
+            comment.remove
+          end
         end
-        doc
       end
     end
   end

data/lib/inline_svg/transform_pipeline/transformations/preserve_aspect_ratio.rb

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class PreserveAspectRatio < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['preserveAspectRatio'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["preserveAspectRatio"] = self.value
+      end
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations/size.rb

@@ -1,11 +1,10 @@
 module InlineSvg::TransformPipeline::Transformations
   class Size < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['width'] = width_of(self.value)
-      svg['height'] = height_of(self.value)
-      doc
+      with_svg(doc) do |svg|
+        svg["width"] = width_of(self.value)
+        svg["height"] = height_of(self.value)
+      end
     end
 
     def width_of(value)

data/lib/inline_svg/transform_pipeline/transformations/title.rb

@@ -1,12 +1,13 @@
 module InlineSvg::TransformPipeline::Transformations
   class Title < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      node = Nokogiri::XML::Node.new('title', doc)
-      node.content = value
-      doc.search('svg title').each { |node| node.remove }
-      doc.at_css('svg').prepend_child(node)
-      doc
+      with_svg(doc) do |svg|
+        node = Nokogiri::XML::Node.new("title", doc)
+        node.content = value
+
+        svg.search("title").each { |node| node.remove }
+        svg.prepend_child(node)
+      end
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations/transformation.rb

@@ -13,6 +13,17 @@ module InlineSvg::TransformPipeline::Transformations
     def transform(*)
       raise "#transform should be implemented by subclasses of Transformation"
     end
+
+    # Parses a document and yields the contained SVG nodeset to the given block
+    # if it exists.
+    #
+    # Returns a Nokogiri::XML::Document.
+    def with_svg(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      svg = doc.at_css "svg"
+      yield svg if svg && block_given?
+      doc
+    end
   end
 
   class NullTransformation < Transformation

data/lib/inline_svg/transform_pipeline/transformations/width.rb

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class Width < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['width'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["width"] = self.value
+      end
     end
   end
 end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/spec/helpers/inline_svg_spec.rb

@@ -14,8 +14,12 @@ describe InlineSvg::ActionView::Helpers do
   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
+      after(:each) do
+        InlineSvg.reset_configuration!
+      end
+
       it "returns an empty, html safe, SVG document as a placeholder" do
         allow(InlineSvg::AssetFile).to receive(:named).
           with('some-missing-file.svg').
@@ -34,6 +38,20 @@ describe InlineSvg::ActionView::Helpers do
         output = helper.inline_svg('missing-file-with-no-extension')
         expect(output).to eq "<svg><!-- SVG file not found: 'missing-file-with-no-extension' (Try adding .svg to your filename) --></svg>"
       end
+
+      it "allows the CSS class on the empty SVG document to be changed" do
+        InlineSvg.configure do |config|
+          config.svg_not_found_css_class = 'missing-svg'
+        end
+
+        allow(InlineSvg::AssetFile).to receive(:named).
+          with('some-other-missing-file.svg').
+          and_raise(InlineSvg::AssetFile::FileNotFound.new)
+
+        output = helper.inline_svg('some-other-missing-file.svg')
+        expect(output).to eq "<svg class='missing-svg'><!-- SVG file not found: 'some-other-missing-file.svg' --></svg>"
+        expect(output).to be_html_safe
+      end
     end
 
     context "when passed an existing SVG file" do

data/spec/inline_svg_spec.rb

@@ -80,6 +80,16 @@ describe InlineSvg do
       end
     end
 
+    context "configuring the default svg-not-found class" do
+      it "sets the class name" do
+        InlineSvg.configure do |config|
+          config.svg_not_found_css_class = 'missing-svg'
+        end
+
+        expect(InlineSvg.configuration.svg_not_found_css_class).to eq 'missing-svg'
+      end
+    end
+
     context "configuring custom transformation" do
       it "allows a custom transformation to be added" do
         InlineSvg.configure do |config|

data/spec/transformation_pipeline/transformations/aria_attributes_spec.rb

@@ -1,8 +1,8 @@
-require 'inline_svg/transform_pipeline'
+require "inline_svg/transform_pipeline"
 
 describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
   it "adds a role attribute to the SVG document" do
-    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    document = Nokogiri::XML::Document.parse("<svg>Some document</svg>")
     transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value({})
 
     expect(transformation.transform(document).to_html).to eq(
@@ -12,7 +12,7 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
 
   context "aria-labelledby attribute" do
     it "adds 'title' when a title element is present" do
-      document = Nokogiri::XML::Document.parse('<svg><title>Some title</title>Some document</svg>')
+      document = Nokogiri::XML::Document.parse("<svg><title>Some title</title>Some document</svg>")
       transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value(true)
 
       expect(InlineSvg::IdGenerator).to receive(:generate).with("title", "Some title").
@@ -24,7 +24,7 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
     end
 
     it "adds 'desc' when a description element is present" do
-      document = Nokogiri::XML::Document.parse('<svg><desc>Some description</desc>Some document</svg>')
+      document = Nokogiri::XML::Document.parse("<svg><desc>Some description</desc>Some document</svg>")
       transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value(true)
 
       expect(InlineSvg::IdGenerator).to receive(:generate).with("desc", "Some description").
@@ -36,7 +36,7 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
     end
 
     it "adds both 'desc' and 'title' when title and description elements are present" do
-      document = Nokogiri::XML::Document.parse('<svg><title>Some title</title><desc>Some description</desc>Some document</svg>')
+      document = Nokogiri::XML::Document.parse("<svg><title>Some title</title><desc>Some description</desc>Some document</svg>")
       transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value(true)
 
       expect(InlineSvg::IdGenerator).to receive(:generate).with("title", "Some title").
@@ -50,7 +50,7 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
     end
 
     it "uses existing IDs when they exist" do
-      document = Nokogiri::XML::Document.parse('<svg><title id="my-title">Some title</title><desc id="my-desc">Some description</desc>Some document</svg>')
+      document = Nokogiri::XML::Document.parse("<svg><title id='my-title'>Some title</title><desc id='my-desc'>Some description</desc>Some document</svg>")
       transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value(true)
 
       expect(InlineSvg::IdGenerator).to receive(:generate).with("my-title", "Some title").

data/spec/transformation_pipeline/transformations/height_spec.rb

@@ -9,4 +9,13 @@ describe InlineSvg::TransformPipeline::Transformations::Height do
       "<svg height=\"5%\">Some document</svg>\n"
     )
   end
+
+  it "handles documents without SVG root elements" do
+    document = Nokogiri::XML::Document.parse("<foo>bar</foo><svg>Some document</svg>")
+    transformation = InlineSvg::TransformPipeline::Transformations::Height.create_with_value("5%")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<foo>bar</foo>\n"
+    )
+  end
 end

data/spec/transformation_pipeline/transformations/transformation_spec.rb

@@ -0,0 +1,39 @@
+require 'inline_svg'
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::Transformation do
+  context "#with_svg" do
+    it "returns a Nokogiri::XML::Document representing the parsed document fragment" do
+      document = Nokogiri::XML::Document.parse("<svg>Some document</svg>")
+
+      transformation = InlineSvg::TransformPipeline::Transformations::Transformation.new(:irrelevant)
+      expect(transformation.with_svg(document).to_html).to eq(
+        "<svg>Some document</svg>\n"
+      )
+    end
+
+    it "yields to the block when the document contains an SVG element" do
+      document = Nokogiri::XML::Document.parse("<svg>Some document</svg>")
+      svg = document.at_css("svg")
+
+      transformation = InlineSvg::TransformPipeline::Transformations::Transformation.new(:irrelevant)
+
+      returned_document = nil
+      expect do |b|
+        returned_document = transformation.with_svg(document, &b)
+      end.to yield_control
+
+      expect(returned_document.to_s).to match(/<svg>Some document<\/svg>/)
+    end
+
+    it "does not yield if the document does not contain an SVG element at the root" do
+      document = Nokogiri::XML::Document.parse("<foo>bar</foo><svg>Some document</svg>")
+
+      transformation = InlineSvg::TransformPipeline::Transformations::Transformation.new(:irrelevant)
+
+      expect do |b|
+        transformation.with_svg(document, &b)
+      end.not_to yield_control
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,6 +170,7 @@ files:
 - spec/transformation_pipeline/transformations/preserve_aspect_ratio_spec.rb
 - spec/transformation_pipeline/transformations/size_spec.rb
 - spec/transformation_pipeline/transformations/title_spec.rb
+- spec/transformation_pipeline/transformations/transformation_spec.rb
 - spec/transformation_pipeline/transformations/width_spec.rb
 - spec/transformation_pipeline/transformations_spec.rb
 homepage: https://github.com/jamesmartin/inline_svg
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Embeds an SVG document, inline.
@@ -220,5 +221,6 @@ test_files:
 - spec/transformation_pipeline/transformations/preserve_aspect_ratio_spec.rb
 - spec/transformation_pipeline/transformations/size_spec.rb
 - spec/transformation_pipeline/transformations/title_spec.rb
+- spec/transformation_pipeline/transformations/transformation_spec.rb
 - spec/transformation_pipeline/transformations/width_spec.rb
 - spec/transformation_pipeline/transformations_spec.rb