image_optim 0.31.3 → 0.31.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edffa5fea26babe4654e681a829753b7df3d5d80a158a7b3d2974e97b46a49a5
-  data.tar.gz: 467cdc261c726ac97b5252b6b93507e4fac6e5d3804bd7fc17636ba32a6f565a
+  metadata.gz: 28ea4eea777b5a6eac029c628c28509b70d65f5784ef16466c26b758d189d88b
+  data.tar.gz: b4cdec32a6fde2d92b7c3382b14fb90c094e523e46c79fd8fc24d21737348167
 SHA512:
-  metadata.gz: '0379e12d0d4ef8dd0af9e047a728bc9acf0177136b83b9b4aced834238067d0ab3248350bc1813cc76b33eaa3fc5751032a72c14f03a81d3dad9eed61abb0b99'
-  data.tar.gz: 68489aa06564d6f8555adf409c23454fb4b9d57fa74117cd9b1174787ad65bc56a101a8cce9e455ba0e3474f1a1b7e8c8b9707549768be1bb3a94a063c200721
+  metadata.gz: ad0b465ae7de080c2af44efaaeea7a7b17b8bc343faa0f8034105b027362abfc952bf72fead0d9c30f368a94cb74a1a7d2e19d49b07c626f49bfb59b99f4de69
+  data.tar.gz: 8d7070adae2ff71fe71df2ffaf25addb42acdddca2a427bcfad3f91cd3138d0fccfc2b3284d2cf146dd8f513be9c88a4b9c2f378d6564bcfdf629f5f6ee492cf

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

data/.github/workflows/check.yml

@@ -10,49 +10,69 @@ jobs:
     strategy:
       matrix:
         ruby:
-        - '2.0'
-        - '2.1'
-        - '2.2'
-        - '2.3'
-        - '2.4'
-        - '2.5'
-        - '2.6'
+        - '1.9.3'
         - '2.7'
         - '3.0'
         - '3.1'
         - '3.2'
-        - jruby-9.3
+        - '3.3'
         - jruby-9.4
       fail-fast: false
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: "${{ matrix.ruby }}"
         bundler-cache: true
-    - run: sudo npm install -g svgo
-    - run: curl -L "https://github.com/shssoichiro/oxipng/releases/download/v4.0.3/oxipng-4.0.3-x86_64-unknown-linux-musl.tar.gz" | tar -xz -C /usr/local/bin --strip-components 1 --wildcards '*oxipng'
+    - run: npm install -g svgo
     - run: bundle exec image_optim --info
     - run: bundle exec rspec
+  containers:
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    strategy:
+      matrix:
+        container:
+        - debian:buster
+        - debian:bullseye
+        - debian:bookworm
+        # - alpine
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v4
+    - run: |
+        if command -v apt-get &> /dev/null; then
+          apt-get update
+          apt-get -y install make gcc git curl imagemagick ruby ruby-dev rubygems
+        fi
+    - run: |
+        curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+        . ~/.nvm/nvm.sh
+        nvm install 20
+        echo "PATH=$PATH" >> $GITHUB_ENV
+    - run: npm install -g svgo
+    - run: gem install bundler || gem install bundler --version '< 2.4'
+    - run: bundle install
+    - run: bundle exec bin/image_optim --info
+    - run: bundle exec rspec
   windows:
     runs-on: windows-latest
     strategy:
       matrix:
         ruby:
-        - '2.6'
         - '2.7'
         - '3.0'
         - '3.1'
         - '3.2'
+        - '3.3'
       fail-fast: false
