image_optim 0.26.5 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d63cf5bc17ca54df17e3f0208edba04654f50479d81f36eadbcccab100a7bb
-  data.tar.gz: 6638bec36d88903a81bb5f94999b86fac22756cae0b1b98cc75a5ace2e794cd0
+  metadata.gz: 0fb8179d2e5c5236278611842ad5dbb3ab39fc1ff92bbd50ed9dae6ccd931bf5
+  data.tar.gz: 83ab00c10f205a164ea66f51b6964d3fb4fa7d019c30e472496a0e21879242c0
 SHA512:
-  metadata.gz: 581fbe170f547949f2c5e66e0a69256b2864c198297ce56a1e2ac7391ad80f9db35b496b9cb0a80883176c612e25601b4d06f4b099c0f55fb9bb6e1864440dba
-  data.tar.gz: dd8ead30e38599997fe62af647141c35f8be0876f2e6266862e73a6545f7a5f503ecbd6f126d449214c7ae1b9302a67efd47fa0fad4da3debf9d50499fc12b13
+  metadata.gz: 901e787f11a9829b96dd40f0d8aff14d4f2ac691ff3eaa8486d2915fd020b2f6e0d7425b360cf3bdbc52018afd69508078b69dd4e7846a138d9d5e9ea3b613d7
+  data.tar.gz: 8a21b871165184221bf9af9b9647f144a21e5da1ebe03680ac54b09edf955068f0364da1ee0d6d8dd9976bb96c76ff0cdcf49cb005f43fd5c5cdfe3f51cde39f

data/.appveyor.yml

@@ -6,6 +6,8 @@ install:
   - gem --version
   - bundle package --all
 
+  - ps: Install-Product node
+
   - ps: git --work-tree=tmp\bin checkout origin/windows-binaries -- '*.exe'
 
   - ps: | # svgo

data/.pre-commit-hooks.yaml

@@ -0,0 +1,9 @@
+- id: image_optim
+  name: image_optim
+  entry: image_optim
+  language: ruby
+  types:
+  - image
+  args: []
+  additional_dependencies:
+  - image_optim_pack

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,8 +103,17 @@ Style/ExpandPathArguments:
 Style/FormatStringToken:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+Style/HashConversion:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
 
 Style/IfUnlessModifier:
   Enabled: false
@@ -108,9 +121,15 @@ Style/IfUnlessModifier:
 Style/NumericPredicate:
   EnforcedStyle: comparison
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 
+Style/RedundantBegin:
+  Enabled: false
+
 Style/RescueStandardError:
   EnforcedStyle: implicit
 

data/.travis.yml

@@ -1,4 +1,4 @@
-sudo: false
+dist: xenial
 language: ruby
 cache:
   bundler: true
@@ -6,38 +6,40 @@ cache:
     - $(npm root)
     - ~/bin
 rvm:
-  - '1.8.7-p371'
   - '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.9'
+  - '2.6.7'
+  - '2.7.3'
+  - '3.0.1'
+  - 'jruby-9.2.14.0'
 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'
+  - mkdir -p ~/bin
+  - 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,32 @@
 
 ## unreleased
 
