image_optim 0.27.1 → 0.31.0

data/lib/image_optim/worker.rb

@@ -3,6 +3,7 @@
 
 require 'image_optim/cmd'
 require 'image_optim/configuration_error'
+require 'image_optim/elapsed_time'
 require 'image_optim/path'
 require 'image_optim/worker/class_methods'
 require 'shellwords'
@@ -41,7 +42,7 @@ class ImageOptim
 
     # Optimize image at src, output at dst, must be overriden in subclass
     # return true on success
-    def optimize(_src, _dst)
+    def optimize(_src, _dst, options = {})
       fail NotImplementedError, "implement method optimize in #{self.class}"
     end
 
@@ -104,7 +105,7 @@ class ImageOptim
       return if unknown_options.empty?
 
       fail ConfigurationError, "unknown options #{unknown_options.inspect} "\
-          "for #{self}"
+                               "for #{self}"
     end
 
     # Forward bin resolving to image_optim
@@ -117,47 +118,49 @@ class ImageOptim
     def wrap_resolver_error_message(message)
       name = self.class.bin_sym
       "#{name} worker: #{message}; please provide proper binary or "\
-          "disable this worker (--no-#{name} argument or "\
-          "`:#{name} => false` through options)"
+        "disable this worker (--no-#{name} argument or "\
+        "`:#{name} => false` through options)"
     end
 
     # Run command setting priority and hiding output
-    def execute(bin, *arguments)
+    def execute(bin, arguments, options)
       resolve_bin!(bin)
 
       cmd_args = [bin, *arguments].map(&:to_s)
 
-      start = Time.now
-
-      success = run_command(cmd_args)
-
       if @image_optim.verbose
-        seconds = Time.now - start
-        $stderr << "#{success ? '✓' : '✗'} #{seconds}s #{cmd_args.shelljoin}\n"
+        run_command_verbose(cmd_args, options)
+      else
+        run_command(cmd_args, options)
       end
-
-      success
     end
 
     # Run command defining environment, setting nice level, removing output and
     # reraising signal exception
