capybara 3.29.0 → 3.37.1

data/lib/capybara/minitest.rb

@@ -6,48 +6,54 @@ require 'capybara/dsl'
 module Capybara
   module Minitest
     module Assertions
-      ## Assert text exists
+      ##
+      # Assert text exists
       #
+      # @!method assert_content
       # @!method assert_text
-      #   @see Capybara::Node::Matchers#assert_text
+      #   See {Capybara::Node::Matchers#assert_text}
 
-      ## Assert text does not exist
+      ##
+      # Assert text does not exist
       #
+      # @!method refute_content
+      # @!method assert_no_content
+      # @!method refute_text
       # @!method assert_no_text
-      #   @see Capybara::Node::Matchers#assert_no_text
+      #   See {Capybara::Node::Matchers#assert_no_text}
 
       ##
       # Assertion that page title does match
       #
       # @!method assert_title
-      #   @see Capybara::Node::DocumentMatchers#assert_title
+      #   See {Capybara::Node::DocumentMatchers#assert_title}
 
       ##
       # Assertion that page title does not match
       #
       # @!method refute_title
       # @!method assert_no_title
-      #   @see Capybara::Node::DocumentMatchers#assert_no_title
+      #   See {Capybara::Node::DocumentMatchers#assert_no_title}
 
       ##
       # Assertion that current path matches
       #
       # @!method assert_current_path
-      #   @see Capybara::SessionMatchers#assert_current_path
+      #   See {Capybara::SessionMatchers#assert_current_path}
 
       ##
       # Assertion that current page does not match
       #
       # @!method refute_current_path
       # @!method assert_no_current_path
-      #   @see Capybara::SessionMatchers#assert_no_current_path
+      #   See {Capybara::SessionMatchers#assert_no_current_path}
 
       %w[text no_text title no_title current_path no_current_path].each do |assertion_name|
         class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def assert_#{assertion_name} *args
+          def assert_#{assertion_name}(*args, **kwargs, &optional_filter_block)
             self.assertions +=1
             subject, args = determine_subject(args)
-            subject.assert_#{assertion_name}(*args)
+            subject.assert_#{assertion_name}(*args, **kwargs, &optional_filter_block)
           rescue Capybara::ExpectationNotMet => e
             raise ::Minitest::Assertion, e.message
           end
@@ -61,40 +67,81 @@ module Capybara
       alias_method :assert_content, :assert_text
       alias_method :assert_no_content, :refute_text
 
-      ## Assert selector exists on page
+      ##
+      # Assert selector exists on page
       #
       # @!method assert_selector
-      #   @see Capybara::Node::Matchers#assert_selector
+      #   See {Capybara::Node::Matchers#assert_selector}
 
-      ## Assert selector does not exist on page
+      ##
+      # Assert selector does not exist on page
       #
+      # @!method refute_selector
       # @!method assert_no_selector
-      #   @see Capybara::Node::Matchers#assert_no_selector
+      #   See {Capybara::Node::Matchers#assert_no_selector}
 
-      ## Assert element matches selector
+      ##
+      # Assert element matches selector
       #
       # @!method assert_matches_selector
-      #   @see Capybara::Node::Matchers#assert_matches_selector
+      #   See {Capybara::Node::Matchers#assert_matches_selector}
+
+      ##
+      # Assert element does not match selector
+      #
+      # @!method refute_matches_selector
+      # @!method assert_not_matches_selector
+      #   See {Capybara::Node::Matchers#assert_not_matches_selector}
 
-      ## Assert element does not match selector
+      ##
+      # Assert all of the provided selectors exist on page
       #
-      # @!method assert_xpath
-      #   @see Capybara::Node::Matchers#assert_not_matches_selector
+      # @!method assert_all_of_selectors
+      #   See {Capybara::Node::Matchers#assert_all_of_selectors}
+
+      ##
+      # Assert none of the provided selectors exist on page
+      #
+      # @!method assert_none_of_selectors
+      #   See {Capybara::Node::Matchers#assert_none_of_selectors}
+
+      ##
+      # Assert any of the provided selectors exist on page
+      #
+      # @!method assert_any_of_selectors
+      #   See {Capybara::Node::Matchers#assert_any_of_selectors}
 
-      ## Assert element has the provided CSS styles
+      ##
+      # Assert element has the provided CSS styles
       #
       # @!method assert_matches_style
