rubocop-capybara 2.23.0 → 3.1.0

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

@@ -3,6 +3,43 @@
 module RuboCop
   module Cop
     module Capybara
+      # Help methods for SpecificFinders.
+      # @api private
+      module SpecificFindersHelp
+        MESSAGE = 'Prefer `%<good_finder>s` over `find`.'
+        FIELD_OPTIONS = CapybaraHelp::SPECIFIC_OPTIONS['field']
+        FIELD_SELECTOR_PATTERN = /\Ainput(?:\[.+\])+\z/.freeze
+        UNSAFE_FIELD_TYPES = %w[hidden image submit].freeze
+        FIELD_STATE_OPTIONS = %w[checked disabled multiple readonly].freeze
+
+        module_function
+
+        def field_selector?(arg)
+          return false unless FIELD_SELECTOR_PATTERN.match?(arg)
+
+          attrs = CssSelector.attributes(arg)
+          type = attrs['type'].to_s.downcase
+          return false if UNSAFE_FIELD_TYPES.include?(type)
+          return false if (attrs.keys & FIELD_STATE_OPTIONS).any?
+
+          CapybaraHelp.replaceable_attributes?(attrs) &&
+            attrs.keys.all? { |attr| FIELD_OPTIONS.include?(attr) }
+        end
+
+        def options(attrs)
+          attrs.filter_map { |key, value| "#{key}: #{yield(value)}" }.join(', ')
+        end
+
+        def unsupported_selector?(arg)
+          CssSelector.pseudo_classes(arg).any? ||
+            CssSelector.multiple_selectors?(arg)
+        end
+
+        def message(finder)
+          format(MESSAGE, good_finder: finder)
+        end
+      end
+
       # Checks if there is a more specific finder offered by Capybara.
       #
       # @example
@@ -11,43 +48,90 @@ module RuboCop
       #   find('[id=some-id]')
       #   find(:css, '#some-id')
       #   find(:id, 'some-id')
+      #   find(:link, 'Home')
+      #   find(:field, 'Name')
+      #   find('input[placeholder="Email"]')
+      #   find(:css, 'input[type="checkbox"]')
       #
       #   # good
       #   find_by_id('some-id')
+      #   find_link('Home')
+      #   find_field('Name')
+      #   find_field(placeholder: 'Email')
+      #   find_field(type: 'checkbox')
       #
-      class SpecificFinders < ::RuboCop::Cop::Base
+      class SpecificFinders < RuboCop::Cop::Base # rubocop:disable Metrics/ClassLength
         extend AutoCorrector
         include RangeHelp
 
-        MSG = 'Prefer `find_by_id` over `find`.'
+        MSG = 'Prefer `%<replacement>s` over `find`.'
         RESTRICT_ON_SEND = %i[find].freeze
 
         # @!method find_argument(node)
         def_node_matcher :find_argument, <<~PATTERN
-          (send _ :find $(sym {:css :id})? (str $_) ...)
+          (send _ :find $(sym {:css :id :link :field})? (str $_) ...)
         PATTERN
 
-        # @!method class_options(node)
-        def_node_search :class_options, <<~PATTERN
-          (pair (sym :class) $_ ...)
+        # @!method class_option(node)
+        def_node_matcher :class_option, <<~PATTERN
+          (send _ :find ... (hash <(pair (sym :class) $_) ...>))
         PATTERN
 
         def on_send(node)
           find_argument(node) do |sym, arg|
-            next if CssSelector.pseudo_classes(arg).any?
-            next if CssSelector.multiple_selectors?(arg)
-
-            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
+            handle_find(node, sym, arg)
           end
         end
 
         private
 
