bridgetown-inline-svg 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ab68b27ce5c6ea4b77ff2340e106747d674029911ee582d9ee6eaf0e5ee222
-  data.tar.gz: 3b8e527ff95606f74e10c42f99e80ae65769378bec2f69998060b514a4dd6baf
+  metadata.gz: e1c8e18d390771eeb4fddd2b1dbfb6d82357b55c21fdf8445af38506bb7ba4fc
+  data.tar.gz: 2e75d828cd0dd039dcb91e9efa5b3d9251c80bebfcadf8ea329dd3f80874c9cf
 SHA512:
-  metadata.gz: df96ce63b617fe79b877c1a0b6ac08d2df0bc10464c57dab78fca651f2bbc813f34bb90e7c8a1b1efe38f42471e780ffc487513a0625d21c6d02e1000a95053f
-  data.tar.gz: f1d22d0f9ac90a71cf717e6b469fcfc51cb595f30b7bc0d6f9a42d16e5bb989c8d41667a2597c87e40f174e28014cf84284d54364244a868cc24bea9bbba34ec
+  metadata.gz: d5aca7788bc7464fc726a03bd9a3aed7d9d8831d4a86dc3f55ff6a5809e3164865d60e8bddead21bf1147f28e68e7eed0e13f0f141ede345f7e3be0091f60289
+  data.tar.gz: 737e94de18e8f7fdbfef74439f7dc14aa586cb49f0eb7513d9b1aedc4c34ceb855af7d43f341b7694c90fc41a70ad72902c09e0c8cc1c88e9406500e67439a56

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 ## [Unreleased](https://github.com/andrewmcodes/bridgetown-inline-svg/tree/HEAD)
 
