image_optim 0.26.5 → 0.30.0

data/lib/image_optim/bin_resolver/comparable_condition.rb

@@ -26,6 +26,7 @@ class ImageOptim
       end
 
       attr_reader :method, :args
+
       def initialize(method, *args)
         @method, @args = method.to_sym, args
 

data/lib/image_optim/cache.rb

@@ -21,6 +21,11 @@ class ImageOptim
           "#{bin.name}[#{bin.digest}]"
         end.sort!.uniq.join(', ')]
       end]
+      @global_options = begin
+        options = {}
+        options[:timeout] = image_optim.timeout if image_optim.timeout
+        options.empty? ? '' : options.inspect
+      end
     end
 
     def fetch(original)
@@ -68,6 +73,7 @@ class ImageOptim
       digest = Digest::SHA1.file(path)
       digest.update options_by_format(format)
       digest.update bins_by_format(format) if @cache_worker_digests
+      digest.update @global_options
       s = digest.hexdigest
       "#{s[0..1]}/#{s[2..-1]}"
     end

data/lib/image_optim/cache_path.rb

@@ -7,8 +7,25 @@ class ImageOptim
   class CachePath < Path
     # Atomic replace dst with self
     def replace(dst)
-      dst = self.class.new(dst)
-      dst.temp_path(dst.dirname) do |temp|
+      dst = self.class.convert(dst)
+      tmpdir = [dirname, Path.new(Dir.tmpdir)].find do |dir|
+        dir.same_dev?(dst.dirname)
+      end
+      if tmpdir
+        begin
+          replace_using_tmp_file(dst, tmpdir)
+        rescue Errno::EXDEV
+          replace_using_tmp_file(dst, dst.dirname)
+        end
+      else
+        replace_using_tmp_file(dst, dst.dirname)
+      end
+    end
+
+  private
+
+    def replace_using_tmp_file(dst, tmpdir)
+      dst.temp_path_with_tmp_ext(tmpdir) do |temp|
         copy(temp)
         dst.copy_metadata(temp)
         temp.rename(dst.to_s)

data/lib/image_optim/cmd.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'image_optim/errors'
 require 'English'
 
 class ImageOptim
@@ -10,11 +11,30 @@ class ImageOptim
       # Return success status
       # Will raise SignalException if process was interrupted
       def run(*args)
-        success = system(*args)
+        if args.last.is_a?(Hash) && (timeout = args.last.delete(:timeout))
+          args.last[Gem.win_platform? ? :new_pgroup : :pgroup] = true
 
-        check_status!
+          pid = Process.spawn(*args)
+
+          waiter = Process.detach(pid)
+          if waiter.join(timeout)
+            status = waiter.value
+
+            check_status!(status)
+
+            status.success?
+          else
+            cleanup(pid, waiter)
 
-        success
+            fail Errors::TimeoutExceeded
+          end
+        else
+          success = system(*args)
+
+          check_status!
+
+          success
+        end
       end
 
       # Run using backtick
@@ -30,9 +50,7 @@ class ImageOptim
 
     private
 
-      def check_status!
-        status = $CHILD_STATUS
-
+      def check_status!(status = $CHILD_STATUS)
         return unless status.signaled?
 
         # jruby incorrectly returns true for `signaled?` if process exits with
@@ -46,6 +64,27 @@ class ImageOptim
 
         fail SignalException, status.termsig
       end
+
+      def cleanup(pid, waiter)
+        if Gem.win_platform?
+          kill('KILL', pid)
+        else
+          kill('-TERM', pid)
+
+          # Allow 10 seconds for the process to exit
+          waiter.join(10)
+
+          kill('-KILL', pid)
+        end
+
+        waiter.join
+      end
+
+      def kill(signal, pid)
+        Process.kill(signal, pid)
+      rescue Errno::ESRCH, Errno::EPERM
+        # expected
+      end
     end
   end
 end

data/lib/image_optim/config.rb

@@ -15,9 +15,7 @@ class ImageOptim
 
     # Global config path at `$XDG_CONFIG_HOME/image_optim.yml` (by default
     # `~/.config/image_optim.yml`)
-    GLOBAL_PATH = begin
-      File.join(ENV['XDG_CONFIG_HOME'] || '~/.config', 'image_optim.yml')
-    end
+    GLOBAL_PATH = File.join(ENV['XDG_CONFIG_HOME'] || '~/.config', 'image_optim.yml')
 
     # Local config path at `./.image_optim.yml`
     LOCAL_PATH = './.image_optim.yml'
@@ -119,6 +117,14 @@ class ImageOptim
       end
     end
 
+    # Timeout in seconds for each image:
+    # * not set by default and for `nil`
+    # * otherwise converted to float
+    def timeout
+      timeout = get!(:timeout)
+      timeout ? timeout.to_f : nil
+    end
+
     # Verbose mode, converted to boolean
     def verbose
       !!get!(:verbose)
@@ -177,7 +183,7 @@ class ImageOptim
       when true, nil
         {}
       when false
-        {:disable => true}
+        {disable: true}
       else
         fail ConfigurationError, "Got #{worker_options.inspect} for "\
             "#{klass.name} options"
