rubocop-capybara 2.21.0 → 2.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed8a103d3d11a90d7873a5569246e580d816e2ebad0a614827bd2ed3546bf6bf
-  data.tar.gz: d09792f9ea669f7556814b898fbfd9829e8db25fdd3b8873ac85487ee9f199ef
+  metadata.gz: 03bbb0abff1aee334bbe60b255688a098b5713f6f7d675de12ede6298c6ddb87
+  data.tar.gz: 78faf4416bd058d5ba3442a20ffd5ac34f7f406c6e1fe5eb5fcb64ef39b61aab
 SHA512:
-  metadata.gz: '0798dc5b62b3dc8a8ea31bd1f79cedde039d0d69e94cf18a902ced3da7ae757b0529fa17b8d5711baae964fb591eccfcce4f7b16320598cd9dafb657c4aee85c'
-  data.tar.gz: 7de56f77982c7b52973c38698317233da3ebeb2a55dff962c380105419d2708e43e16d5f1f63a87338ec935d6c5c24941efd95a2d308b2236d7dd840bf8c63ab
+  metadata.gz: 29bede0e47aba00c65533df9696d675927830b50f954f3ec3ca6f7417bb036057c3089cdd986cad0327bcc73081226991acb265e8c99d6d915d5b2fdc5942ae5
+  data.tar.gz: bda139c9e52f5dbbac07d95304baeca8186ce23ec2cb2f9099fab7af4d2488f586026232560480eacd2fa502502a3c15742df2e0a94f57a5f548cd81c1502a65

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Edge (Unreleased)
 
+## 2.22.0 (2025-03-10)
+
+- Add `Capybara/AmbiguousClick` cop and make soft-deprecated `Capybara/ClickLinkOrButtonStyle` cop. If you want to use `EnforcedStyle: strict`, use `Capybara/AmbiguousClick` cop instead. ([@ydah])
+- Add new `Capybara/FindAllFirst` cop. ([@ydah])
+- Add a new `Capybara/NegationMatcherAfterVisit` cop. ([@ydah])
+- Fix an error for `Capybara/RSpec/HaveSelector` when passing no arguments. ([@earlopain])
+- Make RuboCop Capybara work as a RuboCop plugin. ([@bquorning])
+
 ## 2.21.0 (2024-06-08)
 
 - Fix a false negative for `Capybara/NegationMatcher` when using `to_not`. ([@ydah])
@@ -75,6 +83,7 @@
 [@aried3r]: https://github.com/aried3r
 [@bquorning]: https://github.com/bquorning
 [@darhazer]: https://github.com/Darhazer
+[@earlopain]: https://github.com/earlopain
 [@onumis]: https://github.com/onumis
 [@oskarsezerins]: https://github.com/OskarsEzerins
 [@pirj]: https://github.com/pirj

data/README.md

