Module: Capybara::Node::Matchers

Included in:
Base, Simple
Defined in:
lib/capybara/node/matchers.rb

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Object



656
657
658
# File 'lib/capybara/node/matchers.rb', line 656

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 Capybara.default_max_wait_time) seconds.



115
116
117
118
119
120
121
122
123
# File 'lib/capybara/node/matchers.rb', line 115

def assert_all_of_selectors(*args, wait: nil, **options, &optional_filter_block)
  wait = session_options.default_max_wait_time if wait.nil?
  selector = args.first.is_a?(Symbol) ? args.shift : session_options.default_selector
  synchronize(wait) do
    args.each do |locator|
      assert_selector(selector, locator, options, &optional_filter_block)
    end
  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)

Parameters:

  • kind (Symbol)

    Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:



488
489
490
491
492
# File 'lib/capybara/node/matchers.rb', line 488

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_no_selector(*args, &optional_filter_block) ⇒ Object Also known as: refute_selector

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

Raises:



166
167
168
169
170
171
172
# File 'lib/capybara/node/matchers.rb', line 166

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

Overloads:

  • #assert_no_text(type, text, options = {}) ⇒ true

    Parameters:

    • type (:all, :visible)

      Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of `Capybara.ignore_hidden_elements`, which defaults to `true`, corresponding to `:visible`.

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

  • #assert_no_text(text, options = {}) ⇒ true

    Parameters:

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

Returns:

  • (true)

Raises:



613
614
615
616
617
618
619
# File 'lib/capybara/node/matchers.rb', line 613

def assert_no_text(*args)
  _verify_text(args) do |count, query|
    if query.matches_count?(count) && ((count > 0) || 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 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 Capybara.default_max_wait_time) seconds.



140
141
142
143
144
145
146
147
148
# File 'lib/capybara/node/matchers.rb', line 140

def assert_none_of_selectors(*args, wait: nil, **options, &optional_filter_block)
  wait = session_options.default_max_wait_time if wait.nil?
  selector = args.first.is_a?(Symbol) ? args.shift : session_options.default_selector
  synchronize(wait) do
    args.each do |locator|
      assert_no_selector(selector, locator, options, &optional_filter_block)
    end
  end
end

#assert_not_matches_selector(*args, &optional_filter_block) ⇒ Object Also known as: refute_matches_selector



494
495
496
497
498
# File 'lib/capybara/node/matchers.rb', line 494

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

Parameters:

  • kind (Symbol)

    Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:



92
93
94
95
96
97
98
# File 'lib/capybara/node/matchers.rb', line 92

def assert_selector(*args, &optional_filter_block)
  _verify_selector_result(args, optional_filter_block) do |result, query|
    unless result.matches_count? && (!result.empty? || query.expects_none?)
      raise Capybara::ExpectationNotMet, result.failure_message
    end
  end
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.

Overloads:

  • #assert_text(type, text, options = {}) ⇒ true

    Parameters:

    • type (:all, :visible)

      Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of `Capybara.ignore_hidden_elements`, which defaults to `true`, corresponding to `:visible`.

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

  • #assert_text(text, options = {}) ⇒ true

    Parameters:

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

Returns:

  • (true)

Raises:



597
598
599
600
601
602
603
# File 'lib/capybara/node/matchers.rb', line 597

def assert_text(*args)
  _verify_text(args) do |count, query|
    unless query.matches_count?(count) && ((count > 0) || query.expects_none?)
      raise Capybara::ExpectationNotMet, query.failure_message
    end
  end
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The text, value or id of a button to check for

Returns:

  • (Boolean)

    Whether it exists



293
294
295
# File 'lib/capybara/node/matchers.rb', line 293

def has_button?(locator = nil, **options, &optional_filter_block)
  has_selector?(:button, locator, options, &optional_filter_block)
end

#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 or id, that is currently checked.

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of a checked field

Returns:

  • (Boolean)

    Whether it exists



358
359
360
# File 'lib/capybara/node/matchers.rb', line 358

def has_checked_field?(locator = nil, **options, &optional_filter_block)
  has_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
end

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

Parameters:

  • path (String)

    A CSS selector

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • :count (Integer) — default: nil

    Number of times the selector should occur

Returns:

  • (Boolean)

    If the selector exists



243
244
245
# File 'lib/capybara/node/matchers.rb', line 243

def has_css?(path, **options, &optional_filter_block)
  has_selector?(:css, path, options, &optional_filter_block)
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of a field to check for

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • :with (String, Regexp)

    The text content of the field or a Regexp to match

  • :type (String)

    The type attribute of the field

Returns:

  • (Boolean)

    Whether it exists



331
332
333
# File 'lib/capybara/node/matchers.rb', line 331

def has_field?(locator = nil, **options, &optional_filter_block)
  has_selector?(:field, locator, options, &optional_filter_block)
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The text or id of a link to check for

  • options