-    def run_command(cmd_args)
-      args = if RUBY_VERSION < '1.9' || defined?(JRUBY_VERSION)
-        %W[
-          env PATH=#{@image_optim.env_path.shellescape}
-          nice -n #{@image_optim.nice}
-          #{cmd_args.shelljoin}
-          > #{Path::NULL} 2>&1
-        ].join(' ')
-      else
-        [
-          {'PATH' => @image_optim.env_path},
-          %W[nice -n #{@image_optim.nice}],
-          cmd_args,
-          {:out => Path::NULL, :err => Path::NULL},
-        ].flatten
-      end
+    def run_command(cmd_args, options)
+      args = [
+        {'PATH' => @image_optim.env_path},
+        *%W[nice -n #{@image_optim.nice}],
+        *cmd_args,
+        options.merge(out: Path::NULL, err: Path::NULL),
+      ]
       Cmd.run(*args)
     end
+
+    # Wrap run_command and output status, elapsed time and command
+    def run_command_verbose(cmd_args, options)
+      start = ElapsedTime.now
+
+      begin
+        success = run_command(cmd_args, options)
+        status = success ? '✓' : '✗'
+        success
+      rescue Errors::TimeoutExceeded
+        status = 'timeout'
+        raise
+      ensure
+        $stderr << format("%s %.1fs %s\n", status, ElapsedTime.now - start, cmd_args.shelljoin)
+      end
+    end
   end
 end

data/lib/image_optim.rb

@@ -3,16 +3,18 @@
 require 'image_optim/bin_resolver'
 require 'image_optim/cache'
 require 'image_optim/config'
+require 'image_optim/errors'
 require 'image_optim/handler'
 require 'image_optim/image_meta'
 require 'image_optim/optimized_path'
 require 'image_optim/path'
+require 'image_optim/timer'
 require 'image_optim/worker'
 require 'in_threads'
 require 'shellwords'
 
 %w[
-  pngcrush pngout advpng optipng pngquant
+  pngcrush pngout advpng optipng pngquant oxipng
   jhead jpegoptim jpegrecompress jpegtran
   gifsicle
   svgo
@@ -46,6 +48,9 @@ class ImageOptim
   # Cache worker digests
   attr_reader :cache_worker_digests
 
+  # Timeout in seconds for each image
+  attr_reader :timeout
+
   # Initialize workers, specify options using worker underscored name:
   #
   # pass false to disable worker
@@ -78,6 +83,7 @@ class ImageOptim
       allow_lossy
       cache_dir
       cache_worker_digests
+      timeout
     ].each do |name|
       instance_variable_set(:"@#{name}", config.send(name))
       $stderr << "#{name}: #{send(name)}\n" if verbose
@@ -110,11 +116,17 @@ class ImageOptim
     return unless (workers = workers_for_image(original))
 
     optimized = @cache.fetch(original) do
+      timer = timeout && Timer.new(timeout)
+
       Handler.for(original) do |handler|
-        workers.each do |worker|
-          handler.process do |src, dst|
-            worker.optimize(src, dst)
+        begin
+          workers.each do |worker|
+            handler.process do |src, dst|
+              worker.optimize(src, dst, timeout: timer)
+            end
           end
+        rescue Errors::TimeoutExceeded
+          handler.result
         end
       end
     end
@@ -188,12 +200,6 @@ class ImageOptim
       optimize_image_method?(method) || super
     end
 
-    if RUBY_VERSION < '1.9'
-      def respond_to?(method, include_private = false)
-        optimize_image_method?(method) || super
-      end
-    end
-
     # Version of image_optim gem spec loaded
     def version
       Gem.loaded_specs['image_optim'].version.to_s

data/script/update_worker_options_in_readme

@@ -18,7 +18,7 @@ def write_worker_options(io, klass)
     klass.option_definitions.each do |option_definition|
       line = "* `:#{option_definition.name}` — #{option_definition.description}"
       unless line['(defaults']
-        line << " *(defaults to #{option_definition.default_description})*"
+        line += " *(defaults to #{option_definition.default_description})*"
       end
       io.puts line
     end
@@ -29,7 +29,7 @@ end
 def write_marked(io)
   io.puts BEGIN_MARKER
   io.puts '<!-- markdown for worker options is generated by '\
-    "`#{Pathname($PROGRAM_NAME).cleanpath}` -->"
+          "`#{Pathname($PROGRAM_NAME).cleanpath}` -->"
   io.puts
 
   ImageOptim::Worker.klasses.sort_by(&:name).each do |klass|

data/script/worker_analysis

@@ -358,20 +358,18 @@ class Analyser
     end
 
     def flatten_animation(image)
-      run_cache[:flatten][image.digest] ||= begin
-        if image.image_format == :gif
-          flattened = image.temp_path
-          Cmd.run(*%W[
-            convert
-            #{image.image_format}:#{image}
-            -coalesce
-            -append
-            #{image.image_format}:#{flattened}
-          ]) || fail("failed flattening of #{image}")
-          flattened
-        else
-          image
-        end
+      run_cache[:flatten][image.digest] ||= if image.image_format == :gif
+        flattened = image.temp_path
+        Cmd.run(*%W[
+          convert
+          #{image.image_format}:#{image}
+          -coalesce
+          -append
+          #{image.image_format}:#{flattened}
+        ]) || fail("failed flattening of #{image}")
+        flattened
+      else
+        image
       end
     end
 
@@ -527,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)
@@ -45,22 +42,22 @@ describe ImageOptim::CachePath do
       end
 
       it 'does not preserve mtime of destination file' do
-        time = src.mtime
+        time = src.mtime - 1000
+        dst.utime(time, time)
 
-        dst.utime(time - 1000, time - 1000)
+        time = dst.mtime
 
         src.replace(dst)
 
-        expect(dst.mtime).to be >= time
+        expect(dst.mtime).to_not eq(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) }
 
@@ -102,7 +102,7 @@ describe ImageOptim::Cache do
           expect(FileUtils).not_to receive(:mv)
           expect(File).not_to receive(:rename)
 
-          expect(cache.fetch(original){}).to eq(cached)
+          expect(cache.fetch(original){ nil }).to eq(cached)
         end
 
         it 'returns nil when file is already optimized' do
@@ -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

@@ -2,10 +2,9 @@
 
 require 'spec_helper'
 require 'image_optim/cmd'
+require 'image_optim/timer'
 
 describe ImageOptim::Cmd do
-  include CapabilityCheckHelpers
-
   before do
     stub_const('Cmd', ImageOptim::Cmd)
   end
@@ -35,12 +34,72 @@ 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 'returns process success status when timeout is instance of ImageOptim::Timer' do
+        timeout = ImageOptim::Timer.new(1.0)
+        expect(Cmd.run('sh -c "exit 0"', timeout: timeout)).to eq(true)
+      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 +121,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).

data/spec/image_optim/elapsed_time_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'image_optim/elapsed_time'
+
+describe ImageOptim::ElapsedTime do
+  let(:timeout){ 0.01 }
+
+  describe '.now' do
+    it 'returns incrementing value' do
+      expect{ sleep timeout }.to change{ described_class.now }.by_at_least(timeout)
+    end
+  end
+end

data/spec/image_optim/handler_spec.rb

@@ -9,7 +9,7 @@ describe ImageOptim::Handler do
   end
 
   it 'uses original as source for first conversion '\
-      'and two temp files for further conversions' do
+     'and two temp files for further conversions' do
     original = double(:original)
     allow(original).to receive(:respond_to?).with(:temp_path).and_return(true)