[Fix #13933] Fix wrong autocorrect for Style/KeywordParametersOrder when the arguments are on multiple lines and contain comments

Earlopain · bbatsov · commit 7e91fd91b9a3 · 2025-03-04T08:10:41.000+02:00
There is nothing sensible to do here, except to not offer autocorrect at all. I think.
diff --git a/changelog/fix_wrong_autocorrect_keyword_param_order_comments.md b/changelog/fix_wrong_autocorrect_keyword_param_order_comments.md
@@ -0,0 +1 @@
+* [#13933](https://github.com/rubocop/rubocop/issues/13933): Fix wrong autocorrect for `Style/KeywordParametersOrder` when the arguments are on multiple lines and contain comments. ([@earlopain][])
diff --git a/lib/rubocop/cop/style/keyword_parameters_order.rb b/lib/rubocop/cop/style/keyword_parameters_order.rb
@@ -42,19 +42,25 @@ def on_kwoptarg(node)
           return if kwarg_nodes.empty?
 
           add_offense(node) do |corrector|
-            if node.parent.find(&:kwoptarg_type?) == node
-              corrector.insert_before(node, "#{kwarg_nodes.map(&:source).join(', ')}, ")
+            defining_node = node.each_ancestor(:def, :defs, :block).first
+            next if processed_source.contains_comment?(arguments_range(defining_node))
+            next unless node.parent.find(&:kwoptarg_type?) == node
 
-              arguments = node.each_ancestor(:def, :defs, :block).first.arguments
-              append_newline_to_last_kwoptarg(arguments, corrector) unless parentheses?(arguments)
-
-              remove_kwargs(kwarg_nodes, corrector)
-            end
+            autocorrect(corrector, node, defining_node, kwarg_nodes)
           end
         end
 
         private
 
+        def autocorrect(corrector, node, defining_node, kwarg_nodes)
+          corrector.insert_before(node, "#{kwarg_nodes.map(&:source).join(', ')}, ")
+
+          arguments = defining_node.arguments
+          append_newline_to_last_kwoptarg(arguments, corrector) unless parentheses?(arguments)
+
+          remove_kwargs(kwarg_nodes, corrector)
+        end
+
         def append_newline_to_last_kwoptarg(arguments, corrector)
           last_argument = arguments.last
           return if last_argument.type?(:kwrestarg, :blockarg)
diff --git a/spec/rubocop/cop/style/keyword_parameters_order_spec.rb b/spec/rubocop/cop/style/keyword_parameters_order_spec.rb
@@ -93,6 +93,18 @@ def m arg, required1:, required2:, optional1: 1, optional2: 2, **rest, &block
     RUBY
   end
 
+  it 'registers an offense but does not autocorrect when the argument range contains comments' do
+    expect_offense(<<~RUBY)
+      def foo(optional: 123,
+              ^^^^^^^^^^^^^ Place optional keyword parameters at the end of the parameters list.
+          # Some explanation
+          required:)
+      end
+    RUBY
+
+    expect_no_corrections
+  end
+
   it 'does not register an offense when there are no `kwoptarg`s before `kwarg`s' do
     expect_no_offenses(<<~RUBY)
       def m(arg, required:, optional: 1)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+* [#13933](https://github.com/rubocop/rubocop/issues/13933): Fix wrong autocorrect for `Style/KeywordParametersOrder` when the arguments are on multiple lines and contain comments. ([@earlopain][])