esvg 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1529e25e48e1086a9ac6756093c81e4e96192400
-  data.tar.gz: d36d81e3e2fec5665acf2320a658d41c1579a36d
+  metadata.gz: 27d93663b8b9b36654390502132bf232efe68c66
+  data.tar.gz: 43344a22127df181e71d73602dbe0764e51d13e5
 SHA512:
-  metadata.gz: 976ec5f1418b143edb27698ccfedc89eb48a8eda4bfa741725d9a73412bc9b7a55ce42b7dafee6b9e9636ff41d5c6a924624d2a2ded858c5e7f2fcbd8658f651
-  data.tar.gz: 8ca64f5d17cc615f18e3202e0b2e79a5abe5c58ab80fce208fa757ce72661c6b1a053256424772e9778dc57500fbdcd461f1849e1126aa908ba6f857382ea6e6
+  metadata.gz: cc486ddf04d4b6692407740dc3d1c808181587ce8d92c0e3a78b33c35c4631d1913b961d649b2179e4e9378d4c230e2d8c53cf8e513568246511686387e3c7b2
+  data.tar.gz: 1d1e3f0476e4c2dee4eb68d2814712407b0e84eb8faf1e5bd49b9b5729bfa95181c106ce5ddd98e6053bb54245907702d8bfe07992dcb2c337d573f7eb65eb20

data/lib/esvg/helpers.rb

@@ -10,10 +10,10 @@ module Esvg::Helpers
 
 
   def embed_svgs(*keys)
-    if Rails.env.production?
-      esvg.build_paths(keys).each do |path|
+    if !Rails.env.production?
+      esvg.build_paths(keys).map do |path|
         javascript_include_tag(path)
-      end.join("\n")
+      end.join("\n").html_safe
     else
       esvg.embed_script(keys).html_safe
     end

data/lib/esvg/svg.rb

@@ -22,7 +22,7 @@ module Esvg
     CONFIG_RAILS = {
       source: "app/assets/svgs",
       assets: "app/assets/javascripts",
-      build: "public/assets",
+      build: "public/javascripts",
       temp: "tmp"
     }
 
@@ -77,7 +77,6 @@ module Esvg
       # Get a list of svg files and modification times
       #
       find_files
-      write_cache
 
       @last_read = Time.now.to_i
 
@@ -90,6 +89,7 @@ module Esvg
 
     def find_files
       files = Dir[File.join(config[:source], '**/*.svg')].uniq.sort
+      @svg_symbols = {}
 
       # Remove deleted files from svg cache
       (svgs.keys - file_keys(files)).each { |f| svgs.delete(f) }
@@ -97,16 +97,18 @@ module Esvg
       dirs = {}
 
       files.each do |path|
-
         mtime = File.mtime(path).to_i
         key = file_key path
         dkey = dir_key path
 
         # Use cache if possible
         if svgs[key].nil? || svgs[key][:last_modified] != mtime
-          svgs[key] = process_file(path, mtime, key)
+          svgs[key] = process_file(path, mtime)
         end
 
+        # Name may have changed due to flatten config
+        svgs[key][:name] = file_name(path)
+
         dirs[dkey]           ||= {}
         (dirs[dkey][:files]  ||= []) << key
 
@@ -117,31 +119,22 @@ module Esvg
 
       dirs = sort(dirs)
 
-      # Remove deleted directories from svg_symbols cache
-      (svg_symbols.keys - dirs.keys).each {|dir| svg_symbols.delete(dir) }
-
       dirs.each do |dir, data|
 
         # overwrite cache if
         if svg_symbols[dir].nil?                                   || # No cache for this dir yet
           svg_symbols[dir][:last_modified] != data[:last_modified] || # New or updated file
-          svg_symbols[dir][:optimized] != optimize?                || # Cache is unoptimized
           svg_symbols[dir][:files] != data[:files]                    # Changed files
 
-          symbols    = data[:files].map { |f| svgs[f][:content] }.join
           attributes = data[:files].map { |f| svgs[f][:attr] }
+          mtimes = data[:files].map { |f| svgs[f][:last_modified] }.join
 
           svg_symbols[dir] = data.merge({
             name: dir,
-            symbols: symbols,
-            optimized: optimize?,
-            version: config[:version] || Digest::MD5.hexdigest(symbols),
-            asset: File.basename(dir).start_with?('_')
+            asset: File.basename(dir).start_with?('_'),
+            version: config[:version] || Digest::MD5.hexdigest(mtimes)
           })
 
-        end
-
-        svg_symbols.keys.each do |dir|
           svg_symbols[dir][:path] = write_path(dir)
         end
       end