@@ -197,10 +203,10 @@ class ImageOptim
       when /darwin9/
         Cmd.capture 'hwprefs cpu_count'
       when /darwin/
-        if (Cmd.capture 'which hwprefs') != ''
-          Cmd.capture 'hwprefs thread_count'
-        else
+        if (Cmd.capture 'which hwprefs') == ''
           Cmd.capture 'sysctl -n hw.ncpu'
+        else
+          Cmd.capture 'hwprefs thread_count'
         end
       when /linux/
         Cmd.capture 'grep -c processor /proc/cpuinfo'

data/lib/image_optim/elapsed_time.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class ImageOptim
+  # Use Process.clock_gettime if available to get time more fitting to calculate elapsed time
+  module ElapsedTime
+    CLOCK_NAME = %w[
+      CLOCK_UPTIME_RAW
+      CLOCK_UPTIME
+      CLOCK_MONOTONIC_RAW
+      CLOCK_MONOTONIC
+      CLOCK_REALTIME
+    ].find{ |name| Process.const_defined?(name) }
+
+    CLOCK_ID = CLOCK_NAME && Process.const_get(CLOCK_NAME)
+
+  module_function
+
+    def now
+      if CLOCK_ID
+        Process.clock_gettime(CLOCK_ID)
+      else
+        Time.now.to_f
+      end
+    end
+  end
+end

data/lib/image_optim/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ImageOptim
+  class Error < StandardError; end
+
+  module Errors
+    class TimeoutExceeded < Error; end
+  end
+end

data/lib/image_optim/optimized_path.rb

@@ -7,7 +7,7 @@ class ImageOptim
   class OptimizedPath < DelegateClass(Path)
     def initialize(path, original_or_size = nil)
       path = Path.convert(path)
-      __setobj__(path)
+      super(path)
       if original_or_size.is_a?(Integer)
         @original = path
         @original_size = original_or_size

data/lib/image_optim/path.rb

@@ -41,7 +41,7 @@ class ImageOptim
       dst.utime(stat.atime, stat.mtime) if time
       begin
         dst.chown(stat.uid, stat.gid)
-      rescue Errno::EPERM
+      rescue Errno::EPERM, Errno::EACCES
         dst.chmod(stat.mode & 0o1777)
       else
         dst.chmod(stat.mode)
@@ -50,11 +50,16 @@ class ImageOptim
 
     # Atomic replace dst with self
     def replace(dst)
-      dst = self.class.new(dst)
-      dst.temp_path(dst.dirname) do |temp|
-        move(temp)
-        dst.copy_metadata(temp)
-        temp.rename(dst.to_s)
+      dst = self.class.convert(dst)
+      if same_dev?(dst.dirname)
+        dst.copy_metadata(self)
+        begin
+          rename(dst.to_s)
+        rescue Errno::EXDEV
+          replace_using_tmp_file(dst)
+        end
+      else
+        replace_using_tmp_file(dst)
       end
     end
 
@@ -68,5 +73,23 @@ class ImageOptim
     def self.convert(path)
       path.is_a?(self) ? path : new(path)
     end
+
+  protected
+
+    def same_dev?(other)
+      stat.dev == other.stat.dev
+    end
+
+    def replace_using_tmp_file(dst)
+      dst.temp_path_with_tmp_ext(dst.dirname) do |temp|
+        move(temp)
+        dst.copy_metadata(temp)
+        temp.rename(dst.to_s)
+      end
+    end
+
+    def temp_path_with_tmp_ext(*args, &block)
+      self.class.temp_file_path([basename.to_s, '.tmp'], *args, &block)
+    end
   end
 end

data/lib/image_optim/runner/option_parser.rb

@@ -182,6 +182,10 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
     options[:allow_lossy] = allow_lossy
   end
 
+  op.on('--timeout N', Float, 'Maximum time in seconds to spend on one image') do |timeout|
+    options[:timeout] = timeout
+  end
+
   op.separator nil
 
   ImageOptim::Worker.klasses.each_with_index do |klass, i|
@@ -202,6 +206,8 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
         [Integer, 'N']
       when Array >= type
         [Array, 'a,b,c']
+      when String >= type
+        [String, 'S']
       when ImageOptim::NonNegativeIntegerRange == type
         [type, 'M-N']
       else

data/lib/image_optim/timer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'image_optim/elapsed_time'
+
+class ImageOptim
+  # Hold start time and timeout
+  class Timer
+    include ElapsedTime
+
+    def initialize(seconds)
+      @start = now
+      @seconds = seconds
+    end
+
+    def elapsed
+      now - @start
+    end
+
+    def left
+      @seconds - elapsed
+    end
+
+    alias_method :to_f, :left
+  end
+end

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
 
@@ -122,42 +123,44 @@ class ImageOptim
     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/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/class_methods.rb

@@ -18,6 +18,7 @@ class ImageOptim
 
       # Remember all classes inheriting from this one
       def inherited(base)
+        super
         @klasses << base
       end
 
@@ -36,6 +37,7 @@ class ImageOptim
 
       def option(name, default, type, description = nil, &proc)
         attr_reader name
+
         OptionDefinition.new(name, default, type, description, &proc).
           tap{ |option_definition| option_definitions << option_definition }
       end