+        def selector?(sym)
+          %i[link field].include?(sym.first.value)
+        end
+
+        def id_symbol?(sym)
+          sym.first&.value == :id
+        end
+
+        def selector_symbol?(sym)
+          sym.first && selector?(sym)
+        end
+
+        def on_sym_selector(node, sym)
+          replacement = "find_#{sym.first.value}"
+          register_selector_offense(node, replacement)
+        end
+
+        def register_selector_offense(node, replacement)
+          message = format(MSG, replacement: replacement)
+          add_offense(offense_range(node), message: message) do |corrector|
+            corrector.replace(node.loc.selector, replacement)
+            remove_selector_argument(corrector, node)
+          end
+        end
+
+        def remove_selector_argument(corrector, node)
+          range = range_between(node.first_argument.source_range.begin_pos,
+                                node.arguments[1].source_range.begin_pos)
+          corrector.remove(range)
+        end
+
+        def handle_find(node, sym, arg)
+          return on_sym_id(node, sym, arg) if id_symbol?(sym)
+          return on_sym_selector(node, sym) if selector_symbol?(sym)
+          return if SpecificFindersHelp.unsupported_selector?(arg)
+
+          if SpecificFindersHelp.field_selector?(arg)
+            return on_field(node, sym, arg)
+          end
+          return on_attr(node, sym, arg) if attribute?(arg)
+
+          on_id(node, sym, arg) if CssSelector.id?(arg)
+        end
+
         def on_attr(node, sym, arg)
           attrs = CssSelector.attributes(arg)
-          return unless (id = attrs['id'])
+          return unless (id = attrs['id']&.to_s)
           return if attrs['class']
 
           register_offense(node, sym, replaced_arguments(arg, id))
@@ -57,12 +141,29 @@ module RuboCop
           return if CssSelector.attributes(arg).any?
 
           id = CssSelector.id(arg)
