inline_svg 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f130c4a553b022e11c90d79588f9b7047db3cf1
-  data.tar.gz: bedb58bb1f1533cf9df734190fff189ea66d60d5
+  metadata.gz: 531cbb7571d96241484ed757b76633654f153f41
+  data.tar.gz: 0266d52dd58d93a2f10ce83b13ccdb74ae638292
 SHA512:
-  metadata.gz: 9f33f0e86a12858fcac918aeb5ebd10fbc1639062db98beece15fa778942383ec07febefe67276d726311fd13c8c82e8905958f0b07fb96cd38da148c2bf596f
-  data.tar.gz: b3706ac43d6532d07a62b9acdd857dbe08c53dfc352ebcf7a93932fab30faef3a8e378c06e4ca8fc74ae366856a4ab009d6de43ad8b40674be51e3c48dd257fa
+  metadata.gz: 0fda6e949182512f4cf42d7301511b056d9db7ce22b0ac56f44e22d74c0ebbc2c2d6c291b1b0e01a407f307105bcf4be0f6a4b60d84714875ddc4ddce6c166f0
+  data.tar.gz: 97343026ab606662d7010e53695156b555c339362ecde1f1d4d35c07c8fff271141f8236fe465b93684110cd7da7acd86538a33ada8070b0f33640c2a03adb83

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing
 
