esvg 4.3.9 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c725ea2fad5a3ce5df37270bb5d49d85d58e012
-  data.tar.gz: 9a1311c39d423b886216d966e45521f1ac2bb592
+  metadata.gz: 80613ecb52693e3f1540e8d538460138a96b0271
+  data.tar.gz: a6c0fe63c64bd8f7ea4dedddefbf6ec47f07d544
 SHA512:
-  metadata.gz: 248cd982eb3cbb1b16b68532be97fb62b6ec192a5ad69b854bfba5b40082f86682fcf59758616263782f3f8493698643d00ec4addba57f3630b5edf553de15ca
-  data.tar.gz: 593cc46f94f68f770019ba967f4d590c3b670054f5e1d8f7bae972592747d10fb74401a115ad6edcc96e4750d58ce530134b42d3d5244d2298f2176bfe49cb74
+  metadata.gz: 13ce53f86132b512ab4fff84afcc87996c1ea086053d6e1a3e4c48e5431de76e4c1e0e0ff9a3fec5fe457398533329ce156e4ab5e1bfe9e63f1852dce063c108
+  data.tar.gz: d49a75c05c53f09184d49db85f9e25a66b5352d69818f77bb5e7320338fddfea7b8c3ccab3e9340f877e8540ef01b172aa97268e78ba6080216e6e5b37d5da98

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 4.4.0 (2018-08-06)
+- New: Jekyll support. Just add esvg to the jekyll_plugins group in Gemfile and use {% esvg %} and {% use_svg %} as you'd expect.
+
 ### 4.3.9 (2017-09-05)
 - Fix: Esvg javascript now properly appends prefixes when generating use tags.
 

data/lib/esvg.rb

@@ -10,12 +10,49 @@ if defined?(Rails)
   require "esvg/railties" 
 end
 
+if defined?(Jekyll)
+  require "esvg/jekyll_hooks" 
+end
+
+CONFIG = {
+  filename: 'svgs',
+  class: 'svg-symbol',
+  prefix: 'svg',
+  cache_file: '.symbols',
+  core: true,
+  optimize: false,
+  gzip: false,
+  scale: false,
+  fingerprint: true,
+  throttle_read: 4,
+  flatten: [],
+  alias: {}
+}
+
+CONFIG_RAILS = {
+  source: "app/assets/svgs",
+  assets: "app/assets/javascripts",
+  build: "public/javascripts",
+  temp: "tmp"
+}
+
+CONFIG_JEKYLL = {
+  source: "_svgs",
+  build: "_site/javascripts",
+  core: false
+}
+
 module Esvg
+
   extend self
 
+  include Esvg::Utils
   def new(options={})
     @svgs ||=[]
-    @svgs << Svgs.new(options)
+    c = config(options)
+    unless @svgs.find { |s| s.config[:source] == c[:source] }
+      @svgs << Svgs.new(c)
+    end
     @svgs.last
   end
 
@@ -44,10 +81,11 @@ module Esvg
   end
 
   def seed_cache(options)
-    svgs = Svgs.new(options)
+    svgs = new(options)
     puts "Optimizing SVGs" if options[:print]
     svgs.symbols.map(&:optimize)
     svgs.write_cache
+    svgs
   end
 
   def find_svgs(names=nil)
@@ -72,7 +110,7 @@ module Esvg
   def precompile_assets
     if defined?(Rails) && Rails.env.production? && defined?(Rake)
       ::Rake::Task['assets:precompile'].enhance do
-        Svgs.new(gzip: true, print: true).build
+        new(gzip: true, print: true).build
       end
     end
   end
@@ -94,4 +132,67 @@ module Esvg
       false
     end
   end
