image_optim 0.17.1 → 0.18.0

data/script/worker_analysis.haml

@@ -0,0 +1,153 @@
+!!! 5
+%html
+  %head
+    %meta(http-equiv="Content-Type" content="text/html; charset=utf-8")
+    %title Worker Analysis
+    :css
+      body {
+        font: 14px "Myriad Pro", "Helvetica", Arial, sans-serif;
+        margin: 20px;
+        padding: 0;
+      }
+
+      .formats {
+        display: block;
+        font-size: 1.5em;
+        margin: 1em 0;
+        font-weight: bold;
+      }
+
+      table {
+        border-collapse: collapse;
+        border-spacing: 0;
+      }
+      th, td {
+        border: 1px solid #ccc;
+        padding: 6px 8px 2px;
+      }
+      th {
+        text-align: left;
+        border-color: #999;
+      }
+      th:not([data-sortable="false"]) {
+        cursor: pointer;
+        padding-right: 18px;
+      }
+      th:after {
+        position: absolute;
+        width: 18px;
+        height: 14px;
+        line-height: 14px;
+        font-size: 0.8em;
+        color: #999;
+        visibility: hidden;
+        text-align: center;
+      }
+      th[data-sorted="true"]:after {
+        visibility: visible;
+      }
+      th[data-sorted-direction="descending"]:after {
+        content: "▼";
+      }
+      th[data-sorted-direction="ascending"]:after {
+        content: "▲";
+      }
+      table[data-sortable] tbody tr:hover {
+        background: #ddf;
+      }
+      tr.unused {
+        display: none;
+      }
+
+      input { margin-top: 1.5em; }
+      #toggle-show-unused:checked ~ table tr.unused { /* without js */
+        display: table-row;
+      }
+
+      .number {
+        text-align: right;
+      }
+
+      .warn-low {
+        background: rgba(255, 0, 0, 0.1);
+      }
+      .warn-medium {
+        background: rgba(255, 0, 0, 0.4);
+      }
+      .warn-high {
+        background: rgba(255, 0, 0, 0.8);
+      }
+
+      .worker-name,
+      .worker-success-count {
+        display: inline-block;
+        border-radius: 8px;
+      }
+      .worker-name {
+        background: #ddd;
+        padding: 2px 5px 0;
+        border: 1px solid #999;
+        margin: -3px 0 1px 0;
+      }
+      .worker-success-count {
+        font-size: 0.9em;
+        line-height: 1em;
+        background: #dfd;
+        padding: 1px 2px 0;
+        border: 1px solid #9b9;
+      }
+      .worker-name.unused {
+        text-decoration: line-through;
+      }
+    :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);
+  %body
+    .formats
+      - format_links.each do |format, link|
+        - if stats_format == format
+          %span= format
+        - else
+          %a(href="#{link}")= format
+    %table
+      %tr
+        %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")
+        Show chains with workers failed for every image
+    %p
+      Images: #{stats.each_chain.first.entry_count},
+      size: #{stats.each_chain.first.original_size}
+    %table(data-sortable)
+      %thead
+        %tr
+          %th Chain
+          %th(data-default-direction="ascending"
+              data-sorted="true"
+              data-sorted-direction="ascending") Optimized size
+          %th(data-default-direction="ascending") Ratio
+          %th(data-default-direction="ascending") Avg ratio
+          %th(data-default-direction="ascending") Time (s)
+          %th(data-default-direction="ascending") Avg difference
+          %th(data-default-direction="ascending") Max difference
+          %th Speed (B/s)
+      %tbody
+        - stats.each_chain do |chain|
+          %tr{class: chain.unused_workers && 'unused'}
+            %td
+              - chain.worker_stats.each do |worker_stat|
+                .worker-name{:class => worker_stat.unused? && 'unused'}
+                  = worker_stat.name
+                  - unless worker_stat.unused?
+                    .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 '%.2f', chain.time
+            %td.number= format '%.5f', chain.avg_difference
+            %td.number{class: chain.warn_level && "warn-#{chain.warn_level}"}
+              = format '%.5f', chain.max_difference
+            %td.number= format '%.2f', chain.speed

data/spec/image_optim/bin_resolver/comparable_condition_spec.rb

