module Capybara::Node::Actions
Constants
- CAPTURE_FILE_ELEMENT_SCRIPT
- DATALIST_OPTIONS_SCRIPT
- RESET_STYLE_SCRIPT
- UPDATE_STYLE_SCRIPT
Public Instance Methods
Source
# File lib/capybara/node/actions.rb, line 279 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 = 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) end end
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') # 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(, 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 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).
@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
Source
# File lib/capybara/node/actions.rb, line 150 def check(locator = nil, **options) _check_with_label(:checkbox, true, locator, **options) end
Find a descendant check box and mark it as checked. The check box can be found 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') # will check `el` if it's a checkbox element el.check()
@overload check(, **options)
@param [String] locator Which check box to check @option options [String] option Value of the checkbox to select @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 @macro label_click @macro waiting_behavior
@return [Capybara::Node::Element] The element checked or the label clicked
Source
# File lib/capybara/node/actions.rb, line 122 def choose(locator = nil, **options) _check_with_label(:radio_button, true, locator, **options) end
Find a descendant radio button and mark it as checked. The radio button can be found 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') # will choose `el` if it's a radio button element el.choose()
@overload choose(, **options)
@param [String] locator Which radio button to choose @option options [String] option Value of the radio_button to choose @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 @macro waiting_behavior @macro label_click
@return [Capybara::Node::Element] The element chosen or the label clicked
Source
# File lib/capybara/node/actions.rb, line 41 def click_link(locator = nil, **options) find(:link, locator, **options).click end
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(, **options)
@macro waiting_behavior @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
Source
# File lib/capybara/node/actions.rb, line 88 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) 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.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' # will fill in `el` if it's a fillable field el.fill_in with: 'Tom'
@overload fill_in(, with:, **options)
@param [String] locator Which field to fill in @param [Hash] options @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? @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] 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.configure default_set_options})
@return [Capybara::Node::Element] The element filled in
Source
# File lib/capybara/node/actions.rb, line 201 def select(value = nil, from: nil, **options) raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element el = from ? find_select_or_datalist_input(from, options) : self if el.respond_to?(:tag_name) && (el.tag_name == 'input') select_datalist_option(el, value) else el.find(:option, value, **options).select_option end end
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 one option. 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'
@overload select(value = nil, from: nil, **options)
@macro waiting_behavior @param value [String] Which option to select @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
Source
# File lib/capybara/node/actions.rb, line 178 def uncheck(locator = nil, **options) _check_with_label(:checkbox, false, locator, **options) end
Find a descendant check box and uncheck it. The check box can be found 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') # will uncheck `el` if it's a checkbox element el.uncheck()
@overload uncheck(, **options)
@param [String] locator Which check box to uncheck @option options [String] option Value of the checkbox to deselect @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 @macro label_click @macro waiting_behavior
@return [Capybara::Node::Element] The element unchecked or the label clicked
Source
# File lib/capybara/node/actions.rb, line 230 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 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, {Capybara.configure test_id} attribute, or label text.
page.unselect 'March', from: 'Month'
@overload unselect(value = nil, from: nil, **options)
@macro waiting_behavior @param value [String] Which option to unselect @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
Private Instance Methods
Source
# File lib/capybara/node/actions.rb, line 364 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.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
Source
# File lib/capybara/node/actions.rb, line 359 def _reset_style(element) element.execute_script(RESET_STYLE_SCRIPT) rescue StandardError # rubocop:disable Lint/SuppressedException swallow extra errors end
Source
# File lib/capybara/node/actions.rb, line 353 def _update_style(element, style) element.execute_script(UPDATE_STYLE_SCRIPT, style) rescue Capybara::NotSupportedByDriverError warn 'The :make_visible option is not supported by the current driver - ignoring' end
Source
# File lib/capybara/node/actions.rb, line 310 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(:datalist_input, from, **options) rescue Capybara::ElementNotFound => dlinput_error raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}" end end end
Source
# File lib/capybara/node/actions.rb, line 324 def select_datalist_option(input, value) datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT) option = datalist_options.find { |opt| opt.values_at('value', 'label').include?(value) } raise ::Capybara::ElementNotFound, %(Unable to find datalist option "#{value}") unless option input.set(option['value']) rescue ::Capybara::NotSupportedByDriverError # Implement for drivers that don't support JS datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false) option = datalist.find(:datalist_option, value, disabled: false) input.set(option.value) end
Source
# File lib/capybara/node/actions.rb, line 337 def while_visible(element, visible_css) if visible_css == true visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' } end _update_style(element, visible_css) unless element.visible? raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible' end begin yield element ensure _reset_style(element) end end