Module: Capybara::Node::Actions
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Defined in: | lib/capybara/node/actions.rb |
Constant Summary
-
CAPTURE_FILE_ELEMENT_SCRIPT =
# File 'lib/capybara/node/actions.rb', line 409<<~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
-
DATALIST_OPTIONS_SCRIPT =
# File 'lib/capybara/node/actions.rb', line 403<<~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
-
RESET_STYLE_SCRIPT =
# File 'lib/capybara/node/actions.rb', line 396<<~JS if (this.hasOwnProperty('capybara_style_cache')) { this.style.cssText = this.capybara_style_cache; delete this.capybara_style_cache; } JS
-
UPDATE_STYLE_SCRIPT =
# File 'lib/capybara/node/actions.rb', line 386<<~JS this.capybara_style_cache = this.style.cssText; var css = arguments[0]; for (var prop in css){ if (css.hasOwnProperty(prop)) { this.style.setProperty(prop, css[prop], "important"); } } JS
Instance Method Summary
-
#attach_file([locator], paths, **options) ⇒ Capybara::Node::Element
Find a descendant file field on the page and attach a file given its path.
-
#check([locator], **options) ⇒ Capybara::Node::Element
Find a descendant check box and mark it as checked.
-
#choose([locator], **options) ⇒ Capybara::Node::Element
Find a descendant radio button and mark it as checked.
-
#click_button([locator], **options) ⇒ Capybara::Node::Element
Finds a button on the page and clicks it.
-
#click_link([locator], **options) ⇒ Capybara::Node::Element
Finds a link by id, test_id attribute, text or title and clicks it.
-
#click_link_or_button([locator], **options) ⇒ Capybara::Node::Element
(also: #click_on)
Finds a button or link and clicks it.
-
#click_on(locator = nil, **options)
Alias for #click_link_or_button.
-
#fill_in([locator], with:, **options) ⇒ Capybara::Node::Element
Locate a text field or text area and fill it in with the given text.
-
#select(value = nil, from: nil, **options) ⇒ Capybara::Node::Element
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. -
#uncheck([locator], **options) ⇒ Capybara::Node::Element
Find a descendant check box and uncheck it.
-
#unselect(value = nil, from: nil, **options) ⇒ Capybara::Node::Element
Find a select box on the page and unselect a particular option from it.
- #_check_with_label(selector, checked, locator, allow_label_click: session_options.automatic_label_click, **options) private
- #_reset_style(element) private
- #_update_style(element, style) private
- #find_select_or_datalist_input(from, options) private
- #select_datalist_option(input, value) private
- #while_visible(element, visible_css) private
Instance Method Details
#_check_with_label(selector, checked, locator, allow_label_click: session_options.automatic_label_click, **options) (private)
[ GitHub ]# File 'lib/capybara/node/actions.rb', line 364
def _check_with_label(selector, checked, locator, allow_label_click: .automatic_label_click, ** ) [:allow_self] = true if locator.nil? synchronize(Capybara::Queries::BaseQuery.wait(, .default_max_wait_time)) do el = find(selector, locator, ** ) el.set(checked) rescue StandardError => e raise unless allow_label_click && catch_error?(e) begin el ||= find(selector, locator, ** .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
#_reset_style(element) (private)
[ GitHub ]# 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
#_update_style(element, style) (private)
[ GitHub ]# 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
#attach_file([locator], paths, **options) ⇒ Capybara::Node::Element
#attach_file(paths) { ... } ⇒ Capybara::Node::Element
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, 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
# File 'lib/capybara/node/actions.rb', line 279
def attach_file(locator = nil, paths, make_visible: nil, ** ) # 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 [: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, ** .merge(visible: :all)) while_visible(ff, make_visible) { |el| el.set(paths) } else (file_field || find(:file_field, locator, ** )).set(paths) end end
#check([locator], **options) ⇒ Capybara::Node::Element
Find a descendant check box and mark it as checked. The check box can be found via name, id, 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()
# File 'lib/capybara/node/actions.rb', line 150
def check(locator = nil, ** ) _check_with_label(:checkbox, true, locator, ** ) end
#choose([locator], **options) ⇒ Capybara::Node::Element
Find a descendant radio button and mark it as checked. The radio button can be found via name, id, 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()
# File 'lib/capybara/node/actions.rb', line 122
def choose(locator = nil, ** ) _check_with_label(:, true, locator, ** ) end
#click_button([locator], **options) ⇒ Capybara::Node::Element
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, name, test_id attribute, value, or title. <button>
elements can also be found by their text content, and image <input>
elements by their alt attribute.
# File 'lib/capybara/node/actions.rb', line 57
def (locator = nil, ** ) find(:, locator, ** ).click end
#click_link([locator], **options) ⇒ Capybara::Node::Element
Finds a link by id, test_id attribute, text or title and clicks it. Also looks at image alt text inside the link.
# File 'lib/capybara/node/actions.rb', line 41
def click_link(locator = nil, ** ) find(:link, locator, ** ).click end
#click_link_or_button([locator], **options) ⇒ Capybara::Node::Element Also known as: #click_on
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.
# File 'lib/capybara/node/actions.rb', line 25
def (locator = nil, ** ) find(:, locator, ** ).click end
#click_on(locator = nil, **options)
Alias for #click_link_or_button.
# File 'lib/capybara/node/actions.rb', line 28
alias_method :click_on, :
#fill_in([locator], with:, **options) ⇒ Capybara::Node::Element
Locate a text field or text area and fill it in with the given text. The field can be found via its name, id, 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'
# File 'lib/capybara/node/actions.rb', line 88
def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, ** ) [:with] = currently_with if currently_with [:allow_self] = true if locator.nil? find(:fillable_field, locator, ** ).set(with, ** ) end
#find_select_or_datalist_input(from, options) (private)
[ GitHub ]# File 'lib/capybara/node/actions.rb', line 310
def find_select_or_datalist_input(from, ) synchronize(Capybara::Queries::BaseQuery.wait(, .default_max_wait_time)) do find(:select, from, ** ) rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName raise if %i[selected with_selected multiple].any? { |option| .key?(option) } begin find(:datalist_input, from, ** ) rescue Capybara::ElementNotFound => dlinput_error raise Capybara::ElementNotFound, "#{select_error.} and #{dlinput_error.}" end end end
#select(value = nil, from: nil, **options) ⇒ Capybara::Node::Element
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, test_id attribute, or label text. The option can be found by its text.
page.select 'March', from: 'Month'
# File 'lib/capybara/node/actions.rb', line 201
def select(value = nil, from: nil, ** ) 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, ) : self if el.respond_to?(:tag_name) && (el.tag_name == 'input') select_datalist_option(el, value) else el.find(:option, value, ** ).select_option end end
#select_datalist_option(input, value) (private)
[ GitHub ]# File 'lib/capybara/node/actions.rb', line 324
def select_datalist_option(input, value) = input.evaluate_script(DATALIST_OPTIONS_SCRIPT) option = .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
#uncheck([locator], **options) ⇒ Capybara::Node::Element
Find a descendant check box and uncheck it. The check box can be found via name, id, 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()
# File 'lib/capybara/node/actions.rb', line 178
def uncheck(locator = nil, ** ) _check_with_label(:checkbox, false, locator, ** ) end
#unselect(value = nil, from: nil, **options) ⇒ Capybara::Node::Element
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, test_id attribute, or label text.
page.unselect 'March', from: 'Month'
#while_visible(element, visible_css) (private)
[ GitHub ]# 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