Merge pull request #988 from r7kamura/ignored-skip-action-filter-option-autocorrection

Add autocorrection for `Rails/IgnoredSkipActionFilterOption`

Author: koic

changelog/new_add_autocorrection_for_rails_ignored_skip_action_filter_option.md

@@ -0,0 +1 @@
+* [#988](https://github.com/rubocop/rubocop-rails/pull/988): Add autocorrection for `Rails/IgnoredSkipActionFilterOption`. ([@r7kamura][])

lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb

@@ -36,6 +36,10 @@ module Rails
       #       if: -> { trusted_origin? && action_name != "admin" }
       #   end
       class IgnoredSkipActionFilterOption < Base
+        extend AutoCorrector
+
+        include RangeHelp
+
         MSG = <<~MSG.chomp.freeze
           `%<ignore>s` option will be ignored when `%<prefer>s` and `%<ignore>s` are used together.
         MSG
@@ -60,9 +64,13 @@ def on_send(node)
           options = options_hash(options)
 
           if if_and_only?(options)
-            add_offense(options[:if], message: format(MSG, prefer: :only, ignore: :if))
+            add_offense(options[:if], message: format(MSG, prefer: :only, ignore: :if)) do |corrector|
+              remove_node_with_left_space_and_comma(corrector, options[:if])
+            end
           elsif if_and_except?(options)
-            add_offense(options[:except], message: format(MSG, prefer: :if, ignore: :except))
+            add_offense(options[:except], message: format(MSG, prefer: :if, ignore: :except)) do |corrector|
+              remove_node_with_left_space_and_comma(corrector, options[:except])
+            end
           end
         end
 
@@ -81,6 +89,18 @@ def if_and_only?(options)
         def if_and_except?(options)
           options.key?(:if) && options.key?(:except)
         end
+
+        def remove_node_with_left_space_and_comma(corrector, node)
+          corrector.remove(
+            range_with_surrounding_comma(
+              range_with_surrounding_space(
+                node.source_range,
+                side: :left
+              ),
+              :left
+            )
+          )
+        end
       end
     end
   end

spec/rubocop/cop/rails/ignored_skip_action_filter_option_spec.rb

@@ -6,13 +6,21 @@
       skip_before_action :login_required, only: :show, if: :trusted_origin?
                                                        ^^^^^^^^^^^^^^^^^^^^ `if` option will be ignored when `only` and `if` are used together.
     RUBY
+
+    expect_correction(<<~RUBY)
+      skip_before_action :login_required, only: :show
+    RUBY
   end
 
   it 'registers an offense when `if` and `except` are used together' do
     expect_offense(<<~RUBY)
       skip_before_action :login_required, except: :admin, if: :trusted_origin?
                                           ^^^^^^^^^^^^^^ `except` option will be ignored when `if` and `except` are used together.
     RUBY
+
+    expect_correction(<<~RUBY)
+      skip_before_action :login_required, if: :trusted_origin?
+    RUBY
   end
 
   it 'does not register an offense when `if` is used only' do