image_optim 0.18.0 → 0.19.0

data/lib/image_optim/worker/class_methods.rb

@@ -0,0 +1,89 @@
+require 'image_optim/bin_resolver'
+require 'image_optim/option_definition'
+
+class ImageOptim
+  class Worker
+    # Class methods of ImageOptim::Worker
+    module ClassMethods
+      def self.extended(klass)
+        klass.instance_variable_set(:@klasses, [])
+      end
+
+      # List of available workers
+      def klasses
+        @klasses.to_enum
+      end
+
+      # Remember all classes inheriting from this one
+      def inherited(base)
+        @klasses << base
+      end
+
+      # Underscored class name symbol
+      def bin_sym
+        @underscored_name ||= name.
+          split('::').last. # get last part
+          gsub(/([a-z])([A-Z])/, '\1_\2').downcase. # convert AbcDef to abc_def
+          to_sym
+      end
+
+      def option_definitions
+        @option_definitions ||= []
+      end
+
+      def option(name, default, type, description = nil, &proc)
+        attr_reader name
+        option_definitions <<
+          OptionDefinition.new(name, default, type, description, &proc)
+      end
+
+      # Create hash with format mapped to list of workers sorted by run order
+      def create_all_by_format(image_optim, &options_proc)
+        by_format = {}
+        create_all(image_optim, &options_proc).each do |worker|
+          worker.image_formats.each do |format|
+            by_format[format] ||= []
+            by_format[format] << worker
+          end
+        end
+        by_format
+      end
+
+      # Create list of workers sorted by run order
+      # Workers are initialized with options provided through options_proc
+      # Resolve all bins of all workers, if there are errors and
+      # skip_missing_workers of image_optim is true - show warnings, otherwise
+      # fail with one joint exception
+      def create_all(image_optim, &options_proc)
+        workers = init_all(image_optim, &options_proc)
+
+        resolved = []
+        errors = BinResolver.collect_errors(workers) do |worker|
+          worker.resolve_used_bins!
+          resolved << worker
+        end
+
+        unless errors.empty?
+          if image_optim.skip_missing_workers
+            errors.each{ |error| warn error }
+          else
+            message = ['Bin resolving errors:', *errors].join("\n")
+            fail BinResolver::Error, message
+          end
+        end
+
+        resolved.sort_by.with_index{ |worker, i| [worker.run_order, i] }
+      end
+
+    private
+
+      def init_all(image_optim, &options_proc)
+        klasses.map do |klass|
+          next unless (options = options_proc[klass])
+          options = options.merge(:allow_lossy => image_optim.allow_lossy)
+          klass.init(image_optim, options)
+        end.compact.flatten
+      end
+    end
+  end
+end

data/lib/image_optim/worker/gifsicle.rb

@@ -4,8 +4,25 @@ class ImageOptim
   class Worker
     # http://www.lcdf.org/gifsicle/
     class Gifsicle < Worker
+      # If interlace specified initialize one instance
+      # Otherwise initialize two, one with interlace off and one with on
+      def self.init(image_optim, options = {})
+        return super if options.key?(:interlace)
+
+        [false, true].map do |interlace|
+          new(image_optim, options.merge(:interlace => interlace))
+        end
+      end
+
       INTERLACE_OPTION =
-      option(:interlace, false, 'Turn interlacing on'){ |v| !!v }
+      option(:interlace, false, TrueFalseNil, 'Interlace: '\
+          '`true` - interlace on, '\
+          '`false` - interlace off, '\
+          '`nil` - as is in original image '\
+          '(defaults to running two instances, one with interlace off and '\
+          'one with on)') do |v|
+        TrueFalseNil.convert(v)
+      end
 
       LEVEL_OPTION =
       option(:level, 3, 'Compression level: '\
@@ -30,7 +47,13 @@ class ImageOptim
           #{src}
         ]
 
