image_optim 0.31.3 → 0.32.0

data/spec/image_optim/worker/svgo_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+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 }
+
+      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

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.3
+  version: 0.32.0
 platform: ruby
 authors:
 - Ivan Kuchin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -166,27 +165,28 @@ 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/codeql.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".pre-commit-hooks.yaml"
 - ".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,10 +254,12 @@ 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
 - 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 +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.3
+  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
@@ -312,8 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-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,
@@ -340,10 +343,12 @@ 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
 - 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