capybara 3.13.2 → 3.40.0

data/lib/capybara/node/actions.rb

@@ -6,62 +6,63 @@ module Capybara
       # @!macro waiting_behavior
       #   If the driver is capable of executing JavaScript, this method will wait for a set amount of time
       #   and continuously retry finding the element until either the element is found or the time
-      #   expires. The length of time +find+ will wait is controlled through {Capybara.default_max_wait_time}
+      #   expires. The length of time this method will wait is controlled through {Capybara.configure default_max_wait_time}.
       #
-      #   @option options [false, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
+      #   @option options [false, true, Numeric] wait
+      #     Maximum time to wait for matching element to appear. Defaults to {Capybara.configure default_max_wait_time}.
 
       ##
       #
-      # Finds a button or link and clicks it.  See {Capybara::Node::Actions#click_button} and
-      # {Capybara::Node::Actions#click_link} for what locator will match against for each type of element
+      # Finds a button or link and clicks it. See {#click_button} and
+      # {#click_link} for what locator will match against for each type of element.
       #
       # @overload click_link_or_button([locator], **options)
       #   @macro waiting_behavior
-      #   @param [String] locator      See {Capybara::Node::Actions#click_button} and {Capybara::Node::Actions#click_link}
+      #   @param [String] locator      See {#click_button} and {#click_link}
       #
       # @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
 
       ##
       #
-      # Finds a link by id, Capybara.test_id attribute, text or title and clicks it. Also looks at image
+      # Finds a link by id, {Capybara.configure test_id} attribute, text or title and clicks it. Also looks at image
       # alt text inside the link.
       #
       # @overload click_link([locator], **options)
       #   @macro waiting_behavior
-      #   @param [String] locator         text, id, Capybara.test_id attribute, title or nested image's alt attribute
-      #   @param options                  See {Capybara::Node::Finders#find_link}
+      #   @param [String] locator         text, id, {Capybara.configure test_id} attribute, title or nested image's alt attribute
+      #   @param [Hash] options           See {Capybara::Node::Finders#find_link}
       #
       # @return [Capybara::Node::Element]  The element clicked
       def click_link(locator = nil, **options)
-        find(:link, locator, options).click
+        find(:link, locator, **options).click
       end
 
       ##
       #
       # Finds a button on the page and clicks it.
-      # This can be any \<input> element of type submit, reset, image, button or it can be a
-      # \<button> element. All buttons can be found by their id, Capybara.test_id attribute, value, or title. \<button> elements can also be found
-      # by their text content, and image \<input> elements by their alt attribute
+      # This can be any `<input>` element of type submit, reset, image, button or it can be a
+      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title. `<button>` elements can also be found
+      # by their text content, and image `<input>` elements by their alt attribute.
       #
       # @overload click_button([locator], **options)
       #   @macro waiting_behavior
       #   @param [String] locator      Which button to find
-      #   @param options     See {Capybara::Node::Finders#find_button}
+      #   @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
 
       ##
       #
-      # Locate a text field or text area and fill it in with the given text
-      # The field can be found via its name, id, Capybara.test_id attribute, or label text.
-      # If no locator is provided will operate on self or a descendant
+      # Locate a text field or text area and fill it in with the given text.
+      # The field can be found via its name, id, {Capybara.configure test_id} attribute, placeholder, or label text.
+      # If no locator is provided this will operate on self or a descendant.
       #
       #     # will fill in a descendant fillable field with name, id, or label text matching 'Name'
       #     page.fill_in 'Name', with: 'Bob'
@@ -73,7 +74,7 @@ module Capybara
       # @overload fill_in([locator], with:, **options)
       #   @param [String] locator                 Which field to fill in
       #   @param [Hash] options
-      #   @param with: [String]                  The value to fill_in
+      #   @param with: [String]                  The value to fill in
       #   @macro waiting_behavior
       #   @option options [String] currently_with The current value property of the field to fill in
       #   @option options [Boolean] multiple      Match fields that can have multiple values?
