rubocop-capybara 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5af741b67ec2d02d9e27e688d553e5e1c8cbb04c845f5d9771b480b291b1d805
-  data.tar.gz: cbef51994ffa79af69a8a7aac9aabf69ccc307b3c2c104eae2a3a4c635467d26
+  metadata.gz: 963a68452b58c47db1d1d9e7f9201db0a98a8b70bb8089473b406911fa5cc33e
+  data.tar.gz: 58e60dd5ff6097695a1029b9e37414209f7c26d2da0d16cbc6b808c8cd56efd8
 SHA512:
-  metadata.gz: 98bcff699a8ee323a24118f26b412ed8e4d26754df9ee82eab0b107f1b96cb2a0ad7ba898925fde7683501244f1474231bd53591f450e6080321e0bd83245257
-  data.tar.gz: 4194b54f6b12d4b168122c59fbfa18ec210e92cb4d20207665787ae870a3a92a240938818e187889f239e5ce29244db5c612c368bf761ee68f65f1617f72092f
+  metadata.gz: cec93e7919aeefbb1f2b2c13f1f0caeb7627c5556f85fe219f107b6520237cccd792ad4713905dfb47151f0bcb82e04d4bd0034a7a747b741e607ea9d4de5e54
+  data.tar.gz: 3e359ec71065b5daf64cdb080d8ddfad4f6144778ad7fb89d932aa083353547663a1316efe7f9e9fd3cb7bca6a6f012812ea7f18e00c76a8af22316f24325f7c

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Edge (Unreleased)
 
+## 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/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.20.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/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.chars 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,16 +5,7 @@ module RuboCop
     module Capybara
       # Enforces use of `have_no_*` or `not_to` for negated expectations.
       #
-      # @example EnforcedStyle: not_to (default)
-      #   # bad
-      #   expect(page).to have_no_selector
-      #   expect(page).to have_no_css('a')
-      #
-      #   # good
-      #   expect(page).not_to have_selector
-      #   expect(page).not_to have_css('a')
-      #
-      # @example EnforcedStyle: have_no
+      # @example EnforcedStyle: have_no (default)
       #   # bad
       #   expect(page).not_to have_selector
       #   expect(page).not_to have_css('a')
@@ -23,6 +14,15 @@ module RuboCop
       #   expect(page).to have_no_selector
       #   expect(page).to have_no_css('a')
       #
+      # @example EnforcedStyle: not_to
+      #   # bad
+      #   expect(page).to have_no_selector
+      #   expect(page).to have_no_css('a')
+      #
+      #   # good
+      #   expect(page).not_to have_selector
+      #   expect(page).not_to have_css('a')
+      #
       class NegationMatcher < ::RuboCop::Cop::Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle

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_finders.rb

@@ -76,7 +76,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
 

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

@@ -42,6 +42,11 @@ module RuboCop
           (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.20.0
 platform: ruby
 authors:
 - Yudai Takada
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -47,8 +47,10 @@ files:
 - 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
@@ -78,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Code style checking for Capybara test files