Module: Capybara::Node::Matchers
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#assert_matches_selector(*args) ⇒ Object
Asserts that the current_node matches a given selector.
-
#assert_no_selector(*args) ⇒ Object
(also: #refute_selector)
Asserts that a given selector is not on the page or current node.
-
#assert_no_text(*args) ⇒ true
Asserts that the page or current node doesn’t have the given text content, ignoring any HTML tags.
- #assert_not_matches_selector(*args) ⇒ Object (also: #refute_matches_selector)
-
#assert_selector(*args) ⇒ Object
Asserts that a given selector is on the page or current node.
-
#assert_text(*args) ⇒ true
Asserts that the page or current node has the given text content, ignoring any HTML tags.
-
#has_button?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a button with the given text, value or id.
-
#has_checked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a radio button or checkbox with the given label, value or id, that is currently checked.
-
#has_css?(path, options = {}) ⇒ Boolean
Checks if a given CSS selector is on the page or current node.
-
#has_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a form field with the given label, name or id.
-
#has_link?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a link with the given text or id.
-
#has_no_button?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no button with the given text, value or id.
-
#has_no_checked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no radio button or checkbox with the given label, value or id, that is currently checked.
-
#has_no_css?(path, options = {}) ⇒ Boolean
Checks if a given CSS selector is not on the page or current node.
-
#has_no_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no form field with the given label, name or id.
-
#has_no_link?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no link with the given text or id.
-
#has_no_select?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no select field with the given label, name or id.
-
#has_no_selector?(*args) ⇒ Boolean
Checks if a given selector is not on the page or current node.
-
#has_no_table?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no table with the given id or caption.
-
#has_no_text?(*args) ⇒ Boolean
(also: #has_no_content?)
Checks if the page or current node does not have the given text content, ignoring any HTML tags and normalizing whitespace.
-
#has_no_unchecked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no radio button or checkbox with the given label, value or id, that is currently unchecked.
-
#has_no_xpath?(path, options = {}) ⇒ Boolean
Checks if a given XPath expression is not on the page or current node.
-
#has_select?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a select field with the given label, name or id.
-
#has_selector?(*args) ⇒ Boolean
Checks if a given selector is on the page or current node.
-
#has_table?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a table with the given id or caption:.
-
#has_text?(*args) ⇒ Boolean
(also: #has_content?)
Checks if the page or current node has the given text content, ignoring any HTML tags.
-
#has_unchecked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a radio button or checkbox with the given label, value or id, that is currently unchecked.
-
#has_xpath?(path, options = {}) ⇒ Boolean
Checks if a given XPath expression is on the page or current node.
-
#matches_selector?(*args) ⇒ Boolean
Checks if the current node matches given selector Usage is identical to Capybara::Node::Matchers#has_selector?.
-
#not_matches_selector?(*args) ⇒ Boolean
Checks if the current node does not match given selector Usage is identical to Capybara::Node::Matchers#has_selector?.
Instance Method Details
#==(other) ⇒ Object
590 591 592 |
# File 'lib/capybara/node/matchers.rb', line 590 def ==(other) self.eql?(other) || (other.respond_to?(:base) && base == other.base) end |
#assert_matches_selector(*args) ⇒ Object
Asserts that the current_node matches a given selector
node.assert_matches_selector('p#foo')
node.assert_matches_selector(:xpath, '//p[@id="foo"]')
node.assert_matches_selector(:foo)
It also accepts all options that Finders#all accepts, such as :text and :visible.
node.assert_matches_selector('li', :text => 'Horse', :visible => true)
177 178 179 180 181 182 183 184 185 186 |
# File 'lib/capybara/node/matchers.rb', line 177 def assert_matches_selector(*args) query = Capybara::Queries::MatchQuery.new(*args) synchronize(query.wait) do result = query.resolve_for(self.query_scope) unless result.include? self raise Capybara::ExpectationNotMet, "Item does not match the provided selector" end end return true end |
#assert_no_selector(*args) ⇒ Object Also known as: refute_selector
Asserts that a given selector is not on the page or current node. Usage is identical to Capybara::Node::Matchers#assert_selector
Query options such as :count, :minimum, :maximum, and :between are considered to be an integral part of the selector. This will return true, for example, if a page contains 4 anchors but the query expects 5:
page.assert_no_selector('a', :minimum => 1) # Found, raises Capybara::ExpectationNotMet
page.assert_no_selector('a', :count => 4) # Found, raises Capybara::ExpectationNotMet
page.assert_no_selector('a', :count => 5) # Not Found, returns true
149 150 151 152 153 154 155 156 157 158 |
# File 'lib/capybara/node/matchers.rb', line 149 def assert_no_selector(*args) query = Capybara::Queries::SelectorQuery.new(*args) synchronize(query.wait) do result = query.resolve_for(self) if result.matches_count? && ((!result.empty?) || Capybara::Helpers.expects_none?(query.)) raise Capybara::ExpectationNotMet, result. end end return true end |
#assert_no_text(type, text, options = {}) ⇒ true #assert_no_text(text, options = {}) ⇒ true
Asserts that the page or current node doesn’t have the given text content, ignoring any HTML tags.
539 540 541 542 543 544 545 546 547 548 549 |
# File 'lib/capybara/node/matchers.rb', line 539 def assert_no_text(*args) query = Capybara::Queries::TextQuery.new(*args) synchronize(query.wait) do count = query.resolve_for(self) matches_count = Capybara::Helpers.matches_count?(count, query.) if matches_count && ((count > 0) || Capybara::Helpers.expects_none?(query.)) raise Capybara::ExpectationNotMet, query. end end return true end |
#assert_not_matches_selector(*args) ⇒ Object Also known as: refute_matches_selector
188 189 190 191 192 193 194 195 196 197 |
# File 'lib/capybara/node/matchers.rb', line 188 def assert_not_matches_selector(*args) query = Capybara::Queries::MatchQuery.new(*args) synchronize(query.wait) do result = query.resolve_for(self.query_scope) if result.include? self raise Capybara::ExpectationNotMet, 'Item matched the provided selector' end end return true end |
#assert_selector(*args) ⇒ Object
Asserts that a given selector is on the page or current node.
page.assert_selector('p#foo')
page.assert_selector(:xpath, './/p[@id="foo"]')
page.assert_selector(:foo)
By default it will check if the expression occurs at least once, but a different number can be specified.
page.assert_selector('p#foo', :count => 4)
This will check if the expression occurs exactly 4 times. See Finders#all for other available result size options.
If a :count of 0 is specified, it will behave like #assert_no_selector; however, use of that method is preferred over this one.
It also accepts all options that Finders#all accepts, such as :text and :visible.
page.assert_selector('li', :text => 'Horse', :visible => true)
‘assert_selector` can also accept XPath expressions generated by the XPath gem:
page.assert_selector(:xpath, XPath.descendant(:p))
122 123 124 125 126 127 128 129 130 131 |
# File 'lib/capybara/node/matchers.rb', line 122 def assert_selector(*args) query = Capybara::Queries::SelectorQuery.new(*args) synchronize(query.wait) do result = query.resolve_for(self) unless result.matches_count? && ((!result.empty?) || Capybara::Helpers.expects_none?(query.)) raise Capybara::ExpectationNotMet, result. end end return true end |
#assert_text(type, text, options = {}) ⇒ true #assert_text(text, options = {}) ⇒ true
Asserts that the page or current node has the given text content, ignoring any HTML tags.
519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/capybara/node/matchers.rb', line 519 def assert_text(*args) query = Capybara::Queries::TextQuery.new(*args) synchronize(query.wait) do count = query.resolve_for(self) matches_count = Capybara::Helpers.matches_count?(count, query.) unless matches_count && ((count > 0) || Capybara::Helpers.expects_none?(query.)) raise Capybara::ExpectationNotMet, query. end end return true end |
#has_button?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a button with the given text, value or id.
318 319 320 |
# File 'lib/capybara/node/matchers.rb', line 318 def (locator, ={}) has_selector?(:button, locator, ) end |
#has_checked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a radio button or checkbox with the given label, value or id, that is currently checked.
383 384 385 |
# File 'lib/capybara/node/matchers.rb', line 383 def has_checked_field?(locator, ={}) has_selector?(:field, locator, .merge(:checked => true)) end |
#has_css?(path, options = {}) ⇒ Boolean
Checks if a given CSS selector is on the page or current node.
page.has_css?('p#foo')
By default it will check if the selector occurs at least once, but a different number can be specified.
page.has_css?('p#foo', :count => 4)
This will check if the selector occurs exactly 4 times.
It also accepts all options that Finders#all accepts, such as :text and :visible.
page.has_css?('li', :text => 'Horse', :visible => true)
268 269 270 |
# File 'lib/capybara/node/matchers.rb', line 268 def has_css?(path, ={}) has_selector?(:css, path, ) end |
#has_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a form field with the given label, name or id.
For text fields and other textual fields, such as textareas and HTML5 email/url/etc. fields, it’s possible to specify a :with option to specify the text the field should contain:
page.has_field?('Name', :with => 'Jonas')
It is also possible to filter by the field type attribute:
page.has_field?('Email', :type => 'email')
Note: ‘textarea’ and ‘select’ are valid type values, matching the associated tag names.
356 357 358 |
# File 'lib/capybara/node/matchers.rb', line 356 def has_field?(locator, ={}) has_selector?(:field, locator, ) end |
#has_link?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a link with the given text or id.
294 295 296 |
# File 'lib/capybara/node/matchers.rb', line 294 def has_link?(locator, ={}) has_selector?(:link, locator, ) end |
#has_no_button?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no button with the given text, value or id.
330 331 332 |
# File 'lib/capybara/node/matchers.rb', line 330 def (locator, ={}) has_no_selector?(:button, locator, ) end |
#has_no_checked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no radio button or checkbox with the given label, value or id, that is currently checked.
396 397 398 |
# File 'lib/capybara/node/matchers.rb', line 396 def has_no_checked_field?(locator, ={}) has_no_selector?(:field, locator, .merge(:checked => true)) end |
#has_no_css?(path, options = {}) ⇒ Boolean
Checks if a given CSS selector is not on the page or current node. Usage is identical to Capybara::Node::Matchers#has_css?
280 281 282 |
# File 'lib/capybara/node/matchers.rb', line 280 def has_no_css?(path, ={}) has_no_selector?(:css, path, ) end |
#has_no_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no form field with the given label, name or id. See #has_field?.
370 371 372 |
# File 'lib/capybara/node/matchers.rb', line 370 def has_no_field?(locator, ={}) has_no_selector?(:field, locator, ) end |
#has_no_link?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no link with the given text or id.
306 307 308 |
# File 'lib/capybara/node/matchers.rb', line 306 def has_no_link?(locator, ={}) has_no_selector?(:link, locator, ) end |
#has_no_select?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no select field with the given label, name or id. See #has_select?.
466 467 468 |
# File 'lib/capybara/node/matchers.rb', line 466 def has_no_select?(locator, ={}) has_no_selector?(:select, locator, ) end |
#has_no_selector?(*args) ⇒ Boolean
Checks if a given selector is not on the page or current node. Usage is identical to Capybara::Node::Matchers#has_selector?
53 54 55 56 57 |
# File 'lib/capybara/node/matchers.rb', line 53 def has_no_selector?(*args) assert_no_selector(*args) rescue Capybara::ExpectationNotMet return false end |
#has_no_table?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no table with the given id or caption. See #has_table?.
492 493 494 |
# File 'lib/capybara/node/matchers.rb', line 492 def has_no_table?(locator, ={}) has_no_selector?(:table, locator, ) end |
#has_no_text?(type, text, options = {}) ⇒ Boolean #has_no_text?(text, options = {}) ⇒ Boolean Also known as: has_no_content?
Checks if the page or current node does not have the given text content, ignoring any HTML tags and normalizing whitespace.
583 584 585 586 587 |
# File 'lib/capybara/node/matchers.rb', line 583 def has_no_text?(*args) assert_no_text(*args) rescue Capybara::ExpectationNotMet return false end |
#has_no_unchecked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has no radio button or checkbox with the given label, value or id, that is currently unchecked.
422 423 424 |
# File 'lib/capybara/node/matchers.rb', line 422 def has_no_unchecked_field?(locator, ={}) has_no_selector?(:field, locator, .merge(:unchecked => true)) end |
#has_no_xpath?(path, options = {}) ⇒ Boolean
Checks if a given XPath expression is not on the page or current node. Usage is identical to Capybara::Node::Matchers#has_xpath?
241 242 243 |
# File 'lib/capybara/node/matchers.rb', line 241 def has_no_xpath?(path, ={}) has_no_selector?(:xpath, path, ) end |
#has_select?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a select field with the given label, name or id.
It can be specified which option should currently be selected:
page.has_select?('Language', :selected => 'German')
For multiple select boxes, several options may be specified:
page.has_select?('Language', :selected => ['English', 'German'])
It’s also possible to check if the exact set of options exists for this select box:
page.has_select?('Language', :options => ['English', 'German', 'Spanish'])
You can also check for a partial set of options:
page.has_select?('Language', :with_options => ['English', 'German'])
454 455 456 |
# File 'lib/capybara/node/matchers.rb', line 454 def has_select?(locator, ={}) has_selector?(:select, locator, ) end |
#has_selector?(*args) ⇒ Boolean
Checks if a given selector is on the page or current node.
page.has_selector?('p#foo')
page.has_selector?(:xpath, './/p[@id="foo"]')
page.has_selector?(:foo)
By default it will check if the expression occurs at least once, but a different number can be specified.
page.has_selector?('p.foo', :count => 4)
This will check if the expression occurs exactly 4 times.
It also accepts all options that Finders#all accepts, such as :text and :visible.
page.has_selector?('li', :text => 'Horse', :visible => true)
has_selector? can also accept XPath expressions generated by the XPath gem:
page.has_selector?(:xpath, XPath.descendant(:p))
39 40 41 42 43 |
# File 'lib/capybara/node/matchers.rb', line 39 def has_selector?(*args) assert_selector(*args) rescue Capybara::ExpectationNotMet return false end |
#has_table?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a table with the given id or caption:
page.has_table?('People')
480 481 482 |
# File 'lib/capybara/node/matchers.rb', line 480 def has_table?(locator, ={}) has_selector?(:table, locator, ) end |
#has_text?(type, text, options = {}) ⇒ Boolean #has_text?(text, options = {}) ⇒ Boolean Also known as: has_content?
Checks if the page or current node has the given text content, ignoring any HTML tags.
Whitespaces are normalized in both node’s text and passed text parameter. Note that whitespace isn’t normalized in passed regexp as normalizing whitespace in regexp isn’t easy and doesn’t seem to be worth it.
By default it will check if the text occurs at least once, but a different number can be specified.
page.has_text?('lorem ipsum', between: 2..4)
This will check if the text occurs from 2 to 4 times.
569 570 571 572 573 |
# File 'lib/capybara/node/matchers.rb', line 569 def has_text?(*args) assert_text(*args) rescue Capybara::ExpectationNotMet return false end |
#has_unchecked_field?(locator, options = {}) ⇒ Boolean
Checks if the page or current node has a radio button or checkbox with the given label, value or id, that is currently unchecked.
409 410 411 |
# File 'lib/capybara/node/matchers.rb', line 409 def has_unchecked_field?(locator, ={}) has_selector?(:field, locator, .merge(:unchecked => true)) end |
#has_xpath?(path, options = {}) ⇒ Boolean
Checks if a given XPath expression is on the page or current node.
page.has_xpath?('.//p[@id="foo"]')
By default it will check if the expression occurs at least once, but a different number can be specified.
page.has_xpath?('.//p[@id="foo"]', :count => 4)
This will check if the expression occurs exactly 4 times.
It also accepts all options that Finders#all accepts, such as :text and :visible.
page.has_xpath?('.//li', :text => 'Horse', :visible => true)
has_xpath? can also accept XPath expressions generate by the XPath gem:
xpath = XPath.generate { |x| x.descendant(:p) }
page.has_xpath?(xpath)
229 230 231 |
# File 'lib/capybara/node/matchers.rb', line 229 def has_xpath?(path, ={}) has_selector?(:xpath, path, ) end |
#matches_selector?(*args) ⇒ Boolean
Checks if the current node matches given selector Usage is identical to Capybara::Node::Matchers#has_selector?
67 68 69 70 71 |
# File 'lib/capybara/node/matchers.rb', line 67 def matches_selector?(*args) assert_matches_selector(*args) rescue Capybara::ExpectationNotMet return false end |
#not_matches_selector?(*args) ⇒ Boolean
Checks if the current node does not match given selector Usage is identical to Capybara::Node::Matchers#has_selector?
82 83 84 85 86 |
# File 'lib/capybara/node/matchers.rb', line 82 def not_matches_selector?(*args) assert_not_matches_selector(*args) rescue Capybara::ExpectationNotMet return false end |