rubocop-capybara 2.17.0 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9046dc7fd875441eeb556b848c7fc36099c2ab694b12a6cf5834ff191937a16
-  data.tar.gz: 354393ab09a0849d1c4c7398116827627c5b385e377f5337a135d3d5ff338b08
+  metadata.gz: bb7f795cc80f072b94781f2339e781cccf9922ad2303c09111c0e34a4af264f8
+  data.tar.gz: d2ae47b522208177b7c93338973c8a144dfbccca2f817f0797b531f8c89e50b9
 SHA512:
-  metadata.gz: 7fab06dac5d6ba1989c2c0bf47cd0a674e067baf7265378b8d4493055a1597087a442b79d88b931eadaa0f4ebd5c78f5d1929a116b12afa0d9c20110506651cd
-  data.tar.gz: fd8f7cfebf049c450b25e20b76d76fba8ddbb1a50d626644e740e042589cdd2b1d406ea410df1d558439fc2d66a2b37733ce4ebd409f7f83568cd96dea27c61a
+  metadata.gz: 36b58f29500840c7dc34c2c2ed55856ff08cdd7ca41822209a9388204948903be89cf13c3065da7cfed3e8332f3433b3293087c8de1cf1266f093fadef2fa69d
+  data.tar.gz: 5b961abac7ae8dd46708ec9649718a23596bde9e45bcc48f7d9e818c2a116d5fda3de0653cf3aa8e56d11ed11ebcb94e24ef49ee0653e739a26d43d2383c2152

data/CHANGELOG.md

@@ -2,11 +2,23 @@
 
 ## Edge (Unreleased)
 
-## 2.17.0 (TBD)
+## 2.18.0 (2023-04-21)
+
+- Fix an offense message for `Capybara/SpecificFinders`. ([@ydah])
+- Expand `Capybara/NegationMatcher` to support `have_content` ([@OskarsEzerins])
+- Fix an incorrect autocorrect for `Capybara/CurrentPathExpectation` when matcher's argument is a method with a argument and no parentheses. ([@ydah])
+
+## 2.17.1 (2023-02-13)
+
+- Fix an incorrect autocorrect for `Capybara/CurrentPathExpectation`. ([@ydah])
+- Fix a false negative for `Capybara/CurrentPathExpectation` when using `match`. ([@ydah])
+- Fix a false positive and incorrect autocorrect for `Capybara/SpecificActions`, `Capybara/SpecificFinders` and `Capybara/SpecificMatcher`. ([@ydah])
+
+## 2.17.0 (2022-12-29)
 
 - Extracted from `rubocop-rspec` into a separate repository for easier use with Minitest/Cucumber. ([@pirj])
 
-## Previously (see rubocop-rspec's changelist for details)
+## Previously (see [rubocop-rspec's changelist](https://github.com/rubocop/rubocop-rspec/blob/9558719/CHANGELOG.md) for details)
 
 - Fix a false positive for `Capybara/SpecificMatcher` when `have_css("a")` without attribute. ([@ydah])
 - Add new `Capybara/NegationMatcher` cop. ([@ydah])
@@ -41,6 +53,7 @@
 [@bquorning]: https://github.com/bquorning
 [@darhazer]: https://github.com/Darhazer
 [@onumis]: https://github.com/onumis
