Module: Capybara::Node::Matchers

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

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Object


810
811
812
# File 'lib/capybara/node/matchers.rb', line 810

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.


155
156
157
158
159
# File 'lib/capybara/node/matchers.rb', line 155

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

Parameters:

  • options (Hash)

    a customizable set of options

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:


739
740
741
742
743
# File 'lib/capybara/node/matchers.rb', line 739

def assert_ancestor(*args, &optional_filter_block)
  _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query|
    raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count? && (result.any? || query.expects_none?)
  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.


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/capybara/node/matchers.rb', line 197

def assert_any_of_selectors(*args, wait: nil, **options, &optional_filter_block)
  wait = session_options.default_max_wait_time if wait.nil?
  selector = extract_selector(args)
  synchronize(wait) do
    res = args.map do |locator|
      begin
        assert_selector(selector, locator, options, &optional_filter_block)
        break nil
      rescue Capybara::ExpectationNotMet => e
        e.message
      end
    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)

Parameters:

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:


559
560
561
562
563
# File 'lib/capybara/node/matchers.rb', line 559

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, **options) ⇒ Object

Asserts that an element has the specified CSS styles.

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

Parameters:

  • styles (Hash)

Raises:


123
124
125
126
127
128
129
130
# File 'lib/capybara/node/matchers.rb', line 123

def assert_matches_style(styles, **options)
  query_args = _set_query_session_options(styles, options)
  query = Capybara::Queries::StyleQuery.new(*query_args)
  synchronize(query.wait) do
    raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
  end
  true
end

#assert_no_ancestor(*args, &optional_filter_block) ⇒ Object


745
746
747
748
749
750
751
# File 'lib/capybara/node/matchers.rb', line 745

def assert_no_ancestor(*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_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 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

Parameters:

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:


231
232
233
234
235
236
237
# File 'lib/capybara/node/matchers.rb', line 231

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


786
787
788
789
790
791
792
# File 'lib/capybara/node/matchers.rb', line 786

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.

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

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

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

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

Returns:

  • (true)

Raises:


689
690
691
692
693
694
695
# File 'lib/capybara/node/matchers.rb', line 689

def assert_no_text(*args)
  _verify_text(args) 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.


176
177
178
179
180
# File 'lib/capybara/node/matchers.rb', line 176

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

Asserts that the current node does not match a given selector. Usage is identical to #assert_matches_selector.

Parameters:

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:


573
574
575
576
577
# File 'lib/capybara/node/matchers.rb', line 573

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:


108
109
110
111
112
# File 'lib/capybara/node/matchers.rb', line 108

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

Parameters:

  • options (Hash)

    a customizable set of options

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Raises:


780
781
782
783
784
# File 'lib/capybara/node/matchers.rb', line 780

def assert_sibling(*args, &optional_filter_block)
  _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|
    raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count? && (result.any? || query.expects_none?)
  end
end

#assert_style(styles, **options) ⇒ Object

Deprecated.

Use #assert_matches_style instead.


135
136
137
138
# File 'lib/capybara/node/matchers.rb', line 135

def assert_style(styles, **options)
  warn 'assert_style is deprecated, please use assert_matches_style instead'
  assert_matches_style(styles, **options)
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 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)

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

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

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

Returns:

  • (true)

Raises:


673
674
675
676
677
678
679
# File 'lib/capybara/node/matchers.rb', line 673

def assert_text(*args)
  _verify_text(args) 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

Predicate version of #assert_ancestor

Returns:

  • (Boolean)

757
758
759
# File 'lib/capybara/node/matchers.rb', line 757

def has_ancestor?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_ancestor(*args, options, &optional_filter_block) }
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


356
357
358
# File 'lib/capybara/node/matchers.rb', line 356

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

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of a checked field

Returns:

  • (Boolean)

    Whether it exists


421
422
423
# File 'lib/capybara/node/matchers.rb', line 421

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


307
308
309
# File 'lib/capybara/node/matchers.rb', line 307

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


394
395
396
# File 'lib/capybara/node/matchers.rb', line 394

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 (Hash)

    a customizable set of options

Options Hash (**options):

  • :href (String, Regexp)

    The value the href attribute must be

Returns:

  • (Boolean)

    Whether it exists


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

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

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

Predicate version of #assert_no_ancestor

Returns:

  • (Boolean)

765
766
767
# File 'lib/capybara/node/matchers.rb', line 765

def has_no_ancestor?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_no_ancestor(*args, 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


368
369
370
# File 'lib/capybara/node/matchers.rb', line 368

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, or test_id attribute 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


434
435
436
# File 'lib/capybara/node/matchers.rb', line 434

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

Parameters:

  • path (String)

    A CSS selector

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

319
320
321
# File 'lib/capybara/node/matchers.rb', line 319

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


408
409
410
# File 'lib/capybara/node/matchers.rb', line 408

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.

Parameters:

  • locator (String) (defaults to: nil)

    The text or id of a link to check for

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

    Whether it doesn't exist


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

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


505
506
507
# File 'lib/capybara/node/matchers.rb', line 505

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

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

Parameters:

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

50
51
52
# File 'lib/capybara/node/matchers.rb', line 50

def has_no_selector?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_no_selector(*args, options, &optional_filter_block) }
end

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

