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

Parameters:

  • locator (String) —

    Which field to attach the file to

  • path (String) —

    The path of the file that will be attached

Raises:



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

def attach_file(locator, path)
  raise Capybara::FileNotFound, "cannot attach file, #{path} does not exist" unless File.exist?(path.to_s)
  msg = "cannot attach file, no file field with id, name, or label '#{locator}' found"
  find(:xpath, XPath::HTML.file_field(locator), :message => msg).set(path)
end

#check(locator) ⇒ 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')

Parameters:

  • locator (String) —

    Which check box to check



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

def check(locator)
  msg = "cannot check field, no checkbox with id, name, or label '#{locator}' found"
  find(:xpath, XPath::HTML.checkbox(locator), :message => msg).set(true)
end

#choose(locator) ⇒ 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')

Parameters:

  • locator (String) —

    Which radio button to choose



66
67
68
69
 
# File 'lib/capybara/node/actions.rb', line 66

def choose(locator)
  msg = "cannot choose field, no radio button with id, name, or label '#{locator}' found"
  find(:xpath, XPath::HTML.radio_button(locator), :message => msg).set(true)
end

#click_button(locator) ⇒ Object

Finds a button by id, text or value and clicks it.

Parameters:

  • locator (String) —

    Text, id or value of button



36
37
38
39
 
# File 'lib/capybara/node/actions.rb', line 36

def click_button(locator)
  msg = "no button with value or id or text '#{locator}' found"
  find(:xpath, XPath::HTML.button(locator), :message => msg).click
end

#click_link(locator) ⇒ Object

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

Parameters:

  • locator (String) —

    Text, id or text of link



25
26
27
28
 
# File 'lib/capybara/node/actions.rb', line 25

def click_link(locator)
  msg = "no link with title, id or text '#{locator}' found"
  find(:xpath, XPath::HTML.link(locator), :message => msg).click
end

#click_link_or_button(locator) ⇒ 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.

Parameters:

  • locator (String) —

    Text, id or value of link or button



12
13
14
15
 
# File 'lib/capybara/node/actions.rb', line 12

def click_link_or_button(locator)
  msg = "no link or button '#{locator}' found"
  find(:xpath, XPath::HTML.link_or_button(locator), :message => msg).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'

Parameters:

  • locator (String) —

    Which field to fill in

  • The (Hash{:with => String}) —

    value to fill in



51
52
53
54
55
 
# File 'lib/capybara/node/actions.rb', line 51

def fill_in(locator, options={})
  msg = "cannot fill in, no text field, text area or password field with id, name, or label '#{locator}' found"
  raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
  find(:xpath, XPath::HTML.fillable_field(locator), :message => msg).set(options[:with])
end

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

Find a select box on the page and select a particular option from 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.

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

Parameters:

  • value (String) —

    Which option to select

  • The (Hash{:from => String}) —

    id, name or label of the select box



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/capybara/node/actions.rb', line 110

def select(value, options={})
  if options.has_key?(:from)
    no_select_msg = "cannot select option, no select box with id, name, or label '#{options[:from]}' found"
    no_option_msg = "cannot select option, no option with text '#{value}' in select box '#{options[:from]}'"
    select = find(:xpath, XPath::HTML.select(options[:from]), :message => no_select_msg)
    select.find(:xpath, XPath::HTML.option(value), :message => no_option_msg).select_option
  else
    no_option_msg = "cannot select option, no option with text '#{value}'"
    find(:xpath, XPath::HTML.option(value), :message => no_option_msg).select_option
  end
end

#uncheck(locator) ⇒ Object

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

page.uncheck('German')

Parameters:

  • locator (String) —

    Which check box to uncheck



94
95
96
97
 
# File 'lib/capybara/node/actions.rb', line 94

def uncheck(locator)
  msg = "cannot uncheck field, no checkbox with id, name, or label '#{locator}' found"
  find(:xpath, XPath::HTML.checkbox(locator), :message => msg).set(false)
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'

Parameters:

  • value (String) —

    Which option to unselect

  • The (Hash{:from => String}) —

    id, name or label of the select box



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/capybara/node/actions.rb', line 133

def unselect(value, options={})
  if options.has_key?(:from)
    no_select_msg = "cannot unselect option, no select box with id, name, or label '#{options[:from]}' found"
    no_option_msg = "cannot unselect option, no option with text '#{value}' in select box '#{options[:from]}'"
    select = find(:xpath, XPath::HTML.select(options[:from]), :message => no_select_msg)
    select.find(:xpath, XPath::HTML.option(value), :message => no_option_msg).unselect_option
  else
    no_option_msg = "cannot unselect option, no option with text '#{value}'"
    find(:xpath, XPath::HTML.option(value), :message => no_option_msg).unselect_option
  end
end