-        args.unshift('--interlace') if interlace
+        if resolve_bin!(:gifsicle).version >= '1.85'
+          args.unshift('--no-extensions', '--no-app-extensions')
+        end
+
+        unless interlace.nil?
+          args.unshift(interlace ? '--interlace' : '--no-interlace')
+        end
         args.unshift('--careful') if careful
         args.unshift("--optimize=#{level}") if level
         execute(:gifsicle, *args) && optimized?(src, dst)

data/lib/image_optim/worker/jpegrecompress.rb

@@ -0,0 +1,44 @@
+require 'image_optim/worker'
+require 'image_optim/option_helpers'
+
+class ImageOptim
+  class Worker
+    # https://github.com/danielgtaylor/jpeg-archive#jpeg-recompress
+    class Jpegrecompress < Worker
+      # Initialize only if allow_lossy
+      def self.init(image_optim, options = {})
+        super if options[:allow_lossy]
+      end
+
+      QUALITY_NAMES = [:low, :medium, :high, :veryhigh]
+
+      quality_names_desc = QUALITY_NAMES.each_with_index.map do |name, i|
+        "`#{i}` - #{name}"
+      end.join(', ')
+
+      QUALITY_OPTION =
+      option(:quality, 3, "JPEG quality preset: #{quality_names_desc}") do |v|
+        OptionHelpers.limit_with_range(v.to_i, 0...QUALITY_NAMES.length)
+      end
+
+      def used_bins
+        [:'jpeg-recompress']
+      end
+
+      # Run first [-1]
+      def run_order
+        -5
+      end
+
+      def optimize(src, dst)
+        args = %W[
+          --quality #{QUALITY_NAMES[quality]}
+          --no-copy
+          #{src}
+          #{dst}
+        ]
+        execute(:'jpeg-recompress', *args) && optimized?(src, dst)
+      end
+    end
+  end
+end

data/lib/image_optim/worker/optipng.rb

@@ -14,7 +14,7 @@ class ImageOptim
       end
 
       INTERLACE_OPTION =
