RubyDoc.info:

Module: Capybara::Node::Matchers

– Documentation for teamcapybara/capybara (master)

– RubyDoc.info (original) (raw)

Instance Method Details

#==(other) ⇒ Object

| 841 842 843 | # File 'lib/capybara/node/matchers.rb', line 841 def ==(other) eql?(other) || (other.respond_to?(:base) && base == other.base) end | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- |

#assert_all_of_selectors([kind = Capybara.default_selector], *locators, **options) ⇒ Object

Asserts that all of the provided selectors are present on the given page or descendants of the current node. If options are provided, the assertion will check that each locator is present with those options as well (other than :wait).

page.assert_all_of_selectors(:custom, 'Tom', 'Joe', visible: all)
page.assert_all_of_selectors(:css, '#my_div', 'a.not_clicked')

It accepts all options that Finders#all accepts, such as :text and :visible.

The :wait option applies to all of the selectors as a group, so all of the locators must be present within :wait (defaults to default_max_wait_time) seconds.

| 159 160 161 162 163 | # File 'lib/capybara/node/matchers.rb', line 159 def assert_all_of_selectors(*args, **options, &optional_filter_block) _verify_multiple(*args, **options) do |selector, locator, opts| assert_selector(selector, locator, opts, &optional_filter_block) end end | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_ancestor(*args, &optional_filter_block) ⇒ Object

Asserts that a given selector matches an ancestor of the current node.

element.assert_ancestor('p#foo')

Accepts the same options as #assert_selector

| 766 767 768 769 770 771 772 | # File 'lib/capybara/node/matchers.rb', line 766 def assert_ancestor(*args, &optional_filter_block) _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query| unless result.matches_count? && (result.any? | | query.expects_none?) raise Capybara::ExpectationNotMet, result.failure_message end end end | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_any_of_selectors([kind = Capybara.default_selector], *locators, **options) ⇒ Object

Asserts that any of the provided selectors are present on the given page or descendants of the current node. If options are provided, the assertion will check that each locator is present with those options as well (other than :wait).

page.assert_any_of_selectors(:custom, 'Tom', 'Joe', visible: all)
page.assert_any_of_selectors(:css, '#my_div', 'a.not_clicked')

It accepts all options that Finders#all accepts, such as :text and :visible.

The :wait option applies to all of the selectors as a group, so any of the locators must be present within :wait (defaults to default_max_wait_time) seconds.

| 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | # File 'lib/capybara/node/matchers.rb', line 201 def assert_any_of_selectors(*args, wait: nil, **options, &optional_filter_block) wait = session_options.default_max_wait_time if wait.nil? selector = (args) synchronize(wait) do res = args.map do |locator| assert_selector(selector, locator, options, &optional_filter_block) break nil rescue Capybara::ExpectationNotMet => e e.message end raise Capybara::ExpectationNotMet, res.join(' or ') if res true end end | | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_matches_selector(*args, &optional_filter_block) ⇒ 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)

| 586 587 588 589 590 | # File 'lib/capybara/node/matchers.rb', line 586 def assert_matches_selector(*args, &optional_filter_block) _verify_match_result(args, optional_filter_block) do |result| raise Capybara::ExpectationNotMet, 'Item does not match the provided selector' unless result.include? self end end | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_matches_style(styles = nil, **options) ⇒ Object

Asserts that an element has the specified CSS styles.

element.assert_matches_style( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )

#assert_no_ancestor(*args, &optional_filter_block) ⇒ Object

| 774 775 776 777 778 779 780 | # File 'lib/capybara/node/matchers.rb', line 774 def assert_no_ancestor(*args, &optional_filter_block) _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query| if result.matches_count? && (!result.empty? | | query.expects_none?) raise Capybara::ExpectationNotMet, result.negative_failure_message end end end | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_no_selector(*args, &optional_filter_block) ⇒ Object