+[@oskarsezerins]: https://github.com/OskarsEzerins
 [@pirj]: https://github.com/pirj
 [@rspeicher]: https://github.com/rspeicher
 [@timrogers]: https://github.com/timrogers

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop-capybara.svg)](https://rubygems.org/gems/rubocop-capybara)
 ![CI](https://github.com/rubocop/rubocop-capybara/workflows/CI/badge.svg)
 
-Capybara-specific analysis for your projects, as an extension to
+[Capybara](https://teamcapybara.github.io/capybara)-specific analysis for your projects, as an extension to
 [RuboCop](https://github.com/rubocop/rubocop).
 
 ## Installation

data/config/default.yml

@@ -6,6 +6,8 @@ Capybara:
     - "**/*_spec.rb"
     - "**/spec/**/*"
     - "**/test/**/*"
+    - "**/*_steps.rb"
+    - "**/features/step_definitions/**/*"
 
 Capybara/CurrentPathExpectation:
   Description: Checks that no expectations are set on Capybara's `current_path`.
@@ -17,7 +19,7 @@ Capybara/CurrentPathExpectation:
 Capybara/MatchStyle:
   Description: Checks for usage of deprecated style methods.
   Enabled: pending
-  VersionAdded: "<<next>>"
+  VersionAdded: '2.17'
   Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/MatchStyle
 
 Capybara/NegationMatcher:

data/lib/rubocop/capybara/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Capybara
     # Version information for the Capybara RuboCop plugin.
     module Version
-      STRING = '2.17.0'
+      STRING = '2.18.0'
     end
   end
 end

data/lib/rubocop/cop/capybara/current_path_expectation.rb

@@ -6,10 +6,10 @@ module RuboCop
       # Checks that no expectations are set on Capybara's `current_path`.
       #
       # The
-      # https://www.rubydoc.info/github/teamcapybara/capybara/main/Capybara/RSpecMatchers#have_current_path-instance_method[`have_current_path` matcher]
+      # https://www.rubydoc.info/github/teamcapybara/capybara/master/Capybara/RSpecMatchers#have_current_path-instance_method[`have_current_path` matcher]
       # should be used on `page` to set expectations on Capybara's
       # current path, since it uses
-      # https://github.com/teamcapybara/capybara/blob/main/README.md#asynchronous-javascript-ajax-and-friends[Capybara's waiting functionality]
+      # https://github.com/teamcapybara/capybara/blob/master/README.md#asynchronous-javascript-ajax-and-friends[Capybara's waiting functionality]
       # which ensures that preceding actions (like `click_link`) have
       # completed.
       #
@@ -30,6 +30,7 @@ module RuboCop
       #
       class CurrentPathExpectation < ::RuboCop::Cop::Base
         extend AutoCorrector
+        include RangeHelp
 
         MSG = 'Do not set an RSpec expectation on `current_path` in ' \
               'Capybara feature specs - instead, use the ' \
@@ -50,11 +51,11 @@ module RuboCop
             ${(send nil? :eq ...) (send nil? :match (regexp ...))})
         PATTERN
 
-        # @!method regexp_str_matcher(node)
-        def_node_matcher :regexp_str_matcher, <<-PATTERN
+        # @!method regexp_node_matcher(node)
+        def_node_matcher :regexp_node_matcher, <<-PATTERN
           (send
             #expectation_set_on_current_path ${:to :to_not :not_to}
-            $(send nil? :match (str $_)))
+            $(send nil? :match ${str dstr xstr}))
         PATTERN
 
         def self.autocorrect_incompatible_with
@@ -78,15 +79,14 @@ module RuboCop
             rewrite_expectation(corrector, node, to_sym, matcher_node)
           end
 
-          regexp_str_matcher(node.parent) do |to_sym, matcher_node, regexp|
+          regexp_node_matcher(node.parent) do |to_sym, matcher_node, regexp|
             rewrite_expectation(corrector, node, to_sym, matcher_node)
-            convert_regexp_str_to_literal(corrector, matcher_node, regexp)
+            convert_regexp_node_to_literal(corrector, matcher_node, regexp)
           end
         end
 
         def rewrite_expectation(corrector, node, to_symbol, matcher_node)
-          current_path_node = node.first_argument
-          corrector.replace(current_path_node, 'page')
+          corrector.replace(node.first_argument, 'page')
           corrector.replace(node.parent.loc.selector, 'to')
           matcher_method = if to_symbol == :to
                              'have_current_path'
@@ -94,15 +94,38 @@ module RuboCop
                              'have_no_current_path'
                            end
           corrector.replace(matcher_node.loc.selector, matcher_method)
+          add_argument_parentheses(corrector, matcher_node.first_argument)
           add_ignore_query_options(corrector, node)
         end
 
-        def convert_regexp_str_to_literal(corrector, matcher_node, regexp_str)
+        def convert_regexp_node_to_literal(corrector, matcher_node, regexp_node)
           str_node = matcher_node.first_argument
-          regexp_expr = Regexp.new(regexp_str).inspect
+          regexp_expr = regexp_node_to_regexp_expr(regexp_node)
           corrector.replace(str_node, regexp_expr)
         end
 
+        def regexp_node_to_regexp_expr(regexp_node)
+          if regexp_node.xstr_type?
+            "/\#{`#{regexp_node.value.value}`}/"
+          else
+            Regexp.new(regexp_node.value).inspect
+          end
+        end
+
+        def add_argument_parentheses(corrector, arg_node)
+          return unless method_call_with_no_parentheses?(arg_node)
+
+          first_argument_range = range_with_surrounding_space(
+            arg_node.first_argument.source_range, side: :left
+          )
+          corrector.insert_before(first_argument_range, '(')
+          corrector.insert_after(arg_node.last_argument, ')')
+        end
+
+        def method_call_with_no_parentheses?(arg_node)
+          arg_node.send_type? && arg_node.arguments? && !arg_node.parenthesized?
+        end
+
         # `have_current_path` with no options will include the querystring
         # while `page.current_path` does not.
         # This ensures the option `ignore_query: true` is added
@@ -110,7 +133,9 @@ module RuboCop
         def add_ignore_query_options(corrector, node)
           expectation_node = node.parent.last_argument
           expectation_last_child = expectation_node.children.last
-          return if %i[regexp str].include?(expectation_last_child.type)
+          return if %i[
+            regexp str dstr xstr
+          ].include?(expectation_last_child.type)
 
           corrector.insert_after(
             expectation_last_child,

data/lib/rubocop/cop/capybara/mixin/capybara_help.rb

@@ -2,76 +2,129 @@
 
 module RuboCop
   module Cop
-    # Help methods for capybara.
-    module CapybaraHelp
-      module_function
+    module Capybara
+      # Help methods for capybara.
+      # @api private
+      module CapybaraHelp
+        COMMON_OPTIONS = %w[
+          id class style
+        ].freeze
+        SPECIFIC_OPTIONS = {
+          'button' => (
+            COMMON_OPTIONS + %w[disabled name value title type]
+          ).freeze,
+          'link' => (
+            COMMON_OPTIONS + %w[href alt title download]
+          ).freeze,
+          'table' => (
+            COMMON_OPTIONS + %w[cols rows]
+          ).freeze,
+          'select' => (
+            COMMON_OPTIONS + %w[
+              disabled name placeholder
+              selected multiple
+            ]
+          ).freeze,
+          'field' => (
+            COMMON_OPTIONS + %w[
+              checked disabled name placeholder
+              readonly type multiple
+            ]
+          ).freeze
+        }.freeze
+        SPECIFIC_PSEUDO_CLASSES = %w[
+          not() disabled enabled checked unchecked
+        ].freeze
 
-      # @param node [RuboCop::AST::SendNode]
-      # @param locator [String]
-      # @param element [String]
-      # @return [Boolean]
-      def specific_option?(node, locator, element)
-        attrs = CssSelector.attributes(locator).keys
-        return false unless replaceable_element?(node, element, attrs)
+        module_function
 
-        attrs.all? do |attr|
-          CssSelector.specific_options?(element, attr)
+        # @param node [RuboCop::AST::SendNode]
+        # @param locator [String]
+        # @param element [String]
+        # @return [Boolean]
+        def replaceable_option?(node, locator, element)
+          attrs = CssSelector.attributes(locator).keys
+          return false unless replaceable_element?(node, element, attrs)
+
+          attrs.all? do |attr|
+            SPECIFIC_OPTIONS.fetch(element, []).include?(attr)
+          end
         end
-      end
 
-      # @param locator [String]
-      # @return [Boolean]
-      def specific_pseudo_classes?(locator)
-        CssSelector.pseudo_classes(locator).all? do |pseudo_class|
-          replaceable_pseudo_class?(pseudo_class, locator)
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   common_attributes?('a[focused]') # => true
+        #   common_attributes?('button[focused][visible]') # => true
+        #   common_attributes?('table[id=some-id]') # => true
+        #   common_attributes?('h1[invalid]') # => false
+        def common_attributes?(selector)
+          CssSelector.attributes(selector).keys.difference(COMMON_OPTIONS).none?
         end
-      end
 
-      # @param pseudo_class [String]
-      # @param locator [String]
-      # @return [Boolean]
-      def replaceable_pseudo_class?(pseudo_class, locator)
-        return false unless CssSelector.specific_pesudo_classes?(pseudo_class)
+        # @param attrs [Array<String>]
+        # @return [Boolean]
+        # @example
+        #   replaceable_attributes?('table[id=some-id]') # => true
+        #   replaceable_attributes?('a[focused]') # => false
+        def replaceable_attributes?(attrs)
+          attrs.values.none?(&:nil?)
+        end
 
-        case pseudo_class
-        when 'not()' then replaceable_pseudo_class_not?(locator)
-        else true
+        # @param locator [String]
+        # @return [Boolean]
+        def replaceable_pseudo_classes?(locator)
+          CssSelector.pseudo_classes(locator).all? do |pseudo_class|
+            replaceable_pseudo_class?(pseudo_class, locator)
+          end
         end
-      end
 
-      # @param locator [String]
-      # @return [Boolean]
-      def replaceable_pseudo_class_not?(locator)
-        locator.scan(/not\(.*?\)/).all? do |negation|
-          CssSelector.attributes(negation).values.all? do |v|
-            v.is_a?(TrueClass) || v.is_a?(FalseClass)
+        # @param pseudo_class [String]
+        # @param locator [String]
+        # @return [Boolean]
+        def replaceable_pseudo_class?(pseudo_class, locator)
+          return false unless SPECIFIC_PSEUDO_CLASSES.include?(pseudo_class)
+
+          case pseudo_class
+          when 'not()' then replaceable_pseudo_class_not?(locator)
+          else true
           end
         end
-      end
 
-      # @param node [RuboCop::AST::SendNode]
-      # @param element [String]
-      # @param attrs [Array<String>]
-      # @return [Boolean]
-      def replaceable_element?(node, element, attrs)
-        case element
-        when 'link' then replaceable_to_link?(node, attrs)
-        else true
+        # @param locator [String]
+        # @return [Boolean]
+        def replaceable_pseudo_class_not?(locator)
+          locator.scan(/not\(.*?\)/).all? do |negation|
+            CssSelector.attributes(negation).values.all? do |v|
+              v.is_a?(TrueClass) || v.is_a?(FalseClass)
+            end
+          end
         end
-      end
 
-      # @param node [RuboCop::AST::SendNode]
-      # @param attrs [Array<String>]
-      # @return [Boolean]
-      def replaceable_to_link?(node, attrs)
-        include_option?(node, :href) || attrs.include?('href')
-      end
+        # @param node [RuboCop::AST::SendNode]
+        # @param element [String]
+        # @param attrs [Array<String>]
+        # @return [Boolean]
+        def replaceable_element?(node, element, attrs)
+          case element
+          when 'link' then replaceable_to_link?(node, attrs)
+          else true
+          end
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @param attrs [Array<String>]
+        # @return [Boolean]
+        def replaceable_to_link?(node, attrs)
+          include_option?(node, :href) || attrs.include?('href')
+        end
 
-      # @param node [RuboCop::AST::SendNode]
-      # @param option [Symbol]
-      # @return [Boolean]
-      def include_option?(node, option)
-        node.each_descendant(:sym).find { |opt| opt.value == option }
+        # @param node [RuboCop::AST::SendNode]
+        # @param option [Symbol]
+        # @return [Boolean]
+        def include_option?(node, option)
+          node.each_descendant(:sym).find { |opt| opt.value == option }
+        end
       end
     end
   end

data/lib/rubocop/cop/capybara/mixin/css_selector.rb

@@ -2,141 +2,108 @@
 
 module RuboCop
   module Cop
-    # Helps parsing css selector.
-    module CssSelector
-      COMMON_OPTIONS = %w[
-        above below left_of right_of near count minimum maximum between text
-        id class style visible obscured exact exact_text normalize_ws match
-        wait filter_set focused
-      ].freeze
-      SPECIFIC_OPTIONS = {
-        'button' => (
-          COMMON_OPTIONS + %w[disabled name value title type]
-        ).freeze,
-        'link' => (
-          COMMON_OPTIONS + %w[href alt title download]
-        ).freeze,
-        'table' => (
-          COMMON_OPTIONS + %w[
-            caption with_cols cols with_rows rows
-          ]
-        ).freeze,
-        'select' => (
-          COMMON_OPTIONS + %w[
-            disabled name placeholder options enabled_options
-            disabled_options selected with_selected multiple with_options
-          ]
-        ).freeze,
-        'field' => (
-          COMMON_OPTIONS + %w[
-            checked unchecked disabled valid name placeholder
-            validation_message readonly with type multiple
-          ]
-        ).freeze
-      }.freeze
-      SPECIFIC_PSEUDO_CLASSES = %w[
-        not() disabled enabled checked unchecked
-      ].freeze
+    module Capybara
+      # Helps parsing css selector.
+      # @api private
+      module CssSelector
+        module_function
 
-      module_function
+        # @param selector [String]
+        # @return [String]
+        # @example
+        #   id('#some-id') # => some-id
+        #   id('.some-cls') # => nil
+        #   id('#some-id.cls') # => some-id
+        def id(selector)
+          return unless id?(selector)
 
-      # @param element [String]
-      # @param attribute [String]
-      # @return [Boolean]
-      # @example
-      #   specific_pesudo_classes?('button', 'name') # => true
-      #   specific_pesudo_classes?('link', 'invalid') # => false
-      def specific_options?(element, attribute)
-        SPECIFIC_OPTIONS.fetch(element, []).include?(attribute)
-      end
-
-      # @param pseudo_class [String]
-      # @return [Boolean]
-      # @example
-      #   specific_pesudo_classes?('disabled') # => true
-      #   specific_pesudo_classes?('first-of-type') # => false
-      def specific_pesudo_classes?(pseudo_class)
-        SPECIFIC_PSEUDO_CLASSES.include?(pseudo_class)
-      end
+          selector.delete('#').gsub(selector.scan(/[^\\]([>,+~.].*)/).join, '')
+        end
 
-      # @param selector [String]
-      # @return [Boolean]
-      # @example
-      #   id?('#some-id') # => true
-      #   id?('.some-class') # => false
-      def id?(selector)
-        selector.start_with?('#')
-      end
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   id?('#some-id') # => true
+        #   id?('.some-cls') # => false
+        def id?(selector)
+          selector.start_with?('#')
+        end
 
-      # @param selector [String]
-      # @return [Boolean]
-      # @example
-      #   attribute?('[attribute]') # => true
-      #   attribute?('attribute') # => false
-      def attribute?(selector)
-        selector.start_with?('[')
-      end
+        # @param selector [String]
+        # @return [Array<String>]
+        # @example
+        #   classes('#some-id') # => []
+        #   classes('.some-cls') # => ['some-cls']
+        #   classes('#some-id.some-cls') # => ['some-cls']
+        #   classes('#some-id.cls1.cls2') # => ['cls1', 'cls2']
+        def classes(selector)
+          selector.scan(/\.([\w-]*)/).flatten
+        end
 
-      # @param selector [String]
-      # @return [Array<String>]
-      # @example
-      #   attributes('a[foo-bar_baz]') # => {"foo-bar_baz=>true}
-      #   attributes('button[foo][bar]') # => {"foo"=>true, "bar"=>true}
-      #   attributes('table[foo=bar]') # => {"foo"=>"'bar'"}
-      def attributes(selector)
-        selector.scan(/\[(.*?)\]/).flatten.to_h do |attr|
-          key, value = attr.split('=')
-          [key, normalize_value(value)]
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   attribute?('[attribute]') # => true
+        #   attribute?('attribute') # => false
+        def attribute?(selector)
+          selector.start_with?('[')
         end
-      end
 
-      # @param selector [String]
-      # @return [Boolean]
-      # @example
-      #   common_attributes?('a[focused]') # => true
-      #   common_attributes?('button[focused][visible]') # => true
-      #   common_attributes?('table[id=some-id]') # => true
-      #   common_attributes?('h1[invalid]') # => false
-      def common_attributes?(selector)
-        attributes(selector).keys.difference(COMMON_OPTIONS).none?
-      end
+        # @param selector [String]
+        # @return [Array<String>]
+        # @example
+        #   attributes('a[foo-bar_baz]') # => {"foo-bar_baz=>nil}
+        #   attributes('button[foo][bar=baz]') # => {"foo"=>nil, "bar"=>"'baz'"}
+        #   attributes('table[foo=bar]') # => {"foo"=>"'bar'"}
+        def attributes(selector)
+          # Extract the inner strings of attributes.
+          # For example, extract the following:
+          # 'button[foo][bar=baz]' => 'foo][bar=baz'
+          inside_attributes = selector.scan(/\[(.*)\]/).flatten.join
+          inside_attributes.split('][').to_h do |attr|
+            key, value = attr.split('=')
+            [key, normalize_value(value)]
+          end
+        end
 
-      # @param selector [String]
-      # @return [Array<String>]
-      # @example
-      #   pseudo_classes('button:not([disabled])') # => ['not()']
-      #   pseudo_classes('a:enabled:not([valid])') # => ['enabled', 'not()']
-      def pseudo_classes(selector)
-        # Attributes must be excluded or else the colon in the `href`s URL
-        # will also be picked up as pseudo classes.
-        # "a:not([href='http://example.com']):enabled" => "a:not():enabled"
-        ignored_attribute = selector.gsub(/\[.*?\]/, '')
-        # "a:not():enabled" => ["not()", "enabled"]
-        ignored_attribute.scan(/:([^:]*)/).flatten
-      end
+        # @param selector [String]
+        # @return [Array<String>]
+        # @example
+        #   pseudo_classes('button:not([disabled])') # => ['not()']
+        #   pseudo_classes('a:enabled:not([valid])') # => ['enabled', 'not()']
+        def pseudo_classes(selector)
+          # Attributes must be excluded or else the colon in the `href`s URL
+          # will also be picked up as pseudo classes.
+          # "a:not([href='http://example.com']):enabled" => "a:not():enabled"
+          ignored_attribute = selector.gsub(/\[.*?\]/, '')
+          # "a:not():enabled" => ["not()", "enabled"]
+          ignored_attribute.scan(/:([^:]*)/).flatten
+        end
 
-      # @param selector [String]
-      # @return [Boolean]
-      # @example
-      #   multiple_selectors?('a.cls b#id') # => true
-      #   multiple_selectors?('a.cls') # => false
-      def multiple_selectors?(selector)
-        selector.match?(/[ >,+~]/)
-      end
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   multiple_selectors?('a.cls b#id') # => true
+        #   multiple_selectors?('a.cls') # => false
+        def multiple_selectors?(selector)
+          normalize = selector.gsub(/(\\[>,+~]|\(.*\))/, '')
+          normalize.match?(/[ >,+~]/)
+        end
 
-      # @param value [String]
-      # @return [Boolean, String]
-      # @example
-      #   normalize_value('true') # => true
-      #   normalize_value('false') # => false
-      #   normalize_value(nil) # => false
-      #   normalize_value("foo") # => "'foo'"
-      def normalize_value(value)
-        case value
-        when 'true' then true
-        when 'false' then false
-        when nil then true
-        else "'#{value}'"
+        # @param value [String]
+        # @return [Boolean, String]
+        # @example
+        #   normalize_value('true') # => true
+        #   normalize_value('false') # => false
+        #   normalize_value(nil) # => nil
+        #   normalize_value("foo") # => "'foo'"
+        def normalize_value(value)
+          case value
+          when 'true' then true
+          when 'false' then false
+          when nil then nil
+          else "'#{value.gsub(/"|'/, '')}'"
+          end
         end
       end
     end

data/lib/rubocop/cop/capybara/negation_matcher.rb

@@ -31,7 +31,7 @@ module RuboCop
         CAPYBARA_MATCHERS = %w[
           selector css xpath text title current_path link button
           field checked_field unchecked_field select table
-          sibling ancestor
+          sibling ancestor content
         ].freeze
         POSITIVE_MATCHERS =
           Set.new(CAPYBARA_MATCHERS) { |element| :"have_#{element}" }.freeze

data/lib/rubocop/cop/capybara/specific_actions.rb

@@ -41,9 +41,7 @@ module RuboCop
             # which the last selector points.
             next unless (selector = last_selector(arg))
             next unless (action = specific_action(selector))
-            next unless CapybaraHelp.specific_option?(node.receiver, arg,
-                                                      action)
-            next unless CapybaraHelp.specific_pseudo_classes?(arg)
+            next unless replaceable?(node, arg, action)
 
             range = offense_range(node, node.receiver)
             add_offense(range, message: message(action, selector))
@@ -56,6 +54,18 @@ module RuboCop
           SPECIFIC_ACTION[last_selector(selector)]
         end
 
+        def replaceable?(node, arg, action)
+          replaceable_attributes?(arg) &&
+            CapybaraHelp.replaceable_option?(node.receiver, arg, action) &&
+            CapybaraHelp.replaceable_pseudo_classes?(arg)
+        end
+
+        def replaceable_attributes?(selector)
+          CapybaraHelp.replaceable_attributes?(
+            CssSelector.attributes(selector)
+          )
+        end
+
         def supported_selector?(selector)
           !selector.match?(/[>,+~]/)
         end
@@ -65,7 +75,7 @@ module RuboCop
         end
 
         def offense_range(node, receiver)
-          receiver.loc.selector.with(end_pos: node.loc.expression.end_pos)
+          receiver.loc.selector.with(end_pos: node.source_range.end_pos)
         end
 
         def message(action, selector)

data/lib/rubocop/cop/capybara/specific_finders.rb

@@ -19,7 +19,7 @@ module RuboCop
 
         include RangeHelp
 
-        MSG = 'Prefer `find_by` over `find`.'
+        MSG = 'Prefer `find_by_id` over `find`.'
         RESTRICT_ON_SEND = %i[find].freeze
 
         # @!method find_argument(node)
@@ -27,8 +27,14 @@ module RuboCop
           (send _ :find (str $_) ...)
         PATTERN
 
+        # @!method class_options(node)
+        def_node_search :class_options, <<~PATTERN
+          (pair (sym :class) $_ ...)
+        PATTERN
+
         def on_send(node)
           find_argument(node) do |arg|
+            next if CssSelector.pseudo_classes(arg).any?
             next if CssSelector.multiple_selectors?(arg)
 
             on_attr(node, arg) if attribute?(arg)
@@ -39,28 +45,57 @@ module RuboCop
         private
 
         def on_attr(node, arg)
-          return unless (id = CssSelector.attributes(arg)['id'])
+          attrs = CssSelector.attributes(arg)
+          return unless (id = attrs['id'])
+          return if attrs['class']
 
           register_offense(node, replaced_arguments(arg, id))
         end
 
         def on_id(node, arg)
-          register_offense(node, "'#{arg.to_s.delete('#')}'")
+          return if CssSelector.attributes(arg).any?
+
+          id = CssSelector.id(arg)
+          register_offense(node, "'#{id}'",
+                           CssSelector.classes(arg.sub("##{id}", '')))
         end
 
         def attribute?(arg)
           CssSelector.attribute?(arg) &&
-            CssSelector.common_attributes?(arg)
+            CapybaraHelp.common_attributes?(arg)
         end
 
-        def register_offense(node, arg_replacement)
+        def register_offense(node, id, classes = [])
           add_offense(offense_range(node)) do |corrector|
             corrector.replace(node.loc.selector, 'find_by_id')
-            corrector.replace(node.first_argument.loc.expression,
-                              arg_replacement)
+            corrector.replace(node.first_argument,
+                              id.delete('\\'))
+            unless classes.compact.empty?
+              autocorrect_classes(corrector, node, classes)
+            end
           end
         end
 
+        def autocorrect_classes(corrector, node, classes)
+          if (options = class_options(node).first)
+            append_options(classes, options)
+            corrector.replace(options, classes.to_s)
+          else
+            corrector.insert_after(node.first_argument,
+                                   keyword_argument_class(classes))
+          end
+        end
+
+        def append_options(classes, options)
+          classes << options.value if options.str_type?
+          options.each_value { |v| classes << v.value } if options.array_type?
+        end
+
+        def keyword_argument_class(classes)
+          value = classes.size > 1 ? classes.to_s : "'#{classes.first}'"
+          ", class: #{value}"
+        end
+
         def replaced_arguments(arg, id)
           options = to_options(CssSelector.attributes(arg))
           options.empty? ? id : "#{id}, #{options}"
@@ -82,7 +117,7 @@ module RuboCop
           if node.loc.end
             node.loc.end.end_pos
           else
-            node.loc.expression.end_pos
+            node.source_range.end_pos
           end
         end
       end

data/lib/rubocop/cop/capybara/specific_matcher.rb

@@ -46,8 +46,7 @@ module RuboCop
           first_argument(node) do |arg|
             next unless (matcher = specific_matcher(arg))
             next if CssSelector.multiple_selectors?(arg)
-            next unless CapybaraHelp.specific_option?(node, arg, matcher)
-            next unless CapybaraHelp.specific_pseudo_classes?(arg)
+            next unless replaceable?(node, arg, matcher)
 
             add_offense(node, message: message(node, matcher))
           end
@@ -60,6 +59,18 @@ module RuboCop
           SPECIFIC_MATCHER[splitted_arg]
         end
 
+        def replaceable?(node, arg, matcher)
+          replaceable_attributes?(arg) &&
+            CapybaraHelp.replaceable_option?(node, arg, matcher) &&
+            CapybaraHelp.replaceable_pseudo_classes?(arg)
+        end
+
+        def replaceable_attributes?(selector)
+          CapybaraHelp.replaceable_attributes?(
+            CssSelector.attributes(selector)
+          )
+        end
+
         def message(node, matcher)
           format(MSG,
                  good_matcher: good_matcher(node, matcher),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-capybara
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 2.18.0
 platform: ruby
 authors:
 - Yudai Takada
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
 summary: Code style checking for Capybara test files