@@ -1,11 +1,10 @@
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
-require 'rspec'
+require 'spec_helper'
 require 'image_optim/bin_resolver/comparable_condition'
 
 describe ImageOptim::BinResolver::ComparableCondition do
   is = ImageOptim::BinResolver::ComparableCondition.is
 
-  it 'should build conditions' do
+  it 'builds conditions' do
     expect(is.between?(10, 20).method).to eq(:between?)
     expect(is.between?(10, 20).args).to eq([10, 20])
 
@@ -16,13 +15,13 @@ describe ImageOptim::BinResolver::ComparableCondition do
     expect((is < 30).args).to eq([30])
   end
 
-  it 'should stringify conditions' do
+  it 'stringifies conditions' do
     expect(is.between?(10, 20).to_s).to eq('10..20')
     expect((is >= 15).to_s).to eq('>= 15')
     expect((is < 30).to_s).to eq('< 30')
   end
 
-  it 'should match conditions' do
+  it 'matches conditions' do
     expect(is.between?(10, 20)).not_to match 9
     expect(is.between?(10, 20)).to match 15
     expect(is.between?(10, 20)).not_to match 21

data/spec/image_optim/bin_resolver/simple_version_spec.rb

@@ -1,34 +1,57 @@
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
-require 'rspec'
+require 'spec_helper'
 require 'image_optim/bin_resolver/simple_version'
 
 describe ImageOptim::BinResolver::SimpleVersion do
-  def v(str)
-    ImageOptim::BinResolver::SimpleVersion.new(str)
+  helpers = Module.new do
+    def v(str)
+      ImageOptim::BinResolver::SimpleVersion.new(str)
+    end
   end
+  include helpers
+  extend helpers
+
+  describe 'compares version 1.17' do
+    subject{ v '1.17' }
 
-  it 'should compare versions' do
-    expect(v '1.17').to be > '0'
-    expect(v '1.17').to be > '0.1'
-    expect(v '1.17').to be > '0.9'
-    expect(v '1.17').to be > '1.9'
-    expect(v '1.17').to be < '1.17.1'
-    expect(v '1.17').to be < '1.99'
-    expect(v '1.17').to be < '2.1'
+    it{ is_expected.to be > '0' }
+    it{ is_expected.to be > '0.1' }
+    it{ is_expected.to be > '0.9' }
+    it{ is_expected.to be > '1.9' }
+    it{ is_expected.to be < '1.17.1' }
+    it{ is_expected.to be < '1.99' }
+    it{ is_expected.to be < '2.1' }
   end
 
-  it 'should normalize versions' do
-    variations = %w[1 01 1.0 1.00 1.0.0 1.0.0.0]
-    variations.each do |a|
-      variations.each do |b|
-        expect(v a).to eq(b)
+  describe 'normalization' do
+    %w[
+      1
+      01
+      1.0
+      1.00
+      1.0.0
+      1.0.0.0
+    ].each do |variation|
+      it "normalizes #{variation}" do
+        expect(v variation).to eq(1)
       end
     end
   end
 
-  it 'should convert objects' do
-    expect(v 1.17).to eq('1.17')
-    expect(v '1.17').to eq('1.17')
-    expect(v(v 1.17)).to eq('1.17')
+  describe 'conversion' do
+    it 'converts Integer' do
+      expect(v 117).to eq('117')
+    end
+
+    it 'converts Float' do
+      expect(v 1.17).to eq('1.17')
+    end
+
+    it 'converts String' do
+      expect(v '1.17').to eq('1.17')
+    end
+
+    it 'converts self' do
+      expect(v(v 1.17)).to eq('1.17')
+    end
   end
 end

data/spec/image_optim/bin_resolver_spec.rb

@@ -1,20 +1,23 @@
-$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
-require 'rspec'
+require 'spec_helper'
 require 'image_optim/bin_resolver'
-
-def with_env(key, value)
-  saved, ENV[key] = ENV[key], value
-  yield
-ensure
-  ENV[key] = saved
-end
+require 'image_optim/cmd'
 
 describe ImageOptim::BinResolver do
-  BinResolver = ImageOptim::BinResolver
-  Bin = BinResolver::Bin
-  SimpleVersion = BinResolver::SimpleVersion
+  def with_env(key, value)
+    saved, ENV[key] = ENV[key], value
+    yield
+  ensure
+    ENV[key] = saved
+  end
 