Options Hash (**options):

  • :href (String, Regexp)

    The value the href attribute must be

Returns:

  • (Boolean)

    Whether it exists



269
270
271
# File 'lib/capybara/node/matchers.rb', line 269

def has_link?(locator = nil, **options, &optional_filter_block)
  has_selector?(:link, locator, options, &optional_filter_block)
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The text, value or id of a button to check for

Returns:

  • (Boolean)

    Whether it doesn't exist



305
306
307
# File 'lib/capybara/node/matchers.rb', line 305

def has_no_button?(locator = nil, **options, &optional_filter_block)
  has_no_selector?(:button, locator, options, &optional_filter_block)
end

#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, that is currently checked.

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of a checked field

Returns:

  • (Boolean)

    Whether it doesn't exist



371
372
373
# File 'lib/capybara/node/matchers.rb', line 371

def has_no_checked_field?(locator = nil, **options, &optional_filter_block)
  has_no_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
end

#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 Capybara::Node::Matchers#has_css?

Returns:

  • (Boolean)


255
256
257
# File 'lib/capybara/node/matchers.rb', line 255

def has_no_css?(path, **options, &optional_filter_block)
  has_no_selector?(:css, path, options, &optional_filter_block)
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of a field to check for

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • :with (String, Regexp)

    The text content of the field or a Regexp to match

  • :type (String)

    The type attribute of the field

Returns:

  • (Boolean)

    Whether it doesn't exist



345
346
347
# File 'lib/capybara/node/matchers.rb', line 345

def has_no_field?(locator = nil, **options, &optional_filter_block)
  has_no_selector?(:field, locator, options, &optional_filter_block)
end

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

Returns:

  • (Boolean)

    Whether it doesn't exist



281
282
283
# File 'lib/capybara/node/matchers.rb', line 281

def has_no_link?(locator = nil, **options, &optional_filter_block)
  has_no_selector?(:link, locator, options, &optional_filter_block)
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of a select box

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

    Whether it doesn't exist



442
443
444
# File 'lib/capybara/node/matchers.rb', line 442

def has_no_select?(locator = nil, **options, &optional_filter_block)
  has_no_selector?(:select, locator, options, &optional_filter_block)
end

#has_no_selector?(*args, &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 Capybara::Node::Matchers#has_selector?

Returns:

  • (Boolean)


53
54
55
56
57
# File 'lib/capybara/node/matchers.rb', line 53

def has_no_selector?(*args, &optional_filter_block)
  assert_no_selector(*args, &optional_filter_block)
rescue Capybara::ExpectationNotMet
  false
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The id or caption of a table

Returns:

  • (Boolean)

    Whether it doesn't exist



468
469
470
# File 'lib/capybara/node/matchers.rb', line 468

def has_no_table?(locator = nil, **options, &optional_filter_block)
  has_no_selector?(:table, locator, options, &optional_filter_block)
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.

Overloads:

  • #has_no_text?(type, text, options = {}) ⇒ Boolean

    Parameters:

    • type (:all, :visible)

      Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of `Capybara.ignore_hidden_elements`, which defaults to `true`, corresponding to `:visible`.

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

  • #has_no_text?(text, options = {}) ⇒ Boolean

    Parameters:

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

Returns:

  • (Boolean)

    Whether it doesn't exist



649
650
651
652
653
# File 'lib/capybara/node/matchers.rb', line 649

def has_no_text?(*args)
  assert_no_text(*args)
rescue Capybara::ExpectationNotMet
  false
end

#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, that is currently unchecked.

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of an unchecked field

Returns:

  • (Boolean)

    Whether it doesn't exist



397
398
399
# File 'lib/capybara/node/matchers.rb', line 397

def has_no_unchecked_field?(locator = nil, **options, &optional_filter_block)
  has_no_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
end

#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 Capybara::Node::Matchers#has_xpath?

Returns:

  • (Boolean)


216
217
218
# File 'lib/capybara/node/matchers.rb', line 216

def has_no_xpath?(path, **options, &optional_filter_block)
  has_no_selector?(:xpath, path, options, &optional_filter_block)
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of a select box

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • :options (Array)

    Options which should be contained in this select box

  • :with_options (Array)

    Partial set of options which should be contained in this select box

  • :selected (String, Array)

    Options which should be selected

  • :with_selected (String, Array)

    Partial set of options which should minimally be selected

Returns:

  • (Boolean)

    Whether it exists



430
431
432
# File 'lib/capybara/node/matchers.rb', line 430

def has_select?(locator = nil, **options, &optional_filter_block)
  has_selector?(:select, locator, options, &optional_filter_block)
end

#has_selector?(*args, &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))

Parameters:

  • args
  • kind (Symbol)

    Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Options Hash (*args):

  • :count (Integer) — default: nil

    Number of times the text should occur

  • :minimum (Integer) — default: nil

    Minimum number of times the text should occur

  • :maximum (Integer) — default: nil

    Maximum number of times the text should occur

  • :between (Range) — default: nil

    Range of times that should contain number of times text occurs

