Module: Capybara::Node::Finders
Instance Method Summary collapse
-
#all([kind], locator, options) ⇒ Capybara::Result
(also: #find_all)
Find all elements on the page matching the given selector and options.
-
#find(*args) ⇒ Capybara::Node::Element
Find an Element based on the given arguments.
-
#find_button([locator], options = {}) ⇒ Capybara::Node::Element
Find a button on the page.
-
#find_by_id(id, options = {}) ⇒ Capybara::Node::Element
Find a element on the page, given its id.
-
#find_field([locator], options = {}) ⇒ Capybara::Node::Element
(also: #field_labeled)
Find a form field on the page.
-
#find_link([locator], options = {}) ⇒ Capybara::Node::Element
Find a link on the page.
-
#first([kind], locator, options) ⇒ Capybara::Node::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 Also known as: find_all
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 if no elements are found, an empty array is returned; however, expectations can be set on the number of elements to be found which will trigger Capybara’s waiting behavior for the expectations to match.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 Helpers#matches_count? for additional information about count matching.
196 197 198 199 200 201 202 203 |
# File 'lib/capybara/node/finders.rb', line 196 def all(*args) query = Capybara::Queries::SelectorQuery.new(*args) synchronize(query.wait) do result = query.resolve_for(self) raise Capybara::ExpectationNotMet, result. unless result.matches_count? result end end |
#find(*args) ⇒ Capybara::Node::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_max_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')
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/capybara/node/finders.rb', line 31 def find(*args) query = Capybara::Queries::SelectorQuery.new(*args) synchronize(query.wait) do if query.match == :smart or query.match == :prefer_exact result = query.resolve_for(self, true) result = query.resolve_for(self, false) if result.empty? && !query.exact? else result = query.resolve_for(self) 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.empty? raise Capybara::ElementNotFound.new("Unable to find #{query.description}") end result.first end.tap(&:allow_reload!) end |
#find_button([locator], options = {}) ⇒ Capybara::Node::Element
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, value, or title. <button> elements can also be found by their text content, and image <input> elements by their alt attribute
119 120 121 122 |
# File 'lib/capybara/node/finders.rb', line 119 def (locator=nil, ={}) locator, = nil, locator if locator.is_a? Hash find(:button, locator, ) end |
#find_by_id(id, options = {}) ⇒ Capybara::Node::Element
Find a element on the page, given its id.
If the driver is capable of executing JavaScript, find_by_id
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.
134 135 136 |
# File 'lib/capybara/node/finders.rb', line 134 def find_by_id(id, ={}) find(:id, id, ) end |
#find_field([locator], options = {}) ⇒ Capybara::Node::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.
76 77 78 79 |
# File 'lib/capybara/node/finders.rb', line 76 def find_field(locator=nil, ={}) locator, = nil, locator if locator.is_a? Hash find(:field, locator, ) end |
#find_link([locator], options = {}) ⇒ Capybara::Node::Element
Find a link on the page. The link can be found by its id or text.
94 95 96 97 |
# File 'lib/capybara/node/finders.rb', line 94 def find_link(locator=nil, ={}) locator, = nil, locator if locator.is_a? Hash find(:link, locator, ) end |
#first([kind], locator, options) ⇒ Capybara::Node::Element
Find the first element on the page matching the given selector and options, or nil if no element matches. By default no waiting behavior occurs, however if Capybara.wait_on_first_by_default is set to true it will trigger Capybara’s waiting behavior for a minimum of 1 matching element to be found and return the first. Waiting behavior can also be triggered by passing in any of the count expectation options.
221 222 223 224 225 226 227 228 229 |
# File 'lib/capybara/node/finders.rb', line 221 def first(*args) if Capybara.wait_on_first_by_default = if args.last.is_a?(Hash) then args.pop.dup else {} end args.push({minimum: 1}.merge()) end all(*args).first rescue Capybara::ExpectationNotMet nil end |