module Capybara::Node::Finders

Public Instance Methods

all(*args, **options, &optional_filter_block) click to toggle source

@!method all([kind = Capybara.default_selector], locator = nil, **options)

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)

By default Capybara's waiting behavior will wait up to `Capybara.default_max_wait_time` seconds for matching elements to be available and then return an empty result if none are available. It is possible to set expectations on the number of results located and Capybara will raise an exception if the number of elements located don't satisfy the specified conditions. The expectations can be set using

page.assert_selector('p#foo', count: 4)
page.assert_selector('p#foo', maximum: 10)
page.assert_selector('p#foo', minimum: 1)
page.assert_selector('p#foo', between: 1..10)

See {Capybara::Helpers#matches_count?} for additional information about count matching.

@param [Symbol] kind Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector @param [String] locator The locator for the specified selector @option options [String, Regexp] text Only find elements which contain this text or match this regexp @option options [String, Boolean] exact_text (Capybara.exact_text) When String the elements contained text must match exactly, when Boolean controls whether the :text option must match exactly @option options [Boolean] normalize_ws (Capybara.default_normalize_ws) Whether the `text`/`exact_text` options are compared against elment text with whitespace normalized or as returned by the driver @option options [Boolean, Symbol] visible Only find elements with the specified visibility:

* true - only finds visible elements.
* false - finds invisible _and_ visible elements.
* :all - same as false; finds visible and invisible elements.
* :hidden - only finds invisible elements.
* :visible - same as true; only finds visible elements.

@option options [Integer] count Exact number of matches that are expected to be found @option options [Integer] maximum Maximum number of matches that are expected to be found @option options [Integer] minimum Minimum number of matches that are expected to be found @option options [Range] between Number of matches found must be within the given range @option options [Boolean] exact Control whether `is` expressions in the given XPath match exactly or partially @option options [Integer, false] wait (Capybara.default_max_wait_time) The time to wait for matching elements to become available @overload all([kind = Capybara.default_selector], locator = nil, **options) @overload all([kind = Capybara.default_selector], locator = nil, **options, &filter_block)

@yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results
@yieldreturn [Boolean]                     Should the element be considered in the results?

@return [Capybara::Result] A collection of found elements @raise [Capybara::ExpectationNotMet] The number of elements found doesn't match the specified conditions

# File lib/capybara/node/finders.rb, line 245
def all(*args, **options, &optional_filter_block)
  minimum_specified = options_include_minimum?(options)
  options = { minimum: 1 }.merge(options) unless minimum_specified
  options[:session_options] = session_options
  query = Capybara::Queries::SelectorQuery.new(*args, options, &optional_filter_block)
  result = nil
  begin
    synchronize(query.wait) do
      result = query.resolve_for(self)
      raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?
      result
    end
  rescue Capybara::ExpectationNotMet
    raise if minimum_specified || (result.compare_count == 1)
    Result.new([], nil)
  end
end
Also aliased as: find_all
ancestor(*args, **options, &optional_filter_block) click to toggle source

Find an {Capybara::Node::Element} based on the given arguments that is also an ancestor of the element called on. ancestor will raise an error if the element is not found.

ancestor takes the same options as find.

element.ancestor('#foo').find('.bar')
element.ancestor(:xpath, './/div[contains(., "bar")]')
element.ancestor('ul', text: 'Quox').click_link('Delete')

@param (see Capybara::Node::Finders#find)

@!macro waiting_behavior

@option options [Boolean] match The matching strategy to use.

@return [Capybara::Node::Element] The found element @raise [Capybara::ElementNotFound] If the element can't be found before time expires

# File lib/capybara/node/finders.rb, line 56
def ancestor(*args, **options, &optional_filter_block)
  options[:session_options] = session_options
  synced_resolve Capybara::Queries::AncestorQuery.new(*args, options, &optional_filter_block)
end
find(*args, **options, &optional_filter_block) click to toggle source

Find an {Capybara::Node::Element} based on the given arguments. find will raise an error if the element is not found.

@!macro waiting_behavior

If the driver is capable of executing JavaScript, +$0+ 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}
and defaults to 2 seconds.
@option options [false, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.

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

@param (see Capybara::Node::Finders#all)

@option options [Boolean] match The matching strategy to use.

@return [Capybara::Node::Element] The found element @raise [Capybara::ElementNotFound] If the element can't be found before time expires

# File lib/capybara/node/finders.rb, line 31
def find(*args, **options, &optional_filter_block)
  options[:session_options] = session_options
  synced_resolve Capybara::Queries::SelectorQuery.new(*args, options, &optional_filter_block)
end
find_all(*args, **options, &optional_filter_block)
Alias for: all
find_button(locator = nil, **options, &optional_filter_block) click to toggle source

Find a button on the page. 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, Capbyara.test_id attribute, value, or title. <button> elements can also be found by their text content, and image <input> elements by their alt attribute

@overload find_button(, **options)

@param [String] locator            id, Capybara.test_id attribute, value, title, text content, alt of image

@overload find_button(**options)

@macro waiting_behavior

@option options [Boolean, Symbol] disabled (false)  Match disabled button?
                                                    * true - only finds a disabled button
                                                    * false - only finds an enabled button
                                                    * :all - finds either an enabled or disabled button
@option options [String] id                 Match buttons with the id provided
@option options [String] title              Match buttons with the title provided
@option options [String] value              Match buttons with the value provided
@option options [String, Array<String>] class    Match buttons that match the class(es) provided

@return [Capybara::Node::Element] The found element

# File lib/capybara/node/finders.rb, line 162
def find_button(locator = nil, **options, &optional_filter_block)
  find(:button, locator, options, &optional_filter_block)
end
find_by_id(id, **options, &optional_filter_block) click to toggle source

Find a element on the page, given its id.

@macro waiting_behavior

@param [String] id id of element

@return [Capybara::Node::Element] The found element

# File lib/capybara/node/finders.rb, line 176
def find_by_id(id, **options, &optional_filter_block)
  find(:id, id, options, &optional_filter_block)
end
find_field(locator = nil, **options, &optional_filter_block) click to toggle source

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

@overload find_field(, **options)

@param [String] locator             name, id, Capybara.test_id attribute, placeholder or text of associated label element

@macro waiting_behavior

@option options [Boolean] checked       Match checked field?
@option options [Boolean] unchecked     Match unchecked field?
@option options [Boolean, Symbol] disabled (false)  Match disabled field?
                                                    * true - only finds a disabled field
                                                    * false - only finds an enabled field
                                                    * :all - finds either an enabled or disabled field
@option options [Boolean] readonly      Match readonly field?
@option options [String, Regexp] with   Value of field to match on
@option options [String] type           Type of field to match on
@option options [Boolean] multiple      Match fields that can have multiple values?
@option options [String] id             Match fields that match the id attribute
@option options [String] name           Match fields that match the name attribute
@option options [String] placeholder    Match fields that match the placeholder attribute
@option options [String, Array<String>] Match fields that match the class(es) passed

@return [Capybara::Node::Element] The found element

# File lib/capybara/node/finders.rb, line 114
def find_field(locator = nil, **options, &optional_filter_block)
  find(:field, locator, options, &optional_filter_block)
end
first(*args, **options, &optional_filter_block) click to toggle source

Find the first element on the page matching the given selector and options. By default `first` will wait up to `Capybara.default_max_wait_time` seconds for matching elements to appear and then raise an error if no matching element is found, or `nil` if the provided count options allow for empty results.

@overload first(, locator, options)

@param [:css, :xpath] kind                 The type of selector
@param [String] locator                    The selector
@param [Hash] options                      Additional options; see {#all}

@return [Capybara::Node::Element] The found element or nil @raise [Capybara::ElementNotFound] If element(s) matching the provided options can't be found before time expires

# File lib/capybara/node/finders.rb, line 278
def first(*args, **options, &optional_filter_block)
  options = { minimum: 1 }.merge(options) unless options_include_minimum?(options)
  all(*args, options, &optional_filter_block).first
end
sibling(*args, **options, &optional_filter_block) click to toggle source

Find an {Capybara::Node::Element} based on the given arguments that is also a sibling of the element called on. sibling will raise an error if the element is not found.

sibling takes the same options as find.

element.sibling('#foo').find('.bar')
element.sibling(:xpath, './/div[contains(., "bar")]')
element.sibling('ul', text: 'Quox').click_link('Delete')

@param (see Capybara::Node::Finders#find)

@macro waiting_behavior

@option options [Boolean] match The matching strategy to use.

@return [Capybara::Node::Element] The found element @raise [Capybara::ElementNotFound] If the element can't be found before time expires

# File lib/capybara/node/finders.rb, line 82
def sibling(*args, **options, &optional_filter_block)
  options[:session_options] = session_options
  synced_resolve Capybara::Queries::SiblingQuery.new(*args, options, &optional_filter_block)
end

Private Instance Methods

ambiguous?(query, result) click to toggle source
# File lib/capybara/node/finders.rb, line 301
def ambiguous?(query, result)
  %i[one smart].include?(query.match) && (result.size > 1)
end
options_include_minimum?(opts) click to toggle source
# File lib/capybara/node/finders.rb, line 309
def options_include_minimum?(opts)
  %i[count minimum between].any? { |key| opts.key?(key) }
end
parent() click to toggle source
# File lib/capybara/node/finders.rb, line 313
def parent
  first(:xpath, './parent::*', minimum: 0)
end
prefer_exact?(query) click to toggle source
# File lib/capybara/node/finders.rb, line 305
def prefer_exact?(query)
  %i[smart prefer_exact].include?(query.match)
end
synced_resolve(query) click to toggle source
# File lib/capybara/node/finders.rb, line 285
def synced_resolve(query)
  synchronize(query.wait) do
    if prefer_exact?(query)
      result = query.resolve_for(self, true)
      result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?
    else
      result = query.resolve_for(self)
    end

    raise Capybara::Ambiguous, "Ambiguous match, found #{result.size} elements matching #{query.applied_description}" if ambiguous?(query, result)
    raise Capybara::ElementNotFound, "Unable to find #{query.applied_description}" if result.empty?

    result.first
  end.tap(&:allow_reload!)
end