Module: Capybara::Node::Actions

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

Instance Method Summary (collapse)

Instance Method Details

- (Object) attach_file(locator, path, options = {})

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, or an array of paths



151
152
153
154
155
156
# File 'lib/capybara/node/actions.rb', line 151

def attach_file(locator, path, options={})
  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

- (Object) check(locator, options = {})

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



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

def check(locator, options={})
  find(:checkbox, locator, options).set(true)
end

- (Object) choose(locator, options = {})

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



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

def choose(locator, options={})
  find(:radio_button, locator, options).set(true)
end

- (Object) click_button(locator, options = {})

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

Parameters:

  • locator (String)

    Text, id, value or title of button



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

def click_button(locator, 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.

Parameters:

  • locator (String)

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

  • options (defaults to: {})

Options Hash (options):

  • :href (String)

    The value the href attribute must equal



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

def click_link(locator, options={})
  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.

Parameters:

  • locator (String)

    Text, id or value of link or button



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

def click_link_or_button(locator, options={})
  find(:link_or_button, locator, options).click
end

- (Object) fill_in(locator, options = {})

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

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

Options Hash (options):

  • :with (String)

    The value to fill in - required

  • :fill_options (Hash)

    Driver specific options regarding how to fill fields



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

def fill_in(locator, options={})
  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

- (Object) select(value, options = {})

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'

Parameters:

  • value (String)

    Which option to select

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

    a customizable set of options

Options Hash (options):

  • :from (String)

    The id, name or label of the select box



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

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

- (Object) uncheck(locator, options = {})

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

def uncheck(locator, options={})
  find(:checkbox, locator, options).set(false)
end

- (Object) unselect(value, options = {})

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

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

    The id, name or label of the select box



132
133
134
135
136
137
138
139
# File 'lib/capybara/node/actions.rb', line 132

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