add a basic check for names of enabled and disabled svgo plugins

Author: toy

CHANGELOG.markdown

@@ -6,6 +6,7 @@
 * 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)
 
 ## v0.31.4 (2024-11-19)
 

lib/image_optim/worker/svgo.rb

@@ -7,14 +7,16 @@ 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 =
@@ -49,6 +51,18 @@ def optimize(src, dst, options = {})
         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
     end
   end
 end

spec/image_optim/worker/svgo_spec.rb

@@ -4,6 +4,49 @@
 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 }