image_optim 0.29.0 → 0.30.0

data/lib/image_optim/worker/advpng.rb

@@ -21,7 +21,7 @@ class ImageOptim
         4
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         src.copy(dst)
         args = %W[
           --recompress
@@ -30,7 +30,7 @@ class ImageOptim
           --
           #{dst}
         ]
-        execute(:advpng, *args) && optimized?(src, dst)
+        execute(:advpng, args, options) && optimized?(src, dst)
       end
     end
   end

data/lib/image_optim/worker/gifsicle.rb

@@ -12,7 +12,7 @@ class ImageOptim
         return super if options.key?(:interlace)
 
         [false, true].map do |interlace|
-          new(image_optim, options.merge(:interlace => interlace))
+          new(image_optim, options.merge(interlace: interlace))
         end
       end
 
@@ -37,7 +37,7 @@ class ImageOptim
       CAREFUL_OPTION =
       option(:careful, false, 'Avoid bugs with some software'){ |v| !!v }
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         args = %W[
           --output=#{dst}
           --no-comments
@@ -58,7 +58,7 @@ class ImageOptim
         end
         args.unshift '--careful' if careful
         args.unshift "--optimize=#{level}" if level
-        execute(:gifsicle, *args) && optimized?(src, dst)
+        execute(:gifsicle, args, options) && optimized?(src, dst)
       end
     end
   end

data/lib/image_optim/worker/jhead.rb

@@ -25,7 +25,7 @@ class ImageOptim
         [:jhead, :jpegtran]
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         return false unless oriented?(src)
 
         src.copy(dst)
@@ -34,7 +34,7 @@ class ImageOptim
           #{dst}
         ]
         resolve_bin!(:jpegtran)
-        execute(:jhead, *args) && dst.size?
+        execute(:jhead, args, options) && dst.size?
       end
 
     private

data/lib/image_optim/worker/jpegoptim.rb

