rubocop-capybara 2.19.0 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5af741b67ec2d02d9e27e688d553e5e1c8cbb04c845f5d9771b480b291b1d805
-  data.tar.gz: cbef51994ffa79af69a8a7aac9aabf69ccc307b3c2c104eae2a3a4c635467d26
+  metadata.gz: ed8a103d3d11a90d7873a5569246e580d816e2ebad0a614827bd2ed3546bf6bf
+  data.tar.gz: d09792f9ea669f7556814b898fbfd9829e8db25fdd3b8873ac85487ee9f199ef
 SHA512:
-  metadata.gz: 98bcff699a8ee323a24118f26b412ed8e4d26754df9ee82eab0b107f1b96cb2a0ad7ba898925fde7683501244f1474231bd53591f450e6080321e0bd83245257
-  data.tar.gz: 4194b54f6b12d4b168122c59fbfa18ec210e92cb4d20207665787ae870a3a92a240938818e187889f239e5ce29244db5c612c368bf761ee68f65f1617f72092f
+  metadata.gz: '0798dc5b62b3dc8a8ea31bd1f79cedde039d0d69e94cf18a902ced3da7ae757b0529fa17b8d5711baae964fb591eccfcce4f7b16320598cd9dafb657c4aee85c'
+  data.tar.gz: 7de56f77982c7b52973c38698317233da3ebeb2a55dff962c380105419d2708e43e16d5f1f63a87338ec935d6c5c24941efd95a2d308b2236d7dd840bf8c63ab

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## Edge (Unreleased)
 
+## 2.21.0 (2024-06-08)
+
+- Fix a false negative for `Capybara/NegationMatcher` when using `to_not`. ([@ydah])
+- Fix a false negative for `Capybara/SpecificFinders` when using `find(:id, 'some-id')`. ([@ydah])
+
+## 2.20.0 (2024-01-03)
+
+- Change to default `EnforcedStyle: link_or_button` for `Capybara/ClickLinkOrButtonStyle` cop. ([@ydah])
+- Fix a false negative for `RSpec/HaveSelector` when first argument is dstr node. ([@ydah])
+- Add new `Capybara/RedundantWithinFind` cop. ([@ydah])
+- Fix an invalid attributes parse when name with multiple `[]` for `Capybara/SpecificFinders` and `Capybara/SpecificActions` and `Capybara/SpecificMatcher`. ([@ydah])
+- Change to default `EnforcedStyle: have_no` for `Capybara/NegationMatcher` cop. ([@ydah])
+- Fix a false positive for `Capybara/SpecificMatcher` when `text:` or `exact_text:` with regexp. ([@ydah])
+
 ## 2.19.0 (2023-09-20)
 
 - Add new `Capybara/RSpec/PredicateMatcher` cop. ([@ydah])

data/config/default.yml

@@ -10,13 +10,14 @@ Capybara:
     - "**/features/step_definitions/**/*"
 
 Capybara/ClickLinkOrButtonStyle:
-  Description: Checks for click button or link style.
+  Description: Checks for methods of button or link clicks.
   Enabled: pending
   VersionAdded: '2.19'
-  EnforcedStyle: strict
+  VersionChanged: '2.20'
+  EnforcedStyle: link_or_button
   SupportedStyles:
-    - strict
     - link_or_button
+    - strict
   Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/ClickLinkOrButtonStyle
 
 Capybara/CurrentPathExpectation:
@@ -36,12 +37,19 @@ Capybara/NegationMatcher:
   Description: Enforces use of `have_no_*` or `not_to` for negated expectations.
   Enabled: pending
   VersionAdded: '2.14'
-  EnforcedStyle: not_to
+  VersionChanged: '2.20'
+  EnforcedStyle: have_no
   SupportedStyles:
     - have_no
     - not_to
   Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/NegationMatcher
 