Returns:

  • (Boolean)

    If the expression exists



39
40
41
42
43
# File 'lib/capybara/node/matchers.rb', line 39

def has_selector?(*args, &optional_filter_block)
  assert_selector(*args, &optional_filter_block)
rescue Capybara::ExpectationNotMet
  false
end

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

Parameters:

  • locator (String) (defaults to: nil)

    The id or caption of a table

Returns:

  • (Boolean)

    Whether it exist



456
457
458
# File 'lib/capybara/node/matchers.rb', line 456

def has_table?(locator = nil, **options, &optional_filter_block)
  has_selector?(:table, locator, options, &optional_filter_block)
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.

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.

Overloads:

  • #has_text?(type, text, options = {}) ⇒ Boolean

    Parameters:

    • type (:all, :visible)

      Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of `Capybara.ignore_hidden_elements`, which defaults to `true`, corresponding to `:visible`.

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

  • #has_text?(text, options = {}) ⇒ Boolean

    Parameters:

    • text (String, Regexp)

      The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.

    Options Hash (options):

    • :count (Integer) — default: nil

      Number of times the text is expected to occur

    • :minimum (Integer) — default: nil

      Minimum number of times the text is expected to occur

    • :maximum (Integer) — default: nil

      Maximum number of times the text is expected to occur

    • :between (Range) — default: nil

      Range of times that is expected to contain number of times text occurs

    • :wait (Numeric) — default: Capybara.default_max_wait_time

      Maximum time that Capybara will wait for text to eq/match given string/regexp argument

    • :exact (Boolean) — default: Capybara.exact_text

      Whether text must be an exact match or just substring

Returns:

  • (Boolean)

    Whether it exists



635
636
637
638
639
# File 'lib/capybara/node/matchers.rb', line 635

def has_text?(*args)
  assert_text(*args)
rescue Capybara::ExpectationNotMet
  false
end

#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, that is currently unchecked.

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of an unchecked field

Returns:

  • (Boolean)

    Whether it exists



384
385
386
# File 'lib/capybara/node/matchers.rb', line 384

def has_unchecked_field?(locator = nil, **options, &optional_filter_block)
  has_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
end

#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 generate by the XPath gem:

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

Parameters:

  • path (String)

    An XPath expression

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • :count (Integer) — default: nil

    Number of times the expression should occur

Returns:

  • (Boolean)

    If the expression exists



204
205
206
# File 'lib/capybara/node/matchers.rb', line 204

def has_xpath?(path, **options, &optional_filter_block)
  has_selector?(:xpath, path, options, &optional_filter_block)
end

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

Checks if the current node matches given CSS selector

Parameters:

  • css (String)

    The CSS selector to match against the current code

Returns:

  • (Boolean)


532
533
534
# File 'lib/capybara/node/matchers.rb', line 532

def matches_css?(css, **options, &optional_filter_block)
  matches_selector?(:css, css, options, &optional_filter_block)
end

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

Checks if the current node matches given selector

Returns:

  • (Boolean)


508
509
510
511
512
# File 'lib/capybara/node/matchers.rb', line 508

def matches_selector?(*args, &optional_filter_block)
  assert_matches_selector(*args, &optional_filter_block)
rescue Capybara::ExpectationNotMet
  return false
end

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

Checks if the current node matches given XPath expression

Parameters:

  • xpath (String, XPath::Expression)

    The XPath expression to match against the current code

Returns:

  • (Boolean)


521
522
523
# File 'lib/capybara/node/matchers.rb', line 521

def matches_xpath?(xpath, **options, &optional_filter_block)
  matches_selector?(:xpath, xpath, options, &optional_filter_block)
end

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

Checks if the current node does not match given CSS selector

Parameters:

  • css (String)

    The CSS selector to match against the current code

Returns:

  • (Boolean)


568
569
570
# File 'lib/capybara/node/matchers.rb', line 568

def not_matches_css?(css, **options, &optional_filter_block)
  not_matches_selector?(:css, css, options, &optional_filter_block)
end

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

Checks if the current node does not match given selector Usage is identical to Capybara::Node::Matchers#has_selector?

Returns:

  • (Boolean)


544
545
546
547
548
# File 'lib/capybara/node/matchers.rb', line 544

def not_matches_selector?(*args, &optional_filter_block)
  assert_not_matches_selector(*args, &optional_filter_block)
rescue Capybara::ExpectationNotMet
  return false
end

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

Checks if the current node does not match given XPath expression

Parameters:

  • xpath (String, XPath::Expression)

    The XPath expression to match against the current code

Returns:

  • (Boolean)


557
558
559
# File 'lib/capybara/node/matchers.rb', line 557

def not_matches_xpath?(xpath, **options, &optional_filter_block)
  not_matches_selector?(:xpath, xpath, options, &optional_filter_block)
end