inline_svg 1.0.0 → 1.10.0

data/lib/inline_svg/io_resource.rb

@@ -1,16 +1,17 @@
 module InlineSvg
   module IOResource
-    def self.=== object
+    def self.===(object)
       object.is_a?(IO) || object.is_a?(StringIO)
     end
 
-    def self.default_for object
+    def self.default_for(object)
       case object
       when StringIO then ''
       when IO then 1
       end
     end
-    def self.read object
+
+    def self.read(object)
       start = object.pos
       str = object.read
       object.seek start

data/lib/inline_svg/propshaft_asset_finder.rb

@@ -0,0 +1,16 @@
+module InlineSvg
+  class PropshaftAssetFinder
+    def self.find_asset(filename)
+      new(filename)
+    end
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def pathname
+      asset_path = ::Rails.application.assets.load_path.find(@filename)
+      asset_path.path unless asset_path.nil?
+    end
+  end
+end

data/lib/inline_svg/railtie.rb

@@ -10,9 +10,14 @@ module InlineSvg
 
     config.after_initialize do |app|
       InlineSvg.configure do |config|
-        # In default Rails apps, this will be a fully operational
-        # Sprockets::Environment instance
-        config.asset_finder = app.instance_variable_get(:@assets)
+        # Configure the asset_finder:
+        # Only set this when a user-configured asset finder has not been
+        # configured already.
+        if config.asset_finder.nil?
+          # In default Rails apps, this will be a fully operational
+          # Sprockets::Environment instance
+          config.asset_finder = app.instance_variable_get(:@assets)
+        end
       end
     end
   end

data/lib/inline_svg/static_asset_finder.rb

@@ -1,7 +1,9 @@
+require "pathname"
+
 # Naive fallback asset finder for when sprockets >= 3.0 &&
 # config.assets.precompile = false
 # Thanks to @ryanswood for the original code:
-# https://github.com/AbleHealth/inline_svg/commit/661bbb3bef7d1b4bd6ccd63f5f018305797b9509
+# https://github.com/jamesmartin/inline_svg/commit/661bbb3bef7d1b4bd6ccd63f5f018305797b9509
 module InlineSvg
   class StaticAssetFinder
     def self.find_asset(filename)
@@ -14,7 +16,8 @@ module InlineSvg
 
     def pathname
       if ::Rails.application.config.assets.compile
-        ::Rails.application.assets[@filename].pathname
+        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/aria_attributes.rb

@@ -1,34 +1,31 @@
 module InlineSvg::TransformPipeline::Transformations
   class AriaAttributes < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css("svg")
+      with_svg(doc) do |svg|
+        # Add role
+        svg["role"] = "img"
 
-      # Add role
-      svg["role"] = "img"
+        # Build aria-labelledby string
+        aria_elements = []
+        svg.search("title").each do |element|
+          aria_elements << element["id"] = element_id_for("title", element)
+        end
 
-      # Build aria-labelledby string
-      aria_elements = []
-      doc.search("svg title").each do |element|
-        aria_elements << element['id'] = element_id_for("title", element)
-      end
-
-      doc.search("svg desc").each do |element|
-        aria_elements << element['id'] = element_id_for("desc", element)
-      end
+        svg.search("desc").each do |element|
+          aria_elements << element["id"] = element_id_for("desc", element)
+        end
 
-      if aria_elements.any?
-        svg["aria-labelledby"] = aria_elements.join(" ")
+        if aria_elements.any?
+          svg["aria-labelledby"] = aria_elements.join(" ")
+        end
       end
-
-      doc
     end
 
     def element_id_for(base, element)
-      if element['id'].nil?
+      if element["id"].nil?
         InlineSvg::IdGenerator.generate(base, element.text)
       else
-        InlineSvg::IdGenerator.generate(element['id'], element.text)
+        InlineSvg::IdGenerator.generate(element["id"], element.text)
       end
     end
   end

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

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

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

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

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