-      #   @see Capybara::Node::Matchers#assert_matches_style
+      #   See {Capybara::Node::Matchers#assert_matches_style}
 
-      ## Assert element has a matching sibling
+      ##
+      # Assert element has a matching sibling
       #
       # @!method assert_sibling
-      #   @see Capybara::Node::Matchers#assert_sibling
+      #   See {Capybara::Node::Matchers#assert_sibling}
 
-      ## Assert element has a matching ancestor
+      ##
+      # Assert element does not have a matching sibling
+      #
+      # @!method refute_sibling
+      # @!method assert_no_sibling
+      #   See {Capybara::Node::Matchers#assert_no_sibling}
+
+      ##
+      # Assert element has a matching ancestor
       #
       # @!method assert_ancestor
-      #   @see Capybara::Node::Matchers#assert_ancestor
+      #   See {Capybara::Node::Matchers#assert_ancestor}
+
+      ##
+      # Assert element does not have a matching ancestor
+      #
+      # @!method refute_ancestor
+      # @!method assert_no_ancestor
+      #   See {Capybara::Node::Matchers#assert_no_ancestor}
 
       %w[selector no_selector matches_style
          all_of_selectors none_of_selectors any_of_selectors
@@ -109,6 +156,7 @@ module Capybara
             raise ::Minitest::Assertion, e.message
           end
         ASSERTION
+        ruby2_keywords "assert_#{assertion_name}" if respond_to?(:ruby2_keywords)
       end
 
       alias_method :refute_selector, :assert_no_selector
@@ -116,18 +164,137 @@ module Capybara
       alias_method :refute_ancestor, :assert_no_ancestor
       alias_method :refute_sibling, :assert_no_sibling
 
+      ##
+      # Assert that provided xpath exists
+      #
+      # @!method assert_xpath
+      #   See {Capybara::Node::Matchers#has_xpath?}
+
+      ##
+      # Assert that provide xpath does not exist
+      #
+      # @!method refute_xpath
+      # @!method assert_no_xpath
+      #   See {Capybara::Node::Matchers#has_no_xpath?}
+
+      ##
+      # Assert that provided css exists
+      #
+      # @!method assert_css
+      #   See {Capybara::Node::Matchers#has_css?}
+
+      ##
+      # Assert that provided css does not exist
+      #
+      # @!method refute_css
+      # @!method assert_no_css
+      #   See {Capybara::Node::Matchers#has_no_css?}
+
+      ##
+      # Assert that provided link exists
+      #
+      # @!method assert_link
+      #   See {Capybara::Node::Matchers#has_link?}
+
+      ##
+      # Assert that provided link does not exist
+      #
+      # @!method assert_no_link
+      # @!method refute_link
+      #   See {Capybara::Node::Matchers#has_no_link?}
+
+      ##
+      # Assert that provided button exists
+      #
+      # @!method assert_button
+      #   See {Capybara::Node::Matchers#has_button?}
+
+      ##
+      # Assert that provided button does not exist
+      #
+      # @!method refute_button
+      # @!method assert_no_button
+      #   See {Capybara::Node::Matchers#has_no_button?}
+
+      ##
+      # Assert that provided field exists
+      #
+      # @!method assert_field
+      #   See {Capybara::Node::Matchers#has_field?}
+
+      ##
+      # Assert that provided field does not exist
+      #
+      # @!method refute_field
+      # @!method assert_no_field
+      #   See {Capybara::Node::Matchers#has_no_field?}
+
+      ##
+      # Assert that provided checked field exists
+      #
+      # @!method assert_checked_field
+      #   See {Capybara::Node::Matchers#has_checked_field?}
+
+      ##
+      # Assert that provided checked_field does not exist
+      #
+      # @!method assert_no_checked_field
+      # @!method refute_checked_field
+      #   See {Capybara::Node::Matchers#has_no_checked_field?}
+
+      ##
+      # Assert that provided unchecked field exists
+      #
+      # @!method assert_unchecked_field
+      #   See {Capybara::Node::Matchers#has_unchecked_field?}
+
+      ##
+      # Assert that provided unchecked field does not exist
+      #
+      # @!method assert_no_unchecked_field
+      # @!method refute_unchecked_field
+      #   See {Capybara::Node::Matchers#has_no_unchecked_field?}
+
+      ##
+      # Assert that provided select exists
+      #
+      # @!method assert_select
+      #   See {Capybara::Node::Matchers#has_select?}
+
+      ##
+      # Assert that provided select does not exist
+      #
+      # @!method refute_select
+      # @!method assert_no_select
+      #   See {Capybara::Node::Matchers#has_no_select?}
+
+      ##
+      # Assert that provided table exists
+      #
+      # @!method assert_table
+      #   See {Capybara::Node::Matchers#has_table?}
+
+      ##
+      # Assert that provided table does not exist
+      #
+      # @!method refute_table
+      # @!method assert_no_table
+      #   See {Capybara::Node::Matchers#has_no_table?}
+
       %w[xpath css link button field select table].each do |selector_type|
         define_method "assert_#{selector_type}" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_selector(subject, selector_type.to_sym, locator, options, &optional_filter_block)
+          assert_selector(subject, selector_type.to_sym, locator, **options, &optional_filter_block)
         end
+        ruby2_keywords "assert_#{selector_type}" if respond_to?(:ruby2_keywords)
 
         define_method "assert_no_#{selector_type}" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_no_selector(subject, selector_type.to_sym, locator, options, &optional_filter_block)
+          assert_no_selector(subject, selector_type.to_sym, locator, **options, &optional_filter_block)
         end
+        ruby2_keywords "assert_no_#{selector_type}" if respond_to?(:ruby2_keywords)
         alias_method "refute_#{selector_type}", "assert_no_#{selector_type}"
       end
 
@@ -135,145 +302,66 @@ module Capybara
         define_method "assert_#{field_type}_field" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_selector(subject, :field, locator, options.merge(field_type.to_sym => true), &optional_filter_block)
+          assert_selector(subject, :field, locator, **options.merge(field_type.to_sym => true), &optional_filter_block)
         end
+        ruby2_keywords "assert_#{field_type}_field" if respond_to?(:ruby2_keywords)
 
         define_method "assert_no_#{field_type}_field" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_no_selector(subject, :field, locator, options.merge(field_type.to_sym => true), &optional_filter_block)
+          assert_no_selector(
+            subject,
+            :field,
+            locator,
+            **options.merge(field_type.to_sym => true),
+            &optional_filter_block
+          )
         end
+        ruby2_keywords "assert_no_#{field_type}_field" if respond_to?(:ruby2_keywords)
         alias_method "refute_#{field_type}_field", "assert_no_#{field_type}_field"
       end
 
+      ##
+      # Assert that element matches xpath
+      #
+      # @!method assert_matches_xpath
+      #   See {Capybara::Node::Matchers#matches_xpath?}
+
+      ##
+      # Assert that element does not match xpath
+      #
+      # @!method refute_matches_xpath
+      # @!method assert_not_matches_xpath
+      #   See {Capybara::Node::Matchers#not_matches_xpath?}
+
+      ##
+      # Assert that element matches css
+      #
+      # @!method assert_matches_css
+      #   See {Capybara::Node::Matchers#matches_css?}
+
+      ##
+      # Assert that element matches css
+      #
+      # @!method refute_matches_css
+      # @!method assert_not_matches_css
+      #   See {Capybara::Node::Matchers#not_matches_css?}
+
       %w[xpath css].each do |selector_type|
         define_method "assert_matches_#{selector_type}" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           assert_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
         end
+        ruby2_keywords "assert_matches_#{selector_type}" if respond_to?(:ruby2_keywords)
 
         define_method "assert_not_matches_#{selector_type}" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           assert_not_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
         end
+        ruby2_keywords "assert_not_matches_#{selector_type}" if respond_to?(:ruby2_keywords)
         alias_method "refute_matches_#{selector_type}", "assert_not_matches_#{selector_type}"
       end
 
-    ##
-    # Assertion that there is xpath
-    #
-    # @!method assert_xpath
-    #   @see Capybara::Node::Matchers#has_xpath?
-
-    ##
-    # Assertion that there is no xpath
-    #
-    # @!method refute_xpath
-    # @!method assert_no_xpath
-    #   @see Capybara::Node::Matchers#has_no_xpath?
-
-    ##
-    # Assertion that there is css
-    #
-    # @!method assert_css
-    #   @see Capybara::Node::Matchers#has_css?
-
-    ##
-    # Assertion that there is no css
-    #
-    # @!method refute_css
-    # @!method assert_no_css
-    #   @see Capybara::Node::Matchers#has_no_css?
-
-    ##
-    # Assertion that there is link
-    #
-    # @!method assert_link
-    #   @see Capybara::Node::Matchers#has_link?
-
-    ##
-    # Assertion that there is no link
-    #
-    # @!method assert_no_link
-    # @!method refute_link
-    #   @see Capybara::Node::Matchers#has_no_link?
-
-    ##
-    # Assertion that there is button
-    #
-    # @!method assert_button
-    #   @see Capybara::Node::Matchers#has_button?
-
-    ##
-    # Assertion that there is no button
-    #
-    # @!method refute_button
-    # @!method assert_no_button
-    #   @see Capybara::Node::Matchers#has_no_button?
-
-    ##
-    # Assertion that there is field
-    #
-    # @!method assert_field
-    #   @see Capybara::Node::Matchers#has_field?
-
-    ##
-    # Assertion that there is no field
-    #
-    # @!method refute_field
-    # @!method assert_no_field
-    #   @see Capybara::Node::Matchers#has_no_field?
-
-    ##
-    # Assertion that there is checked_field
-    #
-    # @!method assert_checked_field
-    #   @see Capybara::Node::Matchers#has_checked_field?
-
-    ##
-    # Assertion that there is no checked_field
-    #
-    # @!method assert_no_checked_field
-    # @!method refute_checked_field
-
-    ##
-    # Assertion that there is unchecked_field
-    #
-    # @!method assert_unchecked_field
-    #   @see Capybara::Node::Matchers#has_unchecked_field?
-
-    ##
-    # Assertion that there is no unchecked_field
-    #
-    # @!method assert_no_unchecked_field
-    # @!method refute_unchecked_field
-
-    ##
-    # Assertion that there is select
-    #
-    # @!method assert_select
-    #   @see Capybara::Node::Matchers#has_select?
-
-    ##
-    # Assertion that there is no select
-    #
-    # @!method refute_select
-    # @!method assert_no_select
-    #   @see Capybara::Node::Matchers#has_no_select?
-
-    ##
-    # Assertion that there is table
-    #
-    # @!method assert_table
-    #   @see Capybara::Node::Matchers#has_table?
-
-    ##
-    # Assertion that there is no table
-    #
-    # @!method refute_table
-    # @!method assert_no_table
-    #   @see Capybara::Node::Matchers#has_no_table?
-
     private
 
       def determine_subject(args)

data/lib/capybara/node/actions.rb

@@ -23,7 +23,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The element clicked
       #
       def click_link_or_button(locator = nil, **options)
-        find(:link_or_button, locator, options).click
+        find(:link_or_button, locator, **options).click
       end
       alias_method :click_on, :click_link_or_button
 
@@ -39,7 +39,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element clicked
       def click_link(locator = nil, **options)
-        find(:link, locator, options).click
+        find(:link, locator, **options).click
       end
 
       ##
@@ -55,7 +55,7 @@ module Capybara
       #   @param [Hash] options        See {Capybara::Node::Finders#find_button}
       # @return [Capybara::Node::Element]  The element clicked
       def click_button(locator = nil, **options)
-        find(:button, locator, options).click
+        find(:button, locator, **options).click
       end
 
       ##
@@ -88,12 +88,13 @@ module Capybara
       def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)
         find_options[:with] = currently_with if currently_with
         find_options[:allow_self] = true if locator.nil?
