image_optim 0.27.1 → 0.31.0

data/lib/image_optim/runner/option_parser.rb

@@ -38,7 +38,7 @@ class ImageOptim
         columns = terminal_columns - 1
         # 1 for distance between summary and description
         # 2 for additional indent
-        wrapped_indent = summary_indent + ' ' * (summary_width + 1 + 2)
+        wrapped_indent = summary_indent + (' ' * (summary_width + 1 + 2))
         wrapped_width = columns - wrapped_indent.length
         # don't try to wrap if there is too little space for description
         return text if wrapped_width < 20
@@ -84,7 +84,7 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   ImageOptim::TrueFalseNil.add_to_option_parser(op)
   ImageOptim::NonNegativeIntegerRange.add_to_option_parser(op)
 
-  op.banner = <<-TEXT.gsub(/^\s*\|/, '')
+  op.banner = <<-TEXT.gsub(/^\s*\|/, '') # rubocop:disable Layout/DotPosition
     |#{ImageOptim.full_version}
     |
     |Usage:
@@ -97,29 +97,29 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   TEXT
 
   op.on('--config-paths PATH1,PATH2', Array, 'Config paths to use instead of '\
-      'default ones') do |paths|
+                                             'default ones') do |paths|
     options[:config_paths] = paths
   end
 
   op.separator nil
 
   op.on('-r', '-R', '--recursive', 'Recursively scan directories '\
-      'for images') do |recursive|
+                                   'for images') do |recursive|
     options[:recursive] = recursive
   end
 
   op.on("--exclude-dir 'GLOB'", 'Glob for excluding directories '\
-      '(defaults to .*)') do |glob|
+                                '(defaults to .*)') do |glob|
     options[:exclude_dir_glob] = glob
   end
 
   op.on("--exclude-file 'GLOB'", 'Glob for excluding files '\
-      '(defaults to .*)') do |glob|
+                                 '(defaults to .*)') do |glob|
     options[:exclude_file_glob] = glob
   end
 
   op.on("--exclude 'GLOB'", 'Set glob for excluding both directories and '\
-      'files') do |glob|
+                            'files') do |glob|
     options[:exclude_file_glob] = options[:exclude_dir_glob] = glob
   end
 
@@ -130,19 +130,19 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   end
 
   op.on('--[no-]threads N', Integer, 'Number of threads or disable '\
-      '(defaults to number of processors)') do |threads|
+                                     '(defaults to number of processors)') do |threads|
     options[:threads] = threads
   end
 
   op.on('--[no-]nice N', Integer, 'Nice level, priority of all used tools '\
-      'with higher value meaning lower priority, in range -20..19, negative '\
-      'values can be set only if run by root user (defaults to 10)') do |nice|
+                                  'with higher value meaning lower priority, in range -20..19, negative '\
+                                  'values can be set only if run by root user (defaults to 10)') do |nice|
     options[:nice] = nice
   end
 
   op.on('--[no-]pack', 'Require image_optim_pack or disable it, '\
-      'by default image_optim_pack will be used if available, '\
-      'will turn on skip-missing-workers unless explicitly disabled') do |pack|
+                       'by default image_optim_pack will be used if available, '\
+                       'will turn on skip-missing-workers unless explicitly disabled') do |pack|
     options[:pack] = pack
   end
 
@@ -150,12 +150,12 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   op.separator '  Caching:'
 
   op.on('--cache-dir DIR', 'Cache optimized images '\
-        'into the specified directory') do |cache_dir|
+                           'into the specified directory') do |cache_dir|
     options[:cache_dir] = cache_dir
   end
 
   op.on('--cache-worker-digests', 'Cache worker digests '\
-        '(updating workers invalidates cache)') do |cache_worker_digests|
+                                  '(updating workers invalidates cache)') do |cache_worker_digests|
     options[:cache_worker_digests] = cache_worker_digests
   end
 
@@ -163,7 +163,7 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   op.separator '  Disabling workers:'
 
   op.on('--[no-]skip-missing-workers', 'Skip workers with missing or '\
-      'problematic binaries') do |skip|
+                                       'problematic binaries') do |skip|
     options[:skip_missing_workers] = skip
   end
 
@@ -178,10 +178,14 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   op.separator '  Worker options:'
 
   op.on('--allow-lossy', 'Allow lossy workers and '\
-      'optimizations') do |allow_lossy|
+                         'optimizations') do |allow_lossy|
     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
@@ -224,8 +230,8 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   op.separator '  Common options:'
 
   op.on_tail('-v', '--verbose', 'Verbose output (show global and worker '\
-      'config, binary resolution log, information about each tool invocation, '\
-      'backtrace of exception)') do
+                                'config, binary resolution log, information about each tool invocation, '\
+                                'backtrace of exception)') do
     options[:verbose] = true
   end
 

data/lib/image_optim/runner.rb

@@ -38,7 +38,7 @@ class ImageOptim
         if size_a == size_b
           "------ #{Space::EMPTY_SPACE}"
         else
-          percent = 100 - 100.0 * size_b / size_a
+          percent = 100 - (100.0 * size_b / size_a)
           space = Space.space(size_a - size_b)
           format('%5.2f%% %s', percent, space)
         end

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/advpng.rb