-      option(:interlace, false, TrueFalseNil, 'Interlace, '\
+      option(:interlace, false, TrueFalseNil, 'Interlace: '\
           '`true` - interlace on, '\
           '`false` - interlace off, '\
           '`nil` - as is in original image') do |v|

data/script/update_worker_options_in_readme

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bundler/setup'
 
 require 'image_optim'
 
@@ -17,12 +17,11 @@ def write_worker_options(io, klass)
     io.puts 'Worker has no options'
   else
     klass.option_definitions.each do |option_definition|
-      io.puts %W[
-        *
-        `:#{option_definition.name}`
-        — #{option_definition.description}
-        *(defaults to `#{option_definition.default.inspect}`)*
-      ].join(' ')
+      line = "* `:#{option_definition.name}` — #{option_definition.description}"
+      unless line['(defaults']
+        line << " *(defaults to `#{option_definition.default.inspect}`)*"
+      end
+      io.puts line
     end
   end
   io.puts

data/script/worker_analysis

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bundler/setup'
 
 require 'image_optim'
 require 'image_optim/cmd'
@@ -141,12 +141,16 @@ class Analyser
 
   # Delegate to worker with short id
   class WorkerVariant < DelegateClass(ImageOptim::Worker)
-    attr_reader :klass, :id
+    attr_reader :cons_id, :id
     def initialize(klass, image_optim, options)
-      @klass = klass
+      allow_consecutive_on = Array(options.delete(:allow_consecutive_on))
       @image_optim = image_optim
-      @id = "#{klass.bin_sym}#{options unless options.empty?}"
+      @id = klass.bin_sym.to_s
+      unless options.empty?
+        @id << "(#{options.map{ |k, v| "#{k}:#{v.inspect}" }.join(', ')})"
+      end
       __setobj__(klass.new(image_optim, options))
+      @cons_id = [klass, allow_consecutive_on.map{ |key| [key, send(key)] }]
     end
 
     def cache_etag
@@ -270,7 +274,7 @@ class Analyser
 
         block.call(chain_result)
 
-        workers_left = workers.reject{ |w| w.klass == worker.klass }
+        workers_left = workers.reject{ |w| w.cons_id == worker.cons_id }
         run_workers(result_image, workers_left, chain_result, &block)
       end
     end
@@ -427,6 +431,7 @@ class Analyser
     @workers_by_format = Hash.new{ |h, k| h[k] = [] }
     ImageOptim::Worker.klasses.each do |klass|
       worker_options_config = option_variants.delete(klass.bin_sym) || {}
+      allow_consecutive_on = worker_options_config.delete(:allow_consecutive_on)
       worker_option_variants = case worker_options_config
       when Array
         worker_options_config
@@ -437,6 +442,7 @@ class Analyser
       end
       worker_option_variants.each do |options|
         options = HashHelpers.deep_symbolise_keys(options)
+        options[:allow_consecutive_on] = allow_consecutive_on
         worker = WorkerVariant.new(klass, image_optim, options)
         puts worker.id
         worker.image_formats.each do |format|
@@ -517,6 +523,10 @@ Example of `.analysis_variants.yml`:
   optipng: # 6 worker variants by combining options
     level: [6, 7]
     interlace: [true, false, nil]
+  gifsicle: # allow variants with different interlace to run consecutively
+    allow_consecutive_on: interlace
+    interlace: [true, false]
+    careful: [true, false]
   # other workers will be used with default options
   HELP
 end

data/script/worker_analysis.haml

@@ -55,14 +55,12 @@
       table[data-sortable] tbody tr:hover {
         background: #ddf;
       }
-      tr.unused {
+      body:not(.show-unused) tr.unused, tr.filtered-out {
         display: none;
       }
 
-      input { margin-top: 1.5em; }
-      #toggle-show-unused:checked ~ table tr.unused { /* without js */
-        display: table-row;
-      }
+      input { display: block; width: 30%; }
+      input[type=checkbox] { display: inline; width: auto; }
 
       .number {
         text-align: right;
@@ -102,6 +100,24 @@
     :javascript
       /*! sortable.js 0.6.0 */
       (function(){var a,b,c,d,e,f,g;a="table[data-sortable]",d=/^-?[£$¤]?[\d,.]+%?$/,g=/^\s+|\s+$/g,f="ontouchstart"in document.documentElement,c=f?"touchstart":"click",b=function(a,b,c){return null!=a.addEventListener?a.addEventListener(b,c,!1):a.attachEvent("on"+b,c)},e={init:function(b){var c,d,f,g,h;for(null==b&&(b={}),null==b.selector&&(b.selector=a),d=document.querySelectorAll(b.selector),h=[],f=0,g=d.length;g>f;f++)c=d[f],h.push(e.initTable(c));return h},initTable:function(a){var b,c,d,f,g,h;if(1===(null!=(h=a.tHead)?h.rows.length:void 0)&&"true"!==a.getAttribute("data-sortable-initialized")){for(a.setAttribute("data-sortable-initialized","true"),d=a.querySelectorAll("th"),b=f=0,g=d.length;g>f;b=++f)c=d[b],"false"!==c.getAttribute("data-sortable")&&e.setupClickableTH(a,c,b);return a}},setupClickableTH:function(a,d,f){var g;return g=e.getColumnType(a,f),"click"===c&&b(d,"mousedown",function(){return event.preventDefault?event.preventDefault():event.returnValue=!1}),b(d,c,function(){var b,c,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v;for("true"===this.getAttribute("data-sorted")?(l=this.getAttribute("data-sorted-direction"),b="ascending"===l?"descending":"ascending"):b=this.getAttribute("data-default-direction")||g.defaultSortDirection,n=this.parentNode.querySelectorAll("th"),o=0,r=n.length;r>o;o++)d=n[o],d.setAttribute("data-sorted","false"),d.removeAttribute("data-sorted-direction");for(this.setAttribute("data-sorted","true"),this.setAttribute("data-sorted-direction",b),m=a.tBodies[0],i=[],u=m.rows,c=p=0,s=u.length;s>p;c=++p)h=u[c],i.push([e.getNodeValue(h.cells[f]),h,c]);for(k="descending"===b?-1:1,i.sort(function(a,b){var c;return c=g.compare(a,b),0!==c?c*k:a[2]-b[2]}),v=[],q=0,t=i.length;t>q;q++)j=i[q],v.push(m.appendChild(j[1]));return v})},getColumnType:function(a,b){var c,f,g,h,i;for(i=a.tBodies[0].rows,g=0,h=i.length;h>g;g++)if(c=i[g],f=e.getNodeValue(c.cells[b]),""!==f){if(f.match(d))return e.types.numeric;if(!isNaN(Date.parse(f)))return e.types.date}return e.types.alpha},getNodeValue:function(a){return a?null!==a.getAttribute("data-value")?a.getAttribute("data-value"):"undefined"!=typeof a.innerText?a.innerText.replace(g,""):a.textContent.replace(g,""):""},types:{numeric:{defaultSortDirection:"descending",compare:function(a,b){var c,d;return c=parseFloat(a[0].replace(/[^0-9.-]/g,""),10),d=parseFloat(b[0].replace(/[^0-9.-]/g,""),10),isNaN(c)&&(c=0),isNaN(d)&&(d=0),c-d}},alpha:{defaultSortDirection:"ascending",compare:function(a,b){return a[0].localeCompare(b[0])}},date:{defaultSortDirection:"ascending",compare:function(a,b){var c,d;return c=Date.parse(a[0]),d=Date.parse(b[0]),isNaN(c)&&(c=0),isNaN(d)&&(d=0),c-d}}}},setTimeout(e.init,0),window.Sortable=e}).call(this);
+    :javascript
+      function toggleShowUnused(){
+        var checked = document.getElementById('toggle-show-unused').checked
+        document.body.classList[checked ? 'add' : 'remove']('show-unused')
+      }
+      function filterTable(){
+        var filter = new RegExp(document.getElementById('filter').value)
+        var rows = document.querySelectorAll('tbody.filterable tr')
+        for (var i = 0, _i = rows.length; i < _i; i++) {
+          var row = rows[i]
+          if (!row.hasAttribute('data-filter-text')) {
+            var text = row.textContent.replace(/\s+/g, ' ')
+            row.setAttribute('data-filter-text', text)
+          }
+          var show = filter.test(row.getAttribute('data-filter-text'))
+          row.classList[show ? 'remove' : 'add']('filtered-out')
+        }
+      }
   %body
     .formats
       - format_links.each do |format, link|
@@ -114,9 +130,14 @@
         %td.warn-low Max difference >= 0.001
         %td.warn-medium Max difference >= 0.01
         %td.warn-high Max difference >= 0.1
-    %input#toggle-show-unused(type="checkbox")
-      %label(for="toggle-show-unused")
+    %p
+      %label
+        %input#toggle-show-unused(type="checkbox" onchange="toggleShowUnused()")
         Show chains with workers failed for every image
+    %p
+      %label(for="filter")
+        Filter chains by regexp
+        %input#filter(type="text" onkeyup="filterTable()")
     %p
       Images: #{stats.each_chain.first.entry_count},
       size: #{stats.each_chain.first.original_size}
@@ -133,7 +154,7 @@
           %th(data-default-direction="ascending") Avg difference
           %th(data-default-direction="ascending") Max difference
           %th Speed (B/s)
-      %tbody
+      %tbody.filterable
         - stats.each_chain do |chain|
           %tr{class: chain.unused_workers && 'unused'}
             %td
@@ -144,8 +165,8 @@
                     .worker-success-count(title="successfull count")
                       = worker_stat.success_count
             %td.number= chain.optimized_size
-            %td.number= format '%.4f', chain.ratio
-            %td.number= format '%.4f', chain.avg_ratio
+            %td.number= format '%.5f', chain.ratio
+            %td.number= format '%.5f', chain.avg_ratio
             %td.number= format '%.2f', chain.time
             %td.number= format '%.5f', chain.avg_difference
             %td.number{class: chain.warn_level && "warn-#{chain.warn_level}"}

data/spec/image_optim/bin_resolver_spec.rb

@@ -102,7 +102,8 @@ describe ImageOptim::BinResolver do
       expect(resolver).to receive(:full_path).with(:ls).and_return('/bin/ls')
       bin = double
       expect(Bin).to receive(:new).with(:ls, '/bin/ls').and_return(bin)
-      expect(bin).to receive(:check!).exactly(5).times
+      expect(bin).to receive(:check!).once
+      expect(bin).to receive(:check_fail!).exactly(5).times
 
       5.times do
         expect(resolver.resolve!(:ls)).to eq(bin)
@@ -149,7 +150,8 @@ describe ImageOptim::BinResolver do
       bin = double
       expect(Bin).to receive(:new).
         with(:image_optim, File.expand_path(path)).and_return(bin)
-      expect(bin).to receive(:check!).exactly(5).times
+      expect(bin).to receive(:check!).once
+      expect(bin).to receive(:check_fail!).exactly(5).times
 
       at_exit_blocks = []
       expect(resolver).to receive(:at_exit).once do |&block|
@@ -202,9 +204,10 @@ describe ImageOptim::BinResolver do
       bin = double
       expect(Bin).to receive(:new).once.with(:ls, '/bin/ls').and_return(bin)
 
-      check_count = 0
+      count = 0
       mutex = Mutex.new
-      allow(bin).to receive(:check!){ mutex.synchronize{ check_count += 1 } }
+      allow(bin).to receive(:check!).once
+      allow(bin).to receive(:check_fail!){ mutex.synchronize{ count += 1 } }
 
       10.times.map do
         Thread.new do
@@ -212,29 +215,58 @@ describe ImageOptim::BinResolver do
         end
       end.each(&:join)
 
-      expect(check_count).to eq(10)
+      expect(count).to eq(10)
     end
   end
 
-  it 'raises if did not got bin version' do
-    bin = Bin.new(:pngcrush, '/bin/pngcrush')
-    allow(bin).to receive(:version).and_return(nil)
+  describe 'checking version' do
+    before do
+      allow(resolver).to receive(:full_path){ |name| "/bin/#{name}" }
+    end
+
+    it 'raises every time if did not get bin version' do
+      with_env 'PNGCRUSH_BIN', nil do
+        bin = Bin.new(:pngcrush, '/bin/pngcrush')
+
+        expect(Bin).to receive(:new).and_return(bin)
+        allow(bin).to receive(:version).and_return(nil)
 
-    5.times do
-      expect do
-        bin.check!
-      end.to raise_error Bin::BadVersion
+        5.times do
+          expect do
+            resolver.resolve!(:pngcrush)
+          end.to raise_error Bin::UnknownVersion
+        end
+      end
     end
-  end
 
-  it 'raises on detection of problematic version' do
-    bin = Bin.new(:pngcrush, '/bin/pngcrush')
-    allow(bin).to receive(:version).and_return(SimpleVersion.new('1.7.60'))
+    it 'raises every time on detection of misbehaving version' do
+      with_env 'PNGCRUSH_BIN', nil do
+        bin = Bin.new(:pngcrush, '/bin/pngcrush')
+
+        expect(Bin).to receive(:new).and_return(bin)
+        allow(bin).to receive(:version).and_return(SimpleVersion.new('1.7.60'))
 
-    5.times do
-      expect do
-        bin.check!
-      end.to raise_error Bin::BadVersion
+        5.times do
+          expect do
+            resolver.resolve!(:pngcrush)
+          end.to raise_error Bin::BadVersion
+        end
+      end
+    end
+
+    it 'warns once on detection of problematic version' do
+      with_env 'ADVPNG_BIN', nil do
+        bin = Bin.new(:advpng, '/bin/advpng')
+
+        expect(Bin).to receive(:new).and_return(bin)
+        allow(bin).to receive(:version).and_return(SimpleVersion.new('1.15'))
+
+        expect(bin).to receive(:warn).once
+
+        5.times do
+          resolver.resolve!(:pngcrush)
+        end
+      end
     end
   end
 end