Merge pull request #785 from koic/fix_false_positive_for_rails_dynami…

…c_find_by [Fix #778] Fix a false positive for `Rails/DynamicFindBy`
rubocop · Sep 30, 2022 · 150728d · 150728d
2 parents 181b497 + 449162b
commit 150728d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/changelog/fix_false_positive_for_rails_dynamic_find_by.md b/changelog/fix_false_positive_for_rails_dynamic_find_by.md
@@ -0,0 +1 @@
+* [#778](https://github.com/rubocop/rubocop-rails/issues/778): Fix a false positive for `Rails/DynamicFindBy` when using `page.find_by_id` as a Capybara testing API. ([@koic][])
diff --git a/config/default.yml b/config/default.yml
@@ -354,6 +354,7 @@ Rails/DynamicFindBy:
     - find_by_token_for
   AllowedReceivers:
     - Gem::Specification
+    - page # Prevents a warning for `page.find_by_id`. See: https://github.com/rubocop/rubocop-rails/issues/778
 
 Rails/EagerEvaluationLogMessage:
   Description: 'Checks that blocks are used for interpolated strings passed to `Rails.logger.debug`.'

diff --git a/lib/rubocop/cop/rails/dynamic_find_by.rb b/lib/rubocop/cop/rails/dynamic_find_by.rb
@@ -31,12 +31,14 @@ module Rails
       #   User.find_by_sql(users_sql)
       #   User.find_by_token_for(:password_reset, token)
       #
-      # @example AllowedReceivers: ['Gem::Specification'] (default)
+      # @example AllowedReceivers: ['Gem::Specification', 'page'] (default)
       #   # bad
       #   Specification.find_by_name('backend').gem_dir
+      #   page.find_by_id('a_dom_id').click
       #
       #   # good
       #   Gem::Specification.find_by_name('backend').gem_dir
+      #   page.find_by_id('a_dom_id').click
       class DynamicFindBy < Base
         include ActiveRecordHelper
         extend AutoCorrector
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		* [#778](https://github.com/rubocop/rubocop-rails/issues/778): Fix a false positive for `Rails/DynamicFindBy` when using `page.find_by_id` as a Capybara testing API. ([@koic][])