@@ -152,15 +145,12 @@ module Esvg
 
     def read_cache
       @svgs        = YAML.load(read_tmp '.svgs') || {}
-      @svg_symbols = YAML.load(read_tmp '.svg_symbols') || {}
     end
 
     def write_cache
       return if production?
 
       write_tmp '.svgs', sort(@svgs).to_yaml
-      write_tmp '.svg_symbols', sort(@svg_symbols).to_yaml
-
     end
 
     def sort(hash)
@@ -195,26 +185,22 @@ module Esvg
       end.map { |k| svg_symbols[k] }
     end
 
-    def process_file(file, mtime, name)
-      content   = File.read(file)
-      id        = id(name)
+    def process_file(path, mtime)
+      content   = File.read(path)
+      id        = id(file_key(path))
       size_attr = dimensions(content)
 
-      svg = {
-        name: name,
+      {
+        path: path,
         use: %Q{<use xlink:href="##{id}"/>},
         last_modified: mtime,
-        attr: { id: id }.merge(size_attr)
+        attr: { id: id }.merge(size_attr),
+        content: content
       }
-      # Add attributes
-      svg[:content] = prep_svg(content, svg[:attr])
-
-      svg
     end
 
     def use(file, options={})
-      if name = exist?(file, options[:fallback])
-        svg = svgs[name]
+      if svg = find_svg(file, options[:fallback])
 
         if options[:color]
           options[:style] ||= ''
@@ -225,7 +211,7 @@ module Esvg
           fill:   options[:fill],
           style:  options[:style],
           viewBox: svg[:attr][:viewBox],
-          class: [config[:class], svg[:attr][:id], options[:class]].compact.join(' ')
+          class: [config[:class], id(svg[:name]), options[:class]].compact.join(' ')
         }
 
         # If user doesn't pass a size or set scale: true
@@ -283,14 +269,17 @@ module Esvg
     end
 
     def exist?(name, fallback=nil)
+      !find_svg(name, fallback).nil?
+    end
+
+    def find_svg(name, fallback=nil)
       name = get_alias dasherize(name)
 
-      if svgs[name].nil?
-        exist?(fallback) if fallback
-      else
-        name
+      if svg = svgs.values.find { |v| v[:name] == name }
+        svg
+      elsif fallback
+        find_svg(fallback)
       end
-
     end
 
     alias_method :exists?, :exist?
@@ -344,7 +333,9 @@ module Esvg
       paths = []
 
       files.each do |file|
-        write_file(file[:path], js(file[:name]))
+        content = js(file[:name])
+
+        write_file(file[:path], content)
         puts "Writing #{file[:path]}" if config[:print]
         paths << file[:path]
 
@@ -354,17 +345,29 @@ module Esvg
         end
       end
 
+      write_cache
+
       paths
     end
 
     def symbols(keys)
       symbols = valid_keys(keys).map { |key|
-        svg_symbols[key][:symbols]
+        # Build on demand
+        build_symbols(svg_symbols[key][:files])
       }.join.gsub(/\n/,'')
 
       %Q{<svg id="esvg-#{key_id(keys)}" version="1.1" style="height:0;position:absolute">#{symbols}</svg>}
     end
 
+    def build_symbols(files)
+      files.map { |file|
+        if svgs[file][:optimized_at].nil? || svgs[file][:optimized_at] < svgs[file][:last_modified]
+          svgs[file][:optimized_content] = optimize(svgs[file])
+        end
+        svgs[file][:optimized_content]
+      }.join.gsub(/\n/,'')
+    end
+
     def js(key)
       keys = valid_keys(key)
       return if keys.empty?
@@ -471,10 +474,16 @@ module Esvg
 
     private
 
+    def file_key(path)
+      dasherize sub_path(path).sub('.svg','')
+    end
+
     def dir_key(path)
       dir = File.dirname(flatten_path(path))
 
       # Flattened paths which should be treated as assets will use '_' as their dir key
+      # - flatten: _foo - _foo/icon.svg will have a dirkey of _
+      # - filename: _icons - treats all root or flattened files as assets
       if dir == '.' && ( sub_path(path).start_with?('_') || config[:filename].start_with?('_') )
         '_'
       else
@@ -482,6 +491,10 @@ module Esvg
       end
     end
 
+    def file_name(path)
+      dasherize flatten_path(path).sub('.svg','')
+    end
+
     def sub_path(path)
       path.sub("#{config[:source]}/",'')
     end
@@ -490,10 +503,6 @@ module Esvg
       sub_path(path).sub(Regexp.new(config[:flatten]), '')
     end
 
-    def file_key(path)
-      dasherize flatten_path(path).sub('.svg', '')
-    end
-
     def file_keys(paths)
       paths.flatten.map { |p| file_key(p) }
     end
@@ -518,31 +527,60 @@ module Esvg
       end
     end
 
-    def prep_svg(content, attr)
-      content = content.gsub(/<?.+\?>/,'').gsub(/<!.+?>/,'')  # Get rid of doctypes and comments
+    def svgo?
+      !!(config[:optimize] && svgo_cmd)
+    end
+
+    def optimize(svg)
+      svg[:optimized_content] = pre_optimize svg[:content]
+      svg[:optimized_content] = sub_def_ids svg
+
+      if svgo?
+        response = Open3.capture3(%Q{#{} --disable=removeUselessDefs -s '#{svg[:content]}' -o -})
+        svg[:optimized_content] = response[0] if response[2].success?
+      end
+
+      svg[:optimized_at] = Time.now.to_i
+      svg[:optimized_content] = post_optimize svg
+    end
+
+    def pre_optimize(svg)
+      reg = %w(xmlns xmlns:xlink xml:space version).map { |m| "#{m}=\".+?\"" }.join('|')
+      svg.gsub(Regexp.new(reg), '')                           # Remove unwanted attributes
+         .gsub(/<?.+\?>/,'').gsub(/<!.+?>/,'')                # Get rid of doctypes and comments
          .gsub(/\n/, '')                                      # Remove endlines
          .gsub(/\s{2,}/, ' ')                                 # Remove whitespace
          .gsub(/>\s+</, '><')                                 # Remove whitespace between tags
          .gsub(/\s?fill="(#0{3,6}|black|rgba?\(0,0,0\))"/,'') # Strip black fill
          .gsub(/style="([^"]*?)fill:(.+?);/m, 'fill="\2" style="\1')                   # Make fill a property instead of a style
          .gsub(/style="([^"]*?)fill-opacity:(.+?);/m, 'fill-opacity="\2" style="\1')   # Move fill-opacity a property instead of a style
