inline_svg 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f01fd31a0bdd3ab4c9e7ea1f60019c63f1bab406
-  data.tar.gz: 8e2166fe6324a179fa700c8754df55e94432f511
+SHA256:
+  metadata.gz: 52f5490767e351a088411f8254fb15e480581f7ea1bdff75a2215381c9fb2b78
+  data.tar.gz: f99942d0bd757bfe3dae3b9d4b0020f66241c1303c918b9d959e59b858b53135
 SHA512:
-  metadata.gz: 14fc0204ff18a3d6c7dd99d3e56d7c1f7f533ed249a4e62a8bc7bbfdcfc5bcd23854de446e200a60c0cc71c208f81a318e8191fed5de7ad679ef735fe9663f0a
-  data.tar.gz: 5d2ead12b0f658e540285c62a88b4e062f1c646385bf4488e6a22813a52b39e795a61ab0aeb9524db89a7e8672ab1e4796259433c9572f9fc881387761fad412
+  metadata.gz: 26f337f5bfc1dcd438ec10a7d4d4fd0a3404a57bc9563cb1b0ec3a0fa119f18f1fd95436be80f682a0f9d4a43dd3876fe5a79589a875192a6dc302801e486c13
+  data.tar.gz: f273c2270832a82a1edf9a964f1e52f63fc6a0f8156967e7fea29bc04b11767b70ddd3a26ef2cb152e8af0804fc769f03d28d4876ed9fb8472380f0670cab83b

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+before_install:
+  - gem install -v 2.0.1 bundler --no-rdoc --no-ri
+script: bundle exec rspec

data/CHANGELOG.md

@@ -5,6 +5,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing
 
+## [1.4.0] - 2019-04-19
+### Fixed
+- Prevent invalid XML names being generated via IdGenerator
+  [#87](https://github.com/jamesmartin/inline_svg/issues/87)
+  Thanks, [@endorfin](https://github.com/endorfin)
+
+### Added
+- Raise error on file not found (if configured)
+  [#93](https://github.com/jamesmartin/inline_svg/issues/93)
+
 ## [1.3.1] - 2017-12-14
 ### Fixed
 - Allow Ruby < 2.1 to work with `CachedAssetFile`

data/README.md

@@ -294,6 +294,15 @@ Which would instead render:
 <svg class='svg-not-found'><!-- SVG file not found: 'some-missing-file.svg' --></svg>
 ```
 
+Alternatively, `inline_svg` can be configured to raise an exception when a file
+is not found:
+
+```ruby
+InlineSvg.configure do |config|
+  config.raise_on_file_not_found = true
+end
+```
+
 ## Contributing
 
 1. Fork it ( [http://github.com/jamesmartin/inline_svg/fork](http://github.com/jamesmartin/inline_svg/fork) )

data/circle.yml

@@ -1,3 +1,3 @@
 machine:
   ruby:
-    version:  2.2.2
+    version:  2.5.0

data/inline_svg.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "rspec_junit_formatter", "0.2.2"

data/lib/inline_svg.rb

@@ -21,6 +21,7 @@ module InlineSvg
       @custom_transformations = {}
       @asset_file = InlineSvg::AssetFile
       @svg_not_found_css_class = nil
+      @raise_on_file_not_found = false
     end
 
     def asset_file=(custom_asset_file)
@@ -61,6 +62,14 @@ module InlineSvg
       @custom_transformations.merge!(Hash[ *[options.fetch(:attribute, :no_attribute), options] ])
     end
 
+    def raise_on_file_not_found=(value)
+      @raise_on_file_not_found = value
+    end
+
+    def raise_on_file_not_found?
+      !!@raise_on_file_not_found
+    end
+
     private
 
     def incompatible_transformation?(klass)

data/lib/inline_svg/action_view/helpers.rb

@@ -7,7 +7,8 @@ module InlineSvg
       def inline_svg(filename, transform_params={})
         begin
           svg_file = read_svg(filename)
-        rescue InlineSvg::AssetFile::FileNotFound
+        rescue InlineSvg::AssetFile::FileNotFound => error
+          raise error if InlineSvg.configuration.raise_on_file_not_found?
           return placeholder(filename) unless transform_params[:fallback].present?
 
           if transform_params[:fallback].present?

data/lib/inline_svg/id_generator.rb

@@ -1,3 +1,5 @@
+require 'digest'
+
 module InlineSvg
   class IdGenerator
     class Randomness
@@ -9,7 +11,7 @@ module InlineSvg
 
     def self.generate(base, salt, randomness: Randomness)
       bytes = Digest::SHA1.digest("#{base}-#{salt}-#{randomness.call}")
-      Digest.hexencode(bytes).to_i(16).to_s(36)
+      'a' + Digest.hexencode(bytes).to_i(16).to_s(36)
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -40,8 +40,11 @@ module InlineSvg::TransformPipeline::Transformations
   end
 
   def self.lookup(transform_params)
+    return [] unless transform_params.any? || custom_transformations.any?
+
+    transform_params_with_defaults = params_with_defaults(transform_params)
     all_transformations.map { |name, definition|
-      value = params_with_defaults(transform_params)[name]
+      value = transform_params_with_defaults[name]
       definition.fetch(:transform, no_transform).create_with_value(value) if value
     }.compact
   end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/spec/helpers/inline_svg_spec.rb

@@ -20,6 +20,22 @@ describe InlineSvg::ActionView::Helpers do
         InlineSvg.reset_configuration!
       end
 
+      context "and configured to raise" do
+        it "raises an exception" do
+          InlineSvg.configure do |config|
+            config.raise_on_file_not_found = true
+          end
+
+          allow(InlineSvg::AssetFile).to receive(:named).
+            with('some-missing-file.svg').
+            and_raise(InlineSvg::AssetFile::FileNotFound.new)
+
+          expect {
+            helper.inline_svg('some-missing-file.svg')
+          }.to raise_error(InlineSvg::AssetFile::FileNotFound)
+        end
+      end
+
       it "returns an empty, html safe, SVG document as a placeholder" do
         allow(InlineSvg::AssetFile).to receive(:named).
           with('some-missing-file.svg').

data/spec/id_generator_spec.rb

@@ -5,6 +5,6 @@ describe InlineSvg::IdGenerator do
     randomizer = -> { "some-random-value" }
 
     expect(InlineSvg::IdGenerator.generate("some-base", "some-salt", randomness: randomizer)).
-      to eq("t2c17mkqnvopy36iccxspura7wnreqf")
+      to eq("at2c17mkqnvopy36iccxspura7wnreqf")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2019-04-19 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
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -214,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Embeds an SVG document, inline.