esvg 4.6.2 → 4.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41bb830e6af4939063aeca838f5c69c550a851f71e701599ed3d4cbb52a42b5c
-  data.tar.gz: f494f42e0e9f9f847145a8f9d65658a9bf3104741f4a4bf513866cb6d92f942b
+  metadata.gz: f283459b842a4ae61b966de4db35aa1be8520bddbdcb3f24ce6c9784b5797137
+  data.tar.gz: '078008b881bdbbc81cfb581bb7a0dc7b692087acd37bd838fad1cf62ccc1d543'
 SHA512:
-  metadata.gz: bbce86545a336224d47db5219352407210fa16b16efc85c6f984058ee3ba09ea559a24122488c03e02bef076f141895107a70a2ce5f5868898f73c3dd708037e
-  data.tar.gz: e62b4ad90f511af5671df2d0c39c9c54e9506b25f580da403f84015cefb77f4fc843d2def09b42382bb52bb23991f70beaca2c19402883af4ac233c6aaddab14
+  metadata.gz: 4e34a8ff5f0f8b33c6a8c900336facc7649bec44e2aa99dda6601da1cf06a2d9372e9eccf089d74f9a74a3926d34ed0094897c3af4a83c97537c7ddcd165de75
+  data.tar.gz: 28bb6320c1f83fbed93d1b32100bfeb3146f2e1e74668beceaf810d9cbdb2ce94c1a3fc5c64627b262374b2bf3d18ff66a970e3ab52cd6e67d5c3d9369630672

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### 4.6.3 (2018-12-19)
+- Fix: Reworked configuration model, fixing build optimization failures.
+
+### 4.6.2 (2018-12-18)
+- New: Config is reloaded on change in development mode (Rails, Jekyll)
+
+### 4.6.1 (2018-12-17)
+- New: Embeds All Svgs in development mode (making reubilding after change unnecessary)
+
 ### 4.6.0 (2018-12-12)
 - New: `presets` configuration. Configure `presets: { icon: { height: '1em', fill: 'currentColor' }}` in esvg.yml and set option `preset: 'icon'` to apply these defaults options.
 - New: `sizes` configuration. Configure `sizes: { sm: { height: '10px' }, med: { height: '14px' }, … }` in esvg.yml and set option `size: 'sm'` to add load those size configuration options.

data/README.md

@@ -28,7 +28,7 @@ Or install it yourself as:
 
 ## Usage: Rails
 
-Add `Esvg.precompile_assets` to your `config/initializers/assets.rb` to add build with `rake assets:precomile`.
+Add `Esvg.precompile_assets` to your `config/initializers/assets.rb` to add build with `rake assets:precompile`.
 
 Add SVG files to your `app/assets/svgs/` directory.
 

data/exe/esvg

@@ -8,6 +8,7 @@ require 'esvg'
 options = {
   core: false,
   fingerprint: false,
+  cli: true
 }
 
 OptionParser.new do |opts|

data/lib/esvg.rb

@@ -49,6 +49,7 @@ module Esvg
   extend self
 
   include Esvg::Utils
+
   def new(options={})
     @svgs ||=[]
     c = config(options)
@@ -110,10 +111,6 @@ module Esvg
     defined?(Rails) || File.exist?("./bin/rails")
   end
 
-  def rails_production?
-    rails? && Rails.env.production?
-  end
-
   def html_safe(input)
     input = input.html_safe if rails?
     input
@@ -121,9 +118,9 @@ module Esvg
 
   # Add SVG build task to `rake assets:precompile`
   def precompile_assets
-    if rails_production? && defined?(Rake)
+    if rails? && defined?(Rake)
       ::Rake::Task['assets:precompile'].enhance do
-        new(gzip: true, print: true).build
+        svgs.map(&:build)
       end
     end
   end
@@ -170,37 +167,46 @@ module Esvg
 
     if rails? || options[:rails]
       config.merge!(CONFIG_RAILS)
+      config[:env] ||= Rails.env
     elsif defined?(Jekyll)
       config.merge!(CONFIG_JEKYLL)
+      config[:env] ||= Jekyll.env
     end
 
+    config.merge!(options)
+
     if path = paths.select{ |p| File.exist?(p)}.first
       options[:config_file] = path
       config.merge!(deep_symbolize_keys(YAML.load(File.read(path) || {})))
