Add New AllowedKeys to Rails/HttpPositionalArguments

Author: pr4-bot

changelog/new_add_new_allowed_key_to.md

@@ -0,0 +1 @@
+* [#1491](https://github.com/rubocop/rubocop-rails/pull/1491): Add New AllowedKeys to `Rails/HttpPositionalArguments`. ([@steiley][])

config/default.yml

@@ -581,6 +581,7 @@ Rails/HttpPositionalArguments:
   Description: 'Use keyword arguments instead of positional arguments in http method calls.'
   Enabled: true
   VersionAdded: '0.44'
+  AllowedKeys: []
   Include:
     - 'spec/**/*'
     - 'test/**/*'

docs/modules/ROOT/pages/cops_rails.adoc

@@ -2931,6 +2931,15 @@ get :new, params: { user_id: 1 }
 get :new, **options
 ----
 
+[#allowedkeys_-__foo__-railshttppositionalarguments]
+==== AllowedMethods: ['foo']
+
+[source,ruby]
+----
+# good
+get :new, foo: 'bar'
+----
+
 [#configurable-attributes-railshttppositionalarguments]
 === Configurable attributes
 
@@ -2940,6 +2949,10 @@ get :new, **options
 | Include
 | `+spec/**/*+`, `+test/**/*+`
 | Array
+
+|AllowedKeys
+|`[]`
+|Array
 |===
 
 [#railshttpstatus]

lib/rubocop/cop/rails/http_positional_arguments.rb

@@ -20,6 +20,11 @@ module Rails
       #   # good
       #   get :new, params: { user_id: 1 }
       #   get :new, **options
+      #
+      # @example AllowedKeys: ['foo']
+      #   # good
+      #   get :new, foo: 'bar'
+      #
       class HttpPositionalArguments < Base
         include RangeHelp
         extend AutoCorrector
@@ -94,7 +99,8 @@ def needs_conversion?(data)
           return false if kwsplat_hash?(data)
 
           data.each_pair.none? do |pair|
-            special_keyword_arg?(pair.key) || (format_arg?(pair.key) && data.pairs.one?)
+            special_keyword_arg?(pair.key) || allowed_arg?(pair.key) ||
+             (format_arg?(pair.key) && data.pairs.one?)
           end
         end
         # rubocop:enable Metrics/CyclomaticComplexity
@@ -103,6 +109,10 @@ def special_keyword_arg?(node)
           node.sym_type? && KEYWORD_ARGS.include?(node.value)
         end
 
+        def allowed_arg?(node)
+          node.sym_type? && cop_config['AllowedKeys'].include?(node.value.to_s)
+        end
+
         def format_arg?(node)
           node.sym_type? && node.value == :format
         end

spec/rubocop/cop/rails/http_positional_arguments_spec.rb

@@ -200,6 +200,14 @@
       end
     end
 
+    describe 'when using AllowedKeys option value' do
+      let(:cop_config) { { 'AllowedKeys' => ['user_id', 'foo'] } }
+
+      it 'does not register an offense' do
+        expect_no_offenses("get :new, user_id: @user.id, foo: 'bar'")
+      end
+    end
+
     describe '.get' do
       it 'registers an offense' do
         expect_offense(<<~RUBY)