inline_svg 0.11.0 → 1.7.2

data/spec/id_generator_spec.rb

@@ -1,8 +1,10 @@
 require_relative '../lib/inline_svg/id_generator'
 
 describe InlineSvg::IdGenerator do
-  it "generates a hexencoded ID based on a salt" do
-    expect(InlineSvg::IdGenerator.generate("some-base", "some-salt")).
-      to eq("ksiuuy1jduycacqpoj5smn2kyt9iv02")
+  it "generates a hexencoded ID based on a salt and a random value" do
+    randomizer = -> { "some-random-value" }
+
+    expect(InlineSvg::IdGenerator.generate("some-base", "some-salt", randomness: randomizer)).
+      to eq("at2c17mkqnvopy36iccxspura7wnreqf")
   end
 end

data/spec/inline_svg_spec.rb

@@ -13,6 +13,10 @@ class MyInvalidCustomTransformInstance
   def self.create_with_value(value); end
 end
 
+class MyCustomAssetFile
+  def self.named(filename); end
+end
+
 describe InlineSvg do
   describe "configuration" do
     context "when a block is not given" do
@@ -42,6 +46,50 @@ describe InlineSvg do
       end
     end
 
+    context "configuring a custom asset file" do
+      it "falls back to the built-in asset file implementation by deafult" do
+        expect(InlineSvg.configuration.asset_file).to eq(InlineSvg::AssetFile)
+      end
+
+      it "adds a collaborator that meets the interface specification" do
+        InlineSvg.configure do |config|
+          config.asset_file = MyCustomAssetFile
+        end
+
+        expect(InlineSvg.configuration.asset_file).to eq MyCustomAssetFile
+      end
+
+      it "rejects a collaborator that does not conform to the interface spec" do
+        bad_asset_file = double("bad_asset_file")
+
+        expect do
+          InlineSvg.configure do |config|
+            config.asset_file = bad_asset_file
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /asset_file should implement the #named method/)
+      end
+
+      it "rejects a collaborator that implements the correct interface with the wrong arity" do
+        bad_asset_file = double("bad_asset_file", named: nil)
+
+        expect do
+          InlineSvg.configure do |config|
+            config.asset_file = bad_asset_file
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /asset_file should implement the #named method with arity 1/)
+      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,10 +12,10 @@ 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>')
-      transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value("some-salt")
+      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-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("title", "Some title").
         and_return("some-id")
 
       expect(transformation.transform(document).to_html).to eq(
@@ -24,10 +24,10 @@ 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>')
-      transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value("some-salt")
+      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-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("desc", "Some description").
         and_return("some-id")
 
       expect(transformation.transform(document).to_html).to eq(
@@ -36,12 +36,12 @@ 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>')
-      transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value("some-salt")
+      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-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("title", "Some title").
         and_return("some-id")
-      expect(InlineSvg::IdGenerator).to receive(:generate).with("desc", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("desc", "Some description").
         and_return("some-other-id")
 
       expect(transformation.transform(document).to_html).to eq(
@@ -50,12 +50,12 @@ 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>')
-      transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value("some-salt")
+      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-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("my-title", "Some title").
         and_return("some-id")
-      expect(InlineSvg::IdGenerator).to receive(:generate).with("my-desc", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("my-desc", "Some description").
         and_return("some-other-id")
 
       expect(transformation.transform(document).to_html).to eq(

data/spec/transformation_pipeline/transformations/aria_hidden_attribute_spec.rb

@@ -0,0 +1,12 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::AriaHiddenAttribute do
+  it "adds an aria-hidden='true' attribute to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::AriaHiddenAttribute.create_with_value(true)
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg aria-hidden=\"true\">Some document</svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations/data_attributes_spec.rb

@@ -10,6 +10,24 @@ describe InlineSvg::TransformPipeline::Transformations::DataAttributes do
     )
   end
 
+  it "dasherizes the data attribute name" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::DataAttributes.create_with_value({some_name: "value"})
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg data-some-name=\"value\">Some document</svg>\n"
+    )
+  end
+
+  it "dasherizes a data attribute name with multiple parts" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::DataAttributes.create_with_value({some_other_name: "value"})
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg data-some-other-name=\"value\">Some document</svg>\n"
+    )
+  end
+
   context "when multiple data attributes are supplied" do
     it "adds data attributes to the SVG for each supplied value" do
       document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')

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/style_attribute_spec.rb

@@ -0,0 +1,26 @@
+require "inline_svg/transform_pipeline"
+
+describe InlineSvg::TransformPipeline::Transformations::ClassAttribute do
+  it "adds a style attribute to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation =
+      InlineSvg::TransformPipeline::Transformations::StyleAttribute
+        .create_with_value("padding: 10px")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg style=\"padding: 10px\">Some document</svg>\n"
+    )
+  end
+
+  it "preserves existing style attributes on a SVG document" do
+    xml = '<svg style="fill: red">Some document</svg>'
+    document = Nokogiri::XML::Document.parse(xml)
+    transformation =
+      InlineSvg::TransformPipeline::Transformations::StyleAttribute
+        .create_with_value("padding: 10px")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg style=\"fill: red;padding: 10px\">Some document</svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations/title_spec.rb

@@ -27,4 +27,13 @@ describe InlineSvg::TransformPipeline::Transformations::Title do
       "<svg><title>Some Title</title></svg>\n"
     )
   end
+
+  it "handles non-ASCII characters" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Title.create_with_value("åäö")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg><title>åäö</title>Some document</svg>\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

data/spec/transformation_pipeline/transformations_spec.rb

@@ -15,6 +15,7 @@ describe InlineSvg::TransformPipeline::Transformations do
       transformations = InlineSvg::TransformPipeline::Transformations.lookup(
         nocomment: 'irrelevant',
         class: 'irrelevant',
+        style: 'irrelevant',
         title: 'irrelevant',
         desc: 'irrelevant',
         size: 'irrelevant',
@@ -24,11 +25,13 @@ describe InlineSvg::TransformPipeline::Transformations do
         data: 'irrelevant',
         preserve_aspect_ratio: 'irrelevant',
         aria: 'irrelevant',
+        aria_hidden: "true"
       )
 
       expect(transformations.map(&:class)).to match_array([
         InlineSvg::TransformPipeline::Transformations::NoComment,
         InlineSvg::TransformPipeline::Transformations::ClassAttribute,
+        InlineSvg::TransformPipeline::Transformations::StyleAttribute,
         InlineSvg::TransformPipeline::Transformations::Title,
         InlineSvg::TransformPipeline::Transformations::Description,
         InlineSvg::TransformPipeline::Transformations::Size,
@@ -37,7 +40,8 @@ describe InlineSvg::TransformPipeline::Transformations do
         InlineSvg::TransformPipeline::Transformations::IdAttribute,
         InlineSvg::TransformPipeline::Transformations::DataAttributes,
         InlineSvg::TransformPipeline::Transformations::PreserveAspectRatio,
-        InlineSvg::TransformPipeline::Transformations::AriaAttributes
+        InlineSvg::TransformPipeline::Transformations::AriaAttributes,
+        InlineSvg::TransformPipeline::Transformations::AriaHiddenAttribute
       ])
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.7.2
 platform: ruby
 authors:
 - James Martin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,47 +81,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: loofah
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.6'
 description: Get an SVG into your view and then style it with CSS.
 email:
 - inline_svg@jmrtn.com
@@ -129,17 +129,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/integration_test.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- circle.yml
 - inline_svg.gemspec
 - lib/inline_svg.rb
 - lib/inline_svg/action_view/helpers.rb
 - lib/inline_svg/asset_file.rb
+- lib/inline_svg/cached_asset_file.rb
 - lib/inline_svg/finds_asset_paths.rb
 - lib/inline_svg/id_generator.rb
 - lib/inline_svg/io_resource.rb
@@ -148,6 +152,8 @@ files:
 - lib/inline_svg/transform_pipeline.rb
 - lib/inline_svg/transform_pipeline/transformations.rb
 - lib/inline_svg/transform_pipeline/transformations/aria_attributes.rb
+- lib/inline_svg/transform_pipeline/transformations/aria_hidden.rb
+- lib/inline_svg/transform_pipeline/transformations/aria_hidden_attribute.rb
 - lib/inline_svg/transform_pipeline/transformations/class_attribute.rb
 - lib/inline_svg/transform_pipeline/transformations/data_attributes.rb
 - lib/inline_svg/transform_pipeline/transformations/description.rb
@@ -156,18 +162,28 @@ files:
 - lib/inline_svg/transform_pipeline/transformations/no_comment.rb
 - lib/inline_svg/transform_pipeline/transformations/preserve_aspect_ratio.rb
 - lib/inline_svg/transform_pipeline/transformations/size.rb
+- lib/inline_svg/transform_pipeline/transformations/style_attribute.rb
 - lib/inline_svg/transform_pipeline/transformations/title.rb
 - lib/inline_svg/transform_pipeline/transformations/transformation.rb
 - lib/inline_svg/transform_pipeline/transformations/width.rb
 - lib/inline_svg/version.rb
+- lib/inline_svg/webpack_asset_finder.rb
 - spec/asset_file_spec.rb
+- spec/cached_asset_file_spec.rb
 - spec/files/example.svg
+- spec/files/static_assets/assets0/known-document-two.svg
+- spec/files/static_assets/assets0/known-document.svg
+- spec/files/static_assets/assets0/some-document.svg
+- spec/files/static_assets/assets1/known-document.svg
+- spec/files/static_assets/assets1/other-document.svg
+- spec/files/static_assets/assets1/some-file.txt
 - spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
 - spec/id_generator_spec.rb
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
 - spec/transformation_pipeline/transformations/aria_attributes_spec.rb
+- spec/transformation_pipeline/transformations/aria_hidden_attribute_spec.rb
 - spec/transformation_pipeline/transformations/class_attribute_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
 - spec/transformation_pipeline/transformations/description_spec.rb
@@ -175,14 +191,16 @@ files:
 - spec/transformation_pipeline/transformations/id_attribute_spec.rb
 - spec/transformation_pipeline/transformations/preserve_aspect_ratio_spec.rb
 - spec/transformation_pipeline/transformations/size_spec.rb
+- spec/transformation_pipeline/transformations/style_attribute_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
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -197,20 +215,27 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Embeds an SVG document, inline.
 test_files:
 - spec/asset_file_spec.rb
+- spec/cached_asset_file_spec.rb
 - spec/files/example.svg
+- spec/files/static_assets/assets0/known-document-two.svg
+- spec/files/static_assets/assets0/known-document.svg
+- spec/files/static_assets/assets0/some-document.svg
+- spec/files/static_assets/assets1/known-document.svg
+- spec/files/static_assets/assets1/other-document.svg
+- spec/files/static_assets/assets1/some-file.txt
 - spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
 - spec/id_generator_spec.rb
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
 - spec/transformation_pipeline/transformations/aria_attributes_spec.rb
+- spec/transformation_pipeline/transformations/aria_hidden_attribute_spec.rb
 - spec/transformation_pipeline/transformations/class_attribute_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
 - spec/transformation_pipeline/transformations/description_spec.rb
@@ -218,6 +243,8 @@ test_files:
 - spec/transformation_pipeline/transformations/id_attribute_spec.rb
 - spec/transformation_pipeline/transformations/preserve_aspect_ratio_spec.rb
 - spec/transformation_pipeline/transformations/size_spec.rb
+- spec/transformation_pipeline/transformations/style_attribute_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