+
+  def symbolize_keys(hash)
+    h = {}
+    hash.each {|k,v| h[k.to_sym] = v }
+    h
+  end
+
+  def config(options={})
+    paths = [options[:config_file], 'config/esvg.yml', 'esvg.yml'].compact
+
+    config = CONFIG.dup
+
+    if Esvg.rails? || options[:rails]
+      config.merge!(CONFIG_RAILS)
+    elsif defined?(Jekyll)
+      config.merge!(CONFIG_JEKYLL)
+    end
+
+    if path = paths.select{ |p| File.exist?(p)}.first
+      config.merge!(symbolize_keys(YAML.load(File.read(path) || {})))
+    end
+
+    config.merge!(options)
+
+    config[:filename] = File.basename(config[:filename], '.*')
+
+    config[:pwd]      = File.expand_path Dir.pwd
+    config[:source]   = File.expand_path config[:source] || config[:pwd]
+    config[:build]    = File.expand_path config[:build]  || config[:pwd]
+    config[:assets]   = File.expand_path config[:assets] || config[:pwd]
+
+    config[:temp]     = config[:pwd] if config[:temp].nil?
+    config[:temp]     = File.expand_path File.join(config[:temp], '.esvg-cache')
+
+    config[:aliases] = load_aliases(config[:alias])
+    config[:flatten] = [config[:flatten]].flatten.map { |dir| File.join(dir, '/') }.join('|')
+
+    config
+  end
+  
+  # Load aliases from configuration.
+  #  returns a hash of aliasees mapped to a name.
+  #  Converts configuration YAML:
+  #    alias:
+  #      foo: bar
+  #      baz: zip, zop
+  #  To output:
+  #    { :bar => "foo", :zip => "baz", :zop => "baz" }
+  #
+  def load_aliases(aliases)
+    a = {}
+    aliases.each do |name,alternates|
+      alternates.split(',').each do |val|
+        a[dasherize(val.strip).to_sym] = dasherize(name.to_s)
+      end
+    end
+    a
+  end
+
+  def dasherize(input)
+    input.gsub(/[\W,_]/, '-').sub(/^-/,'').gsub(/-{2,}/, '-')
+  end
+
 end

data/lib/esvg/jekyll_hooks.rb