Predicate version of #assert_no_sibling

Returns:

  • (Boolean)

806
807
808
# File 'lib/capybara/node/matchers.rb', line 806

def has_no_sibling?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_no_sibling(*args, options, &optional_filter_block) }
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

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

    Whether it doesn't exist


539
540
541
# File 'lib/capybara/node/matchers.rb', line 539

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

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

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

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

Returns:

  • (Boolean)

    Whether it doesn't exist


723
724
725
# File 'lib/capybara/node/matchers.rb', line 723

def has_no_text?(*args, **options)
  make_predicate(options) { assert_no_text(*args, options) }
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, or test_id attribute 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


460
461
462
# File 'lib/capybara/node/matchers.rb', line 460

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

Parameters:

  • path (String)

    An XPath expression

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

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

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


493
494
495
# File 'lib/capybara/node/matchers.rb', line 493

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

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

Parameters:

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • :count (Integer) — default: nil

    Number of matching elements that should exist

  • :minimum (Integer) — default: nil

    Minimum number of matching elements that should exist

  • :maximum (Integer) — default: nil

    Maximum number of matching elements that should exist

  • :between (Range) — default: nil

    Range of number of matching elements that should exist

Returns:

  • (Boolean)

    If the expression exists


38
39
40
# File 'lib/capybara/node/matchers.rb', line 38

def has_selector?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_selector(*args, options, &optional_filter_block) }
end

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

Predicate version of #assert_sibling

Returns:

  • (Boolean)

798
799
800
# File 'lib/capybara/node/matchers.rb', line 798

def has_sibling?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_sibling(*args, options, &optional_filter_block) }
end

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

Deprecated.

Use #matches_style? instead.

Returns:

  • (Boolean)

70
71
72
73
# File 'lib/capybara/node/matchers.rb', line 70

def has_style?(styles, **options)
  warn 'DEPRECATED: has_style? is deprecated, please use matches_style?'
  matches_style?(styles, **options)
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

  • options (Hash)

    a customizable set of options

Options Hash (**options):

  • :rows (Array<Array<String>>)

    Text which should be contained in the tables <td> elements organized by row (<td> visibility is not considered)

  • :with_rows (Array<Array<String>>, Array<Hash<String,String>>)

    Partial set of text which should be contained in the tables <td> elements organized by row (<td> visibility is not considered)

  • :cols (Array<Array<String>>)

    Text which should be contained in the tables <td> elements organized by column (<td> visibility is not considered)

  • :with_cols (Array<Array<String>>, Array<Hash<String,String>>)

    Partial set of text which should be contained in the tables <td> elements organized by column (<td> visibility is not considered)

Returns:

  • (Boolean)

    Whether it exists


527
528
529
# File 'lib/capybara/node/matchers.rb', line 527

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

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

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

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

    • :exact (Boolean)

      Whether text must be an exact match or just substring. Defaults to exact_text.

    • :normalize_ws (Boolean) — default: false

      When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space

Returns:

  • (Boolean)

    Whether it exists


711
712
713
# File 'lib/capybara/node/matchers.rb', line 711

def has_text?(*args, **options)
  make_predicate(options) { assert_text(*args, options) }
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, or test_id attribute that is currently unchecked.

Parameters:

  • locator (String) (defaults to: nil)

    The label, name or id of an unchecked field

Returns:

  • (Boolean)

    Whether it exists


447
448
449
# File 'lib/capybara/node/matchers.rb', line 447

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 generated 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


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

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)

608
609
610
# File 'lib/capybara/node/matchers.rb', line 608

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

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

Checks if the current node matches given selector.

Parameters:

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

586
587
588
# File 'lib/capybara/node/matchers.rb', line 586

def matches_selector?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_matches_selector(*args, options, &optional_filter_block) }
end

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

Checks if a an element has the specified CSS styles.

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

Parameters:

  • styles (Hash)

Returns:

  • (Boolean)

    If the styles match


63
64
65
# File 'lib/capybara/node/matchers.rb', line 63

def matches_style?(styles, **options)
  make_predicate(options) { assert_matches_style(styles, options) }
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)

597
598
599
# File 'lib/capybara/node/matchers.rb', line 597

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)

642
643
644
# File 'lib/capybara/node/matchers.rb', line 642

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

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

Parameters:

  • kind (Symbol)

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

  • locator (String)

    The locator for the specified selector

  • options (Hash)

    a customizable set of options

Returns:

  • (Boolean)

620
621
622
# File 'lib/capybara/node/matchers.rb', line 620

def not_matches_selector?(*args, **options, &optional_filter_block)
  make_predicate(options) { assert_not_matches_selector(*args, options, &optional_filter_block) }
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)

631
632
633
# File 'lib/capybara/node/matchers.rb', line 631

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