Asserts that a given selector is not on the page or a descendant of the current node. Usage is identical to #assert_selector.

Query options such as :count, :minimum, :maximum, and :between are considered to be an integral part of the selector. This will returntrue, 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

| 233 234 235 236 237 238 239 | # File 'lib/capybara/node/matchers.rb', line 233 def assert_no_selector(*args, &optional_filter_block) _verify_selector_result(args, optional_filter_block) do |result, query| if result.matches_count? && (!result.empty? | | query.expects_none?) raise Capybara::ExpectationNotMet, result.negative_failure_message end end end | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_no_sibling(*args, &optional_filter_block) ⇒ Object

| 817 818 819 820 821 822 823 | # File 'lib/capybara/node/matchers.rb', line 817 def assert_no_sibling(*args, &optional_filter_block) _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query| if result.matches_count? && (!result.empty? | | query.expects_none?) raise Capybara::ExpectationNotMet, result.negative_failure_message end end 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.

| 716 717 718 719 720 721 722 | # File 'lib/capybara/node/matchers.rb', line 716 def assert_no_text(type_or_text, *args, **opts) _verify_text(type_or_text, *args, **opts) do |count, query| if query.matches_count?(count) && (count.positive? | | query.expects_none?) raise Capybara::ExpectationNotMet, query.negative_failure_message end end end | | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_none_of_selectors([kind = Capybara.default_selector], *locators, **options) ⇒ Object

Asserts that none of the provided selectors are present on the given page or descendants of the current node. If options are provided, the assertion will check that each locator is not present with those options as well (other than :wait).

page.assert_none_of_selectors(:custom, 'Tom', 'Joe', visible: all)
page.assert_none_of_selectors(:css, '#my_div', 'a.not_clicked')

It accepts all options that Finders#all accepts, such as :text and :visible.

The :wait option applies to all of the selectors as a group, so none of the locators must be present within :wait (defaults to default_max_wait_time) seconds.

| 180 181 182 183 184 | # File 'lib/capybara/node/matchers.rb', line 180 def assert_none_of_selectors(*args, **options, &optional_filter_block) _verify_multiple(*args, **options) do |selector, locator, opts| assert_no_selector(selector, locator, opts, &optional_filter_block) end end | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_not_matches_selector(*args, &optional_filter_block) ⇒ Object

| 600 601 602 603 604 | # File 'lib/capybara/node/matchers.rb', line 600 def assert_not_matches_selector(*args, &optional_filter_block) _verify_match_result(args, optional_filter_block) do |result| raise Capybara::ExpectationNotMet, 'Item matched the provided selector' if result.include? self end end | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_selector(*args, &optional_filter_block) ⇒ Object

Asserts that a given selector is on the page or a descendant of the 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. SeeFinders#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))

| 109 110 111 112 113 114 115 | # File 'lib/capybara/node/matchers.rb', line 109 def assert_selector(*args, &optional_filter_block) _verify_selector_result(args, optional_filter_block) do |result, query| unless result.matches_count? && (result.any? | | query.expects_none?) raise Capybara::ExpectationNotMet, result.failure_message end end end | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_sibling(*args, &optional_filter_block) ⇒ Object

Asserts that a given selector matches a sibling of the current node.

element.assert_sibling('p#foo')

Accepts the same options as #assert_selector

| 809 810 811 812 813 814 815 | # File 'lib/capybara/node/matchers.rb', line 809 def assert_sibling(*args, &optional_filter_block) _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query| unless result.matches_count? && (result.any? | | query.expects_none?) raise Capybara::ExpectationNotMet, result.failure_message end end end | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#assert_style(styles = nil, **options) ⇒ Object

#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.

| 700 701 702 703 704 705 706 | # File 'lib/capybara/node/matchers.rb', line 700 def assert_text(type_or_text, *args, **opts) _verify_text(type_or_text, *args, **opts) do |count, query| unless query.matches_count?(count) && (count.positive? | | query.expects_none?) raise Capybara::ExpectationNotMet, query.failure_message end end end | | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#has_ancestor?(*args, **options, &optional_filter_block) ⇒ Boolean

