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 = {}) ⇒ Object

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



257
258
259
260
261
262
263
 
# File 'lib/capybara/node/actions.rb', line 257

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
  find(:file_field, locator, options).set(path)
end

#check([locator], options) ⇒ Object

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

  • :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.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/capybara/node/actions.rb', line 139

def check(locator, options={})
  locator, options = nil, locator if locator.is_a? Hash
  allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }

  begin
    find(:checkbox, locator, options).set(true)
  rescue Capybara::ElementNotFound => e
    raise unless allow_label_click
    begin
      cbox = find(:checkbox, locator, options.merge({wait: 0, visible: :hidden}))
      label = find(:label, for: cbox, wait: 0, visible: true)
      label.click unless cbox.checked?
    rescue
      raise e
    end
  end
end

#choose([locator], options) ⇒ Object

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

  • 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.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/capybara/node/actions.rb', line 104

def choose(locator, options={})
  locator, options = nil, locator if locator.is_a? Hash
  allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }

  begin
    find(:radio_button, locator, options).set(true)
  rescue Capybara::ElementNotFound => e
    raise unless allow_label_click
    begin
      radio = find(:radio_button, locator, options.merge({wait: 0, visible: :hidden}))
      label = find(:label, for: radio, wait: 0, visible: true)
      label.click unless radio.checked?
    rescue
      raise e
    end
  end
end

#click_button([locator], options) ⇒ Object

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.



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

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

#click_link([locator], options) ⇒ Object

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 —

    See Finders#find_link

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.



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

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

#click_link_or_button([locator], options) ⇒ Object Also known as: click_on

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.



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

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 = {}) ⇒ Object

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, fill_in 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

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



78
79
80
81
82
83
84
 
# File 'lib/capybara/node/actions.rb', line 78

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)
  find(:fillable_field, locator, options).set(with, fill_options)
end

#select(value, options = {}) ⇒ Object

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



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

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) ⇒ Object

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

  • :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.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/capybara/node/actions.rb', line 174

def uncheck(locator, options={})
  locator, options = nil, locator if locator.is_a? Hash
  allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }

  begin
    find(:checkbox, locator, options).set(false)
  rescue Capybara::ElementNotFound => e
    raise unless allow_label_click
    begin
      cbox = find(:checkbox, locator, options.merge({wait: 0, visible: :hidden}))
      label = find(:label, for: cbox, wait: 0, visible: true)
      label.click if cbox.checked?
    rescue
      raise e
    end
  end
end

#unselect(value, options = {}) ⇒ Object

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.



230
231
232
233
234
235
236
237
 
# File 'lib/capybara/node/actions.rb', line 230

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