-        find(:fillable_field, locator, find_options).set(with, fill_options)
+        find(:fillable_field, locator, **find_options).set(with, **fill_options)
       end
 
       # @!macro label_click
-      #   @option options [Boolean] allow_label_click
+      #   @option options [Boolean, Hash] allow_label_click
       #     Attempt to click the label to toggle state if element is non-visible. Defaults to {Capybara.configure automatic_label_click}.
+      #     If set to a Hash it is passed as options to the `click` on the label
 
       ##
       #
@@ -119,7 +120,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element chosen or the label clicked
       def choose(locator = nil, **options)
-        _check_with_label(:radio_button, true, locator, options)
+        _check_with_label(:radio_button, true, locator, **options)
       end
 
       ##
@@ -147,7 +148,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element checked or the label clicked
       def check(locator = nil, **options)
-        _check_with_label(:checkbox, true, locator, options)
+        _check_with_label(:checkbox, true, locator, **options)
       end
 
       ##
@@ -175,7 +176,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element unchecked or the label clicked
       def uncheck(locator = nil, **options)
-        _check_with_label(:checkbox, false, locator, options)
+        _check_with_label(:checkbox, false, locator, **options)
       end
 
       ##
@@ -205,7 +206,7 @@ module Capybara
         if el.respond_to?(:tag_name) && (el.tag_name == 'input')
           select_datalist_option(el, value)
         else