@@ -81,23 +82,25 @@ module Capybara
       #   @option options [String] name           Match fields that match the name attribute
       #   @option options [String] placeholder    Match fields that match the placeholder attribute
       #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
-      #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from Capybara.default_set_options)
+      #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from {Capybara.configure default_set_options})
       #
-      # @return [Capybara::Node::Element]  The element filled_in
+      # @return [Capybara::Node::Element]  The element filled in
       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 (Capybara.automatic_label_click) Attempt to click the label to toggle state if element is non-visible.
+      #   @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
 
       ##
       #
       # Find a descendant radio button and mark it as checked. The radio button can be found
-      # via name, id or label text. If no locator is provided this will match against self or
-      # a descendant.
+      # via name, id, {Capybara.configure test_id} attribute or label text. If no locator is
+      # provided this will match against self or a descendant.
       #
       #     # will choose a descendant radio button with a name, id, or label text matching 'Male'
       #     page.choose('Male')
@@ -117,14 +120,14 @@ 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
 
       ##
       #
       # Find a descendant check box and mark it as checked. The check box can be found
-      # via name, id or label text. If no locator is provided this will match against
-      # self or a descendant.
+      # via name, id, {Capybara.configure test_id} attribute, or label text. If no locator
+      # is provided this will match against self or a descendant.
       #
       #     # will check a descendant checkbox with a name, id, or label text matching 'German'
       #     page.check('German')
@@ -145,14 +148,14 @@ 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
 
       ##
       #
       # Find a descendant check box and uncheck it. The check box can be found
-      # via name, id or label text. If no locator is provided this will match against
-      # self or a descendant.
+      # via name, id, {Capybara.configure test_id} attribute, or label text. If
+      # no locator is provided this will match against self or a descendant.
       #
       #     # will uncheck a descendant checkbox with a name, id, or label text matching 'German'
       #     page.uncheck('German')
@@ -173,17 +176,18 @@ 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
 
       ##
       #
-      # If `:from` option is present, `select` finds a select box, or text input with associated datalist,
+      # If `from` option is present, {#select} finds a select box, or text input with associated datalist,
       # on the page and selects a particular option from it.
       # Otherwise it finds an option inside current scope and selects it.
-      # If the select box is a multiple select, +select+ can be called multiple times to select more than
+      # If the select box is a multiple select, {#select} can be called multiple times to select more than
       # one option.
-      # The select box can be found via its name, id or label text. The option can be found by its text.
+      # The select box can be found via its name, id, {Capybara.configure test_id} attribute, or label text.
+      # The option can be found by its text.
       #
       #     page.select 'March', from: 'Month'
       #
@@ -191,7 +195,7 @@ module Capybara
       #   @macro waiting_behavior
       #
       #   @param value [String] Which option to select
-      #   @param from [String]  The id, Capybara.test_id atrtribute, name or label of the select box
+      #   @param from [String]  The id, {Capybara.configure test_id} attribute, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element selected
       def select(value = nil, from: nil, **options)
@@ -202,15 +206,16 @@ 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
 
       ##
       #
       # Find a select box on the page and unselect a particular option from it. If the select
-      # box is a multiple select, +unselect+ can be called multiple times to unselect more than
-      # one option. The select box can be found via its name, id or label text.
+      # box is a multiple select, {#unselect} can be called multiple times to unselect more than
+      # one option. The select box can be found via its name, id, {Capybara.configure test_id} attribute,
+      # or label text.
       #
       #     page.unselect 'March', from: 'Month'
       #
@@ -218,24 +223,27 @@ module Capybara
       #   @macro waiting_behavior
       #
       #   @param value [String]     Which option to unselect
-      #   @param from [String]      The id, Capybara.test_id attribute, name or label of the select box
+      #   @param from [String]      The id, {Capybara.configure test_id} attribute, name or label of the select box
       #
       #
       # @return [Capybara::Node::Element]  The option element unselected
       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
 
       ##
       #