-  let(:image_optim){ double(:image_optim, :verbose => false) }
+  before do
+    stub_const('BinResolver', ImageOptim::BinResolver)
+    stub_const('Bin', BinResolver::Bin)
+    stub_const('SimpleVersion', BinResolver::SimpleVersion)
+    stub_const('Cmd', ImageOptim::Cmd)
+  end
+
+  let(:image_optim){ double(:image_optim, :verbose => false, :pack => false) }
   let(:resolver){ BinResolver.new(image_optim) }
 
   describe :full_path do
@@ -23,25 +26,39 @@ describe ImageOptim::BinResolver do
     end
 
     def command_v(name)
-      path = `sh -c 'command -v #{name}' 2> /dev/null`.strip
+      path = Cmd.capture("sh -c 'command -v #{name}' 2> /dev/null").strip
       path unless path.empty?
     end
 
-    it 'should find binary in path' do
+    it 'finds binary in path' do
       with_env 'PATH', 'bin' do
         expect(full_path('image_optim')).
           to eq(File.expand_path('bin/image_optim'))
       end
     end
 
-    it 'should find bin in vendor' do
+    it 'finds bin in vendor' do
       with_env 'PATH', nil do
         expect(full_path('jpegrescan')).
           to eq(File.expand_path('vendor/jpegrescan'))
       end
     end
 
-    it 'should work with different path separator' do
+    it 'finds bin in pack' do
+      allow(image_optim).to receive(:pack).and_return(true)
+      stub_const('ImageOptim::Pack', Class.new do
+        def self.path
+          'script'
+        end
+      end)
+
+      with_env 'PATH', nil do
+        expect(full_path('update_worker_options_in_readme')).
+          to eq(File.expand_path('script/update_worker_options_in_readme'))
+      end
+    end
+
+    it 'works with different path separator' do
       stub_const('File::PATH_SEPARATOR', 'O_o')
       with_env 'PATH', 'bin' do
         expect(full_path('image_optim')).
@@ -49,20 +66,37 @@ describe ImageOptim::BinResolver do
       end
     end
 
-    it 'should return nil on failure' do
+    it 'returns nil on failure' do
       with_env 'PATH', 'lib' do
         expect(full_path('image_optim')).to be_nil
       end
     end
 
-    %w[ls sh which bash image_optim should_not_exist].each do |name|
-      it "should return same path as `command -v` for #{name}" do
+    %w[ls sh which bash image_optim does_not_exist].each do |name|
+      it "returns same path as `command -v` for #{name}" do
         expect(full_path(name)).to eq(command_v(name))
       end
     end
   end
 
-  it 'should resolve bin in path' do
+  it 'combines path in order dir:pack:path:vendor' do
+    allow(image_optim).to receive(:pack).and_return(true)
+    stub_const('ImageOptim::Pack', Class.new do
+      def self.path
+        'pack_path'
+      end
+    end)
+    allow(resolver).to receive(:dir).and_return('temp_dir')
+
+    expect(resolver.env_path).to eq([
+      'temp_dir',
+      'pack_path',
+      ENV['PATH'],
+      BinResolver::VENDOR_PATH,
+    ].join(':'))
+  end
+
+  it 'resolves bin in path and returns instance of Bin' do
     with_env 'LS_BIN', nil do
       expect(FSPath).not_to receive(:temp_dir)
       expect(resolver).to receive(:full_path).with(:ls).and_return('/bin/ls')
@@ -71,7 +105,7 @@ describe ImageOptim::BinResolver do
       expect(bin).to receive(:check!).exactly(5).times
 
       5.times do