-[Full Changelog](https://github.com/andrewmcodes/bridgetown-inline-svg/compare/v1.0.0...HEAD)
+[Full Changelog](https://github.com/andrewmcodes/bridgetown-inline-svg/compare/v1.1.0...HEAD)
+
+**Closed issues:**
+
+- Unknown tag 'svg'  [\#7](https://github.com/andrewmcodes/bridgetown-inline-svg/issues/7)
+
+**Merged pull requests:**
+
+- feat: Extend Bridgetown::Builder over extending liquid [\#6](https://github.com/andrewmcodes/bridgetown-inline-svg/pull/6) ([MikeRogers0](https://github.com/MikeRogers0))
+
+## [v1.1.0](https://github.com/andrewmcodes/bridgetown-inline-svg/tree/v1.1.0) (2020-07-21)
+
+[Full Changelog](https://github.com/andrewmcodes/bridgetown-inline-svg/compare/v1.0.0...v1.1.0)
 
 **Merged pull requests:**
 

data/lib/bridgetown-inline-svg.rb

@@ -1,9 +1,8 @@
-# frozen_string_literal: true
-
 require "bridgetown"
+require "bridgetown-inline-svg/tag"
 
 module BridgetownInlineSvg
-  autoload :SvgTag, "bridgetown-inline-svg/svg-tag"
+  autoload :Markup, "bridgetown-inline-svg/markup"
+  autoload :RenderSvg, "bridgetown-inline-svg/render_svg"
+  autoload :RenderOptimizedSvg, "bridgetown-inline-svg/render_optimized_svg"
 end
-
-Liquid::Template.register_tag("svg", BridgetownInlineSvg::SvgTag)

data/lib/bridgetown-inline-svg/markup.rb

@@ -0,0 +1,94 @@
+# Converts the mark passed to the tag into a path & a hash of arguments.
+module BridgetownInlineSvg
+  class Markup
+    attr_reader :markup
+
+    # Separate file path from other attributes
+    PATH_SYNTAX = /
+      ^(?<path>[^\s"']+|"[^"]+"|'[^']+')
+      (?<params>.*)
+    /x.freeze
+
+    # Parse the first parameter in a string, giving :
+    #  [full_match, param_name, double_quoted_val, single_quoted_val, unquoted_val]
+    # The Regex works like :
+    # - first group
+    #    - match a group of characters that is alphanumeric, _ or -.
+    # - second group (non-capturing OR)
+    #    - match a double-quoted string
+    #    - match a single-quoted string
+    #    - match an unquoted string matching the set : [\w\.\-#]
+    #
+    PARAM_SYNTAX = /
+    ([\w-]+)\s*=\s*
+      (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w.\-#]+))
+    /x.freeze
+
+    def self.parse(markup)
+      new(markup).call
+    end
+
+    def initialize(markup)
+      @markup = markup
+    end
+
+    def call
+      raise_exception! unless matched
+
+      [path, params]
+    end
+
+    private
+
+    def matched
+      @matched ||= markup.strip.match(PATH_SYNTAX)
+    end
+
+    def path
+      @path ||= matched["path"].sub(/^["']/, "").sub(/["']$/, "").strip
+    end
+
+    def params
+      @params ||= begin
+        @params = {}
+        params_parse_with_liquid_match!
+        params_parse_with_custom_match!
+        params_set_height_if_missing!
+        @params
+      end
+    end
+
+    # Scan for arguments using liquids regex
+    # From: https://github.com/Shopify/liquid/blob/57c9cf64ebc777fe5e92d4408d31a911f087eeb4/lib/liquid/tags/render.rb#L27
+    def params_parse_with_liquid_match!
+      raw_params.scan(Liquid::TagAttributes) do |key, value|
+        @params[key.to_sym] = value
+      end
+    end
+
+    # Scan using our regex to support id="some-id"
+    def params_parse_with_custom_match!
+      raw_params.scan(PARAM_SYNTAX) do |key, group_2, group_3, group_4|
+        @params[key.to_sym] = (group_2 || group_3 || group_4)
+      end
+    end
+
+    # IE11 requires we have both width & height attributes
+    # on SVG elements
+    def params_set_height_if_missing!
+      @params[:height] = @params[:width] if @params.key?(:width) && @params[:width] != "" && !@params.key?(:height)
+    end
+
+    def raw_params
+      @raw_params = matched["params"].strip
+    end
+
+    def raise_exception!
+      raise SyntaxError, <<~END
+        Syntax Error in tag 'svg' while parsing the following markup:
+        #{markup}
+        Valid syntax: svg <path> [property=value]
+      END
+    end
+  end
+end

data/lib/bridgetown-inline-svg/render_optimized_svg.rb

@@ -0,0 +1,34 @@
+require "svg_optimizer"
+
+module BridgetownInlineSvg
+  class RenderOptimizedSvg < RenderSvg
+    PLUGINS_BLOCKLIST = [
+      SvgOptimizer::Plugins::CleanupId
+    ].freeze
+
+    PLUGINS = SvgOptimizer::DEFAULT_PLUGINS.delete_if { |plugin|
+      PLUGINS_BLOCKLIST.include?(plugin)
+    }
+
+    def call
+      SvgOptimizer.optimize(file, [create_plugin!] + PLUGINS)
+    end
+
+    private
+
+    def create_plugin!
+      mod = Class.new(SvgOptimizer::Plugins::Base) {
+        def self.set(params)
+          @@params = params
+        end
+
+        def process
+          @@params.each { |key, value| xml.root.set_attribute(key, value) }
+          xml
+        end
+      }
+      mod.set(@attributes)
+      mod
+    end
+  end
+end

data/lib/bridgetown-inline-svg/render_svg.rb

@@ -0,0 +1,24 @@
+require "nokogiri"
+
+module BridgetownInlineSvg
+  class RenderSvg
+    attr_reader :attributes
+
+    def initialize(file_path, attributes)
+      @file_path = file_path
+      @attributes = attributes
+    end
+
+    def call
+      xml = Nokogiri::XML(file)
+      attributes.each { |key, value| xml.root.set_attribute(key, value) }
+      xml.root.to_xml
+    end
+
+    private
+
+    def file
+      @file ||= File.open(@file_path, File::RDONLY).read
+    end
+  end
+end

data/lib/bridgetown-inline-svg/tag.rb

@@ -0,0 +1,62 @@
+module BridgetownInlineSvg
+  class Tag < Bridgetown::Builder
+    attr_reader :attributes
+    attr_reader :context
+    attr_reader :markup
+    attr_reader :svg_path
+
+    def build
+      liquid_tag "svg", :render
+    end
+
+    def render(markup, builder)
+      @context = builder.context
+      @markup = markup
+
+      interpolate_variables_in_markup!
+      set_svg_path_and_attributes!
+
+      return unless svg_path
+
+      add_file_to_dependency!
+
+      render_svg
+    end
+
+    private
+
+    # Parse any variables in our Markup
+    def interpolate_variables_in_markup!
+      @markup = Liquid::Template.parse(markup).render(context)
+    end
+
+    def set_svg_path_and_attributes!
+      @svg_path, @attributes = Markup.parse(markup)
+      @svg_path = Bridgetown.sanitized_path(site.source, svg_path)
+    end
+
+    # When we change the svg, it'll regenerate our page.
+    def add_file_to_dependency!
+      if context.registers[:page]&.key?("path")
+        site.regenerator.add_dependency(
+          site.in_source_dir(context.registers[:page]["path"]),
+          svg_path
+        )
+      end
+    end
+
+    def render_svg
+      render_svg_class.new(svg_path, attributes).call
+    end
+
+    def render_svg_class
+      options["optimize"] == true ? RenderOptimizedSvg : RenderSvg
+    end
+
+    def options
+      config["svg"] || {}
+    end
+  end
+end
+
+BridgetownInlineSvg::Tag.register

data/lib/bridgetown-inline-svg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownInlineSvg
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-inline-svg
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Mason
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -99,7 +99,10 @@ files:
 - bin/standardrb
 - bridgetown-inline-svg.gemspec
 - lib/bridgetown-inline-svg.rb
-- lib/bridgetown-inline-svg/svg-tag.rb
+- lib/bridgetown-inline-svg/markup.rb
+- lib/bridgetown-inline-svg/render_optimized_svg.rb
+- lib/bridgetown-inline-svg/render_svg.rb
+- lib/bridgetown-inline-svg/tag.rb
 - lib/bridgetown-inline-svg/version.rb
 - media/banner.png
 homepage: https://github.com/andrewmcodes/bridgetown-inline-svg

data/lib/bridgetown-inline-svg/svg-tag.rb

@@ -1,144 +0,0 @@
-require "nokogiri"
-require "svg_optimizer"
-require "bridgetown-core/liquid_extensions"
-
-PLUGINS_BLOCKLIST = [
-  SvgOptimizer::Plugins::CleanupId
-]
-
-PLUGINS = SvgOptimizer::DEFAULT_PLUGINS.delete_if { |plugin|
-  PLUGINS_BLOCKLIST.include? plugin
-}
-
-module BridgetownInlineSvg
-  class SvgTag < Liquid::Tag
-    # import lookup_variable function
-    # https://github.com/bridgetownrb/bridgetown/blob/main/bridgetown-core/lib/bridgetown-core/liquid_extensions.rb
-    include Bridgetown::LiquidExtensions
-
-    # For interpoaltion, look for liquid variables
-    VARIABLE = /\{\{\s*([\w.\-]+)\s*\}\}/i
-
-    # Separate file path from other attributes
-    PATH_SYNTAX = %r{
-      ^(?<path>[^\s"']+|"[^"]+"|'[^']+')
-      (?<params>.*)
-    }x
-
-    # parse the first parameter in a string, giving :
-    #  [full_match, param_name, double_quoted_val, single_quoted_val, unquoted_val]
-    # The Regex works like :
-    # - first group
-    #    - match a group of characters that is alphanumeric, _ or -.
-    # - second group (non-capturing OR)
-    #    - match a double-quoted string
-    #    - match a single-quoted string
-    #    - match an unquoted string matching the set : [\w\.\-#]
-    PARAM_SYNTAX = %r{
-      ([\w-]+)\s*=\s*
-      (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w.\-#]+))
-    }x
-
-    def initialize(tag_name, markup, tokens)
-      super
-      @svg, @params = BridgetownInlineSvg::SvgTag.parse_params(markup)
-    end
-
-    # lookup Liquid variables from markup in context
-    def interpolate(markup, context)
-      markup.scan VARIABLE do |variable|
-        markup = markup.sub(VARIABLE, lookup_variable(context, variable.first))
-      end
-      markup
-    end
-
-    def split_params(markup, context)
-      params = {}
-      while (match = PARAM_SYNTAX.match(markup))
-        markup = markup[match.end(0)..-1]
-        value = if match[2]
-          interpolate(match[2].gsub(%r{\\"}, '"'), context)
-        elsif match[3]
-          interpolate(match[3].gsub(%r{\\'}, "'"), context)
-        elsif match[4]
-          lookup_variable(context, match[4])
-        end
-        params[match[1]] = value
-      end
-      params
-    end
-
-    # Parse parameters. Returns : [svg_path, parameters]
-    # Does not interpret variables as it's done at render time
-    def self.parse_params(markup)
-      matched = markup.strip.match(PATH_SYNTAX)
-      unless matched
-        raise SyntaxError, <<~END
-          Syntax Error in tag 'svg' while parsing the following markup:
-          #{markup}
-          Valid syntax: svg <path> [property=value]
-        END
-      end
-      path = matched["path"].sub(%r{^["']}, "").sub(%r{["']$}, "").strip
-      params = matched["params"].strip
-      [path, params]
-    end
-
-    def fmt(params)
-      r = params.to_a.select { |v| v[1] != "" }.map { |v| %(#{v[0]}="#{v[1]}") }
-      r.join(" ")
-    end
-
-    def create_plugin(params)
-      mod = Class.new(SvgOptimizer::Plugins::Base) {
-        def self.set(p)
-          @@params = p
-        end
-
-        def process
-          @@params.each { |key, val| xml.root.set_attribute(key, val) }
-          xml
-        end
-      }
-      mod.set(params)
-      mod
-    end
-
-    def add_file_to_dependency(site, path, context)
-      if context.registers[:page]&.key?("path")
-        site.regenerator.add_dependency(
-          site.in_source_dir(context.registers[:page]["path"]),
-          path
-        )
-      end
-    end
-
-    def render(context)
-      # global site variable
-      site = context.registers[:site]
-      # check if given name is a variable. Otherwise use it as a file name
-      svg_file = Bridgetown.sanitized_path(site.source, interpolate(@svg, context))
-      return unless svg_file
-
-      add_file_to_dependency(site, svg_file, context)
-      # replace variables with their current value
-      params = split_params(@params, context)
-      # because ie11 require to have a height AND a width
-      if params.key?("width") && !params.key?("height")
-        params["height"] = params["width"]
-      end
-      # params = @params
-      file = File.open(svg_file, "rb").read
-
-      conf = site.config["svg"] || {}
-
-      if conf["optimize"] == true
-        SvgOptimizer.optimize(file, [create_plugin(params)] + PLUGINS)
-      else
-        xml = Nokogiri::XML(file)
-        params.each { |key, val| xml.root.set_attribute(key, val) }
-        xml.root.to_xml
-      end
-    end
-  end
-end