-      # Find a descendant file field on the page and attach a file given its path. The file field can
-      # be found via its name, id or label text. In the case of the file field being hidden for
+      # Find a descendant file field on the page and attach a file given its path. There are two ways to use
+      # {#attach_file}, in the first method the file field can be found via its name, id,
+      # {Capybara.configure test_id} attribute, or label text. In the case of the file field being hidden for
       # styling reasons the `make_visible` option can be used to temporarily change the CSS of
       # the file field, attach the file, and then revert the CSS back to original. If no locator is
       # passed this will match self or a descendant.
+      # The second method, which is currently in beta and may be changed/removed, involves passing a block
+      # which performs whatever actions would trigger the file chooser to appear.
       #
       #     # will attach file to a descendant file input element that has a name, id, or label_text matching 'My File'
       #     page.attach_file('My File', '/path/to/file.png')
@@ -243,32 +251,57 @@ module Capybara
       #     # will attach file to el if it's a file input element
       #     el.attach_file('/path/to/file.png')
       #
+      #     # will attach file to whatever file input is triggered by the block
+      #     page.attach_file('/path/to/file.png') do
+      #       page.find('#upload_button').click
+      #     end
+      #
       # @overload attach_file([locator], paths, **options)
       #   @macro waiting_behavior
       #
       #   @param [String] locator                  Which field to attach the file to
       #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached
       #
-      #   @option options [Symbol] match (Capybara.match)     The matching strategy to use (:one, :first, :prefer_exact, :smart).
-      #   @option options [Boolean] exact (Capybara.exact)    Match the exact label name/contents or accept a partial match.
+      #   @option options [Symbol] match
+      #     The matching strategy to use (:one, :first, :prefer_exact, :smart). Defaults to {Capybara.configure match}.
+      #   @option options [Boolean] exact
+      #     Match the exact label name/contents or accept a partial match. Defaults to {Capybara.configure exact}.
       #   @option options [Boolean] multiple Match field which allows multiple file selection
       #   @option options [String, Regexp] id             Match fields that match the id attribute
       #   @option options [String] name           Match fields that match the name attribute
       #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
-      #   @option options [true, Hash] make_visible   A Hash of CSS styles to change before attempting to attach the file, if `true` { opacity: 1, display: 'block', visibility: 'visible' } is used (may not be supported by all drivers)
-      #
-      #   @return [Capybara::Node::Element]  The file field element
+      #   @option options [true, Hash] make_visible
+      #     A Hash of CSS styles to change before attempting to attach the file, if `true`, `{ opacity: 1, display: 'block', visibility: 'visible' }` is used (may not be supported by all drivers).
+      # @overload attach_file(paths, &blk)
+      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached
+      #   @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
+        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)
         end
         options[:allow_self] = true if locator.nil?
+
+        if block_given?
+          begin
+            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 = 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
-          find(:file_field, locator, options).set(paths)
+          (file_field || find(:file_field, locator, **options)).set(paths)
         end
       end
 
@@ -276,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
-            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
+            raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
           end
         end
       end
@@ -304,9 +335,13 @@ module Capybara
       end
 
       def while_visible(element, visible_css)
-        visible_css = { opacity: 1, display: 'block', visibility: 'visible' } if visible_css == true
+        if visible_css == true
+          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
@@ -323,31 +358,32 @@ 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 => err
-            raise unless allow_label_click && catch_error?(err)
-
-            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 err
+            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
 
-      UPDATE_STYLE_SCRIPT = <<~'JS'
+      UPDATE_STYLE_SCRIPT = <<~JS
         this.capybara_style_cache = this.style.cssText;
         var css = arguments[0];
         for (var prop in css){
@@ -357,18 +393,28 @@ module Capybara
         }
       JS
 