-          el.find(:option, value, options).select_option
+          el.find(:option, value, **options).select_option
         end
       end
 
@@ -229,8 +230,8 @@ module Capybara
       def unselect(value = nil, from: nil, **options)
         raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element
 
-        scope = from ? find(:select, from, options) : self
-        scope.find(:option, value, options).unselect_option
+        scope = from ? find(:select, from, **options) : self
+        scope.find(:option, value, **options).unselect_option
       end
 
       ##
@@ -276,7 +277,9 @@ module Capybara
       #   @yield Block whose actions will trigger the system file chooser to be shown
       # @return [Capybara::Node::Element]  The file field element
       def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments
-        raise ArgumentError, '``#attach_file` does not support passing both a locator and a block' if locator && block_given?
+        if locator && block_given?
+          raise ArgumentError, '`#attach_file` does not support passing both a locator and a block'
+        end
 
         Array(paths).each do |path|
           raise Capybara::FileNotFound, "cannot attach file, #{path} does not exist" unless File.exist?(path.to_s)
@@ -295,10 +298,10 @@ module Capybara
         end
         # Allow user to update the CSS style of the file input since they are so often hidden on a page
         if make_visible
-          ff = file_field || find(:file_field, locator, options.merge(visible: :all))
+          ff = file_field || find(:file_field, locator, **options.merge(visible: :all))
           while_visible(ff, make_visible) { |el| el.set(paths) }
         else