@@ -9,11 +9,11 @@ class ImageOptim
     class Advpng < Worker
       LEVEL_OPTION =
       option(:level, 4, 'Compression level: '\
-          '`0` - don\'t compress, '\
-          '`1` - fast, '\
-          '`2` - normal, '\
-          '`3` - extra, '\
-          '`4` - extreme') do |v|
+                        '`0` - don\'t compress, '\
+                        '`1` - fast, '\
+                        '`2` - normal, '\
+                        '`3` - extra, '\
+                        '`4` - extreme') do |v|
         OptionHelpers.limit_with_range(v.to_i, 0..4)
       end
 
@@ -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,32 +12,32 @@ 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
 
       INTERLACE_OPTION =
       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|
+                                              '`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: '\
-          '`1` - light and fast, '\
-          '`2` - normal, '\
-          '`3` - heavy (slower)') do |v|
+                        '`1` - light and fast, '\
+                        '`2` - normal, '\
+                        '`3` - heavy (slower)') do |v|
         OptionHelpers.limit_with_range(v.to_i, 1..3)
       end
 
       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

@@ -11,14 +11,16 @@ class ImageOptim
       option(:allow_lossy, false, 'Allow limiting maximum quality'){ |v| !!v }
 
       STRIP_OPTION =
-      option(:strip, :all, Array, 'List of extra markers to strip: '\
-          '`:comments`, '\
-          '`:exif`, '\
-          '`:iptc`, '\
-          '`:icc` or '\
-          '`:all`') do |v|
+      option(:strip, :all, Array, 'List of markers to strip: '\
+                                  '`:com`, '\
+                                  '`:exif`, '\
+                                  '`:iptc`, '\
+                                  '`:icc`, '\
+                                  '`:xmp`, '\
+                                  '`:none` or '\
+                                  '`:all`') do |v|
         values = Array(v).map(&:to_s)
-        known_values = %w[all comments exif iptc icc]
+        known_values = %w[com exif iptc icc xmp none all]
         unknown_values = values - known_values
         unless unknown_values.empty?
           warn "Unknown markers for jpegoptim: #{unknown_values.join(', ')}"
@@ -28,13 +30,13 @@ class ImageOptim
 
       MAX_QUALITY_OPTION =
       option(:max_quality, 100, 'Maximum image quality factor '\
-          '`0`..`100`, ignored in default/lossless mode') do |v, opt_def|
+                                '`0`..`100`, ignored in default/lossless mode') do |v, opt_def|
         if allow_lossy
           OptionHelpers.limit_with_range(v.to_i, 0..100)
         else
           if v != opt_def.default
             warn "#{self.class.bin_sym} #{opt_def.name} #{v} ignored " \
-                'in lossless mode'
+                 'in lossless mode'
           end
           opt_def.default
         end
@@ -45,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
@@ -56,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

@@ -26,6 +26,20 @@ class ImageOptim
         OptionHelpers.limit_with_range(v.to_i, 0...QUALITY_NAMES.length)
       end
 
+      METHOD_OPTION =
+      option(:method, 'ssim', 'Comparison Metric: '\
+                              '`mpe` - Mean pixel error, '\
+                              '`ssim` - Structural similarity, '\
+                              '`ms-ssim` - Multi-scale structural similarity (slow!), '\
+                              '`smallfry` - Linear-weighted BBCQ-like (may be patented)') do |v, opt_def|
+        if %w[mpe ssim ms-ssim smallfry].include? v
+          v
+        else
+          warn "Unknown method for jpegrecompress: #{v}"
+          opt_def.default
+        end
+      end
+
       def used_bins
         [:'jpeg-recompress']
       end
@@ -35,14 +49,15 @@ class ImageOptim
         -5
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         args = %W[
           --quality #{QUALITY_NAMES[quality]}
+          --method #{method}
           --no-copy
           #{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

@@ -17,13 +17,13 @@ class ImageOptim
 
       JPEGRESCAN_OPTION =
       option(:jpegrescan, true, 'Use jpegtran through jpegrescan, '\
-          'ignore progressive option'){ |v| !!v }
+                                'ignore progressive option'){ |v| !!v }
 
       def used_bins
         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

@@ -10,16 +10,16 @@ class ImageOptim
     class Optipng < Worker
       LEVEL_OPTION =
       option(:level, 6, 'Optimization level preset: '\
-          '`0` is least, '\
-          '`7` is best') do |v|
+                        '`0` is least, '\
+                        '`7` is best') do |v|
         OptionHelpers.limit_with_range(v.to_i, 0..7)
       end
 
       INTERLACE_OPTION =
       option(:interlace, false, TrueFalseNil, 'Interlace: '\
-          '`true` - interlace on, '\
-          '`false` - interlace off, '\
-          '`nil` - as is in original image') do |v|
+                                              '`true` - interlace on, '\
+                                              '`false` - interlace off, '\
+                                              '`nil` - as is in original image') do |v|
         TrueFalseNil.convert(v)
       end
 