@@ -1,12 +1,11 @@
 module InlineSvg::TransformPipeline::Transformations
   class ClassAttribute < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css "svg"
-      classes = (svg["class"] || "").split(" ")
-      classes << value
-      svg["class"] = classes.join(" ")
-      doc
+      with_svg(doc) do |svg|
+        classes = (svg["class"] || "").split(" ")
+        classes << value
+        svg["class"] = classes.join(" ")
+      end
     end
   end
 end

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

@@ -1,12 +1,11 @@
 module InlineSvg::TransformPipeline::Transformations
   class DataAttributes < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      with_valid_hash_from(self.value).each_pair do |name, data|
-        svg["data-#{dasherize(name)}"] = data
+      with_svg(doc) do |svg|
+        with_valid_hash_from(self.value).each_pair do |name, data|
+          svg["data-#{dasherize(name)}"] = data
+        end
       end
-      doc
     end
 
     private

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

@@ -1,12 +1,13 @@
 module InlineSvg::TransformPipeline::Transformations
   class Description < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      node = Nokogiri::XML::Node.new('desc', doc)
-      node.content = value
-      doc.search('svg desc').each { |node| node.remove }
-      doc.at_css('svg').prepend_child(node)
-      doc
+      with_svg(doc) do |svg|
+        node = Nokogiri::XML::Node.new("desc", doc)
+        node.content = value
+
+        svg.search("desc").each { |node| node.remove }
+        svg.prepend_child(node)
+      end
     end
   end
 end

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

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class Height < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['height'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["height"] = self.value
+      end
     end
   end
 end

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

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class IdAttribute < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['id'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["id"] = self.value
+      end
     end
   end
 end

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

@@ -2,11 +2,11 @@ module InlineSvg::TransformPipeline
   module Transformations
     class NoComment < Transformation
       def transform(doc)
-        doc = Nokogiri::XML::Document.parse(doc.to_html)
-        doc.xpath("//comment()").each do |comment|
-          comment.remove
+        with_svg(doc) do |svg|
+          svg.xpath("//comment()").each do |comment|
+            comment.remove
+          end
         end
-        doc
       end
     end
   end

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

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class PreserveAspectRatio < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['preserveAspectRatio'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["preserveAspectRatio"] = self.value
+      end
     end
   end
 end

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

@@ -1,11 +1,10 @@
 module InlineSvg::TransformPipeline::Transformations
   class Size < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['width'] = width_of(self.value)
-      svg['height'] = height_of(self.value)
-      doc
+      with_svg(doc) do |svg|
+        svg["width"] = width_of(self.value)
+        svg["height"] = height_of(self.value)
+      end
     end
 
     def width_of(value)

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

@@ -0,0 +1,11 @@
+module InlineSvg::TransformPipeline::Transformations
+  class StyleAttribute < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        styles = svg["style"].to_s.split(";")
+        styles << value
+        svg["style"] = styles.join(";")
+      end
+    end
+  end
+end

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

@@ -1,12 +1,13 @@
 module InlineSvg::TransformPipeline::Transformations
   class Title < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      node = Nokogiri::XML::Node.new('title', doc)
-      node.content = value
-      doc.search('svg title').each { |node| node.remove }
-      doc.at_css('svg').prepend_child(node)
-      doc
+      with_svg(doc) do |svg|
+        node = Nokogiri::XML::Node.new("title", doc)
+        node.content = value
+
+        svg.search("title").each { |node| node.remove }
+        svg.prepend_child(node)
+      end
     end
   end
 end

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

@@ -13,6 +13,19 @@ module InlineSvg::TransformPipeline::Transformations
     def transform(*)
       raise "#transform should be implemented by subclasses of Transformation"
     end
+
+    # Parses a document and yields the contained SVG nodeset to the given block
+    # if it exists.
+    #
+    # Returns a Nokogiri::XML::Document.
+    def with_svg(doc)
+      doc = Nokogiri::XML::Document.parse(
+        doc.to_html(encoding: "UTF-8"), nil, "UTF-8"
+      )
+      svg = doc.at_css "svg"
+      yield svg if svg && block_given?
+      doc
+    end
   end
 
   class NullTransformation < Transformation

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

@@ -1,10 +1,9 @@
 module InlineSvg::TransformPipeline::Transformations
   class Width < Transformation
     def transform(doc)
-      doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['width'] = self.value
-      doc
+      with_svg(doc) do |svg|
+        svg["width"] = self.value
+      end
     end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -6,13 +6,16 @@ module InlineSvg::TransformPipeline::Transformations
       desc: { transform: Description, priority: 2 },
       title: { transform: Title, priority: 3 },
       aria: { transform: AriaAttributes },
+      aria_hidden: { transform: AriaHiddenAttribute },
       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
 
@@ -38,8 +41,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
@@ -72,12 +78,15 @@ end
 require 'inline_svg/transform_pipeline/transformations/transformation'
 require 'inline_svg/transform_pipeline/transformations/no_comment'
 require 'inline_svg/transform_pipeline/transformations/class_attribute'
+require 'inline_svg/transform_pipeline/transformations/style_attribute'
 require 'inline_svg/transform_pipeline/transformations/title'
 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"

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.0.0"
+  VERSION = "1.10.0"
 end

data/lib/inline_svg/webpack_asset_finder.rb

@@ -0,0 +1,60 @@
+module InlineSvg
+  class WebpackAssetFinder
+    def self.find_asset(filename)
+      new(filename)
+    end
+
+    def initialize(filename)
+      @filename = 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 asset_helper.dev_server.running?
+        dev_server_asset(@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)
+
+      begin
+        Tempfile.new(file_path).tap do |file|
+          file.binmode
+          file.write(asset)
+          file.rewind
+        end
+      rescue StandardError => e
+        Rails.logger.error "[inline_svg] Error creating tempfile for #{@filename}: #{e}"
+        raise
+      end
+    end
+
+    def fetch_from_dev_server(file_path)
+      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
+    rescue StandardError => e
+      Rails.logger.error "[inline_svg] Error fetching #{@filename} from webpack-dev-server: #{e}"
+      raise
+    end
+  end
+end

data/lib/inline_svg.rb

@@ -1,12 +1,17 @@
 require "inline_svg/version"
 require "inline_svg/action_view/helpers"
 require "inline_svg/asset_file"
+require "inline_svg/cached_asset_file"
 require "inline_svg/finds_asset_paths"
+require "inline_svg/propshaft_asset_finder"
 require "inline_svg/static_asset_finder"
+require "inline_svg/webpack_asset_finder"
 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/object/blank'
 require 'active_support/core_ext/string'
 require 'nokogiri'
 
@@ -14,24 +19,48 @@ module InlineSvg
   class Configuration
     class Invalid < ArgumentError; end
 
-    attr_reader :asset_finder, :custom_transformations
+    attr_reader :asset_file, :asset_finder, :custom_transformations, :svg_not_found_css_class
 
     def initialize
       @custom_transformations = {}
+      @asset_file = InlineSvg::AssetFile
+      @svg_not_found_css_class = nil
+      @raise_on_file_not_found = false
     end
 
-    def asset_finder=(finder)
-      if finder.respond_to?(:find_asset)
-        @asset_finder = finder
-      else
-        # fallback to a naive static asset finder (sprokects >= 3.0 &&
-        # config.assets.precompile = false
-        # See: https://github.com/jamesmartin/inline_svg/issues/25
-        @asset_finder = InlineSvg::StaticAssetFinder
+    def asset_file=(custom_asset_file)
+      begin
+        method = custom_asset_file.method(:named)
+        if method.arity == 1
+          @asset_file = custom_asset_file
+        else
+          raise InlineSvg::Configuration::Invalid.new("asset_file should implement the #named method with arity 1")
+        end
+      rescue NameError
+        raise InlineSvg::Configuration::Invalid.new("asset_file should implement the #named method")
       end
+    end
+
+    def asset_finder=(finder)
+      @asset_finder = if finder.respond_to?(:find_asset)
+                        finder
+                      elsif finder.class.name == "Propshaft::Assembly"
+                        InlineSvg::PropshaftAssetFinder
+                      else
+                        # fallback to a naive static asset finder
+                        # (sprokects >= 3.0 && config.assets.precompile = false
+                        # See: https://github.com/jamesmartin/inline_svg/issues/25
+                        InlineSvg::StaticAssetFinder
+                      end
       asset_finder
     end
 
+    def svg_not_found_css_class=(css_class)
+      if css_class.present? && css_class.is_a?(String)
+        @svg_not_found_css_class = css_class
+      end
+    end
+
     def add_custom_transformation(options)
       if incompatible_transformation?(options.fetch(:transform))
         raise InlineSvg::Configuration::Invalid.new("#{options.fetch(:transform)} should implement the .create_with_value and #transform methods")
@@ -39,6 +68,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/spec/cached_asset_file_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'pathname'
+require_relative '../lib/inline_svg'
+
+describe InlineSvg::CachedAssetFile do
+  let(:fixture_path) { Pathname.new(File.expand_path("../files/static_assets", __FILE__)) }
+
+  it "loads assets under configured paths" do
+    known_document = File.read(fixture_path.join("assets0", "known-document.svg"))
+
+    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path.join("assets0"))
+
+    expect(asset_loader.named("known-document.svg")).to eq(known_document)
+  end
+
+  it "does not include assets outside of configured paths" do
+    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path.join("assets0"))
+
+    expect(fixture_path.join("assets1", "other-document.svg")).to be_file
+    expect do
+      asset_loader.named("other-document.svg")
+    end.to raise_error InlineSvg::AssetFile::FileNotFound
+  end
+
+  it "differentiates two files with the same name" do
+    known_document_0 = File.read(fixture_path.join("assets0", "known-document.svg"))
+    known_document_1 = File.read(fixture_path.join("assets1", "known-document.svg"))
+
+    expect(known_document_0).not_to eq(known_document_1)
+
+    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path)
+
+    expect(known_document_0).to eq(asset_loader.named("assets0/known-document.svg"))
+    expect(known_document_1).to eq(asset_loader.named("assets1/known-document.svg"))
+  end
+
+  it "chooses the closest exact matching file when similar files exist in the same path" do
+    known_document = File.read(fixture_path.join("assets0", "known-document.svg"))
+    known_document_2 = File.read(fixture_path.join("assets0", "known-document-two.svg"))
+
+    expect(known_document).not_to eq(known_document_2)
+
+    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path.join("assets0"), filters: /\.svg/)
+
+    expect(asset_loader.named("known-document")).to eq(known_document)
+    expect(asset_loader.named("known-document-two")).to eq(known_document_2)
+  end
+
+  it "filters wanted files by simple string matching" do
+    known_document_0 = File.read(fixture_path.join("assets0", "known-document.svg"))
+    known_document_1 = File.read(fixture_path.join("assets1", "known-document.svg"))
+
+    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path, filters: "assets1")
+
+    expect do
+      asset_loader.named("assets0/known-document.svg")
+    end.to raise_error InlineSvg::AssetFile::FileNotFound
+
+    expect(known_document_1).to eq(asset_loader.named("assets1/known-document.svg"))
+  end
+
+  it "filters wanted files by regex matching" do
+    known_document_1 = File.read(fixture_path.join("assets1", "known-document.svg"))
+
+    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path, filters: ["assets1", /\.svg/])
+
+    expect do
+      asset_loader.named("assets1/some-file.txt")
+    end.to raise_error InlineSvg::AssetFile::FileNotFound
+
+    expect(known_document_1).to eq(asset_loader.named("assets1/known-document.svg"))
+  end
+end

data/spec/files/static_assets/assets0/known-document-two.svg

@@ -0,0 +1 @@
+<svg>other interesting content</svg>