inline_svg 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9be789332e6a5c01a7cde946e537fe0cf1fb368fb1c1b102538298bb65791c21
-  data.tar.gz: fbb837594c30b641df85c6d5919737d14a8fc4dc9fe9fcd522ef403af913a0aa
+  metadata.gz: 66214539304b60e87e9263afb26531212492ca77957e9ce8cf89d015cef86239
+  data.tar.gz: 6ab9cb3d75a9f268728600edb48bf27b3503145c80f1addabe8bc484c88af545
 SHA512:
-  metadata.gz: d4181b4e48b2a5ef634dc80504e52bef5304bd7dc1c1cf44a710ed88653d175d7825640b557150033ce45c5d2bcf32f5c4fb906fffd14d9f41a62aedc2eb1254
-  data.tar.gz: 9e79590cf289ec30fb7b773fddd676df83822cc174af6fc6cd0bc0e38536c760a6584937c7795509b8e924384e6da9e86e45742781106697e1808961683264ee
+  metadata.gz: 1f8d4642dff97eb5bfc358fd1ce2257d5113a6f232c02f4ecd847007ee861b2537748539c689e5e2e67297951fdd158594740a754d49469cbd8c13c72002c290
+  data.tar.gz: 1b5cb2dfd5e7067d64ec0cc3449c2aeeead3a39cab42f8d51db33609a296478511fa9a24a965e32b10d7f01c98e5cb4b2ef8a6268fb055a7ad968068499eccd6

data/CHANGELOG.md