-          (file_field || find(:file_field, locator, options)).set(paths)
+          (file_field || find(:file_field, locator, **options)).set(paths)
         end
       end
 
@@ -306,16 +309,14 @@ module Capybara
 
       def find_select_or_datalist_input(from, options)
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
+          find(:select, from, **options)
+        rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName
+          raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
+
           begin
-            find(:select, from, options)
-          rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName
-            raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
-
-            begin
-              find(:datalist_input, from, options)
-            rescue Capybara::ElementNotFound => dlinput_error # rubocop:disable Naming/RescuedExceptionsVariableName
-              raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
-            end
+            find(:datalist_input, from, **options)
+          rescue Capybara::ElementNotFound => dlinput_error
+            raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
           end
         end
       end
@@ -338,7 +339,9 @@ module Capybara
           visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' }
         end
         _update_style(element, visible_css)
-        raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible' unless element.visible?
+        unless element.visible?
+          raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible'
+        end
 
         begin
           yield element
@@ -355,26 +358,27 @@ module Capybara
 
       def _reset_style(element)
         element.execute_script(RESET_STYLE_SCRIPT)
-      rescue StandardError # rubocop:disable Lint/HandleExceptions swallow extra errors
+      rescue StandardError # rubocop:disable Lint/SuppressedException swallow extra errors
       end
 
       def _check_with_label(selector, checked, locator,
                             allow_label_click: session_options.automatic_label_click, **options)
         options[:allow_self] = true if locator.nil?
-
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
+          el = find(selector, locator, **options)
+          el.set(checked)
+        rescue StandardError => e
+          raise unless allow_label_click && catch_error?(e)
+
           begin
-            el = find(selector, locator, options)
-            el.set(checked)
-          rescue StandardError => e
-            raise unless allow_label_click && catch_error?(e)
-
-            begin
-              el ||= find(selector, locator, options.merge(visible: :all))
-              el.session.find(:label, for: el, visible: true).click unless el.checked? == checked
-            rescue StandardError # swallow extra errors - raise original
-              raise e
+            el ||= find(selector, locator, **options.merge(visible: :all))
+            unless el.checked? == checked
+              el.session
+                .find(:label, for: el, visible: true, match: :first)
+                .click(**(Hash.try_convert(allow_label_click) || {}))
             end
+          rescue StandardError # swallow extra errors - raise original
+            raise e
           end
         end
       end
@@ -409,7 +413,7 @@ module Capybara
             this.removeEventListener('click', file_catcher);
             e.preventDefault();
           }
-        })
+        }, {capture: true})
       JS
     end
   end