-      RESET_STYLE_SCRIPT = <<~'JS'
+      RESET_STYLE_SCRIPT = <<~JS
         if (this.hasOwnProperty('capybara_style_cache')) {
           this.style.cssText = this.capybara_style_cache;
           delete this.capybara_style_cache;
         }
       JS
 
-      DATALIST_OPTIONS_SCRIPT = <<~'JS'
+      DATALIST_OPTIONS_SCRIPT = <<~JS
         Array.prototype.slice.call((this.list||{}).options || []).
           filter(function(el){ return !el.disabled }).
           map(function(el){ return { "value": el.value, "label": el.label} })
       JS
+
+      CAPTURE_FILE_ELEMENT_SCRIPT = <<~JS
+        document.addEventListener('click', function file_catcher(e){
+          if (e.target.matches("input[type='file']")) {
+            window._capybara_clicked_file_input = e.target;
+            this.removeEventListener('click', file_catcher);
+            e.preventDefault();
+          }
+        }, {capture: true})
+      JS
     end
   end
 end

data/lib/capybara/node/base.rb

@@ -76,18 +76,26 @@ module Capybara
       def synchronize(seconds = nil, errors: nil)
         return yield if session.synchronized
 
-        seconds = session_options.default_max_wait_time if seconds.nil?
+        seconds = session_options.default_max_wait_time if [nil, true].include? seconds
+        interval = session_options.default_retry_interval
         session.synchronized = true
         timer = Capybara::Helpers.timer(expire_in: seconds)
         begin
           yield
-        rescue StandardError => err
+        rescue StandardError => e
           session.raise_server_error!
-          raise err unless driver.wait? && catch_error?(err, errors)
-          raise err if timer.expired?
+          raise e unless catch_error?(e, errors)
 
-          sleep(0.01)
-          reload if session_options.automatic_reload
+          if driver.wait?
+            raise e if timer.expired?
+
+            sleep interval
+            reload if session_options.automatic_reload
+          else
+            old_base = @base
+            reload if session_options.automatic_reload
+            raise e if old_base == @base
+          end
           retry
         ensure
           session.synchronized = false
@@ -96,19 +104,19 @@ module Capybara
 
       # @api private
       def find_css(css, **options)
-        if base.method(:find_css).arity != 1
-          base.find_css(css, **options)
-        else
+        if base.method(:find_css).arity == 1
           base.find_css(css)
+        else
+          base.find_css(css, **options)
         end
       end
 
       # @api private
       def find_xpath(xpath, **options)
-        if base.method(:find_xpath).arity != 1
-          base.find_xpath(xpath, **options)
-        else
+        if base.method(:find_xpath).arity == 1
           base.find_xpath(xpath)
+        else
+          base.find_xpath(xpath, **options)
         end
       end
 

data/lib/capybara/node/document.rb

@@ -40,8 +40,8 @@ module Capybara
         find(:xpath, '/html').evaluate_script(*args)
       end
 
-      def scroll_to(*args)
-        find(:xpath, '//body').scroll_to(*args)
+      def scroll_to(*args, quirks: false, **options)
+        find(:xpath, quirks ? '//body' : '/html').scroll_to(*args, **options)
       end
     end
   end

data/lib/capybara/node/document_matchers.rb

@@ -42,7 +42,7 @@ module Capybara
       # @return [Boolean]
       #
       def has_title?(title, **options)
-        make_predicate(options) { assert_title(title, options) }
+        make_predicate(options) { assert_title(title, **options) }
       end
 
       ##
@@ -52,13 +52,13 @@ module Capybara
       # @return [Boolean]
       #
       def has_no_title?(title, **options)
-        make_predicate(options) { assert_no_title(title, options) }
+        make_predicate(options) { assert_no_title(title, **options) }
       end
 
     private
 
       def _verify_title(title, options)
-        query = Capybara::Queries::TitleQuery.new(title, options)
+        query = Capybara::Queries::TitleQuery.new(title, **options)
         synchronize(query.wait) { yield(query) }
         true
       end