@@ -3,6 +3,19 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
+
+Nothing.
+
+## [1.10.0] - 2024-09-03
+### Added
+- Support for Shakapacker.  [#158](https://github.com/jamesmartin/inline_svg/pull/158). Thanks, [@tagliala](https://github.com/tagliala)
+
+### Fixed
+- Fixed documentation typos.  [#157](https://github.com/jamesmartin/inline_svg/pull/157). Thanks, [@tagliala](https://github.com/tagliala)
+- Fixed missing ActiveSupport require.  [#152](https://github.com/jamesmartin/inline_svg/pull/152). Thanks, [@xymbol](https://github.com/xymbol)
+- Remove wrapping whitespace from SVG tags.  [#150](https://github.com/jamesmartin/inline_svg/pull/150). Thanks, [@fredboyle](https://github.com/fredboyle)
+
+## [1.9.0] - 2023-03-29
 ### Added
 - A new option: `view_box` adds a `viewBox` attribute to the SVG. [#142](https://github.com/jamesmartin/inline_svg/pull/142). Thanks [@sunny](https://github.com/sunny)
 
@@ -208,7 +221,7 @@ transformations](https://github.com/jamesmartin/inline_svg/blob/master/README.md
 
 ## [0.5.1] - 2015-03-30
 ### Warning
-** This version is NOT comaptible with Sprockets >= 3. **
+** This version is NOT compatible with Sprockets >= 3. **
 
 ### Fixed
 - Support for ActiveSupport (and hence, Rails) 4.2.x. Thanks, @jmarceli.
@@ -249,7 +262,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.8.0...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v1.9.0...HEAD
+[1.9.0]: https://github.com/jamesmartin/inline_svg/compare/v1.8.0...v1.9.0
 [1.8.0]: https://github.com/jamesmartin/inline_svg/compare/v1.7.2...v1.8.0
 [1.7.2]: https://github.com/jamesmartin/inline_svg/compare/v1.7.1...v1.7.2
 [1.7.1]: https://github.com/jamesmartin/inline_svg/compare/v1.7.0...v1.7.1

data/lib/inline_svg/transform_pipeline.rb

@@ -4,7 +4,7 @@ module InlineSvg
       document = Nokogiri::XML::Document.parse(svg_file)
       Transformations.lookup(transform_params).reduce(document) do |doc, transformer|
         transformer.transform(doc)
-      end.to_html
+      end.to_html.strip
     end
   end
 end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "1.9.0"
+  VERSION = "1.10.0"
 end

data/lib/inline_svg/webpack_asset_finder.rb

@@ -6,22 +6,31 @@ module InlineSvg
 
     def initialize(filename)
       @filename = filename
-      manifest_lookup = Webpacker.manifest.lookup(@filename)
+      manifest_lookup = asset_helper.manifest.lookup(@filename)
       @asset_path =  manifest_lookup.present? ? URI(manifest_lookup).path : ""
     end
 
     def pathname
       return if @asset_path.blank?
 
-      if Webpacker.dev_server.running?
+      if asset_helper.dev_server.running?
         dev_server_asset(@asset_path)
-      elsif Webpacker.config.public_path.present?
-        File.join(Webpacker.config.public_path, @asset_path)
+      elsif asset_helper.config.public_path.present?
+        File.join(asset_helper.config.public_path, @asset_path)
       end
     end
 
     private
 
+    def asset_helper
+      @asset_helper ||=
+        if defined?(::Shakapacker)
+          ::Shakapacker
+        else
+          ::Webpacker
+        end
+    end
+
     def dev_server_asset(file_path)
       asset = fetch_from_dev_server(file_path)
 
@@ -38,8 +47,8 @@ module InlineSvg
     end
 
     def fetch_from_dev_server(file_path)
-      http = Net::HTTP.new(Webpacker.dev_server.host, Webpacker.dev_server.port)
-      http.use_ssl = Webpacker.dev_server.https?
+      http = Net::HTTP.new(asset_helper.dev_server.host, asset_helper.dev_server.port)
+      http.use_ssl = asset_helper.dev_server.protocol == "https"
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
       http.request(Net::HTTP::Get.new(file_path)).body

data/lib/inline_svg.rb

@@ -11,6 +11,7 @@ require "inline_svg/io_resource"
 
 require "inline_svg/railtie" if defined?(Rails)
 require 'active_support'
+require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string'
 require 'nokogiri'
 

data/spec/helpers/inline_svg_spec.rb

@@ -86,9 +86,7 @@ describe InlineSvg::ActionView::Helpers do
             with('missing.svg').
             and_raise(InlineSvg::AssetFile::FileNotFound.new)
 
-          fallback_file = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>
-SVG
+          fallback_file = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('fallback.svg').and_return(fallback_file)
           expect(helper.send(helper_method, 'missing.svg', fallback: 'fallback.svg')).to eq fallback_file
         end
@@ -99,9 +97,7 @@ SVG
 
       context "and no options" do
         it "returns a html safe version of the file's contents" do
-          example_file = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>
-SVG
+          example_file = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(example_file)
           expect(helper.send(helper_method, 'some-file')).to eq example_file
         end
@@ -109,12 +105,8 @@ SVG
 
       context "and the 'title' option" do
         it "adds the title node to the SVG output" do
-          input_svg = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
-SVG
-          expected_output = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><title>A title</title></svg>
-SVG
+          input_svg = '<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>'
+          expected_output = '<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><title>A title</title></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
           expect(helper.send(helper_method, 'some-file', title: 'A title')).to eq expected_output
         end
@@ -122,12 +114,8 @@ SVG
 
       context "and the 'desc' option" do
         it "adds the description node to the SVG output" do
-          input_svg = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
-SVG
-          expected_output = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><desc>A description</desc></svg>
-SVG
+          input_svg = '<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>'
+          expected_output = '<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><desc>A description</desc></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
           expect(helper.send(helper_method, 'some-file', desc: 'A description')).to eq expected_output
         end
@@ -135,12 +123,8 @@ SVG
 
       context "and the 'nocomment' option" do
         it "strips comments and other unknown/unsafe nodes from the output" do
-          input_svg = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>
-SVG
-          expected_output = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>
-SVG
+          input_svg = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>'
+          expected_output = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
           expect(helper.send(helper_method, 'some-file', nocomment: true)).to eq expected_output
         end
@@ -148,12 +132,8 @@ SVG
 
       context "and the 'aria_hidden' option" do
         it "sets 'aria-hidden=true' in the output" do
-          input_svg = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>
-SVG
-          expected_output = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en" aria-hidden="true"></svg>
-SVG
+          input_svg = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>'
+          expected_output = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en" aria-hidden="true"></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
           expect(helper.send(helper_method, 'some-file', aria_hidden: true)).to eq expected_output
         end
@@ -161,12 +141,8 @@ SVG
 
       context "and all options" do
         it "applies all expected transformations to the output" do
-          input_svg = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>
-SVG
-          expected_output = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><title>A title</title><desc>A description</desc></svg>
-SVG
+          input_svg = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>'
+          expected_output = '<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><title>A title</title><desc>A description</desc></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
           expect(helper.send(helper_method, 'some-file', title: 'A title', desc: 'A description', nocomment: true)).to eq expected_output
         end
@@ -184,12 +160,8 @@ SVG
         end
 
         it "applies custm transformations to the output" do
-          input_svg = <<-SVG
-<svg></svg>
-SVG
-          expected_output = <<-SVG
-<svg custom="some value"></svg>
-SVG
+          input_svg = '<svg></svg>'
+          expected_output = '<svg custom="some value"></svg>'
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
           expect(helper.send(helper_method, 'some-file', custom: 'some value')).to eq expected_output
         end
@@ -212,7 +184,7 @@ SVG
 
             allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
 
-            expect(helper.send(helper_method, 'some-file')).to eq "<svg custom=\"default value\"></svg>\n"
+            expect(helper.send(helper_method, 'some-file')).to eq "<svg custom=\"default value\"></svg>"
           end
         end
 
@@ -222,7 +194,7 @@ SVG
 
             allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
 
-            expect(helper.send(helper_method, 'some-file', custom: 'some value')).to eq "<svg custom=\"some value\"></svg>\n"
+            expect(helper.send(helper_method, 'some-file', custom: 'some value')).to eq "<svg custom=\"some value\"></svg>"
           end
         end
       end
@@ -251,17 +223,27 @@ SVG
         expect(InlineSvg::IOResource).to receive(:===).with(io_object).and_return(true)
         expect(InlineSvg::IOResource).to receive(:read).with(io_object).and_return("<svg><!-- Test IO --></svg>")
         output = helper.send(helper_method, io_object)
-        expect(output).to eq "<svg><!-- Test IO --></svg>\n"
+        expect(output).to eq "<svg><!-- Test IO --></svg>"
         expect(output).to be_html_safe
       end
 
       it 'return valid svg for file' do
         output = helper.send(helper_method, File.new(file_path))
-        expect(output).to eq "<svg xmlns=\"http://www.w3.org/2000/svg\" xml:lang=\"en\" role=\"presentation\"><!-- This is a test comment --></svg>\n"
+        expect(output).to eq "<svg xmlns=\"http://www.w3.org/2000/svg\" xml:lang=\"en\" role=\"presentation\"><!-- This is a test comment --></svg>"
         expect(output).to be_html_safe
       end
 
     end
+    
+    context 'default output' do
+      it "returns an SVG tag without any pre or post whitespace characters" do
+        input_svg = '<svg></svg>'
+        
+        allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
+        
+        expect(helper.send(helper_method, 'some-file')).to eq "<svg></svg>"
+      end
+    end
   end
 
   describe '#inline_svg' do

data/spec/inline_svg_spec.rb

@@ -47,7 +47,7 @@ describe InlineSvg do
     end
 
     context "configuring a custom asset file" do
-      it "falls back to the built-in asset file implementation by deafult" do
+      it "falls back to the built-in asset file implementation by default" do
         expect(InlineSvg.configuration.asset_file).to eq(InlineSvg::AssetFile)
       end
 

data/spec/webpack_asset_finder_spec.rb

@@ -10,4 +10,14 @@ describe InlineSvg::WebpackAssetFinder do
       expect(described_class.find_asset('some-file').pathname).to be_nil
     end
   end
+
+  context "when Shakapacker is defined" do
+    it "uses the new spelling" do
+      stub_const('Rails', double('Rails').as_null_object)
+      stub_const('Shakapacker', double('Shakapacker').as_null_object)
+      expect(::Shakapacker.manifest).to receive(:lookup).with('some-file').and_return(nil)
+
+      expect(described_class.find_asset('some-file').pathname).to be_nil
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - James Martin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Embeds an SVG document, inline.