-    continue-on-error: ${{ matrix.ruby == '3.2' }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: "${{ matrix.ruby }}"
         bundler-cache: true
-    - uses: actions/cache@v2
+    - uses: actions/cache@v4
       with:
         path: "$HOME/bin"
         key: ${{ runner.os }}
@@ -67,18 +87,26 @@ jobs:
     - run: npm install -g svgo
     - run: bundle exec image_optim --info
     - run: bundle exec rspec
+  update_worker_options_in_readme:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3'
+        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@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: '3'
         bundler-cache: true
-    - run: sudo npm install -g svgo
-    - run: curl -L "https://github.com/shssoichiro/oxipng/releases/download/v4.0.3/oxipng-4.0.3-x86_64-unknown-linux-musl.tar.gz" | tar -xz -C /usr/local/bin --strip-components 1 --wildcards '*oxipng'
-    - uses: paambaati/codeclimate-action@v2.7.5
+    - run: npm install -g svgo
+    - uses: paambaati/codeclimate-action@v9
       with:
         coverageCommand: bundle exec rspec

data/.github/workflows/rubocop.yml

@@ -8,7 +8,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: '3'

data/.rubocop.yml

@@ -88,6 +88,9 @@ Style/AccessorGrouping:
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
+Style/ArgumentsForwarding:
+  Enabled: false
+
 Style/DoubleNegation:
   Enabled: false
 

data/CHANGELOG.markdown

@@ -2,6 +2,10 @@
 
 ## unreleased
 
+## 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)
+
 ## v0.31.3 (2023-02-17)
 
 * Support Psych4/Ruby 3.1 changes to use safe_yaml methods by default [#203](https://github.com/toy/image_optim/issues/203) [#204](https://github.com/toy/image_optim/pull/204) [@oscillot](https://github.com/oscillot) [@toy](https://github.com/toy)

data/LICENSE.txt

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

@@ -375,6 +375,8 @@ Worker has no options
 ### svgo:
 * `:disable_plugins` — List of plugins to disable *(defaults to `[]`)*
 * `:enable_plugins` — List of plugins to enable *(defaults to `[]`)*
+* `:allow_lossy` — Allow precision option *(defaults to `false`)*
+* `:precision` — Number of digits in the fractional part `0`..`20`, ignored in default/lossless mode *(defaults to `3`)*
 
 <!---</worker-options>-->
 
@@ -390,4 +392,4 @@ In separate file [CHANGELOG.markdown](CHANGELOG.markdown).
 
 ## Copyright
 
-Copyright (c) 2012-2023 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.
+Copyright (c) 2012-2024 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.3'
+  s.version     = '0.31.4'
   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']
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     'changelog_uri'     => "https://github.com/toy/#{s.name}/blob/master/CHANGELOG.markdown",
     'documentation_uri' => "https://www.rubydoc.info/gems/#{s.name}/#{s.version}",
     '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")

data/lib/image_optim/runner/option_parser.rb

@@ -34,8 +34,8 @@ class ImageOptim
       def help
         text = super
 
-        # reserve one column
-        columns = terminal_columns - 1
+        # reserve one column and limit to 120
+        columns = [terminal_columns - 1, 120].min
         # 1 for distance between summary and description
         # 2 for additional indent
         wrapped_indent = summary_indent + (' ' * (summary_width + 1 + 2))
@@ -43,20 +43,7 @@ class ImageOptim
         # don't try to wrap if there is too little space for description
         return text if wrapped_width < 20
 
-        wrapped = ''.dup
-        text.split("\n").each do |line|
-          if line.length <= columns
-            wrapped << line << "\n"
-          else
-            indented = line =~ /^\s/
-            wrapped << line.slice!(wrap_regex(columns)) << "\n"
-            line.scan(wrap_regex(wrapped_width)) do |part|
-              wrapped << wrapped_indent if indented
-              wrapped << part << "\n"
-            end
-          end
-        end
-        wrapped
+        wrapped_text(text, wrapped_width, wrapped_indent, columns)
       end
 
     private
@@ -66,6 +53,27 @@ class ImageOptim
         stty_columns ? stty_columns.to_i : `tput cols`.to_i
       end
 
+      def wrapped_text(text, wrapped_width, wrapped_indent, columns)
+        wrapped = []
+        text.split("\n").each do |line|
+          if line.length <= columns
+            wrapped << line << "\n"
+          else
+            wrapped << line.slice!(wrap_regex(columns)).rstrip << "\n"
+            if line =~ /^\s/
+              line.scan(wrap_regex(wrapped_width)) do |part|
+                wrapped << wrapped_indent << part.rstrip << "\n"
+              end
+            else
+              line.scan(wrap_regex(columns)) do |part|
+                wrapped << part.rstrip << "\n"
+              end
+            end
+          end
+        end
+        wrapped.join(nil)
+      end
+
       def wrap_regex(width)
         /.*?.{1,#{width}}(?:\s|\z)/
       end
@@ -96,30 +104,25 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
     |
   TEXT
 
-  op.on('--config-paths PATH1,PATH2', Array, 'Config paths to use instead of ' \
-                                             'default ones') do |paths|
+  op.on('--config-paths PATH1,PATH2', Array, 'Config paths to use instead of default ones') do |paths|
     options[:config_paths] = paths
   end
 
   op.separator nil
 
-  op.on('-r', '-R', '--recursive', 'Recursively scan directories ' \
-                                   'for images') do |recursive|
+  op.on('-r', '-R', '--recursive', 'Recursively scan directories for images') do |recursive|
     options[:recursive] = recursive
   end
 
-  op.on("--exclude-dir 'GLOB'", 'Glob for excluding directories ' \
-                                '(defaults to .*)') do |glob|
+  op.on("--exclude-dir 'GLOB'", 'Glob for excluding directories (defaults to .*)') do |glob|
     options[:exclude_dir_glob] = glob
   end
 
-  op.on("--exclude-file 'GLOB'", 'Glob for excluding files ' \
-                                 '(defaults to .*)') do |glob|
+  op.on("--exclude-file 'GLOB'", 'Glob for excluding files (defaults to .*)') do |glob|
     options[:exclude_file_glob] = glob
   end
 
-  op.on("--exclude 'GLOB'", 'Set glob for excluding both directories and ' \
-                            'files') do |glob|
+  op.on("--exclude 'GLOB'", 'Set glob for excluding both directories and files') do |glob|
     options[:exclude_file_glob] = options[:exclude_dir_glob] = glob
   end
 
@@ -129,41 +132,42 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
     options[:show_progress] = show_progress
   end
 
-  op.on('--[no-]threads N', Integer, 'Number of threads or disable ' \
-                                     '(defaults to number of processors)') do |threads|
+  op.on('--[no-]threads N', Integer, 'Number of threads or disable (defaults to number of processors)') do |threads|
     options[:threads] = threads
   end
 
-  op.on('--[no-]nice N', Integer, '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)') do |nice|
+  op.on(
+    '--[no-]nice N',
+    Integer,
+    '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)'
+  ) do |nice|
     options[:nice] = nice
   end
 
-  op.on('--[no-]pack', 'Require image_optim_pack or disable it, ' \
-                       'by default image_optim_pack will be used if available, ' \
-                       'will turn on skip-missing-workers unless explicitly disabled') do |pack|
+  op.on(
+    '--[no-]pack',
+    'Require image_optim_pack or disable it, by default image_optim_pack will be used if available, will turn on ' \
+    'skip-missing-workers unless explicitly disabled'
+  ) do |pack|
     options[:pack] = pack
   end
 
   op.separator nil
   op.separator '  Caching:'
 
-  op.on('--cache-dir DIR', 'Cache optimized images ' \
-                           'into the specified directory') do |cache_dir|
+  op.on('--cache-dir DIR', 'Cache optimized images into the specified directory') do |cache_dir|
     options[:cache_dir] = cache_dir
   end
 
-  op.on('--cache-worker-digests', 'Cache worker digests ' \
-                                  '(updating workers invalidates cache)') do |cache_worker_digests|
+  op.on('--cache-worker-digests', 'Cache worker digests (updating workers invalidates cache)') do |cache_worker_digests|
     options[:cache_worker_digests] = cache_worker_digests
   end
 
   op.separator nil
   op.separator '  Disabling workers:'
 
-  op.on('--[no-]skip-missing-workers', 'Skip workers with missing or ' \
-                                       'problematic binaries') do |skip|
+  op.on('--[no-]skip-missing-workers', 'Skip workers with missing or problematic binaries') do |skip|
     options[:skip_missing_workers] = skip
   end
 
@@ -177,8 +181,7 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   op.separator nil
   op.separator '  Worker options:'
 
-  op.on('--allow-lossy', 'Allow lossy workers and ' \
-                         'optimizations') do |allow_lossy|
+  op.on('--allow-lossy', 'Allow lossy workers and optimizations') do |allow_lossy|
     options[:allow_lossy] = allow_lossy
   end
 
@@ -229,9 +232,12 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   op.separator nil
   op.separator '  Common options:'
 
-  op.on_tail('-v', '--verbose', 'Verbose output (show global and worker ' \
-                                'config, binary resolution log, information about each tool invocation, ' \
-                                'backtrace of exception)') do
+  op.on_tail(
+    '-v',
+    '--verbose',
+    'Verbose output (show global and worker config, binary resolution log, information about each tool invocation, ' \
+    'backtrace of exception)'
+  ) do
     options[:verbose] = true
   end
 

data/lib/image_optim/worker/svgo.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'image_optim/option_helpers'
 require 'image_optim/worker'
 
 class ImageOptim
@@ -16,6 +17,24 @@ class ImageOptim
         Array(v).map(&:to_s)
       end
 
+      ALLOW_LOSSY_OPTION =
+      option(:allow_lossy, false, 'Allow precision option'){ |v| !!v }
+
+      PRECISION_OPTION =
+      option(:precision, 3, 'Number of digits in the fractional part ' \
+                            '`0`..`20`, ignored in default/lossless mode') \
+                            do |v, opt_def|
+        if allow_lossy
+          OptionHelpers.limit_with_range(v.to_i, 0..20)
+        else
+          if v != opt_def.default
+            warn "#{self.class.bin_sym} #{opt_def.name} #{v} ignored " \
+                 'in default/lossless mode'
+          end
+          opt_def.default
+        end
+      end
+
       def optimize(src, dst, options = {})
         args = %W[
           --input #{src}
@@ -27,6 +46,7 @@ class ImageOptim
         enable_plugins.each do |plugin_name|
           args.unshift "--enable=#{plugin_name}"
         end
+        args.unshift "--precision=#{precision}" if allow_lossy
         execute(:svgo, args, options) && optimized?(src, dst)
       end
     end

data/script/update_worker_options_in_readme

@@ -51,8 +51,21 @@ def update_readme(text)
 end
 
 readme = File.read(README_FILE)
-if (readme = update_readme(readme))
-  File.write(README_FILE, readme)
+program_name = File.basename($PROGRAM_NAME, '.*')
+case ARGV
+when []
+  if (readme = update_readme(readme))
+    File.write(README_FILE, readme)
+  else
+    abort 'Did not update worker options'
+  end
+when %w[-n]
+  updated = update_readme(readme)
+  unless updated == readme
+    puts "Run #{program_name} to update work options in readme"
+    IO.popen('diff -u README.markdown -', 'w'){ |f| f << updated }
+    exit 1
+  end
 else
-  abort 'Did not update worker options'
+  abort "#{program_name} [-n] (-n to change exit code instead of updating)"
 end

data/spec/image_optim/runner/option_parser_spec.rb

@@ -101,7 +101,16 @@ describe ImageOptim::Runner::OptionParser do
       allow(parser).to receive(:terminal_columns).and_return(80)
 
       expect(parser.help.split("\n")).
-        to all(satisfy{ |line| line.length <= 80 })
+        to all(satisfy{ |line| line.length < 80 })
+    end
+
+    it 'wraps texts even for too wide terminals' do
+      parser = OptionParser.new({})
+
+      allow(parser).to receive(:terminal_columns).and_return(1000)
+
+      expect(parser.help.split("\n")).
+        to all(satisfy{ |line| line.length <= 120 })
     end
   end
 end

data/spec/image_optim/worker/svgo_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'image_optim/worker/svgo'
+
+describe ImageOptim::Worker::Svgo do
+  describe 'precision option' do
+    describe 'default' do
+      subject{ described_class::PRECISION_OPTION.default }
+
+      it{ is_expected.to eq(3) }
+    end
+
+    describe 'value' do
+      let(:subject){ described_class.new(ImageOptim.new, options).precision }
+
+      context 'when lossy not allowed' do
+        context 'by default' do
+          let(:options){ {} }
+
+          it{ is_expected.to eq(3) }
+        end
+
+        context 'when value is passed through options' do
+          let(:options){ {precision: 5} }
+
+          it 'warns and keeps default' do
+            expect_any_instance_of(described_class).
+              to receive(:warn).with(%r{ignored in default/lossless mode})
+            is_expected.to eq(3)
+          end
+        end
+      end
+
+      context 'when lossy allowed' do
+        context 'by default' do
+          let(:options){ {allow_lossy: true} }
+
+          it{ is_expected.to eq(3) }
+        end
+
+        context 'when value is passed through options' do
+          let(:options){ {allow_lossy: true, precision: 5} }
+
+          it 'sets the value without warning' do
+            expect_any_instance_of(described_class).not_to receive(:warn)
+            is_expected.to eq(5)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_optim
 version: !ruby/object:Gem::Version
-  version: 0.31.3
+  version: 0.31.4
 platform: ruby
 authors:
 - Ivan Kuchin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -173,8 +173,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/check.yml"
-- ".github/workflows/codeql.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".pre-commit-hooks.yaml"
@@ -256,6 +256,7 @@ files:
 - spec/image_optim/worker/optipng_spec.rb
 - spec/image_optim/worker/oxipng_spec.rb
 - spec/image_optim/worker/pngquant_spec.rb
+- spec/image_optim/worker/svgo_spec.rb
 - spec/image_optim/worker_spec.rb
 - spec/image_optim_spec.rb
 - spec/images/broken_jpeg
@@ -293,7 +294,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.3
+  documentation_uri: https://www.rubydoc.info/gems/image_optim/0.31.4
   source_code_uri: https://github.com/toy/image_optim
 post_install_message: |
   Rails image assets optimization is extracted into image_optim_rails gem
@@ -312,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Command line tool and ruby interface to optimize (lossless compress, optionally
@@ -344,6 +345,7 @@ test_files:
 - spec/image_optim/worker/optipng_spec.rb
 - spec/image_optim/worker/oxipng_spec.rb
 - spec/image_optim/worker/pngquant_spec.rb
+- spec/image_optim/worker/svgo_spec.rb
 - spec/image_optim/worker_spec.rb
 - spec/image_optim_spec.rb
 - spec/images/broken_jpeg

data/.github/workflows/codeql.yml

@@ -1,30 +0,0 @@
-name: codeql
-on:
-  push:
-  pull_request:
-  schedule:
-    - cron: '43 20 * * 0'
-
-jobs:
-  analyze:
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-
-    - uses: github/codeql-action/autobuild@v1
-
-    - uses: github/codeql-action/analyze@v1