Merge pull request #783 from koic/fix_a_false_positive_for_rails_dynamic_find_by

koic · web-flow · commit 6e6e0727d20b · 2022-09-29T00:07:02.000+09:00
[Fix #781] Fix a false positive for `Rails/DynamicFindBy`
diff --git a/changelog/fix_a_false_positive_for_rails_dynamic_find_by.md b/changelog/fix_a_false_positive_for_rails_dynamic_find_by.md
@@ -0,0 +1 @@
+* [#781](https://github.com/rubocop/rubocop-rails/issues/781): Make `Rails/DynamicFindBy` aware of `find_by_token_for`. ([@koic][])
diff --git a/config/default.yml b/config/default.yml
@@ -348,8 +348,10 @@ Rails/DynamicFindBy:
   # The `Whitelist` has been deprecated, Please use `AllowedMethods` instead.
   Whitelist:
     - find_by_sql
+    - find_by_token_for
   AllowedMethods:
     - find_by_sql
+    - find_by_token_for
   AllowedReceivers:
     - Gem::Specification
 
diff --git a/lib/rubocop/cop/rails/dynamic_find_by.rb b/lib/rubocop/cop/rails/dynamic_find_by.rb
@@ -22,12 +22,14 @@ module Rails
       #   User.find_by(name: name, email: email)
       #   User.find_by!(email: email)
       #
-      # @example AllowedMethods: ['find_by_sql'] (default)
+      # @example AllowedMethods: ['find_by_sql', 'find_by_token_for'] (default)
       #   # bad
       #   User.find_by_query(users_query)
+      #   User.find_by_token_for(:password_reset, token)
       #
       #   # good
       #   User.find_by_sql(users_sql)
+      #   User.find_by_token_for(:password_reset, token)
       #
       # @example AllowedReceivers: ['Gem::Specification'] (default)
       #   # bad

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+* [#781](https://github.com/rubocop/rubocop-rails/issues/781): Make `Rails/DynamicFindBy` aware of `find_by_token_for`. ([@koic][])
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,14 @@ module Rails`
`22`	`22`	`# User.find_by(name: name, email: email)`
`23`	`23`	`# User.find_by!(email: email)`
`24`	`24`	`#`
`25`		`- # @example AllowedMethods: ['find_by_sql'] (default)`
	`25`	`+ # @example AllowedMethods: ['find_by_sql', 'find_by_token_for'] (default)`
`26`	`26`	`# # bad`
`27`	`27`	`# User.find_by_query(users_query)`
	`28`	`+ # User.find_by_token_for(:password_reset, token)`
`28`	`29`	`#`
`29`	`30`	`# # good`
`30`	`31`	`# User.find_by_sql(users_sql)`
	`32`	`+ # User.find_by_token_for(:password_reset, token)`
`31`	`33`	`#`
`32`	`34`	`# @example AllowedReceivers: ['Gem::Specification'] (default)`
`33`	`35`	`# # bad`