+
+      # Allow CLI passed options to override config file
+      config.merge!(options) if options[:cli]
     else
       options[:config_file] = false
     end
 
-    config.merge!(options)
-
     if defined? Jekyll
-      config[:build] = File.join(config[:destination], config[:build])
-      config[:source] = File.join(config[:source_dir], config[:source])
+      config[:build]     = File.join(config[:destination], config[:build])
+      config[:source]    = File.join(config[:source_dir], config[:source])
     end
 
-    config[:filename] = File.basename(config[:filename], '.*')
+    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[: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[:root]      ||= config[:pwd] # For relative paths on print
 
-    config[:temp]     = config[:pwd] if config[:temp].nil?
-    config[:temp]     = File.expand_path File.join(config[:temp], '.esvg-cache')
+    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[:aliases]     = load_aliases(config[:alias])
     config[:flatten_dir] = [config[:flatten]].flatten.map { |dir| File.join(dir, '/') }.join('|')
-    config[:read] = Time.now.to_i
+    config[:read]        = Time.now.to_i
+    config[:env]       ||= 'development'
+    config[:print]     ||= true unless config[:env] == 'production'
+    config[:optimize]    = true if config[:env] == 'production'
 
     config
   end

data/lib/esvg/jekyll_hooks.rb

@@ -9,7 +9,7 @@ Jekyll::Hooks.register :site, :post_read do |site|
   site.exclude.push '.esvg-cache'
   config = {
     source_dir: site.config['source'], 
-    destination: site.config['destination']  
+    destination: site.config['destination']
   }.merge site.config["esvg"] || {}
 
   Jekyll.esvg = Esvg.seed_cache(config)

data/lib/esvg/svgs.rb

@@ -14,22 +14,29 @@ module Esvg
       @config = options
       @symbols = []
       @svgs = []
-      @files_loaded = 0
       read_cache
 
       load_files
     end
 
+    def production?
+      @config[:env] == 'production'
+    end
+
     def config
       # use cached configuration
-      if !Esvg.rails_production? && config_expired? && config_changed?
-        puts "LOADING CONFIG"
+      if !production? && config_expired? && config_changed?
+        puts "Reloading ESVG config: #{print_path( @config[:config_file] )}" if @config[:print]
         @config = Esvg.update_config( @config )
       else
         @config
       end
     end
 
+    def print_path( path )
+      sub_path( @config[:root], path )
+    end
+
     def config_expired?
       @config[:throttle_read] < (Time.now.to_i - @config[:read])
     end
@@ -38,34 +45,44 @@ module Esvg
       @config[:config_file] && @config[:read] < File.mtime( @config[:config_file] ).to_i
     end
 
+    def loaded_recently?
+      @last_load && (Time.now.to_i - @last_load) < @config[:throttle_read]
+    end
+
     def load_files
-      return if @config[:throttle_read] < (Time.now.to_i - @files_loaded)
+      return if loaded_recently?
 
-      files = Dir[File.join(@config[:source], '**/*.svg')].uniq.sort
+      files        = Dir[File.join(@config[:source], '**/*.svg')].uniq.sort
+      size_before  = @symbols.size
+      added        = []
+      removed      = []
 
-      if files.empty? && @config[:print]
-        puts "No svgs found at #{@config[:source]}"
-        return
-      end
-
-      # Remove deleted files
-      @symbols.reject(&:read).each { |s| @symbols.delete(s) }
+      # Remove all files which no longer exist
+      @symbols.reject(&:exist?).each { |s| 
+        removed.push @symbols.delete(s) 
+      }
 
       files.each do |path|
         unless @symbols.find { |s| s.path == path }
           @symbols << Symbol.new(path, self)
+          added.push @symbols.last
         end
       end
 
+      if @config[:print]
+        puts %Q{Read #{files.size} SVGs from #{print_path( @config[:source] )}}
+        puts %Q{  Added: #{added.size} SVG#{'s' if added.size != 1} } if added.size > 0 
+        puts %Q{  Removed: #{removed.size} SVG#{'s' if removed.size != 1} } if removed.size > 0 
+      end
+
       @svgs.clear
 
-      sort(@symbols.group_by(&:group)).each do |name, symbols|
+      sort(@symbols.group_by(&:dir)).each do |name, symbols|
         @svgs << Svg.new(name, symbols, self)
       end
 
-      @files_loaded = Time.now.to_i
-
-      puts "Read #{@symbols.size} files from #{@config[:source]}" if @config[:print]
+      @last_load = Time.now.to_i
+      write_cache if cache_stale?
 
     end
 
@@ -82,11 +99,11 @@ module Esvg
       @svgs.each do |file|
         write_file file.path, js(file.embed)
 
-        puts "Writing #{file.path}" if @config[:print]
+        puts "Writing #{print_path( file.path )}" if @config[:print]
         paths << file.path
 
         if !file.asset && @config[:gzip] && gz = compress(file.path)
-          puts "Writing #{gz}" if @config[:print]
+          puts "Writing #{print_path( gz )}" if @config[:print]
           paths << gz
         end
       end
@@ -96,12 +113,12 @@ module Esvg
     end
 
     def write_cache
-      puts "Writing cache" if @config[:print]
+      puts "Writing cache: #{ print_path( File.join( @config[:temp], @config[:cache_file]) )}" if @config[:print]
       write_tmp @config[:cache_file], @symbols.map(&:data).to_yaml
     end
 
     def read_cache
-      (YAML.load(read_tmp @config[:cache_file]) || []).each do |c|
+      (YAML.load(read_tmp(@config[:cache_file])) || []).each do |c|
         @config[:cache] = c
         @symbols << Symbol.new(c[:path], self)
       end
@@ -109,7 +126,7 @@ module Esvg
 
     # Embed svg symbols
     def embed_script(names=nil)
-      if Esvg.rails_production?
+      if production?
         embeds = buildable_svgs(names).map(&:embed)
       else
         embeds = find_svgs(names).map(&:embed)
@@ -136,7 +153,7 @@ module Esvg
 
     def find_symbol(name, fallback=nil)
       # Ensure that file changes are picked up in development
-      load_files unless Esvg.rails_production?
+      load_files unless production?
 
       name = get_alias dasherize(name)
 

data/lib/esvg/symbol.rb

@@ -18,12 +18,20 @@ module Esvg
       @parent.config
     end
 
+    def exist?
+      File.exist?(@path)
+    end
+
+    def dir
+      @group
+    end
+
     def read
-      return if !File.exist?(@path)
+      return if !exist?
 
       # Ensure that cache optimization matches current optimization settings
       # If config has changed name, reset optimized build (name gets baked in)
-      if changed? || @svgo_optimized != svgo? || name != file_name
+      if changed? || @svgo_optimized != optimize? || name != file_name
         @optimized = nil
         @optimized_at = nil
       end
@@ -95,7 +103,7 @@ module Esvg
         defs: @defs,
         optimized: @optimized,
         optimized_at: @optimized_at,
-        svgo_optimized: svgo? && @svgo_optimized
+        svgo_optimized: optimize? && @svgo_optimized
       }
     end
 
@@ -160,17 +168,26 @@ module Esvg
       %Q{<use #{attributes(options)}></use>}
     end
 
-    def svgo?
-      config[:optimize] && !!Esvg.node_module('svgo')
+    # Only optimize if
+    # - Configuration asks for it
+    # - SVGO is present
+    # - If Rails is present 
+    def optimize?
+      config[:optimize] && !!Esvg.node_module('svgo') && config[:env] == 'production'
     end
 
     def optimize
       read if changed?
 
       # Only optimize again if the file has changed
-      return @optimized if @optimized && @optimized_at && @optimized_at > @mtime
+      if @optimized && @optimized_at && @optimized_at > @mtime
+        return @optimized
+      end
+
+      # Only optimize if SVGO is installed
+      if optimize?
+        puts "Optimizing #{name}.svg" if config[:print]
 
-      if svgo?
         response = Open3.capture3(%Q{#{Esvg.node_module('svgo')} --disable=removeUselessDefs -s '#{@content}' -o -})
         if !response[0].empty? && response[2].success?
           @optimized = response[0]

data/lib/esvg/version.rb

@@ -1,3 +1,3 @@
 module Esvg
-  VERSION = "4.6.2"
+  VERSION = "4.6.3"
 end

metadata

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