+Capybara/RedundantWithinFind:
+  Description: Checks for redundant `within find(...)` calls.
+  Enabled: pending
+  VersionAdded: '2.20'
+  Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/RedundantWithinFind
+
 Capybara/SpecificActions:
   Description: Checks for there is a more specific actions offered by Capybara.
   Enabled: pending

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Capybara
+    module Cop
+      # Source and spec generator for new cops
+      #
+      # This generator will take a cop name and generate a source file
+      # and spec file when given a valid qualified cop name.
+      # @api private
+      class Generator < RuboCop::Cop::Generator
+        def todo
+          <<~TODO
+            Do 4 steps:
+              1. Modify the description of #{badge} in config/default.yml
+              2. Implement your new cop in the generated file!
+              3. Add an entry about new cop to CHANGELOG.md
+              4. Commit your new cop with a message such as
+                 e.g. "Add new `#{badge}` cop"
+          TODO
+        end
+      end
+    end
+  end
+end

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.19.0'
+      STRING = '2.21.0'
     end
   end
 end

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

@@ -3,18 +3,16 @@
 module RuboCop
   module Cop
     module Capybara
-      # Checks for click button or link style.
+      # Checks for methods of button or link clicks.
       #
-      # @example EnforcedStyle: strict (default)
-      #   # bad
-      #   click_link_or_button('foo')
-      #   click_on('foo')
+      # By default, prefer to use `click_link_or_button` or `click_on`.
+      # These methods offer a weaker coupling between the test and HTML,
+      # allowing for a more faithful reflection of how the user behaves.
       #
-      #   # good
-      #   click_link('foo')
-      #   click_button('foo')
+      # You can set `EnforcedStyle: strict` to prefer the use of
+      # `click_link` and `click_button`, but this is a deprecated setting.
       #
-      # @example EnforcedStyle: link_or_button
+      # @example EnforcedStyle: link_or_button (default)
       #   # bad
       #   click_link('foo')
       #   click_button('foo')
@@ -23,6 +21,15 @@ module RuboCop
       #   click_link_or_button('foo')
       #   click_on('foo')
       #
+      # @example EnforcedStyle: strict
+      #   # bad
+      #   click_link_or_button('foo')
+      #   click_on('foo')
+      #
+      #   # good
+      #   click_link('foo')
+      #   click_button('foo')
+      #
       class ClickLinkOrButtonStyle < ::RuboCop::Cop::Base
         include ConfigurableEnforcedStyle
 
@@ -43,8 +50,8 @@ module RuboCop
         private
 
         def offense?(node)
-          style == :strict && !strict_method?(node) ||
-            style == :link_or_button && !link_or_button_method?(node)
+          (style == :strict && !strict_method?(node)) ||
+            (style == :link_or_button && !link_or_button_method?(node))
         end
 
         def offense_message(node)

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

@@ -37,20 +37,20 @@ module RuboCop
         RESTRICT_ON_SEND = %i[expect].freeze
 
         # @!method expectation_set_on_current_path(node)
-        def_node_matcher :expectation_set_on_current_path, <<-PATTERN
+        def_node_matcher :expectation_set_on_current_path, <<~PATTERN
           (send nil? :expect (send {(send nil? :page) nil?} :current_path))
         PATTERN
 
         # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
         # @!method as_is_matcher(node)
-        def_node_matcher :as_is_matcher, <<-PATTERN
+        def_node_matcher :as_is_matcher, <<~PATTERN
           (send
             #expectation_set_on_current_path ${:to :to_not :not_to}
             ${(send nil? :eq ...) (send nil? :match (regexp ...))})
         PATTERN
 
         # @!method regexp_node_matcher(node)
