inline_svg 0.11.0 → 1.7.2

data/inline_svg.gemspec

@@ -18,13 +18,13 @@ 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"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rubocop"
 
-  spec.add_runtime_dependency "activesupport", ">= 4.0"
-  spec.add_runtime_dependency "nokogiri", "~> 1.6", '~> 1.6'
-  spec.add_runtime_dependency "loofah", ">= 2.0"
+  spec.add_runtime_dependency "activesupport", ">= 3.0"
+  spec.add_runtime_dependency "nokogiri", ">= 1.6"
 end

data/lib/inline_svg.rb

@@ -1,8 +1,10 @@
 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/static_asset_finder"
+require "inline_svg/webpack_asset_finder"
 require "inline_svg/transform_pipeline"
 require "inline_svg/io_resource"
 
@@ -14,24 +16,46 @@ 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
+                      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 +63,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

@@ -4,21 +4,86 @@ require 'action_view/context' if defined?(Rails)
 module InlineSvg
   module ActionView
     module Helpers
+      def inline_svg_tag(filename, transform_params={})
+        with_asset_finder(InlineSvg.configuration.asset_finder) do
+          render_inline_svg(filename, transform_params)
+        end
+      end
+
+      def inline_svg_pack_tag(filename, transform_params={})
+        with_asset_finder(InlineSvg::WebpackAssetFinder) do
+          render_inline_svg(filename, transform_params)
+        end
+      end
+
       def inline_svg(filename, transform_params={})
+        ActiveSupport::Deprecation.warn(
+          '`inline_svg` is deprecated and will be removed from inline_svg 2.0 (use `inline_svg_tag` or `inline_svg_pack_tag` instead)'
+        )
+
+        render_inline_svg(filename, transform_params)
+      end
+
+      private
+
+      def backwards_compatible_html_escape(filename)
+        # html_escape_once was introduced in newer versions of Rails.
+        if ERB::Util.respond_to?(:html_escape_once)
+          ERB::Util.html_escape_once(filename)
+        else
+          ERB::Util.html_escape(filename)
+        end
+      end
+
+      def render_inline_svg(filename, transform_params={})
         begin
-          svg_file = if InlineSvg::IOResource === filename
-            InlineSvg::IOResource.read filename
-          else
-            InlineSvg::AssetFile.named filename
+          svg_file = read_svg(filename)
+        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?
+            begin
+              svg_file = read_svg(transform_params[:fallback])
+            rescue InlineSvg::AssetFile::FileNotFound
+              placeholder(filename)
+            end
           end
-        rescue InlineSvg::AssetFile::FileNotFound
-          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 read_svg(filename)
+        if InlineSvg::IOResource === filename
+          InlineSvg::IOResource.read filename
+        else
+          configured_asset_file.named filename
+        end
+      end
+
+      def placeholder(filename)
+        css_class = InlineSvg.configuration.svg_not_found_css_class
+        not_found_message = "'#{backwards_compatible_html_escape(filename)}' #{extension_hint(filename)}"
+
+        if css_class.nil?
+          return "<svg><!-- SVG file not found: #{not_found_message}--></svg>".html_safe
+        else
+          return "<svg class='#{css_class}'><!-- SVG file not found: #{not_found_message}--></svg>".html_safe
+        end
+      end
+
+      def configured_asset_file
+        InlineSvg.configuration.asset_file
+      end
+
+      def with_asset_finder(asset_finder)
+        Thread.current[:inline_svg_asset_finder] = asset_finder
+        output = yield
+        Thread.current[:inline_svg_asset_finder] = nil
+
+        output
+      end
 
       def extension_hint(filename)
         filename.ends_with?(".svg") ? "" : "(Try adding .svg to your filename) "