+    end
 
-      content = sub_def_ids content, attr[:id]
-      content = strip_attributes content
-      content = optimize(content) if optimize?
-      content = set_attributes content, attr
-      content.gsub(/<\/svg/,'</symbol')      # Replace svgs with symbols
+    def post_optimize(svg)
+      svg[:optimized_content] = set_attributes(svg)
+        .gsub(/<\/svg/,'</symbol')      # Replace svgs with symbols
         .gsub(/class="def-/,'id="def-') # Replace <def> classes with ids (classes are generated in sub_def_ids)
-        .gsub(/\s{2,}/,'')                 # Remove extra spaces
         .gsub(/\w+=""/,'')              # Remove empty attributes
     end
 
+    def set_attributes(svg)
+      svg[:attr].keys.each { |key| svg[:optimized_content].sub!(/ #{key}=".+?"/,'') }
+      svg[:optimized_content].sub(/<svg/, "<symbol #{attributes(svg[:attr])}")
+    end
+
+    def svgo_cmd
+      find_node_module('svgo')
+    end
+    
     # Scans <def> blocks for IDs
     # If urls(#id) are used, ensure these IDs are unique to this file
     # Only replace IDs if urls exist to avoid replacing defs
     # used in other svg files
     #
-    def sub_def_ids(content, name)
+    def sub_def_ids(svg)
+      content = svg[:optimized_content]
+      name    = svg[:attr][:id]
+
       return content unless !!content.match(/<defs>/)
 
       content.scan(/<defs>.+<\/defs>/m).flatten.each do |defs|
@@ -562,35 +600,6 @@ module Esvg
       content
     end
 
-    def strip_attributes(svg)
-      reg = %w(xmlns xmlns:xlink xml:space version).map { |m| "#{m}=\".+?\"" }.join('|')
-
-      svg.gsub(Regexp.new(reg), '')
-    end
-
-    def set_attributes(svg, attr)
-      attr.keys.each { |key| svg.sub!(/ #{key}=".+?"/,'') }
-      svg.sub(/<svg/, "<symbol #{attributes(attr)}")
-    end
-
-    def optimize?
-      !!(config[:optimize] && svgo_cmd)
-    end
-
-    def svgo_cmd
-      find_node_module('svgo')
-    end
-
-
-    def optimize(svg)
-      path = write_tmp '.svgo-tmp', svg
-      command = "#{svgo_cmd} --disable=removeUselessDefs '#{path}' -o -"
-      svg = `#{command}`
-      FileUtils.rm(path) if File.exist? path
-
-      svg
-    end
-
     def compress(file)
       return if !config[:compress]
 

data/lib/esvg/version.rb

@@ -1,3 +1,3 @@
 module Esvg
-  VERSION = "4.1.0"
+  VERSION = "4.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esvg
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler