image_optim 0.26.5 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d63cf5bc17ca54df17e3f0208edba04654f50479d81f36eadbcccab100a7bb
-  data.tar.gz: 6638bec36d88903a81bb5f94999b86fac22756cae0b1b98cc75a5ace2e794cd0
+  metadata.gz: 2761c4a4a3488017b46d04acf157daa592537169ea05fcbeaf865928b0457618
+  data.tar.gz: 89c7fbe11f6b99cf3f1e8c4f3336fd122c1b16afd71fd56b1d0cbd6ab88c52c1
 SHA512:
-  metadata.gz: 581fbe170f547949f2c5e66e0a69256b2864c198297ce56a1e2ac7391ad80f9db35b496b9cb0a80883176c612e25601b4d06f4b099c0f55fb9bb6e1864440dba
-  data.tar.gz: dd8ead30e38599997fe62af647141c35f8be0876f2e6266862e73a6545f7a5f503ecbd6f126d449214c7ae1b9302a67efd47fa0fad4da3debf9d50499fc12b13
+  metadata.gz: facf38c901cbbd1ba0b8222637845b2e96dc8491e4a55b20a779be53e9ff6e14e561b2ab056aa9182205dd96df20ed0b25c8d8b5a1b3ebe721344ef5384bc7fc
+  data.tar.gz: f2d2f1d4179cce616a1024445d8a30b15367a4a156a0a085fa0d8b177f38e44aaff930788b90de6e8226e7b4c022eb1877794aceee5e62cd7e7c1153554238e3

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   Exclude:
     - '*.gemspec'
     - 'vendor/**/*'
+  NewCops: enable
 
 Bundler/OrderedGems:
   Enabled: false
@@ -9,6 +10,9 @@ Bundler/OrderedGems:
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
+Layout/AssignmentIndentation:
+  Enabled: false
+
 Layout/CaseIndentation:
   EnforcedStyle: end
 
@@ -18,18 +22,18 @@ Layout/DotPosition:
 Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
-Layout/IndentFirstArrayElement:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentAssignment:
-  Enabled: false
-
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
+Layout/LineLength:
+  Max: 120
+
 Layout/RescueEnsureAlignment:
   Enabled: false
 
@@ -47,10 +51,10 @@ Lint/AmbiguousBlockAssociation:
 Lint/NestedPercentLiteral:
   Enabled: false
 
-Lint/UnneededRequireStatement:
+Lint/RedundantRequireStatement:
   Enabled: false
 
-Lint/UnneededSplatExpansion:
+Lint/RedundantSplatExpansion:
   Enabled: false
 
 Metrics/AbcSize:
@@ -68,19 +72,19 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 11
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/MethodLength:
   Max: 25
 
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 10
 
 Security/MarshalLoad:
   Exclude:
     - 'script/worker_analysis'
 
+Style/AccessorGrouping:
+  Enabled: false
+
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
@@ -99,15 +103,27 @@ Style/ExpandPathArguments:
 Style/FormatStringToken:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
 Style/IfUnlessModifier:
   Enabled: false
 
 Style/NumericPredicate:
   EnforcedStyle: comparison
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 

data/.travis.yml

@@ -1,4 +1,5 @@
 sudo: false
+dist: trusty
 language: ruby
 cache:
   bundler: true
@@ -6,38 +7,40 @@ cache:
     - $(npm root)
     - ~/bin
 rvm:
-  - '1.8.7-p371'
+  - '1.8.7-p374'
   - '1.9.3-p551'
   - '2.0.0-p648'
   - '2.1.10'
   - '2.2.10'
   - '2.3.8'
-  - '2.4.6'
-  - '2.5.5'
-  - '2.6.3'
-  - 'jruby-9.1.9.0'
+  - '2.4.10'
+  - '2.5.8'
+  - '2.6.6'
+  - '2.7.1'
+  - 'jruby-9.2.11.1'
 script:
   - bundle exec image_optim --info
   - bundle exec rspec
 before_install:
+  - 'echo "gem: --no-ri --no-rdoc --no-document" > ~/.gemrc'
   - gem install rubygems-update || gem install rubygems-update --version '< 3'
-  - gem update --system
+  - update_rubygems
   - gem install bundler || gem install bundler --version '< 2'
   - nvm install stable
   - mkdir -p ~/bin
   - command -v svgo || npm install -g svgo
-  - command -v pngout || curl -L "http://static.jonof.id.au/dl/kenutils/pngout-20150319-linux.tar.gz" | tar -xz -C ~/bin --strip-components 2 --wildcards '*/x86_64/pngout'
+  - command -v pngout || curl -L "https://www.jonof.id.au/files/kenutils/pngout-20200115-linux.tar.gz" | tar -xz -C ~/bin --strip-components 2 --wildcards '*/amd64/pngout'
 matrix:
   include:
-    - env: CODECLIMATE=✓
-      rvm: '2.4.6'
+    - env: CODECLIMATE=1
+      rvm: '2.4.10'
       after_success: bundle exec codeclimate-test-reporter
-    - env: RUBOCOP=✓
-      rvm: '2.4.6'
+    - env: RUBOCOP=1
+      rvm: '2.4.10'
       script: bundle exec rubocop
       before_install: gem update --system && gem install bundler
-    - env: CHECK_RUBIES=✓
-      rvm: '2.4.6'
+    - env: CHECK_RUBIES=1
+      rvm: '2.4.10'
       script: bundle exec travis_check_rubies
       before_install: gem update --system && gem install bundler
 addons:

data/CHANGELOG.markdown

@@ -2,6 +2,11 @@
 
 ## unreleased
 
+## v0.27.0 (2020-08-27)
+
+* Use `.tmp` as the extension for temporary file if it needs to be created for atomic replacement [#178](https://github.com/toy/image_optim/issues/178) [@toy](https://github.com/toy)
+* Don't create a temporary file in destination directory for atomic replacement if temporary directory is on same device as destination [#178](https://github.com/toy/image_optim/issues/178) [@toy](https://github.com/toy)
+
 ## v0.26.5 (2019-07-14)
 
 * Remove deprecated `rubyforge_project` attribute from gemspec [rubygems/rubygems#2436](https://github.com/rubygems/rubygems/pull/2436) [@toy](https://github.com/toy)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2019 Ivan Kuchin
+Copyright (c) 2012-2020 Ivan Kuchin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -60,7 +60,7 @@ With version:
 
 <!---<update-version>-->
 ```ruby
-gem 'image_optim', '~> 0.26'
+gem 'image_optim', '~> 0.27'
 ```
 <!---</update-version>-->
 
@@ -277,6 +277,10 @@ optipng:
   level: 5
 ```
 
+### Temporary directory
+
+`image_optim` uses standard ruby library for creating temporary files. Temporary directory can be changed using one of `TMPDIR`, `TMP` or `TEMP` environment variables.
+
 ## Options
 
 * `:nice` — 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`)*
@@ -357,4 +361,4 @@ In separate file [CHANGELOG.markdown](CHANGELOG.markdown).
 
 ## Copyright
 
-Copyright (c) 2012-2019 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.
+Copyright (c) 2012-2020 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.

data/image_optim.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.26.5'
+  s.version     = '0.27.0'
   s.summary     = %q{Command line tool and ruby interface to optimize (lossless compress, optionally lossy) jpeg, png, gif and svg images using external utilities (advpng, gifsicle, jhead, jpeg-recompress, jpegoptim, jpegrescan, jpegtran, optipng, pngcrush, pngout, pngquant, svgo)}
-  s.homepage    = "http://github.com/toy/#{s.name}"
+  s.homepage    = "https://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
   s.license     = 'MIT'
 
@@ -34,6 +34,6 @@ EOF
   s.add_development_dependency 'image_optim_pack', '~> 0.2', '>= 0.2.2'
   s.add_development_dependency 'rspec', '~> 3.0'
   if RUBY_VERSION >= '2.2' && !Gem.win_platform? && !defined?(JRUBY_VERSION)
-    s.add_development_dependency 'rubocop', '~> 0.59'
+    s.add_development_dependency 'rubocop', '~> 0.59', '!= 0.78.0'
   end
 end

data/lib/image_optim/bin_resolver/bin.rb

@@ -17,6 +17,7 @@ class ImageOptim
       class BadVersion < Error; end
 
       attr_reader :name, :path, :version
+
       def initialize(name, path)
         @name = name.to_sym
         @path = path.to_s

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_path.rb

@@ -7,8 +7,11 @@ 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
+      dst.temp_path_with_tmp_ext(tmpdir || dst.dirname) do |temp|
         copy(temp)
         dst.copy_metadata(temp)
         temp.rename(dst.to_s)

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

@@ -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)
+        rename(dst.to_s)
+      else
+        dst.temp_path_with_tmp_ext(dst.dirname) do |temp|
+          move(temp)
+          dst.copy_metadata(temp)
+          temp.rename(dst.to_s)
+        end
       end
     end
 
@@ -68,5 +73,15 @@ 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 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/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

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
@@ -452,6 +453,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 +467,7 @@ class Analyser
     end
 
     attr_reader :name, :results, :ids2names
+
     def initialize(name, results, ids2names)
       @name = name.to_s
       @results = results

data/spec/image_optim/cache_path_spec.rb