@@ -31,13 +31,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-capybara
+plugins: rubocop-capybara
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-capybara
 ```
@@ -45,17 +45,20 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Capybara
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```bash
-rubocop --require rubocop-capybara
+rubocop --plugin rubocop-capybara
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-capybara'
+  task.plugins << 'rubocop-capybara'
 end
 ```
 

data/config/default.yml

@@ -9,11 +9,17 @@ Capybara:
     - "**/*_steps.rb"
     - "**/features/step_definitions/**/*"
 
+Capybara/AmbiguousClick:
+  Description: Specify the exact target to click on.
+  Enabled: false
+  VersionAdded: '2.22'
+  Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/AmbiguousClick
+
 Capybara/ClickLinkOrButtonStyle:
   Description: Checks for methods of button or link clicks.
-  Enabled: pending
+  Enabled: false
   VersionAdded: '2.19'
-  VersionChanged: '2.20'
+  VersionChanged: '2.22'
   EnforcedStyle: link_or_button
   SupportedStyles:
     - link_or_button
@@ -27,6 +33,12 @@ Capybara/CurrentPathExpectation:
   VersionChanged: '2.0'
   Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/CurrentPathExpectation
 
+Capybara/FindAllFirst:
+  Description: Enforces use of `first` instead of `all` with `first` or `[0]`.
+  Enabled: pending
+  VersionAdded: '2.22'
+  Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/FindAllFirst
+
 Capybara/MatchStyle:
   Description: Checks for usage of deprecated style methods.
   Enabled: pending
@@ -44,6 +56,12 @@ Capybara/NegationMatcher:
     - not_to
   Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/NegationMatcher
 
+Capybara/NegationMatcherAfterVisit:
+  Description: Do not allow negative matchers to be used immediately after `visit`.
+  Enabled: pending
+  VersionAdded: '2.22'
+  Reference: https://www.rubydoc.info/gems/rubocop-capybara/RuboCop/Cop/Capybara/NegationMatcherAfterVisit
+
 Capybara/RedundantWithinFind:
   Description: Checks for redundant `within find(...)` calls.
   Enabled: pending

data/lib/rubocop/capybara/plugin.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Capybara
+    # A plugin that integrates RuboCop Capybara with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-capybara',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-capybara',
+          description: 'Code style checking for Capybara test files.'
+        )
+      end
+      # :nocov:
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        obsoletion = project_root.join('config', 'obsoletion.yml')
+        ConfigObsoletion.files << obsoletion if obsoletion.exist?
+
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: project_root.join('config/default.yml')
+        )
+      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.21.0'
+      STRING = '2.22.0'
     end
   end
 end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Specify the exact target to click on.
+      #
+      # In projects where accessibility needs to be considered,
+      # it is crucial to specify the click target precisely.
+      #
+      # @example
+      #   # bad
+      #   click_link_or_button('foo')
+      #   click_on('foo')
+      #
+      #   # good
+      #   click_link('foo')
+      #   click_button('foo')
+      #
+      class AmbiguousClick < ::RuboCop::Cop::Base
+        MSG = 'Use `click_link` or `click_button` instead of `%<method>s`.'
+        RESTRICT_ON_SEND = %i[click_link_or_button click_on].freeze
+
+        def on_send(node)
+          add_offense(node, message: format(MSG, method: node.method_name))
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,14 @@ module RuboCop
     module Capybara
       # Checks for methods of button or link clicks.
       #
+      # This cop is deprecated.
+      # We plan to remove this in the next major version update to 3.0.
+      #
+      # The migration target is `Capybara/AmbiguousClick`.
+      # It is only migration target when `EnforcedStyle: strict`.
+      # If you are using this cop, please plan for migration.
+      # There is no migration target when `EnforcedStyle: link_or_button`.
+      #
       # 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.
@@ -59,6 +67,10 @@ module RuboCop
             format(MSG_STRICT, method: node.method_name)
           elsif style == :link_or_button
             format(MSG_CLICK_LINK_OR_BUTTON, method: node.method_name)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Enforces use of `first` instead of `all` with `first` or `[0]`.
+      #
+      # @example
+      #
+      #   # bad
+      #   all('a').first
+      #   all('a')[0]
+      #   find('a', match: :first)
+      #   all('a', match: :first)
+      #
+      #   # good
+      #   first('a')
+      #
+      class FindAllFirst < ::RuboCop::Cop::Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `first(%<selector>s)`.'
+        RESTRICT_ON_SEND = %i[all find].freeze
+
+        # @!method find_all_first?(node)
+        def_node_matcher :find_all_first?, <<~PATTERN
+          {
+            (send (send _ :all _ ...) :first)
+            (send (send _ :all _ ...) :[] (int 0))
+          }
+        PATTERN
+
+        # @!method include_match_first?(node)
+        def_node_matcher :include_match_first?, <<~PATTERN
+          (send _ {:find :all} _ $(hash <(pair (sym :match) (sym :first)) ...>))
+        PATTERN
+
+        def on_send(node)
+          on_all_first(node)
+          on_match_first(node)
+        end
+
+        private
+
+        def on_all_first(node)
+          return unless (parent = node.parent)
+          return unless find_all_first?(parent)
+
+          range = range_between(node.loc.selector.begin_pos,
+                                parent.loc.selector.end_pos)
+          selector = node.arguments.map(&:source).join(', ')
+          add_offense(range,
+                      message: format(MSG, selector: selector)) do |corrector|
+            corrector.replace(range, "first(#{selector})")
+          end
+        end
+
+        def on_match_first(node)
+          include_match_first?(node) do |hash|
+            selector = ([node.first_argument.source] + replaced_hash(hash))
+              .join(', ')
+            add_offense(node,
+                        message: format(MSG, selector: selector)) do |corrector|
+              corrector.replace(node, "first(#{selector})")
+            end
+          end
+        end
+
+        def replaced_hash(hash)
+          hash.child_nodes.flat_map(&:source).reject do |arg|
+            arg == 'match: :first'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,16 @@ module RuboCop
       # Help methods for capybara.
       # @api private
       module CapybaraHelp
+        CAPYBARA_MATCHERS = %w[
+          selector css xpath text title current_path link button
+          field checked_field unchecked_field select table
+          sibling ancestor content
+        ].freeze
+        POSITIVE_MATCHERS =
+          Set.new(CAPYBARA_MATCHERS) { |element| :"have_#{element}" }.freeze
+        NEGATIVE_MATCHERS =
+          Set.new(CAPYBARA_MATCHERS) { |element| :"have_no_#{element}" }
+            .freeze
         COMMON_OPTIONS = %w[
           id class style
         ].freeze

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

@@ -26,18 +26,9 @@ module RuboCop
       class NegationMatcher < ::RuboCop::Cop::Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
+        include CapybaraHelp
 
         MSG = 'Use `expect(...).%<runner>s %<matcher>s`.'
-        CAPYBARA_MATCHERS = %w[
-          selector css xpath text title current_path link button
-          field checked_field unchecked_field select table
-          sibling ancestor content
-        ].freeze
-        POSITIVE_MATCHERS =
-          Set.new(CAPYBARA_MATCHERS) { |element| :"have_#{element}" }.freeze
-        NEGATIVE_MATCHERS =
-          Set.new(CAPYBARA_MATCHERS) { |element| :"have_no_#{element}" }
-            .freeze
         RESTRICT_ON_SEND = (POSITIVE_MATCHERS + NEGATIVE_MATCHERS).freeze
 
         # @!method not_to?(node)
@@ -88,6 +79,10 @@ module RuboCop
             'to'
           when :not_to
             'not_to'
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 
@@ -97,6 +92,10 @@ module RuboCop
             matcher.sub('have_', 'have_no_')
           when :not_to
             matcher.sub('have_no_', 'have_')
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
       end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Do not allow negative matchers to be used immediately after `visit`.
+      #
+      # @example
+      #   # bad
+      #   visit foo_path
+      #   expect(page).to have_no_link('bar')
+      #   expect(page).to have_css('a')
+      #
+      #   # good
+      #   visit foo_path
+      #   expect(page).to have_css('a')
+      #   expect(page).to have_no_link('bar')
+      #
+      #   # bad
+      #   visit foo_path
+      #   expect(page).not_to have_link('bar')
+      #   expect(page).to have_css('a')
+      #
+      #   # good
+      #   visit foo_path
+      #   expect(page).to have_css('a')
+      #   expect(page).not_to have_link('bar')
+      #
+      class NegationMatcherAfterVisit < ::RuboCop::Cop::Base
+        include CapybaraHelp
+
+        MSG = 'Do not use negation matcher immediately after visit.'
+        RESTRICT_ON_SEND = %i[visit].freeze
+
+        # @!method negation_matcher?(node)
+        def_node_matcher :negation_matcher?, <<~PATTERN
+          {
+            (send (send nil? :expect _) :to (send nil? %NEGATIVE_MATCHERS ...))
+            (send (send nil? :expect _) :not_to (send nil? %POSITIVE_MATCHERS ...))
+          }
+        PATTERN
+
+        def on_send(node)
+          negation_matcher?(node.right_sibling) do
+            add_offense(node.right_sibling)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -42,7 +42,8 @@ module RuboCop
           SELECTORS = %i[css xpath].freeze
 
           def on_send(node)
-            argument = node.first_argument
+            return unless (argument = node.first_argument)
+
             on_select_with_type(node, argument) if argument.sym_type?
             on_select_without_type(node) if %i[str dstr].include?(argument.type)
           end

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

@@ -44,7 +44,7 @@ module RuboCop
 
           # @!method be_bool?(node)
           def_node_matcher :be_bool?, <<~PATTERN
-            (send nil? {:be :eq :eql :equal} {true false})
+            (send nil? {:be :eq :eql :equal} boolean)
           PATTERN
 
           # @!method be_boolthy?(node)
@@ -177,6 +177,7 @@ module RuboCop
             "#{matcher.to_s.sub('match_', 'matches_')}?"
           end
 
+          # rubocop:disable Metrics/MethodLength
           def replacement_matcher(node)
             case [cop_config['Strict'], node.method?(:to)]
             when [true, true]
@@ -187,8 +188,13 @@ module RuboCop
               'be_truthy'
             when [false, false]
               'be_falsey'
+            else
+              # :nocov:
+              :noop
+              # :nocov:
             end
           end
+          # rubocop:enable Metrics/MethodLength
         end
 
         # Prefer using predicate matcher over using predicate method directly.
@@ -248,6 +254,10 @@ module RuboCop
               check_inflected(node)
             elsif style == :explicit
               check_explicit(node)
+            else
+              # :nocov:
+              :noop
+              # :nocov:
             end
           end
 

data/lib/rubocop/cop/capybara_cops.rb

@@ -3,10 +3,13 @@
 require_relative 'capybara/rspec/have_selector'
 require_relative 'capybara/rspec/predicate_matcher'
 
+require_relative 'capybara/ambiguous_click'
 require_relative 'capybara/click_link_or_button_style'
 require_relative 'capybara/current_path_expectation'
+require_relative 'capybara/find_all_first'
 require_relative 'capybara/match_style'
 require_relative 'capybara/negation_matcher'
+require_relative 'capybara/negation_matcher_after_visit'
 require_relative 'capybara/redundant_within_find'
 require_relative 'capybara/specific_actions'
 require_relative 'capybara/specific_finders'

data/lib/rubocop-capybara.rb

@@ -5,17 +5,14 @@ require 'yaml'
 
 require 'rubocop'
 
+require_relative 'rubocop/capybara/plugin'
+
 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'
 
-project_root = File.join(__dir__, '..')
-RuboCop::ConfigLoader.inject_defaults!(project_root)
-obsoletion = File.join(project_root, 'config', 'obsoletion.yml')
-RuboCop::ConfigObsoletion.files << obsoletion if File.exist?(obsoletion)
-
 RuboCop::Cop::Style::TrailingCommaInArguments.singleton_class.prepend(
   Module.new do
     def autocorrect_incompatible_with

metadata

@@ -1,33 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-capybara
 version: !ruby/object:Gem::Version
-  version: 2.21.0
+  version: 2.22.0
 platform: ruby
 authors:
 - Yudai Takada
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-08 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.72'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.72'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
 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:
@@ -43,14 +61,18 @@ files:
 - lib/rubocop/capybara/config_formatter.rb
 - lib/rubocop/capybara/cop/generator.rb
 - lib/rubocop/capybara/description_extractor.rb
+- lib/rubocop/capybara/plugin.rb
 - lib/rubocop/capybara/version.rb
+- lib/rubocop/cop/capybara/ambiguous_click.rb
 - lib/rubocop/cop/capybara/click_link_or_button_style.rb
 - lib/rubocop/cop/capybara/current_path_expectation.rb
+- lib/rubocop/cop/capybara/find_all_first.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/negation_matcher_after_visit.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
@@ -66,7 +88,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: 
+  default_lint_roller_plugin: RuboCop::Capybara::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Code style checking for Capybara test files
 test_files: []