-          register_offense(node, sym, "'#{id}'",
+          register_offense(node, sym, ruby_literal(id.delete('\\')),
                            CssSelector.classes(arg.sub("##{id}", '')))
         end
 
         def on_sym_id(node, sym, id)
-          register_offense(node, sym, "'#{id}'")
+          register_offense(node, sym, ruby_literal(id))
+        end
+
+        def on_field(node, sym, arg)
+          add_offense(
+            offense_range(node),
+            message: SpecificFindersHelp.message('find_field')
+          ) do |corrector|
+            corrector.replace(node.loc.selector, 'find_field')
+            corrector.replace(node.first_argument, field_options(arg))
+            corrector.remove(deletion_range(node)) unless sym.empty?
+          end
+        end
+
+        def field_options(arg)
+          SpecificFindersHelp.options(CssSelector.attributes(arg)) do |value|
+            ruby_literal(value)
+          end
         end
 
         def attribute?(arg)
@@ -70,24 +171,36 @@ module RuboCop
             CapybaraHelp.common_attributes?(arg)
         end
 
-        def register_offense(node, sym, id, classes = [])
-          add_offense(offense_range(node)) do |corrector|
+        def register_offense(node, sym, replacement, classes = [])
+          message = format(MSG, replacement: 'find_by_id')
+          add_offense(offense_range(node), message: message) do |corrector|
+            next unless autocorrectable_classes?(node, classes)
+
             corrector.replace(node.loc.selector, 'find_by_id')
-            corrector.replace(node.first_argument, id.delete('\\'))
-            unless classes.compact.empty?
-              autocorrect_classes(corrector, node, classes)
-            end
+            corrector.replace(node.first_argument, replacement)
+            autocorrect_id_classes(corrector, node, classes)
             corrector.remove(deletion_range(node)) unless sym.empty?
           end
         end
 
+        def autocorrectable_classes?(node, classes)
+          return true if classes.empty? || !(options = class_option(node))
+
+          options.str_type? ||
+            (options.array_type? && options.values.all?(&:str_type?))
+        end
+
+        def autocorrect_id_classes(corrector, node, classes)
+          autocorrect_classes(corrector, node, classes) unless classes.empty?
+        end
+
         def deletion_range(node)
           range_between(node.first_argument.source_range.end_pos,
                         node.arguments[1].source_range.end_pos)
         end
 
         def autocorrect_classes(corrector, node, classes)
-          if (options = class_options(node).first)
+          if (options = class_option(node))
             append_options(classes, options)
             corrector.replace(options, classes.to_s)
           else
@@ -108,6 +221,8 @@ module RuboCop
 
         def replaced_arguments(arg, id)
           options = to_options(CssSelector.attributes(arg))
+          id = ruby_literal(id.delete('\\'))
+
           options.empty? ? id : "#{id}, #{options}"
         end
 
@@ -115,20 +230,26 @@ module RuboCop
           attrs.each.filter_map do |key, value|
             next if key == 'id'
 
-            "#{key}: #{value}"
+            "#{key}: #{ruby_literal(value)}"
           end.join(', ')
         end
 
+        def ruby_literal(value)
+          case value
+          when String
+            "'#{value.gsub(/['\\]/) { |char| "\\#{char}" }}'"
+          when nil then 'nil'
+          else
+            value.to_s
+          end
+        end
+
         def offense_range(node)
           range_between(node.loc.selector.begin_pos, end_pos(node))
         end
 
         def end_pos(node)
-          if node.loc.end
-            node.loc.end.end_pos
-          else
-            node.source_range.end_pos
-          end
+          node.loc.end ? node.loc.end.end_pos : node.source_range.end_pos
         end
       end
     end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Checks positional access to Capybara windows, whose order is undefined.
+      #
+      # @example
+      #   # bad
+      #   popup = windows.last
+      #   original = page.windows.first
+      #
+      #   # good
+      #   popup = window_opened_by { click_link 'Open' }
+      #   original = current_window
+      #
+      class UnorderedWindowAccess < RuboCop::Cop::Base
+        MSG = 'Selecting a window by position relies on undefined order. ' \
+              'Use `window_opened_by` or `current_window`.'
+        RESTRICT_ON_SEND = %i[first last [] at fetch].freeze
+
+        # @!method capybara_windows?(node)
+        def_node_matcher :capybara_windows?, <<~PATTERN
+          (call
+            {nil? self
+             (call {nil? self} :page)
+             (call (const {nil? cbase} :Capybara) :current_session)}
+            :windows)
+        PATTERN
+
+        def on_send(node)
+          return if node.method?(:[]) && node.first_argument&.type?(:range)
+
+          add_offense(node) if capybara_windows?(node.receiver)
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Checks for boolean values passed to Capybara's `visible` option.
+      #
+      # `visible: false` finds both visible and hidden elements, rather than
+      # only hidden elements. Use `:all`, `:hidden` or `:visible` instead.
+      # Only `true` is autocorrected, to `:visible`.
+      #
+      # This cop targets Capybara's built-in selectors. Set `DefaultSelector`
+      # to match `Capybara.default_selector`, or to `null` if it varies at
+      # runtime. Queries using custom or unknown selectors are skipped.
+      #
+      # @example
+      #   # bad
+      #   find('.menu', visible: true)
+      #   expect(page).to have_css('.menu', visible: false)
+      #
+      #   # good
+      #   find('.menu', visible: :visible)
+      #   find('.menu', visible: :all)
+      #   find('.menu', visible: :hidden)
+      #
+      # @example DefaultSelector: custom
+      #   # bad
+      #   find(:css, '.menu', visible: true)
+      #
+      #   # good
+      #   find('.menu', visible: true)
+      #
+      class VisibilityOption < RuboCop::Cop::Base
+        extend AutoCorrector
+        include CapybaraHelp
+        include Visibility
+
+        RESTRICT_ON_SEND = QueryMethods.names(
+          :finder, :collection, :selector, :match, :action, :grouped
+        ).difference(CapybaraHelp::VISIBILITY_MATCHER_METHODS).freeze
+
+        # @!method visibility_options(node)
+        def_node_matcher :visibility_options, <<~PATTERN
+          (call #capybara_receiver? _ <$(hash ...) ...>)
+        PATTERN
+
+        # @!method boolean_visibility?(node)
+        def_node_matcher :boolean_visibility?, <<~PATTERN
+          (pair (sym :visible) boolean)
+        PATTERN
+
+        def on_send(node)
+          return unless (options = visibility_options(node))
+          return unless supported_visibility_query?(node, options)
+
+          options.pairs.each do |pair|
+            check_visibility(pair) if boolean_visibility?(pair)
+          end
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

data/lib/rubocop/cop/capybara.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'capybara/rspec'
+
+module RuboCop
+  module Cop
+    # Cops for the `Capybara` department. The department's cops are
+    # registered for lazy loading and their files are loaded on demand.
+    module Capybara
+      extend LazyLoader
+
+      register_cop :AbsoluteXPathInElementScope, "#{__dir__}/capybara/absolute_x_path_in_element_scope"
+      register_cop :AlwaysTrueCountQuery, "#{__dir__}/capybara/always_true_count_query"
+      register_cop :AmbiguousClick, "#{__dir__}/capybara/ambiguous_click"
+      register_cop :AssertStyle, "#{__dir__}/capybara/assert_style"
+      register_cop :ChainedFind, "#{__dir__}/capybara/chained_find"
+      register_cop :FindAllFirst, "#{__dir__}/capybara/find_all_first"
+      register_cop :IgnoredQueryOption, "#{__dir__}/capybara/ignored_query_option"
+      register_cop :ModalMethodWithoutBlock, "#{__dir__}/capybara/modal_method_without_block"
+      register_cop :NativeAttribute, "#{__dir__}/capybara/native_attribute"
+      register_cop :RedundantWithinFind, "#{__dir__}/capybara/redundant_within_find"
+      register_cop :SpecificActions, "#{__dir__}/capybara/specific_actions"
+      register_cop :SpecificFinders, "#{__dir__}/capybara/specific_finders"
+      register_cop :UnorderedWindowAccess, "#{__dir__}/capybara/unordered_window_access"
+      register_cop :VisibilityOption, "#{__dir__}/capybara/visibility_option"
+    end
+  end
+end

data/lib/rubocop/cop/capybara_cops.rb

@@ -1,19 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'capybara/rspec/current_path_expectation'
-require_relative 'capybara/rspec/have_content'
-require_relative 'capybara/rspec/have_selector'
-require_relative 'capybara/rspec/match_style'
-require_relative 'capybara/rspec/negation_matcher'
-require_relative 'capybara/rspec/negation_matcher_after_visit'
-require_relative 'capybara/rspec/predicate_matcher'
-require_relative 'capybara/rspec/specific_matcher'
-require_relative 'capybara/rspec/visibility_matcher'
-
-require_relative 'capybara/ambiguous_click'
-require_relative 'capybara/assert_style'
-require_relative 'capybara/click_link_or_button_style'
-require_relative 'capybara/find_all_first'
-require_relative 'capybara/redundant_within_find'
-require_relative 'capybara/specific_actions'
-require_relative 'capybara/specific_finders'
+# @deprecated This file is deprecated. Cops are registered for lazy loading in
+#   `rubocop/cop/capybara`; this file is kept for compatibility with code that
+#   requires it directly.
+require_relative 'capybara'

data/lib/rubocop-capybara.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'yaml'
-
 require 'rubocop'
 
 require_relative 'rubocop/capybara/plugin'
@@ -11,13 +8,18 @@ require_relative 'rubocop/capybara/version'
 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/mixin/query_methods'
+require_relative 'rubocop/cop/capybara/mixin/visibility'
 
-require_relative 'rubocop/cop/capybara_cops'
+require_relative 'rubocop/cop/capybara'
 
 RuboCop::Cop::Style::TrailingCommaInArguments.singleton_class.prepend(
   Module.new do
     def autocorrect_incompatible_with
-      super.push(RuboCop::Cop::Capybara::RSpec::CurrentPathExpectation)
+      super.push(
+        RuboCop::Cop::Capybara::RSpec::CurrentPathExpectation,
+        RuboCop::Cop::Capybara::RSpec::CurrentUrlExpectation
+      )
     end
   end
 )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-capybara
 version: !ruby/object:Gem::Version
-  version: 2.23.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.81'
+        version: '1.89'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.81'
+        version: '1.89'
 description: |
   Code style checking for Capybara test files (RSpec, Cucumber, Minitest).
   A plugin for the RuboCop code style enforcing & linting tool.
@@ -51,22 +51,32 @@ files:
 - MIT-LICENSE.md
 - README.md
 - config/default.yml
-- config/obsoletion.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/plugin.rb
 - lib/rubocop/capybara/version.rb
+- lib/rubocop/cop/capybara.rb
+- lib/rubocop/cop/capybara/absolute_x_path_in_element_scope.rb
+- lib/rubocop/cop/capybara/always_true_count_query.rb
 - lib/rubocop/cop/capybara/ambiguous_click.rb
 - lib/rubocop/cop/capybara/assert_style.rb
-- lib/rubocop/cop/capybara/click_link_or_button_style.rb
+- lib/rubocop/cop/capybara/chained_find.rb
 - lib/rubocop/cop/capybara/find_all_first.rb
+- lib/rubocop/cop/capybara/ignored_query_option.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/mixin/query_methods.rb
+- lib/rubocop/cop/capybara/mixin/visibility.rb
+- lib/rubocop/cop/capybara/modal_method_without_block.rb
+- lib/rubocop/cop/capybara/native_attribute.rb
 - lib/rubocop/cop/capybara/redundant_within_find.rb
+- lib/rubocop/cop/capybara/rspec.rb
 - lib/rubocop/cop/capybara/rspec/current_path_expectation.rb
+- lib/rubocop/cop/capybara/rspec/current_url_expectation.rb
+- lib/rubocop/cop/capybara/rspec/find_element_value_eq.rb
 - lib/rubocop/cop/capybara/rspec/have_content.rb
 - lib/rubocop/cop/capybara/rspec/have_selector.rb
 - lib/rubocop/cop/capybara/rspec/match_style.rb
@@ -77,6 +87,8 @@ files:
 - lib/rubocop/cop/capybara/rspec/visibility_matcher.rb
 - lib/rubocop/cop/capybara/specific_actions.rb
 - lib/rubocop/cop/capybara/specific_finders.rb
+- lib/rubocop/cop/capybara/unordered_window_access.rb
+- lib/rubocop/cop/capybara/visibility_option.rb
 - lib/rubocop/cop/capybara_cops.rb
 homepage: https://github.com/rubocop/rubocop-capybara
 licenses:
@@ -100,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Code style checking for Capybara test files
 test_files: []

data/config/obsoletion.yml

@@ -1,18 +0,0 @@
-#
-# Configuration of obsolete/deprecated cops used by `ConfigObsoletion`.
-#
-# See: https://docs.rubocop.org/rubocop/extensions.html#config-obsoletions
-#
-
-renamed:
-  Capybara/CurrentPathExpectation: Capybara/RSpec/CurrentPathExpectation
-  Capybara/NegationMatcher: Capybara/RSpec/NegationMatcher
-  Capybara/NegationMatcherAfterVisit: Capybara/RSpec/NegationMatcherAfterVisit
-  Capybara/SpecificMatcher: Capybara/RSpec/SpecificMatcher
-  Capybara/VisibilityMatcher: Capybara/RSpec/VisibilityMatcher
-
-split:
-  Capybara/MatchStyle:
-    alternatives:
-      - Capybara/AssertStyle
-      - Capybara/RSpec/MatchStyle

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    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.
-      #
-      # 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 (default)
-      #   # bad
-      #   click_link('foo')
-      #   click_button('foo')
-      #
-      #   # good
-      #   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
-
-        MSG_STRICT =
-          'Use `click_link` or `click_button` instead of `%<method>s`.'
-        MSG_CLICK_LINK_OR_BUTTON =
-          'Use `click_link_or_button` or `click_on` instead of `%<method>s`.'
-        STRICT_METHODS = %i[click_link click_button].freeze
-        CLICK_LINK_OR_BUTTON = %i[click_link_or_button click_on].freeze
-        RESTRICT_ON_SEND = (STRICT_METHODS + CLICK_LINK_OR_BUTTON).freeze
-
-        def on_send(node)
-          return unless offense?(node)
-
-          add_offense(node, message: offense_message(node))
-        end
-
-        private
-
-        def offense?(node)
-          (style == :strict && !strict_method?(node)) ||
-            (style == :link_or_button && !link_or_button_method?(node))
-        end
-
-        def offense_message(node)
-          if style == :strict
-            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
-
-        def strict_method?(node)
-          STRICT_METHODS.include?(node.method_name)
-        end
-
-        def link_or_button_method?(node)
-          CLICK_LINK_OR_BUTTON.include?(node.method_name)
-        end
-      end
-    end
-  end
-end