+## v0.30.0 (2021-05-11)
+
+* Add `timeout` option to restrict maximum time spent on every image [#21](https://github.com/toy/image_optim/issues/21) [#148](https://github.com/toy/image_optim/pull/148) [#149](https://github.com/toy/image_optim/pull/149) [#162](https://github.com/toy/image_optim/pull/162) [#184](https://github.com/toy/image_optim/pull/184) [#189](https://github.com/toy/image_optim/pull/189) [@tgxworld](https://github.com/tgxworld) [@oblakeerickson](https://github.com/oblakeerickson) [@toy](https://github.com/toy)
+
+## v0.29.0 (2021-04-28)
+
+* Require at least ruby 1.9.3 [@toy](https://github.com/toy)
+* Add support for use as [pre-commit](https://pre-commit.com/) hook [#192](https://github.com/toy/image_optim/pull/192) [@proinsias](https://github.com/proinsias)
+* Fix `Path#copy_metadata` by rescuing also `Errno::EACCES` as it is done in `fileutils` [#187](https://github.com/toy/image_optim/issues/187) [@toy](https://github.com/toy)
+* More precise regular expression for capturing svgo version [@toy](https://github.com/toy)
+
+## v0.28.0 (2020-12-18)
+
+* Fix and update list of markers in jpegoptim worker: allow to pass `com` instead of incorrect `comments` and add missing `xmp` and `none` [#188](https://github.com/toy/image_optim/issues/188) [@toy](https://github.com/toy)
+* Add `--skip-if-larger` flag to pngquant worker. The pngquant worker already does this, but this will make it fail faster. [#125](https://github.com/toy/image_optim/pull/125) [#181](https://github.com/toy/image_optim/pull/181) [@iggant](https://github.com/iggant) [@oblakeerickson](https://github.com/oblakeerickson)
+* Add `method` option for jpegrecompress, default to `ssim` [#102](https://github.com/toy/image_optim/issues/102) [#103](https://github.com/toy/image_optim/pull/103) [#182](https://github.com/toy/image_optim/pull/182) [@ramiroaraujo](https://github.com/ramiroaraujo) [@oblakeerickson](https://github.com/oblakeerickson)
+
+## v0.27.1 (2020-09-30)
+
+* Fixed atomic replacement for case when equal `File::Stat#dev` doesn't mean that file can be linked [#180](https://github.com/toy/image_optim/issues/180) [@toy](https://github.com/toy)
+
+## 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/CONTRIBUTING.markdown

@@ -2,7 +2,10 @@
 
 * Create topic/feature branch: `git checkout -b awesome-changes`
 * Commit…
-* Add entry at the top of [ChangeLog](CHANGELOG.markdown)
+* Add an entry at the top (after ## unreleased) of [ChangeLog](CHANGELOG.markdown), include:
+  * Issues (`[#123](https://github.com/toy/image_optim/issues/123)`)
+  * Pull requests (`[#123](https://github.com/toy/image_optim/pull/123)`)
+  * Authors (`[@octocat](https://github.com/octocat)`)
 * Run tests: `bundle exec rspec`
 * Check code style: `bundle exec rubocop`
 * Rebase on master and squash commits to logical units

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2019 Ivan Kuchin
+Copyright (c) 2012-2021 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.30'
 ```
 <!---</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`)*
@@ -287,6 +291,7 @@ optipng:
 * `:allow_lossy` — Allow lossy workers and optimizations *(defaults to `false`)*
 * `:cache_dir` — Configure cache directory
 * `:cache_worker_digests` - Also cache worker digests along with original file digest and worker options: updating workers invalidates cache
+* `:timeout` — Maximum time in seconds to spend on one image, note multithreading and cache *(defaults to unlimited)*
 
 Worker can be disabled by passing `false` instead of options hash or by setting option `:disable` to `true`.
 
@@ -306,12 +311,13 @@ Worker has no options
 
 ### jpegoptim:
 * `:allow_lossy` — Allow limiting maximum quality *(defaults to `false`)*
-* `:strip` — List of extra markers to strip: `:comments`, `:exif`, `:iptc`, `:icc` or `:all` *(defaults to `:all`)*
+* `:strip` — List of markers to strip: `:com`, `:exif`, `:iptc`, `:icc`, `:xmp`, `:none` or `:all` *(defaults to `:all`)*
 * `:max_quality` — Maximum image quality factor `0`..`100`, ignored in default/lossless mode *(defaults to `100`)*
 
 ### jpegrecompress:
 * `:allow_lossy` — Allow worker, it is always lossy *(defaults to `false`)*
 * `:quality` — JPEG quality preset: `0` - low, `1` - medium, `2` - high, `3` - veryhigh *(defaults to `3`)*
+* `:method` — Comparison Metric: `mpe` - Mean pixel error, `ssim` - Structural similarity, `ms-ssim` - Multi-scale structural similarity (slow!), `smallfry` - Linear-weighted BBCQ-like (may be patented) *(defaults to ssim)*
 
 ### jpegtran:
 * `:copy_chunks` — Copy all chunks *(defaults to `false`)*
@@ -357,4 +363,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-2021 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.

data/Vagrantfile

@@ -3,7 +3,7 @@
 Vagrant.configure('2') do |config|
   config.vm.box = 'ubuntu/precise64'
 
-  config.vm.provision 'shell', :inline => <<-SH
+  config.vm.provision 'shell', inline: <<-SH
     set -e
 
     cd /vagrant

data/image_optim.gemspec

@@ -2,12 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.26.5'
+  s.version     = '0.30.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'
 
+  s.required_ruby_version = '>= 1.9.3'
+
   s.metadata = {
     'bug_tracker_uri'   => "https://github.com/toy/#{s.name}/issues",
     'changelog_uri'     => "https://github.com/toy/#{s.name}/blob/master/CHANGELOG.markdown",
@@ -33,7 +35,8 @@ 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'
+  if RUBY_VERSION >= '2.4' && !Gem.win_platform? && !defined?(JRUBY_VERSION)
+    s.add_development_dependency 'rubocop', '~> 1.0'
+    s.add_development_dependency 'rubocop-rspec', '~> 2.0'
   end
 end

data/lib/image_optim.rb

@@ -3,10 +3,12 @@
 require 'image_optim/bin_resolver'
 require 'image_optim/cache'
 require 'image_optim/config'
+require 'image_optim/errors'
 require 'image_optim/handler'
 require 'image_optim/image_meta'
 require 'image_optim/optimized_path'
 require 'image_optim/path'
+require 'image_optim/timer'
 require 'image_optim/worker'
 require 'in_threads'
 require 'shellwords'
@@ -46,6 +48,9 @@ class ImageOptim
   # Cache worker digests
   attr_reader :cache_worker_digests
 
+  # Timeout in seconds for each image
+  attr_reader :timeout
+
   # Initialize workers, specify options using worker underscored name:
   #
   # pass false to disable worker
@@ -78,6 +83,7 @@ class ImageOptim
       allow_lossy
       cache_dir
       cache_worker_digests
+      timeout
     ].each do |name|
       instance_variable_set(:"@#{name}", config.send(name))
       $stderr << "#{name}: #{send(name)}\n" if verbose
@@ -110,11 +116,17 @@ class ImageOptim
     return unless (workers = workers_for_image(original))
 
     optimized = @cache.fetch(original) do
+      timer = timeout && Timer.new(timeout)
+
       Handler.for(original) do |handler|
-        workers.each do |worker|
-          handler.process do |src, dst|
-            worker.optimize(src, dst)
+        begin
+          workers.each do |worker|
+            handler.process do |src, dst|
+              worker.optimize(src, dst, timeout: timer)
+            end
           end
+        rescue Errors::TimeoutExceeded
+          handler.result
         end
       end
     end
@@ -188,12 +200,6 @@ class ImageOptim
       optimize_image_method?(method) || super
     end
 
-    if RUBY_VERSION < '1.9'
-      def respond_to?(method, include_private = false)
-        optimize_image_method?(method) || super
-      end
-    end
-
     # Version of image_optim gem spec loaded
     def version
       Gem.loaded_specs['image_optim'].version.to_s

data/lib/image_optim/bin_resolver/bin.rb

@@ -14,9 +14,11 @@ class ImageOptim
     # Holds bin name and path, gets version
     class Bin
       class UnknownVersion < Error; end
+
       class BadVersion < Error; end
 
       attr_reader :name, :path, :version
+
       def initialize(name, path)
         @name = name.to_sym
         @path = path.to_s
@@ -36,30 +38,30 @@ class ImageOptim
       is = ComparableCondition.is
 
       FAIL_CHECKS = {
-        :pngcrush => [
+        pngcrush: [
           [is.between?('1.7.60', '1.7.65'), 'is known to produce broken pngs'],
           [is == '1.7.80', 'loses one color in indexed images'],
         ],
-        :pngquant => [
+        pngquant: [
           [is < '2.0', 'is not supported'],
         ],
       }.freeze
 
       WARN_CHECKS = {
-        :advpng => [
+        advpng: [
           [is == 'none', 'is of unknown version'],
           [is < '1.17', 'does not use zopfli'],
         ],
-        :gifsicle => [
+        gifsicle: [
           [is < '1.85', 'does not support removing extension blocks'],
         ],
-        :pngcrush => [
+        pngcrush: [
           [is < '1.7.38', 'does not have blacken flag'],
         ],
-        :pngquant => [
+        pngquant: [
           [is < '2.1', 'may be lossy even with quality `100-`'],
         ],
-        :optipng => [
+        optipng: [
           [is < '0.7', 'does not support -strip option'],
         ],
       }.freeze
@@ -110,7 +112,7 @@ class ImageOptim
         when :gifsicle, :jpegoptim, :optipng
           capture("#{escaped_path} --version 2> #{Path::NULL}")[/\d+(\.\d+)+/]
         when :svgo, :pngquant
-          capture("#{escaped_path} --version 2>&1")[/\d+(\.\d+)+/]
+          capture("#{escaped_path} --version 2>&1")[/\A\d+(\.\d+)+/]
         when :jhead, :'jpeg-recompress'
           capture("#{escaped_path} -V 2> #{Path::NULL}")[/\d+(\.\d+)+/]
         when :jpegtran