Module: Capybara::Node::Finders
Instance Method Summary collapse
-
#all([kind], locator, options) ⇒ Capybara::Result
Find all elements on the page matching the given selector and options.
-
#find(*args) ⇒ Capybara::Element
Find an Element based on the given arguments.
-
#find_button(locator, options = {}) ⇒ Capybara::Element
Find a button on the page.
-
#find_by_id(id, options = {}) ⇒ Capybara::Element
Find a element on the page, given its id.
-
#find_field(locator, options = {}) ⇒ Capybara::Element
(also: #field_labeled)
Find a form field on the page.
-
#find_link(locator, options = {}) ⇒ Capybara::Element
Find a link on the page.
-
#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.
Instance Method Details
#all([kind], locator, options) ⇒ Capybara::Result
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)
128 129 130 |
# File 'lib/capybara/node/finders.rb', line 128 def all(*args) resolve_query(Capybara::Query.new(*args)) end |
#find(*args) ⇒ Capybara::Element
Find an Element based on the given arguments. find
will raise an error if the element is not found.
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')
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/capybara/node/finders.rb', line 28 def find(*args) query = Capybara::Query.new(*args) synchronize(query.wait) do if query.match == :smart or query.match == :prefer_exact result = resolve_query(query, true) result = resolve_query(query, false) if result.size == 0 and not query.exact? else result = resolve_query(query) end if query.match == :one or query.match == :smart and result.size > 1 raise Capybara::Ambiguous.new("Ambiguous match, found #{result.size} elements matching #{query.description}") end if result.size == 0 raise Capybara::ElementNotFound.new("Unable to find #{query.description}") end result.first end.tap(&:allow_reload!) end |
#find_button(locator, options = {}) ⇒ Capybara::Element
Find a button on the page. The button can be found by its id, name or value.
77 78 79 |
# File 'lib/capybara/node/finders.rb', line 77 def (locator, ={}) find(:button, locator, ) end |
#find_by_id(id, options = {}) ⇒ Capybara::Element
Find a element on the page, given its id.
88 89 90 |
# File 'lib/capybara/node/finders.rb', line 88 def find_by_id(id, ={}) find(:id, id, ) end |
#find_field(locator, options = {}) ⇒ 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.
54 55 56 |
# File 'lib/capybara/node/finders.rb', line 54 def find_field(locator, ={}) find(:field, locator, ) end |
#find_link(locator, options = {}) ⇒ Capybara::Element
Find a link on the page. The link can be found by its id or text.
66 67 68 |
# File 'lib/capybara/node/finders.rb', line 66 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.
143 144 145 |
# File 'lib/capybara/node/finders.rb', line 143 def first(*args) all(*args).first end |