image_optim 0.26.5 → 0.30.0

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

@@ -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`, '\
+      option(:strip, :all, Array, 'List of markers to strip: '\
+          '`:com`, '\
           '`:exif`, '\
           '`:iptc`, '\
-          '`:icc` or '\
+          '`: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(', ')}"
@@ -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

@@ -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}
@@ -39,10 +39,10 @@ class ImageOptim
           #{dst}
         ]
         args.unshift "-i#{interlace ? 1 : 0}" unless interlace.nil?
-        if resolve_bin!(:optipng).version >= '0.7'
-          args.unshift '-strip', 'all' if strip
+        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
@@ -39,8 +39,8 @@ class ImageOptim
         end
         flags.push '-fix' if fix
         flags.push '-brute' if brute
-        if resolve_bin!(:pngcrush).version >= '1.7.38'
-          flags.push '-blacken' if blacken
+        if blacken && resolve_bin!(:pngcrush).version >= '1.7.38'
+          flags.push '-blacken'
         end
 
         args = flags + %W[
@@ -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,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

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

data/script/worker_analysis

@@ -137,13 +137,14 @@ class Analyser
   # Delegate to worker with short id
   class WorkerVariant < DelegateClass(ImageOptim::Worker)
     attr_reader :name, :id, :cons_id, :required
+
     def initialize(klass, image_optim, options)
       @required = options.delete(:required)
       @run_order = options.delete(:run_order)
       allow_consecutive_on = Array(options.delete(:allow_consecutive_on))
       @image_optim = image_optim
       @name = klass.bin_sym.to_s + options_string(options)
-      __setobj__(klass.new(image_optim, options))
+      super(klass.new(image_optim, options))
       @id = klass.bin_sym.to_s + options_string(self.options)
       @cons_id = [klass, allow_consecutive_on.map{ |key| [key, send(key)] }]
     end
@@ -357,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
 
@@ -452,6 +451,7 @@ class Analyser
       attr_reader :name
       attr_reader :success_count
       attr_reader :time, :avg_time
+
       def initialize(name, steps)
         @name = name
         @success_count = steps.count(&:success)
@@ -465,6 +465,7 @@ class Analyser
     end
 
     attr_reader :name, :results, :ids2names
+
     def initialize(name, results, ids2names)
       @name = name.to_s
       @results = results
@@ -524,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,55 +5,94 @@ 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)
   end
 
   describe '#replace' do
-    let(:src){ CachePath.temp_file_path }
-    let(:dst){ CachePath.temp_file_path }
+    let(:src_dir){ Path.temp_dir }
+    let(:src){ CachePath.temp_file_path(nil, src_dir) }
+    let(:dst){ Path.temp_file_path }
 
-    it 'moves data to destination' do
-      src.write('src')
+    shared_examples 'replaces file' do
+      it 'moves data to destination' do
+        src.write('src')
 
-      src.replace(dst)
+        src.replace(dst)
 
-      expect(dst.read).to eq('src')
-    end
+        expect(dst.read).to eq('src')
+      end
 
-    it 'does not remove original file' do
-      src.replace(dst)
+      it 'does not remove original file' do
+        src.replace(dst)
 
-      expect(src).to exist
-    end
+        expect(src).to exist
+      end
+
+      it 'preserves attributes of destination file', skip: SkipConditions[:any_file_mode_allowed] do
+        mode = 0o666
+
+        dst.chmod(mode)
+
+        src.replace(dst)
 
-    it 'preserves attributes of destination file' do
-      skip 'full file modes are not support' unless any_file_modes_allowed?
-      mode = 0o666
+        got = dst.stat.mode & 0o777
+        expect(got).to eq(mode), format('expected %04o, got %04o', mode, got)
+      end
 
-      dst.chmod(mode)
+      it 'does not preserve mtime of destination file' do
+        time = src.mtime
 
-      src.replace(dst)
+        dst.utime(time - 1000, time - 1000)
 
-      got = dst.stat.mode & 0o777
-      expect(got).to eq(mode), format('expected %04o, got %04o', mode, got)
+        src.replace(dst)
+
+        expect(dst.mtime).to be >= time
+      end
+
+      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)
+
+        src.replace(dst)
+      end
     end
 
-    it 'does not preserve mtime of destination file' do
-      time = src.mtime
+    context 'when src and dst are on same device' do
+      before do
+        allow_any_instance_of(File::Stat).to receive(:dev).and_return(0)
+      end
 
-      dst.utime(time - 1000, time - 1000)
+      include_examples 'replaces file'
+    end
 
-      src.replace(dst)
+    context 'when src and dst are on different devices' do
+      before do
+        allow_any_instance_of(File::Stat).to receive(:dev, &:__id__)
+      end
 
-      expect(dst.mtime).to be >= time
+      include_examples 'replaces file'
     end
 
-    it 'changes inode of destination' do
-      skip 'inodes are not supported' unless inodes_supported?
-      expect{ src.replace(dst) }.to change{ dst.stat.ino }
+    context 'when src and dst are on same device, but rename causes Errno::EXDEV' do
+      before do
+        allow_any_instance_of(File::Stat).to receive(:dev).and_return(0)
+        allow(described_class).to receive(:temp_file_path).and_call_original
+        expect(described_class).to receive(:temp_file_path).
+          with([dst.basename.to_s, '.tmp'], src.dirname).
+          and_wrap_original do |m, *args, &block|
+            m.call(*args) do |tmp|
+              expect(tmp).to receive(:rename).with(dst.to_s).and_raise(Errno::EXDEV)
+              block.call(tmp)
+            end
+          end
+      end
+
+      include_examples 'replaces file'
     end
   end
 end