esvg 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6e52e2c93bb2014d058e1e67b21993ae847b127
-  data.tar.gz: 134f0a997e953e2216ab91a28ac2b8d78c6d49d6
+  metadata.gz: 0929542e9c469ca502b8d6beb9f5bbf779a23d41
+  data.tar.gz: 2dc3070f381f16fa28c993277fdf19d6632c35ed
 SHA512:
-  metadata.gz: 6fa72d0b91eca23f0c230643ae9c7f61a97d41990a12e43bf654ee0356dc4224353acf0a3af4a1036f90fc32443cabfe3d232c6672b0026aff46734f1c535445
-  data.tar.gz: 0e273e7eaa3f52dbacd920921d1b5f3c2e36031e8043293b1b6d916314981f784eb229af44ca186916676642b5715f8c708060e614d0536eb7f559bec4908b8c
+  metadata.gz: 5126999322552fa4ba22ccf16b459004e6851eb6b2f321992cc20ce93d720a0f3684dbdf34d2d84cd0431e6442cad7c2c5b072a63fcebaaef1ab39f3cf62ad77
+  data.tar.gz: 061e2c49fc7e2d537a5947048651da403c2b12fd78050d08756125b5dcd31d81397ff874bb7988b83e5b66ae346af700f85e3b0c4fa057303c9a6e4e7a3220d4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### 2.4.0 (2015-10-17)
+- New: Caching is now based on file modification times. It's much faster and more efficient.
+- New: Optimization is much faster now too, as it happens after symbol concatenation, so it only runs once per build.
+- Change: Configuration `svgo_path` is now `npm_path` and points to the path where the `node_modules` folder can be found.
+
 ### 2.3.1 (2015-10-15)
 - Minor: Added `svgo_path` config option to specifiy a direct path to the svgo binary.
 

data/exe/esvg

@@ -19,6 +19,14 @@ OptionParser.new do |opts|
   opts.on("-c", "--config PATH", String, "Path to a config file (default: esvg.yml, config/esvg.yml)") do |path|
     options[:config_file] = path
   end
+
+  opts.on("-O", "--optimize", "Optimize svgs with svgo") do |svgo|
+    options[:optimize] = svgo
+  end
+
+  opts.on("-n", "--npm", String, "Path to node_modules director") do |path|
+    options[:npm_path] = path
+  end
 end.parse!
 
 options[:path] = ARGV.shift

data/lib/esvg.rb

@@ -12,10 +12,10 @@ module Esvg
   extend self
 
   def icons(options={})
-    @icons ||= SVG.new(options)
-
-    if rails? && ::Rails.env != 'production' && @icons.modified?
-      @icons.read_icons
+    if @icons.nil?
+      @icons = SVG.new(options)
+    elsif !rails? || (rails? && ::Rails.env.downcase != 'production')
+      @icons.read_files
     end
 
     @icons
@@ -26,7 +26,7 @@ module Esvg
   end
 
   def svg_icon(name, options={})
-    icons.svg_icon(name, options)
+    @icons.svg_icon(name, options)
   end
 
   def rails?

data/lib/esvg/svg.rb

@@ -9,7 +9,7 @@ module Esvg
       base_class: 'svg-icon',
       namespace: 'icon',
       optimize: false,
-      svgo_path: false,
+      npm_path: false,
       namespace_before: true,
       font_size: '1em',
       output_path: Dir.pwd,
@@ -23,17 +23,42 @@ module Esvg
 
     def initialize(options={})
       config(options)
-      read_icons
+
       @svgo = nil
-      @cache = {}
+      @svgs = {}
+
+      read_files
     end
 
-    def modified?
-      @mtime != last_modified(find_files)
+    def config(options={})
+      @config ||= begin
+        paths = [options[:config_file], 'config/esvg.yml', 'esvg.yml'].compact
+
+        config = CONFIG
+        config.merge!(CONFIG_RAILS) if Esvg.rails?
+
+        if path = paths.select{ |p| File.exist?(p)}.first
+          config.merge!(symbolize_keys(YAML.load(File.read(path) || {})))
+        end
+
+        config.merge!(options)
+
+        if config[:verbose]
+          config[:path] = File.expand_path(config[:path])
+          config[:output_path] = File.expand_path(config[:output_path])
+        end
+
+        config[:js_path]   ||= File.join(config[:output_path], 'esvg.js')
+        config[:css_path]  ||= File.join(config[:output_path], 'esvg.css')
+        config[:html_path] ||= File.join(config[:output_path], 'esvg.html')
+        config.delete(:output_path)
+
+        config
+      end
     end
 
     def embed