-        def_node_matcher :regexp_node_matcher, <<-PATTERN
+        def_node_matcher :regexp_node_matcher, <<~PATTERN
           (send
             #expectation_set_on_current_path ${:to :to_not :not_to}
             $(send nil? :match ${str dstr xstr}))

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Css selector parser.
+      # @api private
+      class CssAttributesParser
+        def initialize(selector)
+          @selector = selector
+          @state = :initial
+          @temp = ''
+          @results = {}
+          @bracket_count = 0
+        end
+
+        # @return [Array<String>]
+        def parse # rubocop:disable Metrics/MethodLength
+          @selector.each_char do |char|
+            if char == '['
+              on_bracket_start
+            elsif char == ']'
+              on_bracket_end
+            elsif @state == :inside_attr
+              @temp += char
+            end
+          end
+          @results
+        end
+
+        private
+
+        def on_bracket_start
+          @bracket_count += 1
+          if @state == :initial
+            @state = :inside_attr
+          else
+            @temp += '['
+          end
+        end
+
+        def on_bracket_end
+          @bracket_count -= 1
+          if @bracket_count.zero?
+            @state = :initial
+            key, value = @temp.split('=')
+            @results[key] = normalize_value(value)
+            @temp.clear
+          else
+            @temp += ']'
+          end
+        end
+
+        # @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
+  end
+end

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

@@ -55,15 +55,9 @@ module RuboCop
         #   attributes('a[foo-bar_baz]') # => {"foo-bar_baz=>nil}
         #   attributes('button[foo][bar=baz]') # => {"foo"=>nil, "bar"=>"'baz'"}
         #   attributes('table[foo=bar]') # => {"foo"=>"'bar'"}
+        #   attributes('[foo="bar[baz][qux]"]') # => {"foo"=>"'bar[baz][qux]'"}
         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
+          CssAttributesParser.new(selector).parse
         end
 
         # @param selector [String]
@@ -89,22 +83,6 @@ module RuboCop
           normalize = selector.gsub(/(\\[>,+~]|\(.*\))/, '')
           normalize.match?(/[ >,+~]/)
         end
-
-        # @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
   end

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

@@ -5,23 +5,23 @@ module RuboCop
     module Capybara
       # Enforces use of `have_no_*` or `not_to` for negated expectations.
       #
-      # @example EnforcedStyle: not_to (default)
+      # @example EnforcedStyle: have_no (default)
       #   # bad
-      #   expect(page).to have_no_selector
-      #   expect(page).to have_no_css('a')
+      #   expect(page).not_to have_selector 'a'
+      #   expect(page).not_to have_css('a')
       #
       #   # good
-      #   expect(page).not_to have_selector
-      #   expect(page).not_to have_css('a')
+      #   expect(page).to have_no_selector 'a'
+      #   expect(page).to have_no_css('a')
       #
-      # @example EnforcedStyle: have_no
+      # @example EnforcedStyle: not_to
       #   # bad
-      #   expect(page).not_to have_selector
-      #   expect(page).not_to have_css('a')
+      #   expect(page).to have_no_selector 'a'
+      #   expect(page).to have_no_css('a')
       #
       #   # good
-      #   expect(page).to have_no_selector
-      #   expect(page).to have_no_css('a')
+      #   expect(page).not_to have_selector 'a'
+      #   expect(page).not_to have_css('a')
       #
       class NegationMatcher < ::RuboCop::Cop::Base
         extend AutoCorrector
@@ -42,7 +42,7 @@ module RuboCop
 
         # @!method not_to?(node)
         def_node_matcher :not_to?, <<~PATTERN
