image_optim 0.31.4 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28ea4eea777b5a6eac029c628c28509b70d65f5784ef16466c26b758d189d88b
-  data.tar.gz: b4cdec32a6fde2d92b7c3382b14fb90c094e523e46c79fd8fc24d21737348167
+  metadata.gz: ef1f30c74ae2a4479ec6d68f006313ae236cd92e3f8338a15619a74d5fbb2dc7
+  data.tar.gz: 3db0340fc04da059048f162c4b4e35870213f3ce40a6f8af896059ffd2703cbe
 SHA512:
-  metadata.gz: ad0b465ae7de080c2af44efaaeea7a7b17b8bc343faa0f8034105b027362abfc952bf72fead0d9c30f368a94cb74a1a7d2e19d49b07c626f49bfb59b99f4de69
-  data.tar.gz: 8d7070adae2ff71fe71df2ffaf25addb42acdddca2a427bcfad3f91cd3138d0fccfc2b3284d2cf146dd8f513be9c88a4b9c2f378d6564bcfdf629f5f6ee492cf
+  metadata.gz: 2fdbf6c9cb715760ce38200157ddaa9142e5ec83611813572b475893c24c50f18983207bf268cd9f73d98689d7fb28e3703a8ab9633d5c28bad2c9e003a9f667
+  data.tar.gz: d9826620e1554b8cac570b79995636c8abd652f66318bf8f1bf498156756250919bd48374038c0db99554c9e2ce1ba1f2af194715c73c41ff9afea97e4cc33eb

data/.github/dependabot.yml

@@ -3,4 +3,6 @@ updates:
   - package-ecosystem: github-actions
     directory: /
     schedule:
-      interval: weekly
+      interval: daily
+    cooldown:
+      default-days: 7

data/.github/workflows/build-test-containers.yml

@@ -0,0 +1,60 @@
+name: build-test-containers
+on:
+  workflow_dispatch:
+  schedule:
+  - cron: 11 2 13 * *
+jobs:
+  base:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - uses: docker/login-action@v4
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    - run:
+        docker build
+          -f Dockerfile.test
+          --target ruby-build
+          -t ghcr.io/toy/image_optim.test:ruby-build
+          --push
+          .
+
+  test-images:
+    needs: base
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+        - '1.9'
+        - '2.0'
+        - '2.1'
+        - '2.2'
+        - '2.3'
+        - '2.4'
+        - '2.5'
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        - '3.1'
+        - '3.2'
+        - '3.3'
+        - '3.4'
+        - '4.0'
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v6
+    - uses: docker/login-action@v4
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    - run:
+        docker build
+          -f Dockerfile.test
+          --target test
+          --build-arg "RUBY_VERSION=${{ matrix.ruby }}"
+          -t "ghcr.io/toy/image_optim.test:${{ matrix.ruby }}"
+          --push
+          .

data/.github/workflows/check.yml

@@ -6,20 +6,22 @@ on:
   - cron: 45 4 * * 2
 jobs:
   check:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         ruby:
-        - '1.9.3'
         - '2.7'
         - '3.0'
         - '3.1'
         - '3.2'
         - '3.3'
+        - '3.4'
+        - '4.0'
         - jruby-9.4
+        - jruby-10.1
       fail-fast: false
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: "${{ matrix.ruby }}"
@@ -33,13 +35,12 @@ jobs:
     strategy:
       matrix:
         container:
-        - debian:buster
         - debian:bullseye
         - debian:bookworm
         # - alpine
       fail-fast: false
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - run: |
         if command -v apt-get &> /dev/null; then
           apt-get update
@@ -65,14 +66,16 @@ jobs:
         - '3.1'
         - '3.2'
         - '3.3'
+        - '3.4'
+        - '4.0'
       fail-fast: false
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: "${{ matrix.ruby }}"
         bundler-cache: true
-    - uses: actions/cache@v4
+    - uses: actions/cache@v5
       with:
         path: "$HOME/bin"
         key: ${{ runner.os }}
@@ -90,23 +93,9 @@ jobs:
   update_worker_options_in_readme:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3'
+        ruby-version: '4'
         bundler-cache: true
     - run: script/update_worker_options_in_readme -n
-  coverage:
-    runs-on: ubuntu-latest
-    env:
-      CC_TEST_REPORTER_ID: b433c6540d220a2da0663670c9b260806bafdb3a43c6f22b2e81bfb1f87b12fe
-    steps:
-    - uses: actions/checkout@v4
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '3'
-        bundler-cache: true
-    - run: npm install -g svgo
-    - uses: paambaati/codeclimate-action@v9
-      with:
-        coverageCommand: bundle exec rspec

data/.github/workflows/rubocop.yml

@@ -8,9 +8,9 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3'
+        ruby-version: '4'
         bundler-cache: true
     - run: bundle exec rubocop

data/.rubocop.yml