-      return if @files.empty?
+      return if files.empty?
       case config[:format]
       when "html"
         html
@@ -44,63 +69,120 @@ module Esvg
       end
     end
 
-    def svgo?
-      @svgo ||= begin
-        local_path = config[:svgo_path] || "#{Dir.pwd}/node_modules/svgo/bin/svgo"
+    def read_files
+      @files = {}
 
-        if File.exist?(local_path)
-          local_path
-        elsif `npm ls -g svgo`.match(/empty/).nil?
-          "svgo"
-        else
-          false
+      # Get a list of svg files and modification times
+      #
+      find_files.each do |f|
+        files[f] = File.mtime(f)
+      end
+
+      process_files
+
+      if files.empty? && config[:verbose]
+        puts "No svgs found at #{config[:path]}"
+      end
+    end
+
+    # Add new svgs, update modified svgs, remove deleted svgs
+    #
+    def process_files
+      files.each do |file, mtime|
+        name = file_key(file)
+
+        if svgs[name].nil? || svgs[name][:last_modified] != mtime
+          svgs[name] = process_file(file, mtime, name)
         end
       end
+
+      # Remove deleted svgs
+      #
+      (svgs.keys - files.keys.map {|file| file_key(file) }).each do |file|
+        svgs.delete(file)
+      end
     end
 
-    def cache_name(input, options)
-      "#{input}#{options.flatten.join('-')}"
+    def process_file(file, mtime, name)
+      content = File.read(file).gsub(/<?.+\?>/,'').gsub(/<!.+?>/,'')
+      {
+        content: content,
+        use: use_svg(name, content),
+        last_modified: mtime
+      }
     end
 
