image_optim 0.26.5 → 0.30.0

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) }
 
@@ -64,6 +64,7 @@ describe ImageOptim::Cache do
     end
   end
 
+  # rubocop:disable Style/RedundantFetchBlock
   shared_examples 'an enabled cache' do
     context 'when cached file does not exist' do
       describe :fetch do
@@ -101,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
@@ -116,11 +117,12 @@ describe ImageOptim::Cache do
       end
     end
   end
+  # rubocop:enable Style/RedundantFetchBlock
 
   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, {})
@@ -142,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).

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

@@ -10,10 +10,10 @@ describe ImageOptim::HashHelpers do
 
   context 'stringify/simbolyze' do
     symbol_keys = {
-      :a => 1,
-      :b => {
-        :c => [:a, 'a'],
-        :d => {},
+      a: 1,
+      b: {
+        c: [:a, 'a'],
+        d: {},
       },
     }
 
@@ -38,22 +38,22 @@ describe ImageOptim::HashHelpers do
 
   it 'deep merges hashes' do
     merge_a = {
-      :a => {
-        :b => 1,
-        :c => {
-          :d => 2,
-          :e => {:f => true},
+      a: {
+        b: 1,
+        c: {
+          d: 2,
+          e: {f: true},
         },
       },
-      :y => 10,
+      y: 10,
     }
 
     merge_b = {
       :a => {
-        :b => 2,
-        :c => {
-          :d => 3,
-          :e => false,
+        b: 2,
+        c: {
+          d: 3,
+          e: false,
         },
       },
       'z' => 20,
@@ -61,10 +61,10 @@ describe ImageOptim::HashHelpers do
 
     merge_result = {
       :a => {
-        :b => 2,
-        :c => {
-          :d => 3,
-          :e => false,
+        b: 2,
+        c: {
+          d: 3,
+          e: false,
         },
       },
       :y => 10,

data/spec/image_optim/option_definition_spec.rb

@@ -58,13 +58,13 @@ describe ImageOptim::OptionDefinition do
 
       context 'when option is nil' do
         it 'returns nil' do
-          expect(subject.value(nil, :abc => nil)).to eq(nil)
+          expect(subject.value(nil, abc: nil)).to eq(nil)
         end
       end
 
       context 'when option is set' do
         it 'returns value' do
-          expect(subject.value(nil, :abc => 123)).to eq(123)
+          expect(subject.value(nil, abc: 123)).to eq(123)
         end
       end
     end
@@ -84,13 +84,13 @@ describe ImageOptim::OptionDefinition do
 
       context 'when option is nil' do
         it 'returns nil passed through proc' do
-          expect(subject.value(nil, :abc => nil)).to eq('nil')
+          expect(subject.value(nil, abc: nil)).to eq('nil')
         end
       end
 
       context 'when option is set' do
         it 'returns value passed through proc' do
-          expect(subject.value(nil, :abc => 123)).to eq('123')
+          expect(subject.value(nil, abc: 123)).to eq('123')
         end
       end
     end
@@ -108,13 +108,13 @@ describe ImageOptim::OptionDefinition do
 
       context 'when option is nil' do
         it 'returns nil passed through proc' do
-          expect(subject.value(nil, :abc => nil)).to eq(['nil', subject])
+          expect(subject.value(nil, abc: nil)).to eq(['nil', subject])
         end
       end
 
       context 'when option is set' do
         it 'returns value passed through proc' do
-          expect(subject.value(nil, :abc => 123)).to eq(['123', subject])
+          expect(subject.value(nil, abc: 123)).to eq(['123', subject])
         end
       end
     end

data/spec/image_optim/path_spec.rb

@@ -5,8 +5,6 @@ require 'image_optim/path'
 require 'tempfile'
 
 describe ImageOptim::Path do
-  include CapabilityCheckHelpers
-
   before do
     stub_const('Path', ImageOptim::Path)
   end
@@ -61,45 +59,82 @@ describe ImageOptim::Path do
     let(:src){ Path.temp_file_path }
     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 'removes original file' do
-      src.replace(dst)
+      it 'removes original file' do
+        src.replace(dst)
 
-      expect(src).to_not exist
-    end
+        expect(src).to_not exist
+      end
+
+      it 'preserves attributes of destination file', skip: SkipConditions[:any_file_mode_allowed] do
+        mode = 0o666
+
+        dst.chmod(mode)
+
+        src.replace(dst)
+
+        got = dst.stat.mode & 0o777
+        expect(got).to eq(mode), format('expected %04o, got %04o', mode, got)
+      end
+
+      it 'does not preserve mtime of destination file' do
+        time = src.mtime
+
+        dst.utime(time - 1000, time - 1000)
 
-    it 'preserves attributes of destination file' do
-      skip 'full file modes are not support' unless any_file_modes_allowed?
-      mode = 0o666
+        src.replace(dst)
 
-      dst.chmod(mode)
+        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
+    end
 
-      src.replace(dst)
+    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
 
-      got = dst.stat.mode & 0o777
-      expect(got).to eq(mode), format('expected %04o, got %04o', mode, got)
+      include_examples 'replaces file'
     end
 
-    it 'does not preserve mtime of destination file' do
-      time = src.mtime
+    context 'when src and dst are on different devices' do
+      before do
+        allow_any_instance_of(File::Stat).to receive(:dev, &:__id__)
+      end
 
-      dst.utime(time - 1000, time - 1000)
+      include_examples 'replaces file'
 
-      src.replace(dst)
+      it 'is using temporary file with .tmp extension' do
+        expect(src).to receive(:move).with(having_attributes(extname: '.tmp'))
 
-      expect(dst.mtime).to be >= time
+        src.replace(dst)
+      end
     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)
+        expect(src).to receive(:rename).with(dst.to_s).once.and_raise(Errno::EXDEV)
+      end
+
+      include_examples 'replaces file'
+
+      it 'is using temporary file with .tmp extension' do
+        expect(src).to receive(:move).with(having_attributes(extname: '.tmp'))
+
+        src.replace(dst)
+      end
     end
   end
 end