-          (send ... :not_to
+          (send ... {:not_to :to_not}
             (send nil? %POSITIVE_MATCHERS ...))
         PATTERN
 
@@ -53,7 +53,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless offense?(node.parent)
+          return unless offense?(node)
 
           matcher = node.method_name.to_s
           add_offense(offense_range(node),
@@ -67,8 +67,9 @@ module RuboCop
         private
 
         def offense?(node)
-          (style == :have_no && not_to?(node)) ||
-            (style == :not_to && have_no?(node))
+          node.arguments? &&
+            ((style == :have_no && not_to?(node.parent)) ||
+            (style == :not_to && have_no?(node.parent)))
         end
 
         def offense_range(node)

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Checks for redundant `within find(...)` calls.
+      #
+      # @example
+      #   # bad
+      #   within find('foo.bar') do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   within 'foo.bar' do
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #   within find_by_id('foo') do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   within '#foo' do
+      #     # ...
+      #   end
+      #
+      class RedundantWithinFind < ::RuboCop::Cop::Base
+        extend AutoCorrector
+        MSG = 'Redundant `within %<method>s(...)` call detected.'
+        RESTRICT_ON_SEND = %i[within].freeze
+        FIND_METHODS = Set.new(%i[find find_by_id]).freeze
+
+        # @!method within_find(node)
+        def_node_matcher :within_find, <<~PATTERN
+          (send nil? :within
+            $(send nil? %FIND_METHODS ...))
+        PATTERN
+
+        def on_send(node)
+          within_find(node) do |find_node|
+            add_offense(find_node, message: msg(find_node)) do |corrector|
+              corrector.replace(find_node, replaced(find_node))
+            end
+          end
+        end
+
+        private
+
+        def msg(node)
+          format(MSG, method: node.method_name)
+        end
+
+        def replaced(node)
+          replaced = node.arguments.map(&:source).join(', ')
+          if node.method?(:find_by_id)
+            replaced.sub(/\A(["'])/, '\1#')
+          else
+            replaced
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/capybara/rspec/have_selector.rb

@@ -44,7 +44,7 @@ module RuboCop
           def on_send(node)
             argument = node.first_argument
             on_select_with_type(node, argument) if argument.sym_type?
-            on_select_without_type(node) if argument.str_type?
+            on_select_without_type(node) if %i[str dstr].include?(argument.type)
           end
 
           private

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

@@ -28,7 +28,7 @@ module RuboCop
         }.freeze
 
         # @!method click_on_selector(node)
-        def_node_matcher :click_on_selector, <<-PATTERN
+        def_node_matcher :click_on_selector, <<~PATTERN
           (send _ :find (str $_) ...)
         PATTERN
 

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

@@ -10,6 +10,7 @@ module RuboCop
       #   find('#some-id')
       #   find('[id=some-id]')
       #   find(:css, '#some-id')
+      #   find(:id, 'some-id')
       #
       #   # good
       #   find_by_id('some-id')
@@ -23,7 +24,7 @@ module RuboCop
 
         # @!method find_argument(node)
         def_node_matcher :find_argument, <<~PATTERN
-          (send _ :find $(sym :css)? (str $_) ...)
+          (send _ :find $(sym {:css :id})? (str $_) ...)
         PATTERN
 
         # @!method class_options(node)
@@ -38,6 +39,7 @@ module RuboCop
 
             on_attr(node, sym, arg) if attribute?(arg)
             on_id(node, sym, arg) if CssSelector.id?(arg)
+            on_sym_id(node, sym, arg) if sym.first&.value == :id
           end
         end
 
@@ -59,6 +61,10 @@ module RuboCop
                            CssSelector.classes(arg.sub("##{id}", '')))
         end
 
+        def on_sym_id(node, sym, id)
+          register_offense(node, sym, "'#{id}'")
+        end
+
         def attribute?(arg)
           CssSelector.attribute?(arg) &&
             CapybaraHelp.common_attributes?(arg)
@@ -76,7 +82,7 @@ module RuboCop
         end
 
         def deletion_range(node)
-          range_between(node.arguments[0].source_range.end_pos,
+          range_between(node.first_argument.source_range.end_pos,
                         node.arguments[1].source_range.end_pos)
         end
 
@@ -106,11 +112,11 @@ module RuboCop
         end
 
         def to_options(attrs)
-          attrs.each.map do |key, value|
+          attrs.each.filter_map do |key, value|
             next if key == 'id'
 
             "#{key}: #{value}"
-          end.compact.join(', ')
+          end.join(', ')
         end
 
         def offense_range(node)

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

@@ -23,7 +23,7 @@ module RuboCop
       #   expect(page).to have_no_link('foo', class: 'cls', href: 'http://example.com')
       #   expect(page).to have_table(class: 'cls')
       #   expect(page).to have_select
-      #   expect(page).to have_field('foo')
+      #   expect(page).to have_field(with: 'foo')
       #
       class SpecificMatcher < ::RuboCop::Cop::Base
         MSG = 'Prefer `%<good_matcher>s` over `%<bad_matcher>s`.'
@@ -38,10 +38,15 @@ module RuboCop
         }.freeze
 
         # @!method first_argument(node)
-        def_node_matcher :first_argument, <<-PATTERN
+        def_node_matcher :first_argument, <<~PATTERN
           (send nil? _ (str $_) ... )
         PATTERN
 
+        # @!method text_with_regexp?(node)
+        def_node_search :text_with_regexp?, <<~PATTERN
+          (pair (sym {:text :exact_text}) (regexp ...))
+        PATTERN
+
         def on_send(node)
           first_argument(node) do |arg|
             next unless (matcher = specific_matcher(arg))
@@ -61,6 +66,7 @@ module RuboCop
 
         def replaceable?(node, arg, matcher)
           replaceable_attributes?(arg) &&
+            !text_with_regexp?(node) &&
             CapybaraHelp.replaceable_option?(node, arg, matcher) &&
             CapybaraHelp.replaceable_pseudo_classes?(arg)
         end

data/lib/rubocop/cop/capybara_cops.rb

@@ -7,6 +7,7 @@ require_relative 'capybara/click_link_or_button_style'
 require_relative 'capybara/current_path_expectation'
 require_relative 'capybara/match_style'
 require_relative 'capybara/negation_matcher'
+require_relative 'capybara/redundant_within_find'
 require_relative 'capybara/specific_actions'
 require_relative 'capybara/specific_finders'
 require_relative 'capybara/specific_matcher'

data/lib/rubocop-capybara.rb

@@ -6,6 +6,7 @@ require 'yaml'
 require 'rubocop'
 
 require_relative 'rubocop/cop/capybara/mixin/capybara_help'
+require_relative 'rubocop/cop/capybara/mixin/css_attributes_parser'
 require_relative 'rubocop/cop/capybara/mixin/css_selector'
 
 require_relative 'rubocop/cop/capybara_cops'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-capybara
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 2.21.0
 platform: ruby
 authors:
 - Yudai Takada
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2024-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,10 +24,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.41'
-description: |2
-      Code style checking for Capybara test files (RSpec, Cucumber, Minitest).
-      A plugin for the RuboCop code style enforcing & linting tool.
-email:
+description: |
+  Code style checking for Capybara test files (RSpec, Cucumber, Minitest).
+  A plugin for the RuboCop code style enforcing & linting tool.
+email: 
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -41,14 +41,17 @@ files:
 - config/default.yml
 - lib/rubocop-capybara.rb
 - lib/rubocop/capybara/config_formatter.rb
+- lib/rubocop/capybara/cop/generator.rb
 - lib/rubocop/capybara/description_extractor.rb
 - lib/rubocop/capybara/version.rb
 - lib/rubocop/cop/capybara/click_link_or_button_style.rb
 - lib/rubocop/cop/capybara/current_path_expectation.rb
 - lib/rubocop/cop/capybara/match_style.rb
 - lib/rubocop/cop/capybara/mixin/capybara_help.rb
+- lib/rubocop/cop/capybara/mixin/css_attributes_parser.rb
 - lib/rubocop/cop/capybara/mixin/css_selector.rb
 - lib/rubocop/cop/capybara/negation_matcher.rb
+- lib/rubocop/cop/capybara/redundant_within_find.rb
 - lib/rubocop/cop/capybara/rspec/have_selector.rb
 - lib/rubocop/cop/capybara/rspec/predicate_matcher.rb
 - lib/rubocop/cop/capybara/specific_actions.rb
@@ -63,7 +66,7 @@ metadata:
   changelog_uri: https://github.com/rubocop/rubocop-capybara/blob/main/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-capybara/
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -78,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: Code style checking for Capybara test files
 test_files: []