Module: Capybara::Node::Actions

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

Instance Method Summary collapse

Instance Method Details

#attach_file(locator, path, 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)

    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) (defaults to: {})

    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 links 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:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/capybara/node/actions.rb', line 236

def attach_file(locator, path, options={})
  locator, path, options = nil, locator, path if path.is_a? Hash
  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 style = options.delete(:make_visible)
    style = { opacity: 1, display: 'block', visibility: 'visible' } if style == true
    ff = find(:file_field, locator, options.merge({visible: :all}))
    _update_style(ff, style)
    if ff.visible?
      begin
        ff.set(path)
      ensure
        _reset_style(ff)
      end
    else
      raise ExpectationNotMet, "The style changes in :make_visible did not make the file input visible"
    end
  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 links 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:



139
140
141
# File 'lib/capybara/node/actions.rb', line 139

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 links 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:



116
117
118
# File 'lib/capybara/node/actions.rb', line 116

def choose(locator, 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) (defaults to: {})

    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:



59
60
61
62
# File 'lib/capybara/node/actions.rb', line 59

def click_button(locator=nil, options={})
  locator, options = nil, locator if locator.is_a? Hash
  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) (defaults to: {})

    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:



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

def click_link(locator=nil, options={})
  locator, options = nil, locator if locator.is_a? Hash
  find(:link, locator, options).click
end

Finds a button or link by id, text or value and clicks it. Also looks at image alt text inside the link. 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:

  • locator (String)

    Text, id or value of link or button

Parameters:

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

    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
26
# File 'lib/capybara/node/actions.rb', line 23

def click_link_or_button(locator=nil, options={})
  locator, options = nil, locator if locator.is_a? Hash
  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 links that match the class(es) provided

Returns:



86
87
88
89
90
91
92
93
# File 'lib/capybara/node/actions.rb', line 86

def fill_in(locator, options={})
  locator, options = nil, locator if locator.is_a? Hash
  raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
  with = options.delete(:with)
  fill_options = options.delete(:fill_options)
  options[:with] = options.delete(:currently_with) if options.has_key?(:currently_with)
  find(:fillable_field, locator, options).set(with, fill_options)
end

#select(value, 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)

    Which option to select

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

    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:



183
184
185
186
187
188
189
190
# File 'lib/capybara/node/actions.rb', line 183

def select(value, options={})
  if options.has_key?(:from)
    from = options.delete(:from)
    find(:select, from, options).find(:option, value, options).select_option
  else
    find(:option, value, options).select_option
  end
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 links 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:



162
163
164
# File 'lib/capybara/node/actions.rb', line 162

def uncheck(locator, options={})
  _check_with_label(:checkbox, false, locator, options)
end

#unselect(value, 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)

    Which option to unselect

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

    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:



206
207
208
209
210
211
212
213
# File 'lib/capybara/node/actions.rb', line 206

def unselect(value, options={})
  if options.has_key?(:from)
    from = options.delete(:from)
    find(:select, from, options).find(:option, value, options).unselect_option
  else
    find(:option, value, options).unselect_option
  end
end