@@ -15,45 +15,69 @@ describe ImageOptim::CachePath do
     let(:src){ CachePath.temp_file_path }
     let(:dst){ CachePath.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' do
-      skip 'full file modes are not support' unless any_file_modes_allowed?
-      mode = 0o666
+      it 'preserves attributes of destination file' do
+        skip 'full file modes are not support' unless any_file_modes_allowed?
+        mode = 0o666
 
-      dst.chmod(mode)
+        dst.chmod(mode)
 
-      src.replace(dst)
+        src.replace(dst)
 
-      got = dst.stat.mode & 0o777
-      expect(got).to eq(mode), format('expected %04o, got %04o', mode, got)
-    end
+        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 'does not preserve mtime of destination file' do
-      time = src.mtime
+        src.replace(dst)
 
-      dst.utime(time - 1000, time - 1000)
+        expect(dst.mtime).to be >= time
+      end
 
-      src.replace(dst)
+      it 'changes inode of destination' do
+        skip 'inodes are not supported' unless inodes_supported?
+        expect{ src.replace(dst) }.to change{ dst.stat.ino }
+      end
 
-      expect(dst.mtime).to be >= time
+      it 'is using temporary file with .tmp extension' do
+        expect(src).to receive(:copy).with(having_attributes(:extname => '.tmp'))
+
+        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' do
+      before do
+        allow_any_instance_of(File::Stat).to receive(:dev).and_return(0)
+      end
+
+      include_examples 'replaces file'
+    end
+
+    context 'when src and dst are on different devices' do
+      before do
+        allow_any_instance_of(File::Stat).to receive(:dev, &:__id__)
+      end
+
+      include_examples 'replaces file'
     end
   end
 end

data/spec/image_optim/cache_spec.rb

@@ -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
@@ -116,6 +117,7 @@ describe ImageOptim::Cache do
       end
     end
   end
+  # rubocop:enable Style/RedundantFetchBlock
 
   context 'when cache is enabled (without worker digests)' do
     let(:image_optim) do

data/spec/image_optim/path_spec.rb

@@ -61,45 +61,69 @@ 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' do
-      skip 'full file modes are not support' unless any_file_modes_allowed?
-      mode = 0o666
+      it 'preserves attributes of destination file' do
+        skip 'full file modes are not support' unless any_file_modes_allowed?
+        mode = 0o666
 
-      dst.chmod(mode)
+        dst.chmod(mode)
 
-      src.replace(dst)
+        src.replace(dst)
 
-      got = dst.stat.mode & 0o777
-      expect(got).to eq(mode), format('expected %04o, got %04o', mode, got)
-    end
+        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)
+
+        src.replace(dst)
 
-    it 'does not preserve mtime of destination file' do
-      time = src.mtime
+        expect(dst.mtime).to be >= time
+      end
 
-      dst.utime(time - 1000, time - 1000)
+      it 'changes inode of destination' do
+        skip 'inodes are not supported' unless inodes_supported?
+        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
 
-      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 different devices' do
+      before do
+        allow_any_instance_of(File::Stat).to receive(:dev, &:__id__)
+      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

data/spec/images/quant/generate

@@ -17,8 +17,8 @@ palettes.each do |palette|
     rgb:-
     PNG24:#{palette}.png
   ].shelljoin, 'w') do |f|
-    (side * side).times do |i|
-      color = i * palette / (side * side) * 0x10000 / palette
+    (side**2).times do |i|
+      color = i * palette / (side**2) * 0x10000 / palette
       f << [color / 0x100, color % 0x100, 0].pack('C*')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_optim
 version: !ruby/object:Gem::Version
-  version: 0.26.5
+  version: 0.27.0
 platform: ruby
 authors:
 - Ivan Kuchin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-14 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -139,6 +139,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.59'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 0.78.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -146,8 +149,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.59'
-description: 
-email: 
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+description:
+email:
 executables:
 - image_optim
 extensions: []
@@ -257,13 +263,13 @@ files:
 - spec/spec_helper.rb
 - vendor/jpegrescan
 - vendor/jpegrescan.bat
-homepage: http://github.com/toy/image_optim
+homepage: https://github.com/toy/image_optim
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/toy/image_optim/issues
   changelog_uri: https://github.com/toy/image_optim/blob/master/CHANGELOG.markdown
-  documentation_uri: https://www.rubydoc.info/gems/image_optim/0.26.5
+  documentation_uri: https://www.rubydoc.info/gems/image_optim/0.27.0
   source_code_uri: https://github.com/toy/image_optim
 post_install_message: |
   Rails image assets optimization is extracted into image_optim_rails gem
@@ -282,8 +288,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Command line tool and ruby interface to optimize (lossless compress, optionally
   lossy) jpeg, png, gif and svg images using external utilities (advpng, gifsicle,