+## [0.9.1] - 2016-07-18
+### Fixed
+- Provide a hint when the .svg extension is omitted from the filename
+  [#41](https://github.com/jamesmartin/inline_svg/issues/41)
+
 ## [0.9.0] - 2016-06-30
 ### Fixed
 - Hashed IDs for desc and title elements in aria-labeled-by attribute
@@ -96,7 +101,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/v0.9.0...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.9.1...HEAD
+[0.9.1]: https://github.com/jamesmartin/inline_svg/compare/v0.8.0...v0.9.1
 [0.9.0]: https://github.com/jamesmartin/inline_svg/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/jamesmartin/inline_svg/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/jamesmartin/inline_svg/compare/v0.6.4...v0.7.0

data/README.md

@@ -101,16 +101,24 @@ accessibility (a11y) attributes to your embedded SVG:
 
 Here's an example:
 
-```haml
-= inline_svg('iconmonstr-glasses-12-icon.svg', class: 'medium-blue', title: 'An SVG', desc: 'This is my SVG. There are many like it. You get the picture', aria: true)
+```erb
+<%=
+  inline_svg('iconmonstr-glasses-12-icon.svg',
+    aria: true, title: 'An SVG',
+    desc: 'This is my SVG. There are many like it. You get the picture')
+%>
 ```
 
 ```xml
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" x="0px" y="0px" width="512px" height="512px" viewBox="0 0 512 512" style="enable-background:new 0 0 512 512;" xml:space="preserve" data-default-transform="some-default" class="medium-blue" role="img" aria-labelledby="bx6wix4t9pxpwxnohrhrmms3wexsw2o m439lk7mopdzmouktv2o689pl59wmd2"><title id="bx6wix4t9pxpwxnohrhrmms3wexsw2o">An SVG</title>
-    <path id="glasses-12" d="M358.045,135.833c-19.531,0-40.788,2.213-58.256,8.433c-39.195,14.216-47.93,14.393-87.594,0  c-17.452-6.22-38.742-8.433-58.256-8.433c-33.831,0-71.584,6.639-103.939,15.071v30.704c14.535,4.384,18.34,10.763,20.654,25.624  c6.538,41.953,21.542,83.102,87.007,83.102c52.137,0,69.538-38.785,81.055-74.594c5.851-18.189,28.55-18.658,34.484-0.251  c11.551,35.858,28.868,74.845,81.106,74.845c65.48,0,80.502-41.148,87.023-83.102c2.312-14.861,6.119-21.24,20.67-25.624v-30.704  C429.611,142.472,391.875,135.833,358.045,135.833z M226.16,201.307c-8.885,37.317-23.336,71.859-68.499,71.859  c-56.664,0-68.214-32.665-73.395-85.363c-1.24-12.816,1.576-17.846,3.789-20.512c16.261-19.472,102.178-18.691,130.661-1.584  C226.864,170.603,232.161,176.018,226.16,201.307z M427.7,187.803c-5.163,52.698-16.731,85.363-73.394,85.363  c-45.131,0-59.598-34.542-68.482-71.859c-6.02-25.289-0.721-30.704,7.443-35.6c28.582-17.167,114.449-17.812,130.66,1.584  C426.158,169.957,428.975,174.986,427.7,187.803z M344.65,168.557c26.42-4.023,56.965-0.52,65.078,9.213  c1.777,2.129,4.023,6.152,3.018,16.403c-0.536,5.432-1.156,10.578-1.928,15.457C403.795,184.114,385.822,170.435,344.65,168.557z   M101.165,209.63c-0.771-4.879-1.408-10.025-1.944-15.457c-1.006-10.251,1.257-14.274,3.034-16.403  c8.131-9.732,38.675-13.236,65.096-9.213C126.177,170.435,108.206,184.114,101.165,209.63z M376.166,342.923  C356.418,392.177,272.631,380.106,256,349.26c-16.647,30.847-100.418,42.917-120.167-6.337c9.924,8.685,26.873,11.483,39.798,9.589  c38.105-5.582,35.054-41.592,61.693-41.592c7.292,0,13.897,3.034,18.675,7.963c4.777-4.929,11.366-7.963,18.658-7.963  c26.639,0,23.604,36.01,61.693,41.592C349.277,354.406,366.226,351.607,376.166,342.923z"></path>
-    <desc id="m439lk7mopdzmouktv2o689pl59wmd2">This is my SVG. There are many like it. You get the picture</desc></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" \
+  role="img" aria-labelledby="bx6wix4t9pxpwxnohrhrmms3wexsw2o m439lk7mopdzmouktv2o689pl59wmd2">
+  <title id="bx6wix4t9pxpwxnohrhrmms3wexsw2o">An SVG</title>
+  <desc id="m439lk7mopdzmouktv2o689pl59wmd2">This is my SVG. There are many like it. You get the picture</desc>
+</svg>
 ```
 
+***Note:*** The title and desc `id` attributes generated for, and referenced by, `aria-labelled-by` are one-way digests based on the value of the title and desc elements and an optional "salt" value using the SHA1 algorithm. This reduces the chance of `inline_svg` embedding elements inside the SVG with `id` attributes that clash with other elements elsewhere on the page.
+
 ## Custom Transformations
 
 The transformation behavior of `inline_svg` can be customized by creating custom transformation classes.

data/inline_svg.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "rspec_junit_formatter", "0.2.2"
 
-  spec.add_runtime_dependency "activesupport", ">= 4.0.4"
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
   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

@@ -12,11 +12,17 @@ module InlineSvg
             InlineSvg::AssetFile.named filename
           end
         rescue InlineSvg::AssetFile::FileNotFound
-          return "<svg><!-- SVG file not found: '#{filename}' --></svg>".html_safe
+          return "<svg><!-- SVG file not found: '#{filename}' #{extension_hint(filename)}--></svg>".html_safe
         end
 
         InlineSvg::TransformPipeline.generate_html_from(svg_file, transform_params).html_safe
       end
+
+      private
+
+      def extension_hint(filename)
+        filename.ends_with?(".svg") ? "" : "(Try adding .svg to your filename) "
+      end
     end
   end
 end

data/lib/inline_svg/{random_id_generator.rb → id_generator.rb}

@@ -1,5 +1,5 @@
 module InlineSvg
-  class RandomIdGenerator
+  class IdGenerator
     def self.generate(base, salt)
       bytes = Digest::SHA1.digest("#{base}-#{salt}")
       Digest.hexencode(bytes).to_i(16).to_s(36)

data/lib/inline_svg/transform_pipeline.rb

@@ -11,5 +11,5 @@ end
 
 require 'nokogiri'
 require 'loofah'
-require 'inline_svg/random_id_generator'
+require 'inline_svg/id_generator'
 require 'inline_svg/transform_pipeline/transformations'

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

@@ -26,9 +26,9 @@ module InlineSvg::TransformPipeline::Transformations
 
     def element_id_for(base, element)
       if element['id'].nil?
-        InlineSvg::RandomIdGenerator.generate(base, value)
+        InlineSvg::IdGenerator.generate(base, value)
       else
-        InlineSvg::RandomIdGenerator.generate(element['id'], value)
+        InlineSvg::IdGenerator.generate(element['id'], value)
       end
     end
   end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/spec/helpers/inline_svg_spec.rb

@@ -17,11 +17,23 @@ describe InlineSvg::ActionView::Helpers 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>"
+        allow(InlineSvg::AssetFile).to receive(:named).
+          with('some-missing-file.svg').
+          and_raise(InlineSvg::AssetFile::FileNotFound.new)
+
+        output = helper.inline_svg('some-missing-file.svg')
+        expect(output).to eq "<svg><!-- SVG file not found: 'some-missing-file.svg' --></svg>"
         expect(output).to be_html_safe
       end
+
+      it "gives a helpful hint when no .svg extension is provided in the filename" do
+        allow(InlineSvg::AssetFile).to receive(:named).
+          with('missing-file-with-no-extension').
+          and_raise(InlineSvg::AssetFile::FileNotFound.new)
+
+        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
     end
 
     context "when passed an existing SVG file" do

data/spec/id_generator_spec.rb

@@ -0,0 +1,8 @@
+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")
+  end
+end

data/spec/transformation_pipeline/transformations/aria_attributes_spec.rb

@@ -15,7 +15,7 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
       document = Nokogiri::XML::Document.parse('<svg><title>Some title</title>Some document</svg>')
       transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value("some-salt")
 
-      expect(InlineSvg::RandomIdGenerator).to receive(:generate).with("title", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("title", "some-salt").
         and_return("some-id")
 
       expect(transformation.transform(document).to_html).to eq(
@@ -27,7 +27,7 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
       document = Nokogiri::XML::Document.parse('<svg><desc>Some description</desc>Some document</svg>')
       transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value("some-salt")
 
-      expect(InlineSvg::RandomIdGenerator).to receive(:generate).with("desc", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("desc", "some-salt").
         and_return("some-id")
 
       expect(transformation.transform(document).to_html).to eq(
@@ -39,9 +39,9 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes 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")
 
-      expect(InlineSvg::RandomIdGenerator).to receive(:generate).with("title", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("title", "some-salt").
         and_return("some-id")
-      expect(InlineSvg::RandomIdGenerator).to receive(:generate).with("desc", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("desc", "some-salt").
         and_return("some-other-id")
 
       expect(transformation.transform(document).to_html).to eq(
@@ -53,9 +53,9 @@ describe InlineSvg::TransformPipeline::Transformations::AriaAttributes 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")
 
-      expect(InlineSvg::RandomIdGenerator).to receive(:generate).with("my-title", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("my-title", "some-salt").
         and_return("some-id")
-      expect(InlineSvg::RandomIdGenerator).to receive(:generate).with("my-desc", "some-salt").
+      expect(InlineSvg::IdGenerator).to receive(:generate).with("my-desc", "some-salt").
         and_return("some-other-id")
 
       expect(transformation.transform(document).to_html).to eq(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.4
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.4
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -126,9 +126,9 @@ files:
 - lib/inline_svg/action_view/helpers.rb
 - lib/inline_svg/asset_file.rb
 - lib/inline_svg/finds_asset_paths.rb
+- lib/inline_svg/id_generator.rb
 - lib/inline_svg/io_resource.rb
 - lib/inline_svg/railtie.rb
-- lib/inline_svg/random_id_generator.rb
 - lib/inline_svg/static_asset_finder.rb
 - lib/inline_svg/transform_pipeline.rb
 - lib/inline_svg/transform_pipeline/transformations.rb
@@ -149,9 +149,9 @@ files:
 - spec/files/example.svg
 - 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/random_id_generator_spec.rb
 - spec/transformation_pipeline/transformations/aria_attributes_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
 - spec/transformation_pipeline/transformations/height_spec.rb
@@ -190,9 +190,9 @@ test_files:
 - spec/files/example.svg
 - 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/random_id_generator_spec.rb
 - spec/transformation_pipeline/transformations/aria_attributes_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
 - spec/transformation_pipeline/transformations/height_spec.rb

data/spec/random_id_generator_spec.rb

@@ -1,8 +0,0 @@
-require_relative '../lib/inline_svg/random_id_generator'
-
-describe InlineSvg::RandomIdGenerator do
-  it "generates a hexencoded ID based on a salt" do
-    expect(InlineSvg::RandomIdGenerator.generate("some-base", "some-salt")).
-      to eq("ksiuuy1jduycacqpoj5smn2kyt9iv02")
-  end
-end