-    def read_icons
-      @files = {}
-      @svgs  = {}
+    #def compress(file)
+      #if config[:optimize] && svgo?
+         #Compress files outputting to $STDOUT which returns as a string
+        #`#{@svgo} #{file} -o -`
+      #else
+        #File.read(file)
+      #end
+    #end
+
+    def use_svg(file, content)
+      name = classname(file)
+      %Q{<svg class="#{config[:base_class]} #{name}" #{dimensions(content)}><use xlink:href="##{name}"/></svg>}
+    end
 
-      found = find_files
-      @mtime = last_modified(found)
+    def svg_icon(file, options={})
+      file = icon_name(file.to_s)
+      embed = svgs[file][:use]
+      embed = embed.sub(/class="(.+?)"/, 'class="\1 '+options[:class]+'"') if options[:class]
+      embed = embed.sub(/><\/svg/, ">#{title(options)}#{desc(options)}</svg")
+      embed
+    end
 
-      found.each do |f|
-        @files[dasherize(File.basename(f, ".*"))] = read(f)
-      end
+    def dimensions(input)
+      dimension = input.scan(/<svg.+(viewBox=["'](.+?)["'])/).flatten
+      viewbox = dimension.first
+      coords = dimension.last.split(' ')
+
+      width = coords[2].to_i - coords[0].to_i
+      height = coords[3].to_i - coords[1].to_i
+      %Q{#{viewbox} width="#{width}" height="#{height}"}
+    end
 
-      if @files.empty? && config[:verbose]
-        puts "No icons found at #{config[:path]}"
+    def icon_name(name)
+      if svgs[name].nil?
+        raise "No svg named '#{name}' exists at #{config[:path]}"
       end
+      classname(name)
     end
 
-    def last_modified(files)
-      if files.size > 0
-        File.mtime(files.sort_by{ |f| File.mtime(f) }.last)
+    def classname(name)
+      name = dasherize(name)
+      if config[:namespace_before]
+        "#{config[:namespace]}-#{name}"
+      else
+        "#{name}-#{config[:namespace]}"
       end
     end
 
-    def read(file)
-      if config[:optimize] && svgo?
-        # Compress files outputting to $STDOUT which returns as a string
-        `#{@svgo} #{file} -o -`
+    def dasherize(input)
+      input.gsub(/[\W,_]/, '-').gsub(/-{2,}/, '-')
+    end
+
+    def find_files
+      path = File.expand_path(File.join(config[:path], '*.svg'))
+      Dir[path].uniq
+    end
+
+
+    def title(options)
+      if options[:title]
+        "<title>#{options[:title]}</title>"
       else
-        File.read(file)
+        ''
       end
     end
 
-    # Optiize all svg source files
-    #
-    def optimize
-      if svgo?
-        puts "Optimzing #{config[:path]}"
-        system "svgo -f #{config[:path]}"
+    def desc(options)
+      if options[:desc]
+        "<desc>#{options[:desc]}</desc>"
       else
-        abort 'To optimize files, please install svgo; `npm install svgo -g`'
+        ''
       end
     end
 
@@ -116,13 +198,6 @@ module Esvg
       end
     end
 
-    def write_file(path, contents)
-      FileUtils.mkdir_p(File.expand_path(File.dirname(path)))
-      File.open(path, 'w') do |io|
-        io.write(contents)
-      end
-    end
-
     def write_js
       write_file config[:js_path], js
     end
@@ -135,12 +210,18 @@ module Esvg
       write_file config[:html_path], html
     end 
 
+    def write_file(path, contents)
+      FileUtils.mkdir_p(File.expand_path(File.dirname(path)))
+      File.open(path, 'w') do |io|
+        io.write(contents)
+      end
+    end
+
     def css
-      @cache['css'] ||= begin
-        styles = []
-        
-        classes = files.keys.map{|k| ".#{icon_name(k)}"}.join(', ')
-        preamble = %Q{#{classes} { 
+      styles = []
+      
+      classes = svgs.keys.map{|k| ".#{classname(k)}"}.join(', ')
+      preamble = %Q{#{classes} { 
   font-size: #{config[:font_size]};
   clip: auto;
   background-size: auto;
@@ -156,43 +237,52 @@ module Esvg
   vertical-align: middle;
   line-height: 1em;
 }}
-        styles << preamble
-
-        files.each do |name, contents|
-          f = contents.gsub(/</, '%3C') # escape <
-                      .gsub(/>/, '%3E') # escape >
-                      .gsub(/#/, '%23') # escape #
-                      .gsub(/\n/,'')    # remove newlines
-          styles << ".#{icon_name(name)} { background-image: url('data:image/svg+xml;utf-8,#{f}'); }"
+      styles << preamble
+
+      svgs.each do |name, data|
+        if data[:css]
+          styles << css
+        else
+          svg_css = data[:content].gsub(/</, '%3C') # escape <
+                                  .gsub(/>/, '%3E') # escape >
+                                  .gsub(/#/, '%23') # escape #
+                                  .gsub(/\n/,'')    # remove newlines
+          styles << data[:css] = ".#{classname(name)} { background-image: url('data:image/svg+xml;utf-8,#{svg_css}'); }"
         end
-        styles.join("\n")
       end
+      styles.join("\n")
+    end
+
+    def prep_svg(file, content)
+      content.gsub(/<svg.+?>/, %Q{<svg class="#{classname(file)}" #{dimensions(content)}>})  # convert svg to symbols
+             .gsub(/\n/, '')                 # remove endlines
+             .gsub(/\s{2,}/, ' ')            # remove whitespace
+             .gsub(/>\s+</, '><')            # remove whitespace between tags
     end
 
     def html
-      @cache['html'] ||= begin
-        if @files.empty?
-          ''
+      if @files.empty?
+        ''
+      else
+        symbols = []
+        svgs.each do |name, data|
+          symbols << prep_svg(name, data[:content])
+        end
+
+        symbols = if config[:optimize] && svgo?
+          `svgo -s '#{symbols.join}' -o -`
         else
-          files.each do |name, contents|
-            @svgs[name] = contents.gsub(/<svg.+?>/, %Q{<symbol id="#{icon_name(name)}" #{dimensions(contents)}>})  # convert svg to symbols
-                           .gsub(/<\/svg/, '</symbol')     # convert svg to symbols
-                           .gsub(/style=['"].+?['"]/, '')  # remove inline styles
-                           .gsub(/\n/, '')                 # remove endlines
-                           .gsub(/\s{2,}/, ' ')            # remove whitespace
-                           .gsub(/>\s+</, '><')            # remove whitespace between tags
-          end
-
-          icons = @svgs
-
-          %Q{<svg id="esvg-symbols" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none">#{icons.values.join("\n")}</svg>}
+          symbols.join
         end
+
+        symbols = symbols.gsub(/class/,'id').gsub(/svg/,'symbol')
+
+        %Q{<svg id="esvg-symbols" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none">#{symbols}</svg>}
       end
     end
 
     def js
-      @cache['js'] ||= begin
-        %Q{var esvg = {
+      %Q{var esvg = {
   embed: function(){
     if (!document.querySelector('#esvg-symbols')) {
       document.querySelector('body').insertAdjacentHTML('afterbegin', '#{html.gsub(/\n/,'').gsub("'"){"\\'"}}')
@@ -239,96 +329,37 @@ esvg.load()
 // Work with module exports:
 if(typeof(module) != 'undefined') { module.exports = esvg }
 }
-      end
-    end
-
-    def svg_icon(file, options={})
-      file = dasherize(file.to_s)
-      @cache[cache_name(file, options)] ||= begin 
-        name = icon_name(file)
-        %Q{<svg class="#{config[:base_class]} #{name} #{options[:class] || ""}" #{dimensions(@files[file])}><use xlink:href="##{name}"/>#{title(options)}#{desc(options)}</svg>}
-      end
-    end
-
-    def title(options)
-      if options[:title]
-        "<title>#{options[:title]}</title>"
-      end
-    end
-
-    def desc(options)
-      if options[:desc]
-        "<desc>#{options[:desc]}</desc>"
-      end
     end
 
-    def config(options={})
-      @config ||= begin
-        paths = [options[:config_file], 'config/esvg.yml', 'esvg.yml'].compact
-
-        config = CONFIG
-        config.merge!(CONFIG_RAILS) if Esvg.rails?
+    def svgo?
+      @svgo ||= begin
+        npm_path   = "#{config[:npm_path] || Dir.pwd}/node_modules"
+        local_path = File.join(npm_path, "svgo/bin/svgo")
 
-        if path = paths.select{ |p| File.exist?(p)}.first
-          config.merge!(symbolize_keys(YAML.load(File.read(path) || {})))
+        if config[:npm_path] && !File.exist?(npm_path)
+          abort "NPM Path not found: #{File.expand_path(config[:npm_path])}"
         end
 
-        config.merge!(options)
-
-        if config[:verbose]
-          config[:path] = File.expand_path(config[:path])
-          config[:output_path] = File.expand_path(config[:output_path])
+        if File.exist?(local_path)
+          local_path
+        elsif `npm ls -g svgo`.match(/empty/).nil?
+          "svgo"
+        else
+          false
         end
-
-        config[:js_path]   ||= File.join(config[:output_path], 'esvg.js')
-        config[:css_path]  ||= File.join(config[:output_path], 'esvg.css')
-        config[:html_path] ||= File.join(config[:output_path], 'esvg.html')
-        config.delete(:output_path)
-
-        config
       end
     end
 
+    def file_key(name)
+      dasherize(File.basename(name, ".*"))
+    end
+
+
     def symbolize_keys(hash)
       h = {}
       hash.each {|k,v| h[k.to_sym] = v }
       h
     end
 
-    def dimensions(input)
-      dimension = input.scan(/<svg.+(viewBox=["'](.+?)["'])/).flatten
-      viewbox = dimension.first
-      coords = dimension.last.split(' ')
-
-      width = coords[2].to_i - coords[0].to_i
-      height = coords[3].to_i - coords[1].to_i
-      %Q{#{viewbox} width="#{width}" height="#{height}"}
-    end
-
-    def icon_name(name)
-      if @files[name].nil?
-        raise "No icon named '#{name}' exists at #{config[:path]}"
-      end
-      classname(name)
-    end
-
-    def classname(name)
-      name = dasherize(name)
-      if config[:namespace_before]
-        "#{config[:namespace]}-#{name}"
-      else
-        "#{name}-#{config[:namespace]}"
-      end
-    end
-
-    def dasherize(input)
-      input.gsub(/[\W,_]/, '-').gsub(/-{2,}/, '-')
-    end
-
-    def find_files
-      path = File.expand_path(File.join(config[:path], '*.svg'))
-      Dir[path].uniq
-    end
-
   end
 end

data/lib/esvg/version.rb

@@ -1,3 +1,3 @@
 module Esvg
-  VERSION = "2.3.1"
+  VERSION = "2.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esvg
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2015-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler