jekyll-inline-svg 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b35ca0aca2374d360e32fb944580c58dd17379f
-  data.tar.gz: ca91fc4965c53f6c0cd0e5c2dadfd602b5c45d55
+  metadata.gz: 54bf469b224e7c7af5dd5168fa7f417cde9aefe8
+  data.tar.gz: 6419acd66b53406b7d62633a11fb6e439a5c9945
 SHA512:
-  metadata.gz: 7750d9db908305c278698367020be6781019cf16c598f83cdfd4a5dbc5329049460a7388d84f10baf2abb91120ecfb033f974609e38b199edeeef827896e314c
-  data.tar.gz: d47ab973339952966e826de0d3b943c013b7da34bcfe44772d3bd503840dd8193892a5b8ec6cdf45b6df54e22a4b4f0e716c1e9bcbb1b9247c47ceaab16c453b
+  metadata.gz: e4ef60f184b0179b254afa2cb641a87b52d51dae78c6a87123aa1e3be9b3aa276f69fd81dd340f524ab1491d73387475be1eaf2df49bbe821627cefb225ec71d
+  data.tar.gz: 8692d77303fb7400b35705ced6a9bc1a7f654a976088777b6e6b544f5494542f6bb152be76e3dda94351e06edb60b467e8c5ed243e476840f29b36d452014c24

data/README.md

@@ -2,13 +2,28 @@
 
 SVG optimizer and inliner for jekyll
 
-This liquid tag will let you inline SVG images in your jekyll sites.
+This liquid tag will let you inline SVG images in your jekyll sites. It will add `{%svg %}` to `Liquid::Tag`.
+
+## Installation
+
+Run `gem install jekyll-inline-svg` or add `gem "jekyll-inline-svg", "~>0.0.1"` to your **Gemfile**.
+
+Then in your **_config.yml** :
+
+```
+gems:
+  - jekyll-inline-svg
+```
+
+## Usage
+
+Use the Liquid tag in your pages :
 
 ```
-    {% svg /path/to/file.svg width=24 foo="bar" %}
+    {% svg /path/to/square.svg width=24 foo="bar" %}
 ```
 
-Will include the svg file in your output HTML like this :
+Jekyll will include the svg file in your output HTML like this :
 
 ```
 <svg width=24 foo="bar" version="1.1" id="square" xmlns="http://www.w3.org/2000/svg" x="0" y="0" viewBox="0 0 24 24" >

data/jekyll-inline-svg.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   A Liquid tag to inline and optimize SVG images in your HTML
   Supports custom DOM Attributes parameters and variables interpretation.
   EOF
-  spec.version     = "0.0.1"
+  spec.version     = "0.0.2"
   spec.authors     = ["Sebastien DUMETZ"]
   spec.email       = "s.dumetz@holusion.com"
   spec.homepage    = "https://github.com/sdumetz/jekyll-inline-svg"

data/lib/jekyll-inline-svg.rb

@@ -1,7 +1,7 @@
 require 'svg_optimizer'
-require 'shellwords'
 require 'jekyll/liquid_extensions'
 class RemoveSize < SvgOptimizer::Plugins::Base
+  # remove "width" and "height" attributes
   def process
     xml.root.remove_attribute("height")
     xml.root.remove_attribute("width")
@@ -17,15 +17,18 @@ PLUGINS = SvgOptimizer::DEFAULT_PLUGINS.delete_if {|plugin|
   RemoveSize
 ]
 
-#logger.info(PLUGINS)
+
 module Jekyll
   module Tags
     class JekyllInlineSvg < Liquid::Tag
-
-      include Jekyll::LiquidExtensions #import lookup_variable function
+      #import lookup_variable function
       # https://github.com/jekyll/jekyll/blob/master/lib/jekyll/liquid_extensions.rb
+      include Jekyll::LiquidExtensions
+
       # For interpoaltion, look for liquid variables
       VARIABLE = /\{\{\s*([\w]+\.?[\w]*)\s*\}\}/i
+
+      #Separate file path from other attributes
       PATH_SYNTAX = %r!
         ^(?<path>[^\s"']+|"[^"]*"|'[^']*')
         (?<params>.*)
@@ -34,20 +37,22 @@ module Jekyll
       def initialize(tag_name, input, tokens)
         super
 
-        #@logger = Logger.new(STDOUT)
-        #@logger.level = Logger::INFO
         @svg, @params = JekyllInlineSvg.parse_params(input)
-        #@logger.info(@svg +", "+@width)
       end
+
+      #lookup Liquid variables from markup in context
       def interpolate(markup, context)
         markup.scan VARIABLE do |variable|
-          markup = markup.gsub(VARIABLE, lookup_variable(context, variable.first))
+          markup = markup.sub(VARIABLE, lookup_variable(context, variable.first))
         end
         markup
       end
+
+      #Parse parameters. Returns : [svg_path, parameters]
+      # Does not interpret variables as it's done at render time
       def self.parse_params(input)
         matched = input.strip.match(PATH_SYNTAX)
-        return matched["path"].strip.gsub("\"","").gsub("'",""), matched["params"].strip
+        return matched["path"].gsub("\"","").gsub("'","").strip, matched["params"].strip
       end
       def render(context)
         #global site variable

data/spec/fixtures/index.html

@@ -1,5 +1,6 @@
 ---
 svgname: square
+svgclass: hello
 ---
 Hello world
 <div id="base">
@@ -21,5 +22,5 @@ Hello world
 <div id="interpret">
   <label>Interpret embedded variables</label>
   {% svg /files/{{page.svgname}}.svg %}
-  {% svg /files/square.svg id="name-{{page.svgname}}" %}
+  {% svg /files/square.svg id="name-{{page.svgname}}" class="class-{{page.svgclass}}" %}
 </div>

data/spec/jekyll-inline-svg_spec.rb

@@ -27,16 +27,25 @@ describe(Jekyll::Tags::JekyllInlineSvg) do
       svg, params = Jekyll::Tags::JekyllInlineSvg.parse_params("'/path/to/foo space'")
       expect(svg).to eq("/path/to/foo space")
     end
+    it "strip leading and trailing spaces" do
+      svg, params = Jekyll::Tags::JekyllInlineSvg.parse_params(" /path/to/foo ")
+      expect(svg).to eql("/path/to/foo")
+    end
+    # required when a variable is defined with leading/trailing space then embedded.
+    it "strip in-quote leading and trailing spaces" do
+      svg, params = Jekyll::Tags::JekyllInlineSvg.parse_params("'/path/to/foo '")
+      expect(svg).to eql("/path/to/foo")
+    end
+    it "keep Liquid variables" do
+      svg, params = Jekyll::Tags::JekyllInlineSvg.parse_params("/path/to/{{foo}}")
+      expect(svg).to eql("/path/to/{{foo}}")
+    end
     it "don't parse parameters" do
       svg, params = Jekyll::Tags::JekyllInlineSvg.parse_params("'/path/to/foo space' id='bar' style=\"hello\"")
       expect(params).to eq("id='bar' style=\"hello\"")
     end
   end
 
-  describe "Interpolate variables" do
-
-  end
-
   describe "Integration" do
 
     before(:context) do
@@ -79,6 +88,7 @@ describe(Jekyll::Tags::JekyllInlineSvg) do
       expect(data.size).to eq(2)
       expect(data[0].to_xml).to eql(ref)
       expect(data[1].get_attribute("id")).to eql("name-square")
+      expect(data[1].get_attribute("class")).to eql("class-hello")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-inline-svg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sebastien DUMETZ