@@ -0,0 +1,67 @@
+module Jekyll
+  class << self
+    attr_accessor :esvg
+    attr_accessor :esvg_embedded
+  end
+end
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  site.exclude.push '.esvg-cache'
+  Jekyll.esvg = Esvg.seed_cache(site.config["esvg"] || {})
+end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  Jekyll.esvg.build unless Jekyll.esvg_embedded
+end
+
+module Jekyll
+  module Tags
+    class EmbedSvgs < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+        @markup = markup.gsub(/["']/,'').split(/,\s*/)
+      end
+
+      def render(context)
+        super
+        if Jekyll.env == 'production'
+
+          config   = context.registers[:site].config
+          dest     = config["destination"]
+          url      = Jekyll.esvg.config[:build].sub(dest, '')
+          root_url = File.join config["baseurl"], url
+
+          Esvg.build_paths(@markup).map { |path| %Q{<script src="#{File.join(root_url, path)}" async="true"></script>} }.join("\n")
+        else
+          Jekyll.esvg_embedded = true
+          Esvg.embed()
+        end
+      end
+    end
+
+    class UseSvg < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+        markup.sub!(/(\S+) /) do
+          @name = $1.gsub(/[",']/, '')
+          ''
+        end
+
+        @options = markup.strip.split(/,\s*/).join("\n")
+
+        if @options.empty?
+          @options = {}
+        else
+          @options = Jekyll::Utils.symbolize_hash_keys(YAML.load(@options)) unless @options.empty?
+        end
+      end
+
+      def render(context)
+        Esvg.use(@name, @options)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('use_svg', Jekyll::Tags::UseSvg)
+Liquid::Template.register_tag('esvg', Jekyll::Tags::EmbedSvgs)

data/lib/esvg/svg.rb

@@ -82,7 +82,7 @@ module Esvg
 
         optimized = @symbols.map(&:optimize).join.gsub("\n",'')
 
-        @svg = %Q{<svg id="esvg-#{id}" #{attributes(attr)}>#{defs}#{optimized}</svg>}
+        @svg = %Q{<svg id="esvg-#{id}" #{attributes(attr)} data-turbolinks-permanent>#{defs}#{optimized}</svg>}
       end
     end
 

data/lib/esvg/svgs.rb

@@ -9,31 +9,10 @@ module Esvg
     include Esvg::Utils
 
     attr_reader :symbols
-
-    CONFIG = {
-      filename: 'svgs',
-      class: 'svg-symbol',
-      prefix: 'svg',
-      cache_file: '.symbols',
-      core: true,
-      optimize: false,
-      gzip: false,
-      scale: false,
-      fingerprint: true,
-      throttle_read: 4,
-      flatten: [],
-      alias: {}
-    }
-
-    CONFIG_RAILS = {
-      source: "app/assets/svgs",
-      assets: "app/assets/javascripts",
-      build: "public/javascripts",
-      temp: "tmp"
-    }
+    attr_reader :config
 
     def initialize(options={})
-      config(options)
+      @config = options
       @symbols = []
       @svgs = []
       @last_read = 0
@@ -42,39 +21,6 @@ module Esvg
       load_files
     end
 
-    def config(options={})
-      @config ||= begin
-        paths = [options[:config_file], 'config/esvg.yml', 'esvg.yml'].compact
-
-        config = CONFIG.dup
-
-        if Esvg.rails? || options[:rails]
-          config.merge!(CONFIG_RAILS)
-        end
-
-        if path = paths.select{ |p| File.exist?(p)}.first
-          config.merge!(symbolize_keys(YAML.load(File.read(path) || {})))
-        end
-
-        config.merge!(options)
-
-        config[:filename] = File.basename(config[:filename], '.*')
-
-        config[:pwd]      = File.expand_path Dir.pwd
-        config[:source]   = File.expand_path config[:source] || config[:pwd]
-        config[:build]    = File.expand_path config[:build]  || config[:pwd]
-        config[:assets]   = File.expand_path config[:assets] || config[:pwd]
-
-        config[:temp]     = config[:pwd] if config[:temp].nil?
-        config[:temp]     = File.expand_path File.join(config[:temp], '.esvg-cache')
-
-        config[:aliases] = load_aliases(config[:alias])
-        config[:flatten] = [config[:flatten]].flatten.map { |dir| File.join(dir, '/') }.join('|')
-
-        config
-      end
-    end
-
     def load_files
       return if (Time.now.to_i - @last_read) < config[:throttle_read]
 
@@ -291,25 +237,6 @@ module Esvg
       config[:aliases][dasherize(name).to_sym] || name
     end
 
-    # Load aliases from configuration.
-    #  returns a hash of aliasees mapped to a name.
-    #  Converts configuration YAML:
-    #    alias:
-    #      foo: bar
-    #      baz: zip, zop
-    #  To output:
-    #    { :bar => "foo", :zip => "baz", :zop => "baz" }
-    #
-    def load_aliases(aliases)
-      a = {}
-      aliases.each do |name,alternates|
-        alternates.split(',').each do |val|
-          a[dasherize(val.strip).to_sym] = dasherize(name.to_s)
-        end
-      end
-      a
-    end
-
     def write_tmp(name, content)
       path = File.join(config[:temp], name)
       FileUtils.mkdir_p(File.dirname(path))

data/lib/esvg/utils.rb

@@ -8,12 +8,6 @@ module Esvg
       path.sub(File.join(root,''),'')
     end
 
-    def symbolize_keys(hash)
-      h = {}
-      hash.each {|k,v| h[k.to_sym] = v }
-      h
-    end
-
     def attributes(hash)
       att = []
       hash.each do |key, value|

data/lib/esvg/version.rb

@@ -1,3 +1,3 @@
 module Esvg
-  VERSION = "4.3.9"
+  VERSION = "4.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esvg
 version: !ruby/object:Gem::Version
-  version: 4.3.9
+  version: 4.4.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - exe/esvg
 - lib/esvg.rb
 - lib/esvg/helpers.rb
+- lib/esvg/jekyll_hooks.rb
 - lib/esvg/railties.rb
 - lib/esvg/svg.rb
 - lib/esvg/svgs.rb