@@ -47,7 +47,7 @@ class ImageOptim
         max_quality < 100 ? -1 : 0
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         src.copy(dst)
         args = %W[
           --quiet
@@ -58,7 +58,7 @@ class ImageOptim
           args.unshift "--strip-#{strip_marker}"
         end
         args.unshift "--max=#{max_quality}" if max_quality < 100
-        execute(:jpegoptim, *args) && optimized?(src, dst)
+        execute(:jpegoptim, args, options) && optimized?(src, dst)
       end
     end
   end

data/lib/image_optim/worker/jpegrecompress.rb

@@ -49,7 +49,7 @@ class ImageOptim
         -5
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         args = %W[
           --quality #{QUALITY_NAMES[quality]}
           --method #{method}
@@ -57,7 +57,7 @@ class ImageOptim
           #{src}
           #{dst}
         ]
-        execute(:'jpeg-recompress', *args) && optimized?(src, dst)
+        execute(:'jpeg-recompress', args, options) && optimized?(src, dst)
       end
     end
   end

data/lib/image_optim/worker/jpegtran.rb

@@ -23,7 +23,7 @@ class ImageOptim
         jpegrescan ? [:jpegtran, :jpegrescan] : [:jpegtran]
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         if jpegrescan
           args = %W[
             #{src}
@@ -31,7 +31,7 @@ class ImageOptim
           ]
           args.unshift '-s' unless copy_chunks
           resolve_bin!(:jpegtran)
-          execute(:jpegrescan, *args) && optimized?(src, dst)
+          execute(:jpegrescan, args, options) && optimized?(src, dst)
         else
           args = %W[
             -optimize
@@ -40,7 +40,7 @@ class ImageOptim
           ]
           args.unshift '-copy', (copy_chunks ? 'all' : 'none')
           args.unshift '-progressive' if progressive
-          execute(:jpegtran, *args) && optimized?(src, dst)
+          execute(:jpegtran, args, options) && optimized?(src, dst)
         end
       end
     end

data/lib/image_optim/worker/optipng.rb

@@ -30,7 +30,7 @@ class ImageOptim
         -4
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         src.copy(dst)
         args = %W[
           -o #{level}
@@ -42,7 +42,7 @@ class ImageOptim
         if strip && resolve_bin!(:optipng).version >= '0.7'
           args.unshift '-strip', 'all'
         end
-        execute(:optipng, *args) && optimized?(src, dst)
+        execute(:optipng, args, options) && optimized?(src, dst)
       end
 
       def optimized?(src, dst)

data/lib/image_optim/worker/pngcrush.rb

@@ -28,7 +28,7 @@ class ImageOptim
         -6
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         flags = %w[
           -reduce
           -cc
@@ -49,7 +49,7 @@ class ImageOptim
           #{dst}
         ]
 
-        execute(:pngcrush, *args) && optimized?(src, dst)
+        execute(:pngcrush, args, options) && optimized?(src, dst)
       end
     end
   end

data/lib/image_optim/worker/pngout.rb

@@ -24,7 +24,7 @@ class ImageOptim
         2
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         args = %W[
           -k#{copy_chunks ? 1 : 0}
           -s#{strategy}
@@ -33,7 +33,7 @@ class ImageOptim
           #{src}
           #{dst}
         ]
-        execute(:pngout, *args) && optimized?(src, dst)
+        execute(:pngout, args, options) && optimized?(src, dst)
       rescue SignalException => e
         raise unless Signal.list.key(e.signo) == 'SEGV'
         raise unless resolve_bin!(:pngout).version <= '20150920'

data/lib/image_optim/worker/pngquant.rb

@@ -50,7 +50,7 @@ class ImageOptim
         -2
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         args = %W[
           --quality=#{quality.begin}-#{quality.end}
           --speed=#{speed}
@@ -61,7 +61,7 @@ class ImageOptim
           --
           #{src}
         ]
-        execute(:pngquant, *args) && optimized?(src, dst)
+        execute(:pngquant, args, options) && optimized?(src, dst)
       end
     end
   end

data/lib/image_optim/worker/svgo.rb

@@ -16,7 +16,7 @@ class ImageOptim
         Array(v).map(&:to_s)
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         args = %W[
           --input #{src}
           --output #{dst}
@@ -27,7 +27,7 @@ class ImageOptim
         enable_plugins.each do |plugin_name|
           args.unshift "--enable=#{plugin_name}"
         end
-        execute(:svgo, *args) && optimized?(src, dst)
+        execute(:svgo, args, options) && optimized?(src, dst)
       end
     end
   end

data/script/worker_analysis

@@ -525,10 +525,10 @@ class Analyser
       stats = Stats.new('all', by_format[format], worker_ids2names)
       path = FSPath("#{DIR}/#{basenames[format]}")
       model = {
-        :stats_format => format,
-        :stats => stats,
-        :format_links => basenames,
-        :template_dir => template_path.dirname.relative_path_from(path.dirname),
+        stats_format: format,
+        stats: stats,
+        format_links: basenames,
+        template_dir: template_path.dirname.relative_path_from(path.dirname),
       }
       html = template.result(OpenStruct.new(model).instance_eval{ binding })
       path.write(html)

data/spec/image_optim/bin_resolver_spec.rb

@@ -19,7 +19,7 @@ describe ImageOptim::BinResolver do
     allow(ENV).to receive(:[]).and_call_original
   end
 
-  let(:image_optim){ double(:image_optim, :verbose => false, :pack => false) }
+  let(:image_optim){ double(:image_optim, verbose: false, pack: false) }
   let(:resolver){ BinResolver.new(image_optim) }
 
   describe '#full_path' do
@@ -130,7 +130,7 @@ describe ImageOptim::BinResolver do
   it 'resolves bin specified in ENV' do
     path = 'bin/the_optimizer'
     stub_env 'THE_OPTIMIZER_BIN', path
-    tmpdir = double(:tmpdir, :to_str => 'tmpdir')
+    tmpdir = double(:tmpdir, to_str: 'tmpdir')
     symlink = double(:symlink)
 
     full_path = File.expand_path(path)
@@ -180,9 +180,9 @@ describe ImageOptim::BinResolver do
       stub_env 'THE_OPTIMIZER_BIN', path
       expect(FSPath).not_to receive(:temp_dir)
       expect(resolver).not_to receive(:at_exit)
-      allow(File).to receive_messages(:exist? => exist?,
-                                      :file? => file?,
-                                      :executable? => executable?)
+      allow(File).to receive_messages(exist?: exist?,
+                                      file?: file?,
+                                      executable?: executable?)
     end
 
     after do

data/spec/image_optim/cache_path_spec.rb

@@ -5,8 +5,6 @@ require 'image_optim/cache_path'
 require 'tempfile'
 
 describe ImageOptim::CachePath do
-  include CapabilityCheckHelpers
-
   before do
     stub_const('Path', ImageOptim::Path)
     stub_const('CachePath', ImageOptim::CachePath)
@@ -32,8 +30,7 @@ describe ImageOptim::CachePath do
         expect(src).to exist
       end
 
-      it 'preserves attributes of destination file' do
-        skip 'full file modes are not support' unless any_file_modes_allowed?
+      it 'preserves attributes of destination file', skip: SkipConditions[:any_file_mode_allowed] do
         mode = 0o666
 
         dst.chmod(mode)
@@ -54,13 +51,12 @@ describe ImageOptim::CachePath do
         expect(dst.mtime).to be >= time
       end
 
-      it 'changes inode of destination' do
-        skip 'inodes are not supported' unless inodes_supported?
+      it 'changes inode of destination', skip: SkipConditions[:inodes_support] do
         expect{ src.replace(dst) }.to change{ dst.stat.ino }
       end
 
       it 'is using temporary file with .tmp extension' do
-        expect(src).to receive(:copy).with(having_attributes(:extname => '.tmp')).at_least(:once)
+        expect(src).to receive(:copy).with(having_attributes(extname: '.tmp')).at_least(:once)
 
         src.replace(dst)
       end

data/spec/image_optim/cache_spec.rb

@@ -11,7 +11,7 @@ describe ImageOptim::Cache do
     stub_const('CachePath', ImageOptim::CachePath)
   end
 
-  let(:tmp_file){ double('/somewhere/tmp/foo/bar', :rename => 0) }
+  let(:tmp_file){ double('/somewhere/tmp/foo/bar', rename: 0) }
 
   let(:cache_dir) do
     dir = '/somewhere/cache'
@@ -24,7 +24,7 @@ describe ImageOptim::Cache do
   end
 
   let(:original) do
-    original = double('/somewhere/original', :image_format => :ext)
+    original = double('/somewhere/original', image_format: :ext)
     allow(Digest::SHA1).to receive(:file).with(original) do
       Digest::SHA1.new << 'some content!'
     end
@@ -32,7 +32,7 @@ describe ImageOptim::Cache do
   end
 
   let(:optimized) do
-    double('/somewhere/optimized', :format => :ext, :basename => 'optimized')
+    double('/somewhere/optimized', format: :ext, basename: 'optimized')
   end
 
   let(:cached) do
@@ -45,7 +45,7 @@ describe ImageOptim::Cache do
 
   context 'when cache is disabled (default)' do
     let(:image_optim) do
-      double(:image_optim, :cache_dir => nil, :cache_worker_digests => false)
+      double(:image_optim, cache_dir: nil, cache_worker_digests: false, timeout: nil)
     end
     let(:cache){ Cache.new(image_optim, double) }
 
@@ -122,7 +122,7 @@ describe ImageOptim::Cache do
   context 'when cache is enabled (without worker digests)' do
     let(:image_optim) do
       double(:image_optim,
-             :cache_dir => cache_dir, :cache_worker_digests => false)
+             cache_dir: cache_dir, cache_worker_digests: false, timeout: nil)
     end
     let(:cache) do
       cache = Cache.new(image_optim, {})
@@ -144,8 +144,8 @@ describe ImageOptim::Cache do
   context 'when cache is enabled (with worker digests)' do
     let(:image_optim) do
       double(:image_optim,
-             :cache_dir => cache_dir,
-             :cache_worker_digests => true)
+             cache_dir: cache_dir,
+             cache_worker_digests: true, timeout: nil)
     end
     let(:cache) do
       cache = Cache.new(image_optim, {})

data/spec/image_optim/cmd_spec.rb

@@ -4,8 +4,6 @@ require 'spec_helper'
 require 'image_optim/cmd'
 
 describe ImageOptim::Cmd do
-  include CapabilityCheckHelpers
-
   before do
     stub_const('Cmd', ImageOptim::Cmd)
   end
@@ -35,12 +33,67 @@ describe ImageOptim::Cmd do
       expect($CHILD_STATUS.exitstatus).to eq(66)
     end
 
-    it 'raises SignalException if process terminates after signal' do
-      skip 'signals are not supported' unless signals_supported?
+    it 'raises SignalException if process terminates after signal', skip: SkipConditions[:signals_support] do
       expect_int_exception do
         Cmd.run('kill -s INT $$')
       end
     end
+
+    context 'with timeout' do
+      it 'returns process success status' do
+        expect(Cmd.run('sh -c "exit 0"', timeout: 1)).to eq(true)
+
+        expect(Cmd.run('sh -c "exit 1"', timeout: 1)).to eq(false)
+
+        expect(Cmd.run('sh -c "exit 66"', timeout: 1)).to eq(false)
+      end
+
+      it 'raises SignalException if process terminates after signal', skip: SkipConditions[:signals_support] do
+        expect_int_exception do
+          Cmd.run('kill -s INT $$', timeout: 1)
+        end
+      end
+
+      it 'raises TimeoutExceeded if process does not exit until timeout' do
+        expect do
+          Cmd.run('sleep 10', timeout: 0)
+        end.to raise_error(ImageOptim::Errors::TimeoutExceeded)
+      end
+
+      it 'does not leave zombie threads' do
+        expect do
+          begin
+            Cmd.run('sleep 10', timeout: 0)
+          rescue ImageOptim::Errors::TimeoutExceeded
+            # noop
+          end
+        end.not_to change{ Thread.list }
+      end
+
+      it 'receives TERM', skip: SkipConditions[:signals_support] do
+        waiter = double
+        allow(Process).to receive(:detach).once{ |pid| @pid = pid; waiter }
+        allow(waiter).to receive(:join){ sleep 0.1; nil }
+
+        expect do
+          Cmd.run('sleep 5', timeout: 0.1)
+        end.to raise_error(ImageOptim::Errors::TimeoutExceeded)
+
+        expect(Process.wait2(@pid).last.termsig).to eq(Signal.list['TERM'])
+      end
+
+      it 'receives KILL if it does not react on TERM', skip: SkipConditions[:signals_support] do
+        waiter = double
+        allow(Process).to receive(:detach).once{ |pid| @pid = pid; waiter }
+        allow(waiter).to receive(:join){ sleep 0.1; nil }
+
+        expect do
+          Cmd.run('trap "" TERM; sleep 5', timeout: 0.1)
+        end.to raise_error(ImageOptim::Errors::TimeoutExceeded)
+
+        expect(Process.wait2(@pid).last.termsig).to eq(Signal.list['KILL'])
+      end
+    end
   end
 
   describe '.capture' do
@@ -62,8 +115,7 @@ describe ImageOptim::Cmd do
       expect($CHILD_STATUS.exitstatus).to eq(66)
     end
 
-    it 'raises SignalException if process terminates after signal' do
-      skip 'signals are not supported' unless signals_supported?
+    it 'raises SignalException if process terminates after signal', skip: SkipConditions[:signals_support] do
       expect_int_exception do
         Cmd.capture('kill -s INT $$')
       end

data/spec/image_optim/config_spec.rb

@@ -19,7 +19,7 @@ describe ImageOptim::Config do
     end
 
     it 'raises when there are unused options' do
-      config = IOConfig.new(:unused => true)
+      config = IOConfig.new(unused: true)
       expect do
         config.assert_no_unused_options!
       end.to raise_error(ImageOptim::ConfigurationError)
@@ -37,12 +37,12 @@ describe ImageOptim::Config do
     end
 
     it 'is 0 if disabled' do
-      config = IOConfig.new(:nice => false)
+      config = IOConfig.new(nice: false)
       expect(config.nice).to eq(0)
     end
 
     it 'converts value to number' do
-      config = IOConfig.new(:nice => '13')
+      config = IOConfig.new(nice: '13')
       expect(config.nice).to eq(13)
     end
   end
@@ -59,16 +59,32 @@ describe ImageOptim::Config do
     end
 
     it 'is 1 if disabled' do
-      config = IOConfig.new(:threads => false)
+      config = IOConfig.new(threads: false)
       expect(config.threads).to eq(1)
     end
 
     it 'converts value to number' do
-      config = IOConfig.new(:threads => '616')
+      config = IOConfig.new(threads: '616')
       expect(config.threads).to eq(616)
     end
   end
 
+  describe '#timeout' do
+    before do
+      allow(IOConfig).to receive(:read_options).and_return({})
+    end
+
+    it 'is nil by default' do
+      config = IOConfig.new({})
+      expect(config.timeout).to eq(nil)
+    end
+
+    it 'converts value to a float' do
+      config = IOConfig.new(timeout: '15.1')
+      expect(config.timeout).to eq(15.1)
+    end
+  end
+
   describe '#cache_dir' do
     before do
       allow(IOConfig).to receive(:read_options).and_return({})
@@ -80,7 +96,7 @@ describe ImageOptim::Config do
     end
 
     it 'is nil if set to the empty string' do
-      config = IOConfig.new(:cache_dir => '')
+      config = IOConfig.new(cache_dir: '')
       expect(config.cache_dir).to be nil
     end
   end
@@ -112,17 +128,17 @@ describe ImageOptim::Config do
     end
 
     it 'returns passed hash' do
-      config = IOConfig.new(:abc => {:option => true})
-      expect(config.for_worker(Abc)).to eq(:option => true)
+      config = IOConfig.new(abc: {option: true})
+      expect(config.for_worker(Abc)).to eq(option: true)
     end
 
     it 'returns {:disable => true} for false' do
-      config = IOConfig.new(:abc => false)
-      expect(config.for_worker(Abc)).to eq(:disable => true)
+      config = IOConfig.new(abc: false)
+      expect(config.for_worker(Abc)).to eq(disable: true)
     end
 
     it 'raises on unknown option' do
-      config = IOConfig.new(:abc => 13)
+      config = IOConfig.new(abc: 13)
       expect do
         config.for_worker(Abc)
       end.to raise_error(ImageOptim::ConfigurationError)
@@ -132,11 +148,11 @@ describe ImageOptim::Config do
   describe '#initialize' do
     it 'reads options from default locations' do
       expect(IOConfig).to receive(:read_options).
-        with(IOConfig::GLOBAL_PATH).and_return(:a => 1, :b => 2, :c => 3)
+        with(IOConfig::GLOBAL_PATH).and_return(a: 1, b: 2, c: 3)
       expect(IOConfig).to receive(:read_options).
-        with(IOConfig::LOCAL_PATH).and_return(:a => 10, :b => 20)
+        with(IOConfig::LOCAL_PATH).and_return(a: 10, b: 20)
 
-      config = IOConfig.new(:a => 100)
+      config = IOConfig.new(a: 100)
       expect(config.get!(:a)).to eq(100)
       expect(config.get!(:b)).to eq(20)
       expect(config.get!(:c)).to eq(3)
@@ -146,17 +162,17 @@ describe ImageOptim::Config do
     it 'does not read options with empty config_paths' do
       expect(IOConfig).not_to receive(:read_options)
 
-      config = IOConfig.new(:config_paths => [])
+      config = IOConfig.new(config_paths: [])
       config.assert_no_unused_options!
     end
 
     it 'reads options from specified paths' do
       expect(IOConfig).to receive(:read_options).
-        with('/etc/image_optim.yml').and_return(:a => 1, :b => 2, :c => 3)
+        with('/etc/image_optim.yml').and_return(a: 1, b: 2, c: 3)
       expect(IOConfig).to receive(:read_options).
-        with('config/image_optim.yml').and_return(:a => 10, :b => 20)
+        with('config/image_optim.yml').and_return(a: 10, b: 20)
 
-      config = IOConfig.new(:a => 100, :config_paths => %w[
+      config = IOConfig.new(a: 100, config_paths: %w[
         /etc/image_optim.yml
         config/image_optim.yml
       ])
@@ -170,7 +186,7 @@ describe ImageOptim::Config do
       expect(IOConfig).to receive(:read_options).
         with('config/image_optim.yml').and_return({})
 
-      config = IOConfig.new(:config_paths => 'config/image_optim.yml')
+      config = IOConfig.new(config_paths: 'config/image_optim.yml')
       config.assert_no_unused_options!
     end
   end
@@ -200,7 +216,7 @@ describe ImageOptim::Config do
 
     it 'returns hash with deep symbolised keys from reader' do
       stringified = {'config' => {'this' => true}}
-      symbolized = {:config => {:this => true}}
+      symbolized = {config: {this: true}}
 
       expect(IOConfig).not_to receive(:warn)
       expect(File).to receive(:expand_path).