-        resolver.resolve!(:ls)
+        expect(resolver.resolve!(:ls)).to eq(bin)
       end
       expect(resolver.env_path).to eq([
         ENV['PATH'],
@@ -80,7 +114,7 @@ describe ImageOptim::BinResolver do
     end
   end
 
-  it 'should raise on failure to resolve bin' do
+  it 'raises on failure to resolve bin' do
     with_env 'LS_BIN', nil do
       expect(FSPath).not_to receive(:temp_dir)
       expect(resolver).to receive(:full_path).with(:ls).and_return(nil)
@@ -98,7 +132,7 @@ describe ImageOptim::BinResolver do
     end
   end
 
-  it 'should resolve bin specified in ENV' do
+  it 'resolves bin specified in ENV' do
     path = 'bin/image_optim'
     with_env 'IMAGE_OPTIM_BIN', path do
       tmpdir = double(:tmpdir, :to_str => 'tmpdir')
@@ -137,11 +171,11 @@ describe ImageOptim::BinResolver do
   end
 
   {
-    'some/path/should_not_exist_bin' => 'doesn\'t exist',
+    'some/path/does/not/exist' => 'doesn\'t exist',
     '.' => 'is not a file',
     __FILE__ => 'is not executable',
   }.each do |path, error_message|
-    it "should raise when bin specified in ENV #{error_message}" do
+    it "raises when bin specified in ENV #{error_message}" do
       with_env 'IMAGE_OPTIM_BIN', path do
         expect(FSPath).not_to receive(:temp_dir)
         expect(resolver).not_to receive(:at_exit)
@@ -159,7 +193,7 @@ describe ImageOptim::BinResolver do
     end
   end
 
-  it 'should resolve bin only once, but check every time' do
+  it 'resolves bin only once, but checks every time' do
     with_env 'LS_BIN', nil do
       expect(resolver).to receive(:full_path).once.with(:ls) do
         sleep 0.1
@@ -182,7 +216,7 @@ describe ImageOptim::BinResolver do
     end
   end
 
-  it 'should raise if did not got bin version' do
+  it 'raises if did not got bin version' do
     bin = Bin.new(:pngcrush, '/bin/pngcrush')
     allow(bin).to receive(:version).and_return(nil)
 
@@ -193,7 +227,7 @@ describe ImageOptim::BinResolver do
     end
   end
 
-  it 'should raise on detection of problematic version' do
+  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'))
 

data/spec/image_optim/cmd_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'image_optim/cmd'
+
+describe ImageOptim::Cmd do
+  before do
+    stub_const('Cmd', ImageOptim::Cmd)
+  end
+
+  def expect_int_exception(&block)
+    expect(&block).to raise_error(SignalException) do |error|
+      expect(error.message.to_s).to match(/INT|#{Signal.list['INT']}/)
+    end
+  end
+
+  describe :run do
+    it 'calls system and returns result' do
+      status = double
+      expect(Cmd).to receive(:system).with('cmd', 'arg').and_return(status)
+      allow(Cmd).to receive(:check_status!)
+      expect(Cmd.run('cmd', 'arg')).to eq(status)
+    end
+
+    it 'returns process success status' do
+      expect(Cmd.run('sh -c exit\ 0')).to eq(true)
+      expect($CHILD_STATUS.exitstatus).to eq(0)
+
+      expect(Cmd.run('sh -c exit\ 1')).to eq(false)
+      expect($CHILD_STATUS.exitstatus).to eq(1)
+
+      expect(Cmd.run('sh -c exit\ 66')).to eq(false)
+      expect($CHILD_STATUS.exitstatus).to eq(66)
+    end
+
+    it 'raises SignalException if process terminates after signal' do
+      expect_int_exception do
+        Cmd.run('kill -s INT $$')
+      end
+    end
+  end
+
+  describe :capture do
+    it 'calls ` and returns result' do
+      output = double
+      expect(Cmd).to receive(:`).with('cmd arg arg+').and_return(output)
+      allow(Cmd).to receive(:check_status!)
+      expect(Cmd.capture('cmd arg arg+')).to eq(output)
+    end
+
+    it 'returns output' do
+      expect(Cmd.capture('echo test')).to eq("test\n")
+      expect($CHILD_STATUS.exitstatus).to eq(0)
+
+      expect(Cmd.capture('printf more; sh -c exit\ 1')).to eq('more')
+      expect($CHILD_STATUS.exitstatus).to eq(1)
+
+      expect(Cmd.capture('sh -c exit\ 66')).to eq('')
+      expect($CHILD_STATUS.exitstatus).to eq(66)
+    end
+
+    it 'raises SignalException if process terminates after signal' do
+      expect_int_exception do
+        Cmd.capture('kill -s INT $$')
+      end
+    end
+  end
+end