Module: Capybara::Node::Finders

Included in:
Capybara::Node
Defined in:
lib/capybara/node/finders.rb

Instance Method Summary collapse

Instance Method Details

#all(*args) ⇒ Capybara::Element

Find all elements on the page matching the given selector and options.

Both XPath and CSS expressions are supported, but Capybara does not try to automatically distinguish between them. The following statements are equivalent:

page.all(:css, 'a#person_123')
page.all(:xpath, '//a[@id="person_123"]')

If the type of selector is left out, Capybara uses Capybara.default_selector. It’s set to :css by default.

page.all("a#person_123")

Capybara.default_selector = :xpath
page.all('//a[@id="person_123"]')

The set of found elements can further be restricted by specifying options. It’s possible to select elements by their text or visibility:

page.all('a', :text => 'Home')
page.all('#menu li', :visible => true)

Parameters:

  • kind_or_locator (:css, :xpath, String) —

    Either the kind of selector or the selector itself

  • locator (String) —

    The selector

  • options (Hash{Symbol => Object}) —

    Additional options

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/capybara/node/finders.rb', line 121

def all(*args)
  options = if args.last.is_a?(Hash) then args.pop else {} end

  results = XPath.wrap(normalize_locator(*args)).paths.map do |path|
    base.find(path)
  end.flatten

  if text = options[:text]
    text = Regexp.escape(text) unless text.kind_of?(Regexp)

    results = results.select { |node| node.text.match(text) }
  end

  if options[:visible] or Capybara.ignore_hidden_elements
    results = results.select { |node| node.visible? }
  end

  results.map { |n| Capybara::Element.new(session, n) }
end

#find(*args) ⇒ Capybara::Element

Find an Element based on the given arguments. find will raise an error if the element is not found. The error message can be customized through the :message option.

If the driver is capable of executing JavaScript, find 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_wait_time and defaults to 2 seconds.

find takes the same options as all.

page.find('#foo').find('.bar')
page.find(:xpath, '//div[contains("bar")]')
page.find('li', :text => 'Quox').click_link('Delete')

Parameters:

  • kind_or_locator (:css, :xpath, String) —

    Either the kind of selector or the selector itself

  • locator (String) —

    The selector

  • options (Hash{Symbol => Object}) —

    Additional options

Returns:

Raises:



25
26
27
28
29
30
31
 
# File 'lib/capybara/node/finders.rb', line 25

def find(*args)
  node = wait_conditionally_until { all(*args).first }
ensure
  options = if args.last.is_a?(Hash) then args.last else {} end
  raise Capybara::ElementNotFound, options[:message] || "Unable to find '#{args[1] || args[0]}'" unless node
  return node
end

#find_button(locator) ⇒ Capybara::Element

Find a button on the page. The link can be found by its id, name or value.

Parameters:

  • locator (String) —

    Which button to find

Returns:



72
73
74
 
# File 'lib/capybara/node/finders.rb', line 72

def find_button(locator)
  find(:xpath, XPath.button(locator))
end

#find_by_id(id) ⇒ Capybara::Element

Find a element on the page, given its id.

Parameters:

  • locator (String) —

    Which element to find

Returns:



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

def find_by_id(id)
  find(:css, "##{id}")
end

#find_field(locator) ⇒ Capybara::Element Also known as: field_labeled

Find a form field on the page. The field can be found by its name, id or label text.

Parameters:

  • locator (String) —

    Which field to find

Returns:



49
50
51
 
# File 'lib/capybara/node/finders.rb', line 49

def find_field(locator)
  find(:xpath, XPath.field(locator))
end

#find_link(locator) ⇒ Capybara::Element

Find a link on the page. The link can be found by its id or text.

Parameters:

  • locator (String) —

    Which link to find

Returns:



61
62
63
 
# File 'lib/capybara/node/finders.rb', line 61

def find_link(locator)
  find(:xpath, XPath.link(locator))
end

#locate(*args) ⇒ Object

Deprecated.

#find now behaves like locate used to. Use #find instead.



37
38
39
40
 
# File 'lib/capybara/node/finders.rb', line 37

def locate(*args)
  warn "DEPRECATED: Please use #find instead of #locate"
  find(*args)
end