inline_svg 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a2c45f1e25e4266196f0e2fc23a4384cb8513be840d2b676ae848b5be1d121
-  data.tar.gz: 8fdb1090f9037ed6c732469ffda28023e200d758533223d4bd9c85b5a20cfb72
+  metadata.gz: 9be789332e6a5c01a7cde946e537fe0cf1fb368fb1c1b102538298bb65791c21
+  data.tar.gz: fbb837594c30b641df85c6d5919737d14a8fc4dc9fe9fcd522ef403af913a0aa
 SHA512:
-  metadata.gz: c3d98f05ba0b9ea222d1b852f87f30584ba4b775d7b6848a2366341e5e85bb6c9912bc1f8441117d129db4d63506d54dcd8ef4d633a5140359e25f5a829a8a1c
-  data.tar.gz: 45eb7d5c8a30f0814e9c775924690825ad3b3ee9c3ada3c9694bf3af46499ababaa1ba81f696514e08dc09aa5ae6520094820fc528ee34fbb307b856dc16b3f4
+  metadata.gz: d4181b4e48b2a5ef634dc80504e52bef5304bd7dc1c1cf44a710ed88653d175d7825640b557150033ce45c5d2bcf32f5c4fb906fffd14d9f41a62aedc2eb1254
+  data.tar.gz: 9e79590cf289ec30fb7b773fddd676df83822cc174af6fc6cd0bc0e38536c760a6584937c7795509b8e924384e6da9e86e45742781106697e1808961683264ee

data/.github/workflows/integration_test.yml

@@ -4,11 +4,11 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
         test-branch: [rails5, rails6, rails7]
+    timeout-minutes: 20
     steps:
     - name: Checkout
       uses: actions/checkout@v2
@@ -19,9 +19,9 @@ jobs:
         ref: ${{ matrix.test-branch }}
         path: test_app
     - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.x
+        ruby-version: 2.7.7
     - name: Build local gem
       run: |
         gem install bundler

data/.github/workflows/rails_6_webpacker_integration_tests.yaml

@@ -18,10 +18,10 @@ jobs:
         repository: jamesmartin/inline_svg_test_app
         ref: ${{ matrix.test-branch }}
         path: test_app
-    - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby 3.1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.x
+        ruby-version: 3.1
     - name: Build local gem
       run: |
         gem install bundler
@@ -46,10 +46,14 @@ jobs:
       with:
         node-version: 16
       if: matrix.test-branch == 'rails6-webpacker'
+    - name: Set up Python 2.7
+      uses: actions/setup-python@v4
+      with:
+        python-version: '2.7'
     - name: Generate Webpacker config
       run: |
         cd $GITHUB_WORKSPACE/test_app
-        yarn install --check-files
+        CXXFLAGS="--std=c++17" yarn install --check-files
         bundle exec rake webpacker:compile
       if: matrix.test-branch == 'rails6-webpacker'
     - name: Test

data/.github/workflows/ruby.yml

@@ -9,10 +9,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 2.7.7
     - name: Build and test with Rake
       run: |
         gem install bundler

data/CHANGELOG.md

@@ -3,8 +3,13 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
+### 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)
 