#has_button?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has a button with the given text, value or id.

#has_checked_field?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has a radio button or checkbox with the given label, value, id, or test_id attribute that is currently checked.

#has_css?(path, **options, &optional_filter_block) ⇒ Boolean

Checks if a given CSS selector is on the page or a descendant of the 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)

#has_element?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has a element with the given local name.

#has_field?(locator = nil, **options, &optional_filter_block) ⇒ 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 :withoption 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.

#has_link?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has a link with the given text or id.

#has_no_ancestor?(*args, **options, &optional_filter_block) ⇒ Boolean

#has_no_button?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no button with the given text, value or id.

#has_no_checked_field?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no radio button or checkbox with the given label, value or id, or test_id attribute that is currently checked.

#has_no_css?(path, **options, &optional_filter_block) ⇒ Boolean

Checks if a given CSS selector is not on the page or a descendant of the current node. Usage is identical to #has_css?.

#has_no_element?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no element with the given local name.

#has_no_field?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no form field with the given label, name or id. See #has_field?.

#has_no_link?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no link with the given text or id.

#has_no_select?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no select field with the given label, name or id. See #has_select?.

#has_no_selector?(*args, **options, &optional_filter_block) ⇒ Boolean

Checks if a given selector is not on the page or a descendant of the current node. Usage is identical to #has_selector?.

#has_no_sibling?(*args, **options, &optional_filter_block) ⇒ Boolean

#has_no_table?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no table with the given id or caption. See #has_table?.

#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.

#has_no_unchecked_field?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has no radio button or checkbox with the given label, value or id, or test_id attribute that is currently unchecked.

#has_no_xpath?(path, **options, &optional_filter_block) ⇒ Boolean

Checks if a given XPath expression is not on the page or a descendant of the current node. Usage is identical to #has_xpath?.

#has_select?(locator = nil, **options, &optional_filter_block) ⇒ 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'])

#has_selector?(*args, **options, &optional_filter_block) ⇒ Boolean

Checks if a given selector is on the page or a descendant of the 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))

#has_sibling?(*args, **options, &optional_filter_block) ⇒ Boolean

#has_style?(styles = nil, **options) ⇒ Boolean

#has_table?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has a table with the given id or caption:

page.has_table?('People')

#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.

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.

#has_unchecked_field?(locator = nil, **options, &optional_filter_block) ⇒ Boolean

Checks if the page or current node has a radio button or checkbox with the given label, value or id, or test_id attribute that is currently unchecked.

#has_xpath?(path, **options, &optional_filter_block) ⇒ Boolean

Checks if a given XPath expression is on the page or a descendant of the 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 generated by the XPath gem:

xpath = XPath.generate { |x| x.descendant(:p) }
page.has_xpath?(xpath)

#matches_css?(css, **options, &optional_filter_block) ⇒ Boolean

Checks if the current node matches given CSS selector.

#matches_selector?(*args, **options, &optional_filter_block) ⇒ Boolean

Checks if the current node matches given selector.

#matches_style?(styles = nil, **options) ⇒ Boolean

Checks if a an element has the specified CSS styles.

element.matches_style?( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )

#matches_xpath?(xpath, **options, &optional_filter_block) ⇒ Boolean

Checks if the current node matches given XPath expression.

#not_matches_css?(css, **options, &optional_filter_block) ⇒ Boolean

Checks if the current node does not match given CSS selector.

#not_matches_selector?(*args, **options, &optional_filter_block) ⇒ Boolean

Checks if the current node does not match given selector. Usage is identical to #has_selector?.

#not_matches_xpath?(xpath, **options, &optional_filter_block) ⇒ Boolean

Checks if the current node does not match given XPath expression.