Module: Capybara::Node::Matchers

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

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Object 



713
714
715
 
# File 'lib/capybara/node/matchers.rb', line 713

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.



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

  • locator (String) —

    The locator for the specified selector

  • options (Hash) —

    a customizable set of options

Raises:



552
553
554
555
556
 
# File 'lib/capybara/node/matchers.rb', line 552

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:



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

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



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

    • :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) — 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

    • :normalize_ws (Boolean) — default: false —

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

Returns:

  • (true)

Raises:



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

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



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 



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

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:



109
110
111
112
113
 
# 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|
    raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count? && (result.any? || query.expects_none?)
  end
end

#assert_style(styles, **options) ⇒ Object

Deprecated. 


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

    • :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) — 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

    • :normalize_ws (Boolean) — default: false —

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

Returns:

  • (true)

Raises:



658
659
660
661
662
663
664
 
# File 'lib/capybara/node/matchers.rb', line 658

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



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

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



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

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



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

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



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

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



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

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



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

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) 


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



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

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



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

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



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

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

Returns:

  • (Boolean) 


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

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

Returns:

  • (Boolean) —

    Whether it doesn’t exist



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

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

    • :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) — 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

    • :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



708
709
710
 
# File 'lib/capybara/node/matchers.rb', line 708

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



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

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) 


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



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

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:

  • 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
 
# File 'lib/capybara/node/matchers.rb', line 39

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

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

Deprecated.

Returns:

  • (Boolean) 


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

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

Returns:

  • (Boolean) —

    Whether it exist



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

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

    • :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) — 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

    • :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



696
697
698
 
# File 'lib/capybara/node/matchers.rb', line 696

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



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

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



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) 


593
594
595
 
# File 'lib/capybara/node/matchers.rb', line 593

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

Returns:

  • (Boolean) 


571
572
573
 
# File 'lib/capybara/node/matchers.rb', line 571

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



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

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) 


582
583
584
 
# File 'lib/capybara/node/matchers.rb', line 582

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) 


627
628
629
 
# File 'lib/capybara/node/matchers.rb', line 627

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

Returns:

  • (Boolean) 


605
606
607
 
# File 'lib/capybara/node/matchers.rb', line 605

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) 


616
617
618
 
# File 'lib/capybara/node/matchers.rb', line 616

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