data/lib/inline_svg/cached_asset_file.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module InlineSvg
+  class CachedAssetFile
+    attr_reader :assets, :filters, :paths
+
+    # For each of the given paths, recursively reads each asset and stores its
+    # contents alongside the full path to the asset.
+    #
+    # paths   - One or more String representing directories on disk to search
+    #           for asset files. Note: paths are searched recursively.
+    # filters - One or more Strings/Regexps to match assets against. Only
+    #           assets matching all filters will be cached and available to load.
+    #           Note: Specifying no filters will cache every file found in
+    #           paths.
+    #
+    def initialize(paths: [], filters: [])
+      @paths = Array(paths).compact.map { |p| Pathname.new(p) }
+      @filters = Array(filters).map { |f| Regexp.new(f) }
+      @assets = @paths.reduce({}) { |assets, p| assets.merge(read_assets(assets, p)) }
+      @sorted_asset_keys = assets.keys.sort { |a, b| a.size <=> b.size }
+    end
+
+    # Public: Finds the named asset and returns the contents as a string.
+    #
+    # asset_name  - A string representing the name of the asset to load
+    #
+    # Returns: A String or raises InlineSvg::AssetFile::FileNotFound error
+    def named(asset_name)
+      assets[key_for_asset(asset_name)] or
+        raise InlineSvg::AssetFile::FileNotFound.new("Asset not found: #{asset_name}")
+    end
+
+    private
+    # Internal: Finds the key for a given asset name (using a Regex). In the
+    # event of an ambiguous asset_name matching multiple assets, this method
+    # ranks the matches by their full file path, choosing the shortest (most
+    # exact) match over all others.
+    #
+    # Returns a String representing the key for the named asset or nil if there
+    # is no match.
+    def key_for_asset(asset_name)
+      @sorted_asset_keys.find { |k| k.include?(asset_name) }
+    end
+
+    # Internal: Recursively descends through current_paths reading each file it
+    # finds and adding them to the accumulator if the fullpath of the file
+    # matches all configured filters.
+    #
+    # acc     - Hash representing the accumulated assets keyed by full path
+    # paths   - Pathname representing the current node in the directory
+    #           structure to consider
+    #
+    # Returns a Hash containing the contents of each asset, keyed by fullpath
+    # to the asset.
+    def read_assets(acc, paths)
+      paths.each_child do |child|
+        if child.directory?
+          read_assets(acc, child)
+        elsif child.readable_real?
+          acc[child.to_s] = File.read(child) if matches_all_filters?(child)
+        end
+      end
+      acc
+    end
+
+    def matches_all_filters?(path)
+      filters.all? { |f| f.match(path.to_s) }
+    end
+  end
+end

data/lib/inline_svg/finds_asset_paths.rb

@@ -6,7 +6,7 @@ module InlineSvg
     end
 
     def self.configured_asset_finder
-      InlineSvg.configuration.asset_finder
+      Thread.current[:inline_svg_asset_finder] || InlineSvg.configuration.asset_finder
     end
   end
 end

data/lib/inline_svg/id_generator.rb

@@ -1,8 +1,17 @@
+require 'digest'
+
 module InlineSvg
   class IdGenerator
-    def self.generate(base, salt)
-      bytes = Digest::SHA1.digest("#{base}-#{salt}")
-      Digest.hexencode(bytes).to_i(16).to_s(36)
+    class Randomness
+      require "securerandom"
+      def self.call
+        SecureRandom.hex(10)
+      end
+    end
+
+    def self.generate(base, salt, randomness: Randomness)
+      bytes = Digest::SHA1.digest("#{base}-#{salt}-#{randomness.call}")
+      'a' + Digest.hexencode(bytes).to_i(16).to_s(36)
     end
   end
 end

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/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,7 @@ module InlineSvg
 
     def pathname
       if ::Rails.application.config.assets.compile
-        ::Rails.application.assets[@filename].pathname
+        Pathname.new(::Rails.application.assets[@filename].filename)
       else
         manifest = ::Rails.application.assets_manifest
         asset_path = manifest.assets[@filename]

data/lib/inline_svg/transform_pipeline.rb

@@ -10,6 +10,5 @@ module InlineSvg
 end
 
 require 'nokogiri'
-require 'loofah'
 require 'inline_svg/id_generator'
 require 'inline_svg/transform_pipeline/transformations'

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -6,7 +6,9 @@ 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 },
@@ -38,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
@@ -72,6 +77,7 @@ 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'
@@ -81,3 +87,4 @@ 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/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?
-        InlineSvg::IdGenerator.generate(base, value)
+      if element["id"].nil?
+        InlineSvg::IdGenerator.generate(base, element.text)
       else
-        InlineSvg::IdGenerator.generate(element['id'], value)
+        InlineSvg::IdGenerator.generate(element["id"], element.text)
       end
     end
   end