Module: Capybara::Node::Finders

Included in:
Base, Simple
Defined in:
lib/capybara/node/finders.rb

Instance Method Summary collapse

Instance Method Details

#all([kind], locator, options) ⇒ Array[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 (:css, :xpath) —

    The type of selector

  • locator (String) —

    The selector

Options Hash (options):

  • text (String, Regexp) —

    Only find elements which contain this text or match this regexp

  • visible (Boolean) —

    Only find elements that are visible on the page. Setting this to false (the default, unless Capybara.ignore_hidden_elements = true), finds invisible and visible elements.

Returns:

  • (Array[Capybara::Element]) —

    The found elements



111
112
113
114
115
116
 
# File 'lib/capybara/node/finders.rb', line 111

def all(*args)
  query = Capybara::Query.new(*args)
  query.xpaths.
    map    { |path| find_in_base(query, path) }.flatten.
    select { |node| query.matches_filters?(node) }
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:

  • options (Hash) —

    a customizable set of options

Returns:

  • (Capybara::Element) —

    The found element

Raises:



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

def find(*args)
  wait_until { first(*args) or raise_find_error(*args) }
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:

  • (Capybara::Element) —

    The found element



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

def find_button(locator)
  find(: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:

  • (Capybara::Element) —

    The found element



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

def find_by_id(id)
  find(:id, 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:

  • (Capybara::Element) —

    The found element



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

def find_field(locator)
  find(: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:

  • (Capybara::Element) —

    The found element



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

def find_link(locator)
  find(:link, locator)
end

#first([kind], locator, options) ⇒ Capybara::Element

Find the first element on the page matching the given selector and options, or nil if no element matches.

Parameters:

  • kind (:css, :xpath) —

    The type of selector

  • locator (String) —

    The selector

  • options (Hash) —

    Additional options; see #all

Returns:

  • (Capybara::Element) —

    The found element or nil



129
130
131
132
133
134
135
136
 
# File 'lib/capybara/node/finders.rb', line 129

def first(*args)
  results = all(*args)
  if Capybara.prefer_visible_elements
    results.find(&:visible?) or results.first
  else
    results.first
  end
end