-Nothing.
+### Fixed
+- Allow Propshaft assets to use fallbacks. [#140](https://github.com/jamesmartin/inline_svg/pull/140). Thanks, [@ohrite](https://github.com/ohrite)
+- Handling missing file when using static assets. [#141](https://github.com/jamesmartin/inline_svg/pull/141). Thanks, [@leighhalliday](https://github.com/leighhalliday)
+- Handle missing file when using Webpacker assets.
 
 ## [1.8.0] - 2022-01-09
 ### Added

data/README.md

@@ -14,7 +14,7 @@ Inline SVG supports:
 
 - [Rails 5](http://weblog.rubyonrails.org/2016/6/30/Rails-5-0-final/) (from [v0.10.0](https://github.com/jamesmartin/inline_svg/releases/tag/v0.10.0))
 - [Rails 6](https://weblog.rubyonrails.org/2019/4/24/Rails-6-0-rc1-released/) with Sprockets or Webpacker (from [v1.5.2](https://github.com/jamesmartin/inline_svg/releases/tag/v1.5.2)).
-- [Rails 7](https://weblog.rubyonrails.org/2021/12/6/Rails-7-0-rc-1-released/) (experimental)
+- [Rails 7](https://weblog.rubyonrails.org/2021/12/6/Rails-7-0-rc-1-released/)
 
 Inline SVG no longer officially supports Rails 3 or Rails 4 (although they may still work). In order to reduce the maintenance cost of this project we now follow the [Rails Maintenance Policy](https://guides.rubyonrails.org/maintenance_policy.html).
 
@@ -97,6 +97,7 @@ key                     | description
 `desc`                  | add a \<desc\> node inside the top level of the SVG document
 `nocomment`             | remove comment tags from the SVG document
 `preserve_aspect_ratio` | adds a `preserveAspectRatio` attribute to the SVG
+`view_box`              | adds a `viewBox` attribute to the SVG
 `aria`                  | adds common accessibility attributes to the SVG (see [PR #34](https://github.com/jamesmartin/inline_svg/pull/34#issue-152062674) for details)
 `aria_hidden`           | adds the `aria-hidden=true` attribute to the SVG
 `fallback`              | set fallback SVG document
@@ -114,6 +115,7 @@ inline_svg_tag(
   desc: 'Some description',
   nocomment: true,
   preserve_aspect_ratio: 'xMaxYMax meet',
+  view_box: '0 0 100 100',
   aria: true,
   aria_hidden: true,
   fallback: 'fallback-document.svg'

data/lib/inline_svg/propshaft_asset_finder.rb

@@ -9,7 +9,8 @@ module InlineSvg
     end
 
     def pathname
-      ::Rails.application.assets.load_path.find(@filename).path
+      asset_path = ::Rails.application.assets.load_path.find(@filename)
+      asset_path.path unless asset_path.nil?
     end
   end
 end

data/lib/inline_svg/static_asset_finder.rb

@@ -16,7 +16,8 @@ module InlineSvg
 
     def pathname
       if ::Rails.application.config.assets.compile
-        Pathname.new(::Rails.application.assets[@filename].filename)
+        asset = ::Rails.application.assets[@filename]
+        Pathname.new(asset.filename) if asset.present?
       else
         manifest = ::Rails.application.assets_manifest
         asset_path = manifest.assets[@filename]

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

@@ -0,0 +1,9 @@
+module InlineSvg::TransformPipeline::Transformations
+  class ViewBox < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["viewBox"] = value
+      end
+    end
+  end
+end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -10,11 +10,12 @@ module InlineSvg::TransformPipeline::Transformations
       class: { transform: ClassAttribute },
       style: { transform: StyleAttribute },
       data: { transform: DataAttributes },
-      height: { transform: Height },
       nocomment: { transform: NoComment },
       preserve_aspect_ratio: { transform: PreserveAspectRatio },
       size: { transform: Size },
       width: { transform: Width },
+      height: { transform: Height },
+      view_box: { transform: ViewBox },
     }
   end
 
@@ -83,8 +84,9 @@ require 'inline_svg/transform_pipeline/transformations/description'
 require 'inline_svg/transform_pipeline/transformations/size'
 require 'inline_svg/transform_pipeline/transformations/height'
 require 'inline_svg/transform_pipeline/transformations/width'
+require 'inline_svg/transform_pipeline/transformations/view_box'
 require 'inline_svg/transform_pipeline/transformations/id_attribute'
 require 'inline_svg/transform_pipeline/transformations/data_attributes'
 require 'inline_svg/transform_pipeline/transformations/preserve_aspect_ratio'
 require 'inline_svg/transform_pipeline/transformations/aria_attributes'
-require "inline_svg/transform_pipeline/transformations/aria_hidden_attribute"
+require "inline_svg/transform_pipeline/transformations/aria_hidden_attribute"

data/lib/inline_svg/version.rb

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

data/lib/inline_svg/webpack_asset_finder.rb

@@ -6,7 +6,8 @@ module InlineSvg
 
     def initialize(filename)
       @filename = filename
-      @asset_path = URI(Webpacker.manifest.lookup(@filename)).path
+      manifest_lookup = Webpacker.manifest.lookup(@filename)
+      @asset_path =  manifest_lookup.present? ? URI(manifest_lookup).path : ""
     end
 
     def pathname

data/lib/inline_svg.rb

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

data/spec/propshaft_asset_finder_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/inline_svg'
+
+describe InlineSvg::PropshaftAssetFinder do
+  context "when the file is not found" do
+    it "returns nil" do
+      stub_const('Rails', double('Rails').as_null_object)
+      expect(::Rails.application.assets.load_path).to receive(:find).with('some-file').and_return(nil)
+
+      expect(InlineSvg::PropshaftAssetFinder.find_asset('some-file').pathname).to be_nil
+    end
+  end
+
+  context "when the file is found" do
+    it "returns fully qualified file paths from Propshaft" do
+      stub_const('Rails', double('Rails').as_null_object)
+      asset = double('Asset')
+      expect(asset).to receive(:path).and_return(Pathname.new('/full/path/to/some-file'))
+      expect(::Rails.application.assets.load_path).to receive(:find).with('some-file').and_return(asset)
+
+      expect(InlineSvg::PropshaftAssetFinder.find_asset('some-file').pathname).to eq Pathname('/full/path/to/some-file')
+    end
+  end
+end

data/spec/static_asset_finder_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../lib/inline_svg'
+
+describe InlineSvg::StaticAssetFinder do
+  context "when the file is not found" do
+    it "returns nil" do
+      stub_const('Rails', double('Rails').as_null_object)
+      expect(::Rails.application.config.assets).to receive(:compile).and_return(true)
+
+      expect(described_class.find_asset('some-file').pathname).to be_nil
+    end
+  end
+
+  context "when the file is found" do
+    it "returns fully qualified file path from Sprockets" do
+      stub_const('Rails', double('Rails').as_null_object)
+      expect(::Rails.application.config.assets).to receive(:compile).and_return(true)
+      pathname = Pathname.new('/full/path/to/some-file')
+      asset = double('Asset')
+      expect(asset).to receive(:filename).and_return(pathname)
+      expect(::Rails.application.assets).to receive(:[]).with('some-file').and_return(asset)
+
+      expect(described_class.find_asset('some-file').pathname).to eq(pathname)
+    end
+  end
+end

data/spec/transformation_pipeline/transformations/view_box_spec.rb

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

data/spec/transformation_pipeline/transformations_spec.rb

@@ -21,6 +21,7 @@ describe InlineSvg::TransformPipeline::Transformations do
         size: 'irrelevant',
         height: 'irrelevant',
         width: 'irrelevant',
+        view_box: 'irrelevant',
         id: 'irrelevant',
         data: 'irrelevant',
         preserve_aspect_ratio: 'irrelevant',
@@ -37,6 +38,7 @@ describe InlineSvg::TransformPipeline::Transformations do
         InlineSvg::TransformPipeline::Transformations::Size,
         InlineSvg::TransformPipeline::Transformations::Height,
         InlineSvg::TransformPipeline::Transformations::Width,
+        InlineSvg::TransformPipeline::Transformations::ViewBox,
         InlineSvg::TransformPipeline::Transformations::IdAttribute,
         InlineSvg::TransformPipeline::Transformations::DataAttributes,
         InlineSvg::TransformPipeline::Transformations::PreserveAspectRatio,

data/spec/webpack_asset_finder_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/inline_svg'
+
+describe InlineSvg::WebpackAssetFinder do
+  context "when the file is not found" do
+    it "returns nil" do
+      stub_const('Rails', double('Rails').as_null_object)
+      stub_const('Webpacker', double('Webpacker').as_null_object)
+      expect(::Webpacker.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.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - James Martin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,6 +167,7 @@ files:
 - 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/view_box.rb
 - lib/inline_svg/transform_pipeline/transformations/width.rb
 - lib/inline_svg/version.rb
 - lib/inline_svg/webpack_asset_finder.rb
@@ -184,6 +185,8 @@ files:
 - spec/id_generator_spec.rb
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
+- spec/propshaft_asset_finder_spec.rb
+- spec/static_asset_finder_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
@@ -196,13 +199,15 @@ files:
 - 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/view_box_spec.rb
 - spec/transformation_pipeline/transformations/width_spec.rb
 - spec/transformation_pipeline/transformations_spec.rb
+- spec/webpack_asset_finder_spec.rb
 homepage: https://github.com/jamesmartin/inline_svg
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Embeds an SVG document, inline.
 test_files:
@@ -236,6 +241,8 @@ test_files:
 - spec/id_generator_spec.rb
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
+- spec/propshaft_asset_finder_spec.rb
+- spec/static_asset_finder_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
@@ -248,5 +255,7 @@ test_files:
 - 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/view_box_spec.rb
 - spec/transformation_pipeline/transformations/width_spec.rb
 - spec/transformation_pipeline/transformations_spec.rb
+- spec/webpack_asset_finder_spec.rb