capybara 3.23.0 → 3.35.3

data/lib/capybara/minitest/spec.rb

@@ -5,192 +5,251 @@ require 'minitest/spec'
 module Capybara
   module Minitest
     module Expectations
-      %w[text content title current_path].each do |assertion|
-        infect_an_assertion "assert_#{assertion}", "must_have_#{assertion}", :reverse
-        infect_an_assertion "refute_#{assertion}", "wont_have_#{assertion}", :reverse
-      end
+      ##
+      # Expectation that there is an ancestor
+      #
+      # @!method must_have_ancestor
+      #   See {Capybara::Node::Matchers#has_ancestor?}
 
-      # rubocop:disable Style/MultilineBlockChain
-      (%w[selector xpath css link button field select table checked_field unchecked_field
-          ancestor sibling].flat_map do |assertion|
-            [%W[assert_#{assertion} must_have_#{assertion}],
-             %W[refute_#{assertion} wont_have_#{assertion}]]
-          end + [%w[assert_all_of_selectors must_have_all_of_selectors],
-                 %w[assert_none_of_selectors must_have_none_of_selectors],
-                 %w[assert_any_of_selectors must_have_any_of_selectors],
-                 %w[assert_matches_style must_match_style]] +
-      %w[selector xpath css].flat_map do |assertion|
-        [%W[assert_matches_#{assertion} must_match_#{assertion}],
-         %W[refute_matches_#{assertion} wont_match_#{assertion}]]
-      end).each do |(meth, new_name)|
-        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{new_name} *args, &block
-            ::Minitest::Expectation.new(self, ::Minitest::Spec.current).#{new_name}(*args, &block)
-          end
-        ASSERTION
+      ##
+      # Expectation that there is button
+      #
+      # @!method must_have_button
+      #   See {Capybara::Node::Matchers#has_button?}
 
-        ::Minitest::Expectation.class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{new_name} *args, &block
-            ctx.#{meth}(target, *args, &block)
-          end
-        ASSERTION
-      end
-      # rubocop:enable Style/MultilineBlockChain
+      ##
+      # Expectation that there is no button
+      #
+      # @!method wont_have_button
+      #   See {Capybara::Node::Matchers#has_no_button?}
 
       ##
-      # @deprecated
-      def must_have_style(*args, &block)
-        warn 'must_have_style is deprecated, please use must_match_style'
-        must_match_style(*args, &block)
-      end
+      # Expectation that there is checked_field
+      #
+      # @!method must_have_checked_field
+      #   See {Capybara::Node::Matchers#has_checked_field?}
 
       ##
-      # Expectation that there is xpath
+      # Expectation that there is no checked_field
       #
-      # @!method must_have_xpath
-      #   see Capybara::Node::Matchers#has_xpath?
+      # @!method wont_have_checked_field
+      #   See {Capybara::Node::Matchers#has_no_checked_field?}
 
       ##
-      # Expectation that there is no xpath
+      # Expectation that there is unchecked_field
       #
-      # @!method wont_have_xpath
-      #   see Capybara::Node::Matchers#has_no_xpath?
+      # @!method must_have_unchecked_field
+      #   See {Capybara::Node::Matchers#has_unchecked_field?}
 
       ##
-      # Expectation that there is css
+      # Expectation that there is no unchecked_field
       #
-      # @!method must_have_css
-      #   see Capybara::Node::Matchers#has_css?
+      # @!method wont_have_unchecked_field
+      #   See {Capybara::Node::Matchers#has_no_unchecked_field?}
 
       ##
-      # Expectation that there is no css
+      # Expectation that page content does match
       #
-      # @!method wont_have_css
-      #   see Capybara::Node::Matchers#has_no_css?
+      # @!method must_have_content
+      #   See {Capybara::Node::Matchers#has_content?}
 
       ##
-      # Expectation that there is link
+      # Expectation that page content does not match
       #
-      # @!method must_have_link
-      #   see {Capybara::Node::Matchers#has_link?}
+      # @!method wont_have_content
+      #   See {Capybara::Node::Matchers#has_no_content?}
 
       ##
-      # Expectation that there is no link
+      # Expectation that there is css
       #
-      # @!method wont_have_link
-      # see {Capybara::Node::Matchers#has_no_link?}
+      # @!method must_have_css
+      #   See {Capybara::Node::Matchers#has_css?}
 
       ##
-      # Expectation that there is button
+      # Expectation that there is no css
       #
-      # @!method must_have_button
-      #   see {Capybara::Node::Matchers#has_button?}
+      # @!method wont_have_css
+      #   See {Capybara::Node::Matchers#has_no_css?}
 
       ##
-      # Expectation that there is no button
+      # Expectation that current path matches
       #
-      # @!method wont_have_button
-      #   see {Capybara::Node::Matchers#has_no_button?}
+      # @!method must_have_current_path
+      #   See {Capybara::SessionMatchers#has_current_path?}
+
+      ##
+      # Expectation that current page does not match
+      #
+      # @!method wont_have_current_path
+      #   See {Capybara::SessionMatchers#has_no_current_path?}
 
       ##
       # Expectation that there is field
       #
       # @!method must_have_field
-      #   see {Capybara::Node::Matchers#has_field?}
+      #   See {Capybara::Node::Matchers#has_field?}
 
       ##
       # Expectation that there is no field
       #
       # @!method wont_have_field
-      #   see {Capybara::Node::Matchers#has_no_field?}
+      #   See {Capybara::Node::Matchers#has_no_field?}
 
       ##
-      # Expectation that there is checked_field
+      # Expectation that there is link
       #
-      # @!method must_have_checked_field
-      #   see {Capybara::Node::Matchers#has_checked_field?}
+      # @!method must_have_link
+      #   See {Capybara::Node::Matchers#has_link?}
 
       ##
-      # Expectation that there is no checked_field
+      # Expectation that there is no link
       #
-      # @!method wont_have_chceked_field
+      # @!method wont_have_link
+      #   See {Capybara::Node::Matchers#has_no_link?}
 
       ##
-      # Expectation that there is unchecked_field
+      # Expectation that page text does match
       #
-      # @!method must_have_unchecked_field
-      #   see {Capybara::Node::Matchers#has_unchecked_field?}
+      # @!method must_have_text
+      #   See {Capybara::Node::Matchers#has_text?}
 
       ##
-      # Expectation that there is no unchecked_field
+      # Expectation that page text does not match
       #
-      # @!method wont_have_unchceked_field
+      # @!method wont_have_text
+      #   See {Capybara::Node::Matchers#has_no_text?}
+
+      ##
+      # Expectation that page title does match
+      #
+      # @!method must_have_title
+      #   See {Capybara::Node::DocumentMatchers#has_title?}
+
+      ##
+      # Expectation that page title does not match
+      #
+      # @!method wont_have_title
+      #   See {Capybara::Node::DocumentMatchers#has_no_title?}
 
       ##
       # Expectation that there is select
       #
       # @!method must_have_select
-      #   see {Capybara::Node::Matchers#has_select?}
+      #   See {Capybara::Node::Matchers#has_select?}
 
       ##
       # Expectation that there is no select
       #
       # @!method wont_have_select
-      #   see {Capybara::Node::Matchers#has_no_select?}
+      #   See {Capybara::Node::Matchers#has_no_select?}
 
       ##
-      # Expectation that there is table
+      # Expectation that there is a selector
       #
-      # @!method must_have_table
-      #   see {Capybara::Node::Matchers#has_table?}
+      # @!method must_have_selector
+      #   See {Capybara::Node::Matchers#has_selector?}
 
       ##
-      # Expectation that there is no table
+      # Expectation that there is no selector
       #
-      # @!method wont_have_table
-      #   see {Capybara::Node::Matchers#has_no_table?}
+      # @!method wont_have_selector
+      #   See {Capybara::Node::Matchers#has_no_selector?}
 
       ##
-      # Expectation that page title does match
+      # Expectation that all of the provided selectors are present
       #
-      # @!method must_have_title
-      #   see {Capybara::Node::DocumentMatchers#assert_title}
+      # @!method must_have_all_of_selectors
+      #   See {Capybara::Node::Matchers#assert_all_of_selectors}
 
       ##
-      # Expectation that page title does not match
+      # Expectation that none of the provided selectors are present
       #
-      # @!method wont_have_title
-      #   see {Capybara::Node::DocumentMatchers#assert_no_title}
+      # @!method must_have_none_of_selectors
+      #   See {Capybara::Node::Matchers#assert_none_of_selectors}
 
       ##
-      # Expectation that current path matches
+      # Expectation that any of the provided selectors are present
       #
-      # @!method must_have_current_path
-      #   see {Capybara::SessionMatchers#assert_current_path}
+      # @!method must_have_any_of_selectors
+      #   See {Capybara::Node::Matchers#assert_any_of_selectors}
 
       ##
-      # Expectation that current page does not match
+      # Expectation that there is a sibling
       #
-      # @!method wont_have_current_path
-      #   see {Capybara::SessionMatchers#assert_no_current_path}
+      # @!method must_have_sibling
+      #   See {Capybara::Node::Matchers#has_sibling?}
 
       ##
       # Expectation that element has style
       #
       # @!method must_match_style
-      #   see {Capybara::Node::Matchers#assert_matches_style}
+      #   See {Capybara::Node::Matchers#matches_style?}
 
       ##
-      # Expectation that there is an ancestor
+      # Expectation that there is table
       #
-      # @!method must_have_ancestor
-      #   see Capybara::Node::Matchers#has_ancestor?
+      # @!method must_have_table
+      #   See {Capybara::Node::Matchers#has_table?}
 
       ##
-      # Expectation that there is a sibling
+      # Expectation that there is no table
       #
-      # @!method must_have_sibling
-      #   see Capybara::Node::Matchers#has_sibling?
+      # @!method wont_have_table
+      #   See {Capybara::Node::Matchers#has_no_table?}
+
+      ##
+      # Expectation that there is xpath
+      #
+      # @!method must_have_xpath
+      #   See {Capybara::Node::Matchers#has_xpath?}
+
+      ##
+      # Expectation that there is no xpath
+      #
+      # @!method wont_have_xpath
+      #   See {Capybara::Node::Matchers#has_no_xpath?}
+
+      # This currently doesn't work for Ruby 2.8 due to Minitest not forwarding keyword args separately
+      # %w[text content title current_path].each do |assertion|
+      #   infect_an_assertion "assert_#{assertion}", "must_have_#{assertion}", :reverse
+      #   infect_an_assertion "refute_#{assertion}", "wont_have_#{assertion}", :reverse
+      # end
+
+      # rubocop:disable Style/MultilineBlockChain
+      (%w[text content title current_path
+          selector xpath css link button field select table checked_field unchecked_field
+          ancestor sibling].flat_map do |assertion|
+            [%W[assert_#{assertion} must_have_#{assertion}],
+             %W[refute_#{assertion} wont_have_#{assertion}]]
+          end + [%w[assert_all_of_selectors must_have_all_of_selectors],
+                 %w[assert_none_of_selectors must_have_none_of_selectors],
+                 %w[assert_any_of_selectors must_have_any_of_selectors],
+                 %w[assert_matches_style must_match_style]] +
+      %w[selector xpath css].flat_map do |assertion|
+        [%W[assert_matches_#{assertion} must_match_#{assertion}],
+         %W[refute_matches_#{assertion} wont_match_#{assertion}]]
+      end).each do |(meth, new_name)|
+        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
+          def #{new_name} *args, **kw_args, &block
+            ::Minitest::Expectation.new(self, ::Minitest::Spec.current).#{new_name}(*args, **kw_args, &block)
+          end
+        ASSERTION
+
+        ::Minitest::Expectation.class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
+          def #{new_name} *args, **kw_args, &block
+            raise "Calling ##{new_name} outside of test." unless ctx
+            ctx.#{meth}(target, *args, **kw_args, &block)
+          end
+        ASSERTION
+      end
+      # rubocop:enable Style/MultilineBlockChain
+
+      ##
+      # @deprecated
+      def must_have_style(*args, **kw_args, &block)
+        warn 'must_have_style is deprecated, please use must_match_style'
+        must_match_style(*args, **kw_args, &block)
+      end
     end
   end
 end

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,7 +88,7 @@ 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
@@ -119,7 +119,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 +147,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 +175,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 +205,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 +229,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 +276,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)
@@ -288,16 +290,17 @@ module Capybara
             execute_script CAPTURE_FILE_ELEMENT_SCRIPT
             yield
             file_field = evaluate_script 'window._capybara_clicked_file_input'
+            raise ArgumentError, "Capybara was unable to determine the file input you're attaching to" unless file_field
           rescue ::Capybara::NotSupportedByDriverError
             warn 'Block mode of `#attach_file` is not supported by the current driver - ignoring.'
           end
         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
 
@@ -305,16 +308,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
-            raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
-
-            begin
-              find(:datalist_input, from, options)
-            rescue Capybara::ElementNotFound => dlinput_error
-              raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
-            end
+            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
         end
       end
@@ -337,7 +338,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
@@ -354,26 +357,23 @@ 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
-            end
+            el ||= find(selector, locator, **options.merge(visible: :all))
+            el.session.find(:label, for: el, visible: true, match: :first).click unless el.checked? == checked
+          rescue StandardError # swallow extra errors - raise original
+            raise e
           end
         end
       end