@@ -67,6 +67,8 @@ Metrics/BlockLength:
     - 'spec/**/*.rb'
 
 Metrics/ClassLength:
+  Exclude:
+    - 'lib/image_optim.rb'
   Max: 150
 
 Metrics/CyclomaticComplexity:

data/CHANGELOG.markdown

@@ -2,6 +2,15 @@
 
 ## unreleased
 
+## v0.32.0 (2026-05-28)
+
+* Use `Etc.nprocessors` for default number of threads with fallback to manual way [@toy](https://github.com/toy)
+* Correct environment variable to specify `jpeg-recompress` location [@toy](https://github.com/toy)
+* Added --benchmark, to compare performance of each tool [#217](https://github.com/toy/image_optim/issues/217) [#218](https://github.com/toy/image_optim/pull/218) [@gurgeous](https://github.com/gurgeous)
+* Don't require presence of `git` in gemspec [@toy](https://github.com/toy)
+* Add a basic check for names of enabled and disabled svgo plugins [@toy](https://github.com/toy)
+* Add support for enabling/disabling plugins in svgo 2.x, 3.x, 4.x [#191](https://github.com/toy/image_optim/issues/191) [#224](https://github.com/toy/image_optim/pull/224) [@tomhughes](https://github.com/tomhughes)
+
 ## v0.31.4 (2024-11-19)
 
 * Added `--svgo-allow-lossy` and `--svgo-precision` options to use svgo in lossy mode. This sets svgo `--precision`, which can result in substantially smaller svgs (see [#211](https://github.com/toy/image_optim/issues/211) for some experiments). Lower values are more lossy. 3 is the default, but many SVGs will work well even with 0 or 1. Like all worker specific lossy flags, this is also enabled with `--allow-lossy`. [#210](https://github.com/toy/image_optim/issues/210) [#211](https://github.com/toy/image_optim/issues/211) [@gurgeous](https://github.com/gurgeous)

data/Dockerfile.test

@@ -0,0 +1,46 @@
+FROM node:slim AS ruby-build
+
+RUN npm install -g svgo
+
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends \
+    build-essential \
+    ca-certificates \
+    curl \
+    git \
+    imagemagick \
+    libffi-dev \
+    libgmp-dev \
+    librsvg2-bin \
+    libssl-dev \
+    libyaml-dev \
+    rustc \
+    tini \
+    zlib1g-dev \
+ && rm -rf /var/lib/apt/lists/*
+
+RUN git clone https://github.com/rbenv/ruby-build.git /ruby-build \
+ && cd /ruby-build \
+ && git checkout $(git describe --tags "$(git rev-list --tags --max-count=1)") \
+ && /ruby-build/install.sh \
+ && rm -r /ruby-build
+
+FROM ghcr.io/toy/image_optim.test:ruby-build AS test
+
+ARG RUBY_VERSION
+RUN FULL_VERSION=$(ruby-build --definitions | perl -e '$p=shift; while(<>){$l=$_ if index($_,$p)==0} print $l' "${RUBY_VERSION}.") \
+ && RUBY_CONFIGURE_OPTS=--disable-install-doc ruby-build --verbose "$FULL_VERSION" /usr/local
+
+ENV BUNDLE_SILENCE_ROOT_WARNING=1
+COPY script/update-rubygems-n-bundler ./script/
+RUN script/update-rubygems-n-bundler
+
+WORKDIR /gem
+# silence warnings about not being in git directory
+RUN git init
+
+COPY Gemfile *.gemspec ./
+RUN bundle install \
+ && rm Gemfile Gemfile.lock *.gemspec
+
+ENTRYPOINT ["/usr/bin/tini", "--"]

data/Gemfile

@@ -4,6 +4,10 @@ source 'https://rubygems.org'
 
 gemspec
 
+if RUBY_VERSION >= '4'
+  gem 'logger'
+end
+
 if ENV['CC_TEST_REPORTER_ID']
   group :test do
     gem 'simplecov'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2024 Ivan Kuchin
+Copyright (c) 2012-2026 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

@@ -1,9 +1,7 @@
 [![Gem Version](https://img.shields.io/gem/v/image_optim?logo=rubygems)](https://rubygems.org/gems/image_optim)
-[![Build Status](https://img.shields.io/github/actions/workflow/status/toy/image_optim/check.yml?logo=github)](https://github.com/toy/image_optim/actions/workflows/check.yml)
+[![Check](https://img.shields.io/github/actions/workflow/status/toy/image_optim/check.yml?label=check&logo=github)](https://github.com/toy/image_optim/actions/workflows/check.yml)
 [![Rubocop](https://img.shields.io/github/actions/workflow/status/toy/image_optim/rubocop.yml?label=rubocop&logo=rubocop)](https://github.com/toy/image_optim/actions/workflows/rubocop.yml)
 [![CodeQL](https://img.shields.io/github/actions/workflow/status/toy/image_optim/codeql.yml?label=codeql&logo=github)](https://github.com/toy/image_optim/actions/workflows/codeql.yml)
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/toy/image_optim?logo=codeclimate)](https://codeclimate.com/github/toy/image_optim)
-[![Code Climate Coverage](https://img.shields.io/codeclimate/coverage/toy/image_optim?logo=codeclimate)](https://codeclimate.com/github/toy/image_optim)
 [![Depfu](https://img.shields.io/depfu/toy/image_optim)](https://depfu.com/github/toy/image_optim)
 [![Inch CI](https://inch-ci.org/github/toy/image_optim.svg?branch=master)](https://inch-ci.org/github/toy/image_optim)
 
@@ -62,7 +60,7 @@ With version:
 
 <!---<update-version>-->
 ```ruby
-gem 'image_optim', '~> 0.31'
+gem 'image_optim', '~> 0.32'
 ```
 <!---</update-version>-->
 
@@ -90,7 +88,7 @@ Simplest way for `image_optim` to locate binaries is to install them in common l
 
 If you cannot install to common location, then install to custom one and add it to `PATH`.
 
-Specify custom bin location using `XXX_BIN` environment variable (`JPEGOPTIM_BIN`, `OPTIPNG_BIN`, …).
+Specify custom bin location using `XXX_BIN` environment variable (`JPEGOPTIM_BIN`, `OPTIPNG_BIN`, `JPEG_RECOMPRESS_BIN`, …).
 
 Besides permanently setting environment variables in `~/.profile`, `~/.bash_profile`, `~/.bashrc`, `~/.zshrc`, … they can be set:
 
@@ -303,6 +301,29 @@ optipng:
 
 `image_optim` uses standard ruby library for creating temporary files. Temporary directory can be changed using one of `TMPDIR`, `TMP` or `TEMP` environment variables.
 
+### Benchmark
+
+Run with `--benchmark` to compare the performance of each individual tool on your images:
+
+```sh
+image_optim --benchmark=isolated -r /tmp/corpus/
+```
+
+```
+benchmarking: 100.0% (elapsed: 3.9m)
+
+BENCHMARK RESULTS
+
+name      files  elapsed  kb saved     kb/s
+--------  -----  -------  --------  -------
+oxipng       50    8.906  1867.253  209.664
+pngquant     50    1.980   214.597  108.386
+pngcrush     50   22.529  1753.704   77.841
+optipng      50  142.940  1641.101   11.481
+advpng       50  137.753   962.549    6.987
+pngout       50  426.706   444.679    1.042
+```
+
 ## 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`)*
@@ -392,4 +413,4 @@ In separate file [CHANGELOG.markdown](CHANGELOG.markdown).
 
 ## Copyright
 
-Copyright (c) 2012-2024 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.
+Copyright (c) 2012-2026 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.

data/image_optim.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.31.4'
+  s.version     = '0.32.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, oxipng, pngcrush, pngout, pngquant, svgo)}
   s.homepage    = "https://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
@@ -17,9 +17,19 @@ Gem::Specification.new do |s|
     'source_code_uri'   => "https://github.com/toy/#{s.name}",
   } if s.respond_to?(:metadata=)
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = Dir[*%w[
+    .gitignore
+    .pre-commit-hooks.yaml
+    .rubocop.yml
+    Dockerfile.test
+    Gemfile
+    LICENSE.txt
+    *.markdown
+    *.gemspec
+    {.github,bin,lib,script,spec,vendor}/**/*
+  ]].reject(&File.method(:directory?))
+  s.test_files    = Dir['spec/**/*'].reject(&File.method(:directory?))
+  s.executables   = Dir['bin/*'].map(&File.method(:basename))
   s.require_paths = %w[lib]
 
   s.post_install_message = <<-EOF

data/lib/image_optim/benchmark_result.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class ImageOptim
+  # Benchmark result for one worker+src
+  class BenchmarkResult
+    attr_reader :bytes, :elapsed, :worker
+
+    def initialize(src, dst, elapsed, worker)
+      @bytes = bytes_saved(src, dst)
+      @elapsed = elapsed
+      @worker = worker.class.bin_sym.to_s
+    end
+
+  private
+
+    def bytes_saved(src, dst)
+      src, dst = src.size, dst.size
+      return 0 if dst == 0 # failure
+      return 0 if dst > src # the file got bigger
+
+      src - dst
+    end
+  end
+end

data/lib/image_optim/bin_resolver.rb

@@ -108,7 +108,7 @@ class ImageOptim
     # Check path in XXX_BIN to exist, be a file and be executable and symlink to
     # dir as name
     def symlink_custom_bin!(name)
-      env_name = "#{name}_bin".upcase
+      env_name = "#{name.to_s.tr('-', '_').upcase}_BIN"
       path = ENV.fetch(env_name, nil)
       return unless path
 

data/lib/image_optim/config.rb

@@ -5,12 +5,13 @@ require 'image_optim/configuration_error'
 require 'image_optim/hash_helpers'
 require 'image_optim/worker'
 require 'image_optim/cmd'
+require 'etc'
 require 'set'
 require 'yaml'
 
 class ImageOptim
   # Read, merge and parse configuration
-  class Config
+  class Config # rubocop:disable Metrics/ClassLength
     include OptionHelpers
 
     # Global config path at `$XDG_CONFIG_HOME/image_optim.yml` (by default
@@ -134,7 +135,7 @@ class ImageOptim
     end
 
     # Verbose mode, converted to boolean
-    def verbose
+    def verbose # rubocop:disable Naming/PredicateMethod
       !!get!(:verbose)
     end
 
@@ -164,7 +165,7 @@ class ImageOptim
     end
 
     # Allow lossy workers and optimizations, converted to boolean
-    def allow_lossy
+    def allow_lossy # rubocop:disable Naming/PredicateMethod
       !!get!(:allow_lossy)
     end
 
@@ -173,7 +174,7 @@ class ImageOptim
       dir unless dir.nil? || dir.empty?
     end
 
-    def cache_worker_digests
+    def cache_worker_digests # rubocop:disable Naming/PredicateMethod
       !!get!(:cache_worker_digests)
     end
 
@@ -205,9 +206,17 @@ class ImageOptim
 
   private
 
-    # http://stackoverflow.com/a/6420817
     def processor_count
-      @processor_count ||= case host_os = RbConfig::CONFIG['host_os']
+      @processor_count ||= if Etc.respond_to?(:nprocessors)
+        Etc.nprocessors
+      else
+        processor_count_manual
+      end
+    end
+
+    # http://stackoverflow.com/a/6420817
+    def processor_count_manual
+      case host_os = RbConfig::CONFIG['host_os']
       when /darwin9/
         Cmd.capture 'hwprefs cpu_count'
       when /darwin/

data/lib/image_optim/runner/option_parser.rb

@@ -153,6 +153,15 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
     options[:pack] = pack
   end
 
+  op.separator nil
+  op.on(
+    '--benchmark TYPE',
+    [:isolated],
+    'Run benchmarks, to compare tools without modifying images. `isolated` is the only supported type so far.'
+  ) do |benchmark|
+    options[:benchmark] = benchmark
+  end
+
   op.separator nil
   op.separator '  Caching:'
 

data/lib/image_optim/runner.rb

@@ -45,6 +45,43 @@ class ImageOptim
       end
     end
 
+    # files, elapsed, kb saved, kb/s
+    class BenchmarkResults
+      def initialize
+        @all = []
+      end
+
+      def add(rows)
+        @all.concat(rows)
+      end
+
+      def print
+        if @all.empty?
+          puts 'nothing to report'
+          return
+        end
+
+        report = @all.group_by(&:worker).map do |name, results|
+          kb = (results.sum(&:bytes) / 1024.0)
+          elapsed = results.sum(&:elapsed)
+          {
+            'name' => name,
+            'files' => results.length,
+            'elapsed' => elapsed,
+            'kb saved' => kb,
+            'kb/s' => (kb / elapsed),
+          }
+        end
+
+        report = report.sort_by do |row|
+          [-row['kb/s'], row['name']]
+        end
+
+        puts "\nBENCHMARK RESULTS\n\n"
+        Table.new(report).write($stdout)
+      end
+    end
+
     def initialize(options)
       options = HashHelpers.deep_symbolise_keys(options)
       @recursive = options.delete(:recursive)
@@ -53,19 +90,40 @@ class ImageOptim
         glob = options.delete(:"exclude_#{type}_glob") || '.*'
         GlobHelpers.expand_braces(glob)
       end
+
+      # --benchmark
+      @benchmark = options.delete(:benchmark)
+      if @benchmark
+        unless options[:threads].nil?
+          warning '--benchmark ignores --threads'
+          options[:threads] = 1 # for consistency
+        end
+        if options[:timeout]
+          warning '--benchmark ignores --timeout'
+        end
+      end
+
       @image_optim = ImageOptim.new(options)
     end
 
-    def run!(args)
+    def run!(args) # rubocop:disable Naming/PredicateMethod
       to_optimize = find_to_optimize(args)
       unless to_optimize.empty?
-        results = Results.new
+        if @benchmark
+          benchmark_results = BenchmarkResults.new
+          benchmark_images(to_optimize).each do |_original, rows| # rubocop:disable Style/HashEachMethods
+            benchmark_results.add(rows)
+          end
+          benchmark_results.print
+        else
+          results = Results.new
 
-        optimize_images!(to_optimize).each do |original, optimized|
-          results.add(original, optimized)
-        end
+          optimize_images!(to_optimize).each do |original, optimized|
+            results.add(original, optimized)
+          end
 
-        results.print
+          results.print
+        end
       end
 
       !@warnings
@@ -73,6 +131,11 @@ class ImageOptim
 
   private
 
+    def benchmark_images(to_optimize, &block)
+      to_optimize = to_optimize.with_progress('benchmarking') if @progress
+      @image_optim.benchmark_images(to_optimize, &block)
+    end
+
     def optimize_images!(to_optimize, &block)
       to_optimize = to_optimize.with_progress('optimizing') if @progress
       @image_optim.optimize_images!(to_optimize, &block)

data/lib/image_optim/table.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class ImageOptim
+  # Handy class for pretty printing a table in the terminal. This is very simple, switch to Terminal
+  # Table, Table Tennis or similar if we need more.
+  class Table
+    attr_reader :rows
+
+    def initialize(rows)
+      @rows = rows
+    end
+
+    def write(io)
+      io.puts render_row(columns)
+      io.puts render_sep
+      rows.each do |row|
+        io.puts render_row(row.values)
+      end
+    end
+
+  protected
+
+    # array of column names
+    def columns
+      @columns ||= rows.first.keys
+    end
+
+    # should columns be justified left or right?
+    def justs
+      @justs ||= columns.map do |col|
+        rows.first[col].is_a?(Numeric) ? :rjust : :ljust
+      end
+    end
+
+    # max width of each column
+    def widths
+      @widths ||= columns.map do |col|
+        values = rows.map{ |row| fmt(row[col]) }
+        ([col] + values).map(&:length).max
+      end
+    end
+
+    # render an array of row values
+    def render_row(values)
+      values.zip(justs, widths).map do |value, just, width|
+        fmt(value).send(just, width)
+      end.join('  ')
+    end
+
+    # render a separator line
+    def render_sep
+      render_row(widths.map{ |width| '-' * width })
+    end
+
+    # format one cell value
+    def fmt(value)
+      if value.is_a?(Float)
+        format('%0.3f', value)
+      else
+        value.to_s
+      end
+    end
+  end
+end

data/lib/image_optim/worker/svgo.rb

@@ -2,19 +2,22 @@
 
 require 'image_optim/option_helpers'
 require 'image_optim/worker'
+require 'fspath'
 
 class ImageOptim
   class Worker
     # https://github.com/svg/svgo
     class Svgo < Worker
+      PLUGIN_NAME_R = /\A[a-zA-Z]+\z/.freeze
+
       DISABLE_PLUGINS_OPTION =
       option(:disable_plugins, [], 'List of plugins to disable') do |v|
-        Array(v).map(&:to_s)
+        parse_plugin_names(v)
       end
 
       ENABLE_PLUGINS_OPTION =
       option(:enable_plugins, [], 'List of plugins to enable') do |v|
-        Array(v).map(&:to_s)
+        parse_plugin_names(v)
       end
 
       ALLOW_LOSSY_OPTION =
@@ -40,15 +43,57 @@ class ImageOptim
           --input #{src}
           --output #{dst}
         ]
-        disable_plugins.each do |plugin_name|
-          args.unshift "--disable=#{plugin_name}"
-        end
-        enable_plugins.each do |plugin_name|
-          args.unshift "--enable=#{plugin_name}"
+        if resolve_bin!(:svgo).version >= '2.0.0'
+          unless disable_plugins.empty? && enable_plugins.empty?
+            config_file = plugins_config_file
+            args.unshift "--config=#{config_file.path}"
+          end
+        else
+          disable_plugins.each do |plugin_name|
+            args.unshift "--disable=#{plugin_name}"
+          end
+          enable_plugins.each do |plugin_name|
+            args.unshift "--enable=#{plugin_name}"
+          end
         end
         args.unshift "--precision=#{precision}" if allow_lossy
         execute(:svgo, args, options) && optimized?(src, dst)
       end
+
+    private
+
+      def parse_plugin_names(value)
+        Array(value).map(&:to_s).select do |name|
+          if name =~ PLUGIN_NAME_R
+            true
+          else
+            warn "Doesn't look like svgo plugin name: #{name}"
+          end
+        end
+      end
+
+      def plugins_config_file
+        @plugins_config_file ||= FSPath.temp_file(%w[image_optim .js]).tap do |config_file|
+          config_file.puts 'export default {'
+          config_file.puts '  plugins: ['
+          config_file.puts '    {'
+          config_file.puts '      name: \'preset-default\','
+          config_file.puts '      params: {'
+          config_file.puts '        overrides: {'
+          disable_plugins.each do |plugin_name|
+            config_file.puts "          #{plugin_name}: false,"
+          end
+          config_file.puts '        }'
+          config_file.puts '      }'
+          config_file.puts '    },'
+          enable_plugins.each do |plugin_name|
+            config_file.puts "  '#{plugin_name}',"
+          end
+          config_file.puts '  ]'
+          config_file.puts '};'
+          config_file.close
+        end
+      end
     end
   end
 end

data/lib/image_optim.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'image_optim/benchmark_result'
 require 'image_optim/bin_resolver'
 require 'image_optim/cache'
 require 'image_optim/config'
@@ -8,6 +9,7 @@ require 'image_optim/handler'
 require 'image_optim/image_meta'
 require 'image_optim/optimized_path'
 require 'image_optim/path'
+require 'image_optim/table'
 require 'image_optim/timer'
 require 'image_optim/worker'
 require 'in_threads'
@@ -162,6 +164,22 @@ class ImageOptim
     end
   end
 
+  def benchmark_image(original)
+    src = Path.convert(original)
+    return unless (workers = workers_for_image(src))
+
+    dst = src.temp_path
+    begin
+      workers.map do |worker|
+        start = ElapsedTime.now
+        worker.optimize(src, dst)
+        BenchmarkResult.new(src, dst, ElapsedTime.now - start, worker)
+      end
+    ensure
+      dst.unlink
+    end
+  end
+
   # Optimize multiple images
   # if block given yields path and result for each image and returns array of
   # yield results
@@ -186,6 +204,10 @@ class ImageOptim
     run_method_for(datas, :optimize_image_data, &block)
   end
 
+  def benchmark_images(paths, &block)
+    run_method_for(paths, :benchmark_image, &block)
+  end
+
   class << self
     # Optimization methods with default options
     def method_missing(method, *args, &block)

data/script/update-rubygems-n-bundler

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+ruby <<'RUBY'
+  short_version = RUBY_VERSION.to_f
+
+  gemrc_path = File.expand_path('~/.gemrc')
+  unless File.exist?(gemrc_path)
+    File.open(gemrc_path, 'w') do |f|
+      if short_version < 2.0
+        f.puts 'gem: --no-ri --no-rdoc'
+      else
+        f.puts 'gem: --no-document'
+      end
+    end
+  end
+
+  def sh(*args)
+    abort unless system(*args)
+  end
+
+  case
+  when short_version < 2.3
+    sh 'curl --output rubygems-update.gem https://rubygems.org/downloads/rubygems-update-2.7.11.gem'
+    sh 'gem install --local rubygems-update.gem'
+    sh 'update_rubygems'
+    File.unlink(`which bundle`.strip)
+    sh 'curl --output bundler.gem https://rubygems.org/downloads/bundler-1.17.3.gem'
+    sh 'gem install --local bundler.gem'
+  when short_version < 2.6
+    sh 'gem update --system 3.3.27'
+    sh 'gem install bundler --version 2.3.27'
+  when short_version < 3.0
+    sh 'gem update --system 3.4.22'
+    sh 'gem install bundler --version 2.4.22'
+  when short_version < 3.1
+    sh 'gem update --system 3.5.23'
+    sh 'gem install bundler --version 2.5.23'
+  when short_version < 3.2
+    sh 'gem update --system 3.6.9'
+    sh 'gem install bundler --version 2.6.9'
+  else
+    sh 'gem update --system'
+    sh 'gem install bundler'
+  end
+RUBY
+
+gem -v
+bundle -v

data/spec/image_optim/bin_resolver_spec.rb

@@ -143,14 +143,14 @@ describe ImageOptim::BinResolver do
     expect(FSPath).to receive(:temp_dir).
       once.and_return(tmpdir)
     expect(tmpdir).to receive(:/).
-      with(:the_optimizer).once.and_return(symlink)
+      with(:'the-optimizer').once.and_return(symlink)
     expect(symlink).to receive(:make_symlink).
       with(File.expand_path(path)).once
 
     expect(resolver).not_to receive(:full_path)
     bin = double
     expect(Bin).to receive(:new).
-      with(:the_optimizer, File.expand_path(path)).and_return(bin)
+      with(:'the-optimizer', File.expand_path(path)).and_return(bin)
     expect(bin).to receive(:check!).once
     expect(bin).to receive(:check_fail!).exactly(5).times
 
@@ -160,7 +160,7 @@ describe ImageOptim::BinResolver do
     end
 
     5.times do
-      resolver.resolve!(:the_optimizer)
+      resolver.resolve!(:'the-optimizer')
     end
     expect(resolver.env_path).to eq([
       tmpdir,

data/spec/image_optim/cache_spec.rb

@@ -15,7 +15,9 @@ describe ImageOptim::Cache do
 
   let(:cache_dir) do
     dir = '/somewhere/cache'
-    allow(FileUtils).to receive(:mkpath).with(Regexp.new(Regexp.escape(dir)), any_args)
+    allow(Dir).to receive(:mkdir).with(File.dirname(dir))
+    allow(Dir).to receive(:mkdir).with(dir)
+    allow(Dir).to receive(:mkdir).with(%r{\A#{Regexp.escape(dir)}/[^/]+\z})
     allow(FileUtils).to receive(:touch)
     allow(FSPath).to receive(:temp_file_path) do
       tmp_file

data/spec/image_optim/option_definition_spec.rb

@@ -71,9 +71,7 @@ describe ImageOptim::OptionDefinition do
 
     context 'when proc given' do
       subject do
-        # not using &:inspect due to ruby Bug #13087
-        # to_s is just to calm rubocop
-        described_class.new('abc', :def, 'desc'){ |o| o.inspect.to_s }
+        described_class.new('abc', :def, 'desc', &:inspect)
       end
 
       context 'when option not provided' do

data/spec/image_optim/true_false_nil_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'image_optim/true_false_nil'
+
+describe ImageOptim::TrueFalseNil do
+  describe '.convert' do
+    it 'keeps true' do
+      expect(described_class.convert(true)).to eq(true)
+    end
+
+    it 'keeps false' do
+      expect(described_class.convert(false)).to eq(false)
+    end
+
+    it 'keeps nil' do
+      expect(described_class.convert(nil)).to eq(nil)
+    end
+
+    it 'converts truthy to true' do
+      expect(described_class.convert(1)).to eq(true)
+    end
+  end
+end

data/spec/image_optim/worker/svgo_spec.rb

@@ -4,6 +4,49 @@ require 'spec_helper'
 require 'image_optim/worker/svgo'
 
 describe ImageOptim::Worker::Svgo do
+  %i[
+    disable_plugins
+    enable_plugins
+  ].each do |option|
+    describe "#{option} option" do
+      let(:subject){ described_class.new(ImageOptim.new, value).send(option) }
+
+      context 'default' do
+        let(:value){ {} }
+
+        it{ is_expected.to eq([]) }
+      end
+
+      context 'when passed single valid value' do
+        let(:value){ {option => :pluginName} }
+
+        it 'converts it to a string array' do
+          is_expected.to eq(%w[pluginName])
+        end
+      end
+
+      context 'when passed multiple valid values' do
+        let(:value){ {option => %i[pluginName anotherName]} }
+
+        it 'converts them to a string array' do
+          is_expected.to eq(%w[pluginName anotherName])
+        end
+      end
+
+      context 'when given invalid values' do
+        let(:value){ {option => %w[1abc pluginName alert() anotherName]} }
+
+        it 'warns and skips them' do
+          expect_any_instance_of(described_class).
+            to receive(:warn).with('Doesn\'t look like svgo plugin name: 1abc')
+          expect_any_instance_of(described_class).
+            to receive(:warn).with('Doesn\'t look like svgo plugin name: alert()')
+          is_expected.to eq(%w[pluginName anotherName])
+        end
+      end
+    end
+  end
+
   describe 'precision option' do
     describe 'default' do
       subject{ described_class::PRECISION_OPTION.default }

data/spec/image_optim_spec.rb

@@ -61,9 +61,10 @@ describe ImageOptim do
 
       base_options = {skip_missing_workers: false}
       [
-        ['lossless', base_options, 0],
-        ['lossy', base_options.merge(allow_lossy: true), 0.001],
-      ].each do |type, options, max_difference|
+        # 120 comes from https://github.com/ImageMagick/ImageMagick/commit/8a7495a6d9
+        ['lossless', base_options, 120],
+        ['lossy', base_options.merge(allow_lossy: true), 30],
+      ].each do |type, options, psnr_min|
         it "does it #{type}" do
           image_optim = ImageOptim.new(options)
           copies = test_images.map{ |image| temp_copy(image) }
@@ -78,7 +79,7 @@ describe ImageOptim do
             expect(optimized).not_to have_same_data_as(original)
 
             compare_to = rotate_images.include?(original) ? rotated : original
-            expect(optimized).to be_similar_to(compare_to, max_difference)
+            expect(optimized).to be_similar_to(compare_to, psnr_min)
           end
         end
       end
@@ -268,6 +269,20 @@ describe ImageOptim do
     end
   end
 
+  describe 'benchmark_images' do
+    it 'does it' do
+      image_optim = ImageOptim.new
+      pairs = image_optim.benchmark_images(test_images)
+      test_images.zip(pairs).each do |original, (src, bm)|
+        expect(original).to equal(src)
+        expect(bm[0]).to be_a(ImageOptim::BenchmarkResult)
+        expect(bm[0].bytes).to be_a(Numeric)
+        expect(bm[0].elapsed).to be_a(Numeric)
+        expect(bm[0].worker).to be_a(String)
+      end
+    end
+  end
+
   %w[
     optimize_image
     optimize_image!

data/spec/images/invisiblepixels/generate

@@ -7,6 +7,8 @@ require 'shellwords'
 
 side = 64
 
+colors = Array.new(256){ [rand(256), rand(256), rand(256)] }
+
 IO.popen(%W[
   convert
   -depth 8
@@ -18,7 +20,7 @@ IO.popen(%W[
   side.times do |a|
     side.times do |b|
       alpha = [0, 1, 0x7f, 0xff][((a / 8) + (b / 8)) % 4]
-      f << [rand(256), rand(256), rand(256), alpha].pack('C*')
+      f << [*colors.sample, alpha].pack('C*')
     end
   end
 end

data/spec/spec_helper.rb

@@ -42,12 +42,12 @@ def flatten_animation(image)
   end
 end
 
-def mepp(image_a, image_b)
+def psnr(image_a, image_b)
   coalesce_a = flatten_animation(image_a)
   coalesce_b = flatten_animation(image_b)
   output = ImageOptim::Cmd.capture((IMAGEMAGICK_PREFIX + %W[
     compare
-    -metric MEPP
+    -metric PSNR
     -alpha Background
     #{coalesce_a.to_s.shellescape}
     #{coalesce_b.to_s.shellescape}
@@ -59,21 +59,21 @@ def mepp(image_a, image_b)
   end
 
   num_r = '\d+(?:\.\d+(?:[eE][-+]?\d+)?)?'
-  output[/\((#{num_r}), #{num_r}\)/, 1].to_f
+  num = output[/\A(#{num_r})/, 1].to_f
+  num == 0 ? Float::INFINITY : num
 end
 
 RSpec::Matchers.define :be_smaller_than do |expected|
   match{ |actual| actual.size < expected.size }
 end
 
-RSpec::Matchers.define :be_similar_to do |expected, max_difference|
+RSpec::Matchers.define :be_similar_to do |expected, psnr_min|
   match do |actual|
-    @diff = mepp(actual, expected)
-    @diff <= max_difference
+    @diff = psnr(actual, expected)
+    @diff >= psnr_min
   end
   failure_message do |actual|
-    "expected #{actual} to have at most #{max_difference} difference from " \
-      "#{expected}, got mean error per pixel of #{@diff}"
+    "expected peaks signal to noise ratio between #{actual} and #{expected} to be #{psnr_min}, got #{@diff}"
   end
 end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: image_optim
 version: !ruby/object:Gem::Version
-  version: 0.31.4
+  version: 0.32.0
 platform: ruby
 authors:
 - Ivan Kuchin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -166,14 +165,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description:
-email:
 executables:
 - image_optim
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/build-test-containers.yml"
 - ".github/workflows/check.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
@@ -181,12 +179,14 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.markdown
 - CONTRIBUTING.markdown
+- Dockerfile.test
 - Gemfile
 - LICENSE.txt
 - README.markdown
 - bin/image_optim
 - image_optim.gemspec
 - lib/image_optim.rb
+- lib/image_optim/benchmark_result.rb
 - lib/image_optim/bin_resolver.rb
 - lib/image_optim/bin_resolver/bin.rb
 - lib/image_optim/bin_resolver/comparable_condition.rb
@@ -211,6 +211,7 @@ files:
 - lib/image_optim/runner/glob_helpers.rb
 - lib/image_optim/runner/option_parser.rb
 - lib/image_optim/space.rb
+- lib/image_optim/table.rb
 - lib/image_optim/timer.rb
 - lib/image_optim/true_false_nil.rb
 - lib/image_optim/worker.rb
@@ -230,6 +231,7 @@ files:
 - script/template/jquery-2.1.3.min.js
 - script/template/sortable-0.6.0.min.js
 - script/template/worker_analysis.erb
+- script/update-rubygems-n-bundler
 - script/update_worker_options_in_readme
 - script/worker_analysis
 - spec/files/config_with_range.yaml
@@ -252,6 +254,7 @@ files:
 - spec/image_optim/runner/option_parser_spec.rb
 - spec/image_optim/space_spec.rb
 - spec/image_optim/timer_spec.rb
+- spec/image_optim/true_false_nil_spec.rb
 - spec/image_optim/worker/jpegrecompress_spec.rb
 - spec/image_optim/worker/optipng_spec.rb
 - spec/image_optim/worker/oxipng_spec.rb
@@ -294,7 +297,7 @@ licenses:
 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.31.4
+  documentation_uri: https://www.rubydoc.info/gems/image_optim/0.32.0
   source_code_uri: https://github.com/toy/image_optim
 post_install_message: |
   Rails image assets optimization is extracted into image_optim_rails gem
@@ -313,8 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 4.0.3
 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,
@@ -341,6 +343,7 @@ test_files:
 - spec/image_optim/runner/option_parser_spec.rb
 - spec/image_optim/space_spec.rb
 - spec/image_optim/timer_spec.rb
+- spec/image_optim/true_false_nil_spec.rb
 - spec/image_optim/worker/jpegrecompress_spec.rb
 - spec/image_optim/worker/optipng_spec.rb
 - spec/image_optim/worker/oxipng_spec.rb