@@ -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/oxipng.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'image_optim/worker'
+require 'image_optim/option_helpers'
+require 'image_optim/true_false_nil'
+
+class ImageOptim
+  class Worker
+    # https://github.com/shssoichiro/oxipng
+    class Oxipng < Worker
+      LEVEL_OPTION =
+      option(:level, 3, 'Optimization level preset: '\
+                        '`0` is least, '\
+                        '`6` is best') do |v|
+        OptionHelpers.limit_with_range(v.to_i, 0..6)
+      end
+
+      INTERLACE_OPTION =
+      option(:interlace, false, TrueFalseNil, 'Interlace: '\
+                                              '`true` - interlace on, '\
+                                              '`false` - interlace off, '\
+                                              '`nil` - as is in original image') do |v|
+        TrueFalseNil.convert(v)
+      end
+
+      STRIP_OPTION =
+      option(:strip, true, 'Remove all auxiliary chunks'){ |v| !!v }
+
+      def run_order
+        -4
+      end
+
+      def optimize(src, dst, options = {})
+        src.copy(dst)
+        args = %W[
+          -o #{level}
+          --quiet
+          --
+          #{dst}
+        ]
+        args.unshift "-i#{interlace ? 1 : 0}" unless interlace.nil?
+        if strip
+          args.unshift '--strip', 'all'
+        end
+        execute(:oxipng, args, options) && optimized?(src, dst)
+      end
+
+      def optimized?(src, dst)
+        interlace ? dst.size? : super
+      end
+    end
+  end
+end

data/lib/image_optim/worker/pngcrush.rb

@@ -8,18 +8,18 @@ class ImageOptim
     class Pngcrush < Worker
       CHUNKS_OPTION =
       option(:chunks, :alla, Array, 'List of chunks to remove or '\
-          '`:alla` - all except tRNS/transparency or '\
-          '`:allb` - all except tRNS and gAMA/gamma') do |v|
+                                    '`:alla` - all except tRNS/transparency or '\
+                                    '`:allb` - all except tRNS and gAMA/gamma') do |v|
         Array(v).map(&:to_s)
       end
 
       FIX_OPTION =
       option(:fix, false, 'Fix otherwise fatal conditions '\
-          'such as bad CRCs'){ |v| !!v }
+                          'such as bad CRCs'){ |v| !!v }
 
       BRUTE_OPTION =
       option(:brute, false, 'Brute force try all methods, '\
-          'very time-consuming and generally not worthwhile'){ |v| !!v }
+                            'very time-consuming and generally not worthwhile'){ |v| !!v }
 
       BLACKEN_OPTION =
       option(:blacken, true, 'Blacken fully transparent pixels'){ |v| !!v }
@@ -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

@@ -12,11 +12,11 @@ class ImageOptim
 
       STRATEGY_OPTION =
       option(:strategy, 0, 'Strategy: '\
-          '`0` - xtreme, '\
-          '`1` - intense, '\
-          '`2` - longest Match, '\
-          '`3` - huffman Only, '\
-          '`4` - uncompressed') do |v|
+                           '`0` - xtreme, '\
+                           '`1` - intense, '\
+                           '`2` - longest Match, '\
+                           '`3` - huffman Only, '\
+                           '`4` - uncompressed') do |v|
         OptionHelpers.limit_with_range(v.to_i, 0..4)
       end
 
@@ -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

@@ -19,9 +19,9 @@ class ImageOptim
       QUALITY_OPTION =
       option(:quality, '`100..100`, `0..100` in lossy mode',
              NonNegativeIntegerRange, 'min..max - don\'t '\
-         'save below min, use less colors below max (both in range `0..100`; '\
-         'in yaml - `!ruby/range 0..100`), ignored in default/lossless '\
-         'mode') do |v, opt_def|
+                                      'save below min, use less colors below max (both in range `0..100`; '\
+                                      'in yaml - `!ruby/range 0..100`), ignored in default/lossless '\
+                                      'mode') do |v, opt_def|
         if allow_lossy
           if v == opt_def.default
             0..100
@@ -32,7 +32,7 @@ class ImageOptim
         else
           if v != opt_def.default
             warn "#{self.class.bin_sym} #{opt_def.name} #{v} ignored " \
-                'in lossless mode'
+                 'in lossless mode'
           end
           100..100
         end
@@ -40,9 +40,9 @@ class ImageOptim
 
       SPEED_OPTION =
       option(:speed, 3, 'speed/quality trade-off: '\
-          '`1` - slow, '\
-          '`3` - default, '\
-          '`11` - fast & rough') do |v|
+                        '`1` - slow, '\
+                        '`3` - default, '\
+                        '`11` - fast & rough') do |v|
         OptionHelpers.limit_with_range(v.to_i, 1..11)
       end
 
@@ -50,17 +50,18 @@ class ImageOptim
         -2
       end
 
-      def optimize(src, dst)
+      def optimize(src, dst, options = {})
         args = %W[
           --quality=#{quality.begin}-#{quality.end}
           --speed=#{speed}
           --output=#{dst}
+          --skip-if-larger
           --force
           #{max_colors}
           --
           #{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