Module: Capybara::Node::Actions

Included in:
Base
Defined in:
lib/capybara/node/actions.rb

Instance Method Summary collapse

Instance Method Details

#attach_file(locator = nil, path, make_visible: nil, **options) ⇒ Capybara::Node::Element

Find a 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.

page.attach_file(locator, '/path/to/file.png')

If the driver is capable of executing JavaScript, attach_file 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

Parameters:

  • locator (String) (defaults to: nil)

    Which field to attach the file to

  • path (String)

    The path of the file that will be attached, or an array of paths

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

  • match (Symbol) — default: Capybara.match

    The matching strategy to use (:one, :first, :prefer_exact, :smart).

  • exact (Boolean) — default: Capybara.exact

    Match the exact label name/contents or accept a partial match.

  • multiple (Boolean)

    Match field which allows multiple file selection

  • id (String)

    Match fields that match the id attribute

  • name (String)

    Match fields that match the name attribute

  • :class (String, Array<String>)

    Match fields that match the class(es) provided

  • make_visible (true, Hash)

    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)

Returns:



221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/capybara/node/actions.rb', line 221

def attach_file(locator = nil, path, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments
  Array(path).each do |p|
    raise Capybara::FileNotFound, "cannot attach file, #{p} does not exist" unless File.exist?(p.to_s)
  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))
    while_visible(ff, make_visible) { |el| el.set(path) }
  else
    find(:file_field, locator, options).set(path)
  end
end

#check([locator], options) ⇒ Capybara::Node::Element

Find a check box and mark it as checked. The check box can be found via name, id or label text.

page.check('German')

If the driver is capable of executing JavaScript, ++ 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

Parameters:

  • locator (String)

    Which check box to check

Options Hash (options):

  • :option (String)

    Value of the checkbox to select

  • id (String)

    Match fields that match the id attribute

  • name (String)

    Match fields that match the name attribute

  • :class (String, Array<String>)

    Match fields that match the class(es) provided

  • :allow_label_click (Boolean) — default: Capybara.automatic_label_click

    Attempt to click the label to toggle state if element is non-visible.

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

Returns:



132
133
134
# File 'lib/capybara/node/actions.rb', line 132

def check(locator, **options)
  _check_with_label(:checkbox, true, locator, **options)
end

#choose([locator], options) ⇒ Capybara::Node::Element

Find a radio button and mark it as checked. The radio button can be found via name, id or label text.

page.choose('Male')

If the driver is capable of executing JavaScript, ++ 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

Parameters:

  • locator (String)

    Which radio button to choose

Options Hash (options):

  • :option (String)

    Value of the radio_button to choose

  • :id (String)

    Match fields that match the id attribute

  • :name (String)

    Match fields that match the name attribute

  • :class (String, Array<String>)

    Match fields that match the class(es) provided

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

  • :allow_label_click (Boolean) — default: Capybara.automatic_label_click

    Attempt to click the label to toggle state if element is non-visible.

Returns:



109
110
111
# File 'lib/capybara/node/actions.rb', line 109

def choose(locator = nil, **options)
  _check_with_label(:radio_button, true, locator, **options)
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, value, or title. <button> elements can also be found by their text content, and image <input> elements by their alt attribute

If the driver is capable of executing JavaScript, click_button 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

Parameters:

Parameters:

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

Returns:



57
58
59
# File 'lib/capybara/node/actions.rb', line 57

def click_button(locator = nil, **options)
  find(:button, locator, options).click
end

Finds a link by id, text or title and clicks it. Also looks at image alt text inside the link.

If the driver is capable of executing JavaScript, click_link 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

Parameters:

  • locator (String)

    text, id, title or nested image's alt attribute

  • options

Parameters:

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

Returns:



40
41
42
# File 'lib/capybara/node/actions.rb', line 40

def click_link(locator = nil, **options)
  find(:link, locator, options).click
end

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 If the driver is capable of executing JavaScript, click_link_or_button 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

Parameters:

Parameters:

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

Returns:



23
24
25
# File 'lib/capybara/node/actions.rb', line 23

def click_link_or_button(locator = nil, **options)
  find(:link_or_button, locator, options).click
end

#fill_in([locator], 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 or label text.

page.fill_in 'Name', with: 'Bob'

If the driver is capable of executing JavaScript, ++ 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

Parameters:

  • locator (String)

    Which field to fill in

  • options (Hash) (defaults to: {})

Options Hash (options):

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

  • :with (String)

    The value to fill in - required

  • :fill_options (Hash)

    Driver specific options regarding how to fill fields

  • :currently_with (String)

    The current value property of the field to fill in

  • :multiple (Boolean)

    Match fields that can have multiple values?

  • :id (String)

    Match fields that match the id attribute

  • :name (String)

    Match fields that match the name attribute

  • :placeholder (String)

    Match fields that match the placeholder attribute

  • :class (String, Array<String>)

    Match fields that match the class(es) provided

Returns:



83
84
85
86
# File 'lib/capybara/node/actions.rb', line 83

def fill_in(locator = nil, with:, fill_options: {}, **options)
  options[:with] = options.delete(:currently_with) if options.key?(:currently_with)
  find(:fillable_field, locator, options).set(with, fill_options)
end

#select(value = nil, from: nil, **options) ⇒ Capybara::Node::Element

If `:from` option is present, `select` finds a select box 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 or label text. The option can be found by its text.

page.select 'March', from: 'Month'

If the driver is capable of executing JavaScript, select 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

Parameters:

  • value (String) (defaults to: nil)

    Which option to select

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

  • :from (String)

    The id, name or label of the select box

Returns:



176
177
178
179
# File 'lib/capybara/node/actions.rb', line 176

def select(value = nil, from: nil, **options)
  scope = from ? find(:select, from, options) : self
  scope.find(:option, value, options).select_option
end

#uncheck([locator], options) ⇒ Capybara::Node::Element

Find a check box and mark uncheck it. The check box can be found via name, id or label text.

page.uncheck('German')

If the driver is capable of executing JavaScript, ++ 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

Parameters:

  • locator (String)

    Which check box to uncheck

Options Hash (options):

  • :option (String)

    Value of the checkbox to deselect

  • id (String)

    Match fields that match the id attribute

  • name (String)

    Match fields that match the name attribute

  • :class (String, Array<String>)

    Match fields that match the class(es) provided

  • :allow_label_click (Boolean) — default: Capybara.automatic_label_click

    Attempt to click the label to toggle state if element is non-visible.

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

Returns:



155
156
157
# File 'lib/capybara/node/actions.rb', line 155

def uncheck(locator = nil, **options)
  _check_with_label(:checkbox, false, locator, **options)
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 or label text.

page.unselect 'March', from: 'Month'

If the driver is capable of executing JavaScript, unselect 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

Parameters:

  • value (String) (defaults to: nil)

    Which option to unselect

  • options (Hash{:from => String})

    The id, name or label of the select box

Options Hash (**options):

  • wait (false, Numeric) — default: Capybara.default_max_wait_time

    Maximum time to wait for matching element to appear.

Returns:



195
196
197
198
# File 'lib/capybara/node/actions.rb', line 195

def unselect(value = nil, from: nil, **options)
  scope = from ? find(:select, from, options) : self
  scope.find(:option, value, options).unselect_option
end