Module: Capybara::Node::Matchers

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

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Object



523
524
525
# File 'lib/capybara/node/matchers.rb', line 523

def ==(other)
  self.eql?(other) || (other.respond_to?(:base) && base == other.base)
end

#assert_no_selector(*args) ⇒ Object Also known as: refute_selector

Asserts that a given selector is not on the page or current node. Usage is identical to Capybara::Node::Matchers#assert_selector

Query options such as :count, :minimum, :maximum, and :between are considered to be an integral part of the selector. This will return true, for example, if a page contains 4 anchors but the query expects 5:

page.assert_no_selector('a', :minimum => 1) # Found, raises Capybara::ExpectationNotMet
page.assert_no_selector('a', :count => 4)   # Found, raises Capybara::ExpectationNotMet
page.assert_no_selector('a', :count => 5)   # Not Found, returns true

Raises:



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

def assert_no_selector(*args)
  query = Capybara::Query.new(*args)
  synchronize(query.wait) do
    result = query.resolve_for(self)
    matches_count = Capybara::Helpers.matches_count?(result.size, query.options)
    if matches_count && ((result.size > 0) || Capybara::Helpers.expects_none?(query.options))
      raise Capybara::ExpectationNotMet, result.negative_failure_message
    end
  end
  return true
end

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

Asserts that the page or current node doesn't have the given text content, ignoring any HTML tags.

Overloads:

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

    Parameters:

    • type (:all, :visible)

      Whether to check for only visible or all text

    • 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

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

Returns:

  • (true)

Raises:



472
473
474
475
476
477
478
479
480
481
482
# File 'lib/capybara/node/matchers.rb', line 472

def assert_no_text(*args)
  query = Capybara::Queries::TextQuery.new(*args)
  synchronize(query.wait) do
    count = query.resolve_for(self)
    matches_count = Capybara::Helpers.matches_count?(count, query.options)
    if matches_count && ((count > 0) || Capybara::Helpers.expects_none?(query.options))
      raise Capybara::ExpectationNotMet, query.negative_failure_message
    end
  end
  return true
end

#assert_selector(*args) ⇒ Object

Asserts that a given selector is on the page or current node.

page.assert_selector('p#foo')
page.assert_selector(:xpath, './/p[@id="foo"]')
page.assert_selector(:foo)

By default it will check if the expression occurs at least once, but a different number can be specified.

page.assert_selector('p#foo', :count => 4)

This will check if the expression occurs exactly 4 times. See Finders#all for other available result size options.

If a :count of 0 is specified, it will behave like #assert_no_selector; however, use of that method is preferred over this one.

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

page.assert_selector('li', :text => 'Horse', :visible => true)

`assert_selector` can also accept XPath expressions generated by the XPath gem:

page.assert_selector(:xpath, XPath.descendant(:p))

Parameters:

  • options (Hash)

    a customizable set of options

Raises:



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

def assert_selector(*args)
  query = Capybara::Query.new(*args)
  synchronize(query.wait) do
    result = query.resolve_for(self)
    matches_count = Capybara::Helpers.matches_count?(result.size, query.options)
    unless matches_count && ((result.size > 0) || Capybara::Helpers.expects_none?(query.options))
      raise Capybara::ExpectationNotMet, result.failure_message
    end
  end
  return true
end

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

Asserts that the page or current node has the given text content, ignoring any HTML tags.

Overloads:

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

    Parameters:

    • type (:all, :visible)

      Whether to check for only visible or all text

    • 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

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

Returns:

  • (true)

Raises:



452
453
454
455
456
457
458
459
460
461
462
# File 'lib/capybara/node/matchers.rb', line 452

def assert_text(*args)
  query = Capybara::Queries::TextQuery.new(*args)
  synchronize(query.wait) do
    count = query.resolve_for(self)
    matches_count = Capybara::Helpers.matches_count?(count, query.options)
    unless matches_count && ((count > 0) || Capybara::Helpers.expects_none?(query.options))
      raise Capybara::ExpectationNotMet, query.failure_message
    end
  end
  return true
end

#has_button?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

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

Returns:

  • (Boolean)

    Whether it exists



251
252
253
# File 'lib/capybara/node/matchers.rb', line 251

def has_button?(locator, options={})
  has_selector?(:button, locator, options)
end

#has_checked_field?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

    The label, name or id of a checked field

Returns:

  • (Boolean)

    Whether it exists



316
317
318
# File 'lib/capybara/node/matchers.rb', line 316

def has_checked_field?(locator, options={})
  has_selector?(:field, locator, options.merge(:checked => true))
end

#has_css?(path, options = {}) ⇒ Boolean

Checks if a given CSS selector is on the page or current node.

page.has_css?('p#foo')

By default it will check if the selector occurs at least once, but a different number can be specified.

page.has_css?('p#foo', :count => 4)

This will check if the selector occurs exactly 4 times.

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

page.has_css?('li', :text => 'Horse', :visible => true)

Parameters:

  • path (String)

    A CSS selector

  • options (Hash) (defaults to: {})

    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



201
202
203
# File 'lib/capybara/node/matchers.rb', line 201

def has_css?(path, options={})
  has_selector?(:css, path, options)
end

#has_field?(locator, options = {}) ⇒ Boolean

Checks if the page or current node has a form field with the given label, name or id.

For text fields and other textual fields, such as textareas and HTML5 email/url/etc. fields, it's possible to specify a :with option to specify the text the field should contain:

page.has_field?('Name', :with => 'Jonas')

It is also possible to filter by the field type attribute:

page.has_field?('Email', :type => 'email')

Note: 'textarea' and 'select' are valid type values, matching the associated tag names.

Parameters:

  • locator (String)

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

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :with (String)

    The text content of the field

  • :type (String)

    The type attribute of the field

Returns:

  • (Boolean)

    Whether it exists



289
290
291
# File 'lib/capybara/node/matchers.rb', line 289

def has_field?(locator, options={})
  has_selector?(:field, locator, options)
end

#has_link?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

    The text or id of a link to check for

  • options (defaults to: {})

Options Hash (options):

  • :href (String, Regexp)

    The value the href attribute must be

Returns:

  • (Boolean)

    Whether it exists



227
228
229
# File 'lib/capybara/node/matchers.rb', line 227

def has_link?(locator, options={})
  has_selector?(:link, locator, options)
end

#has_no_button?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

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

Returns:

  • (Boolean)

    Whether it doesn't exist



263
264
265
# File 'lib/capybara/node/matchers.rb', line 263

def has_no_button?(locator, options={})
  has_no_selector?(:button, locator, options)
end

#has_no_checked_field?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

    The label, name or id of a checked field

Returns:

  • (Boolean)

    Whether it doesn't exist



329
330
331
# File 'lib/capybara/node/matchers.rb', line 329

def has_no_checked_field?(locator, options={})
  has_no_selector?(:field, locator, options.merge(:checked => true))
end

#has_no_css?(path, options = {}) ⇒ Boolean

Checks if a given CSS selector is not on the page or current node. Usage is identical to Capybara::Node::Matchers#has_css?

Returns:

  • (Boolean)


213
214
215
# File 'lib/capybara/node/matchers.rb', line 213

def has_no_css?(path, options={})
  has_no_selector?(:css, path, options)
end

#has_no_field?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

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

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :with (String)

    The text content of the field

  • :type (String)

    The type attribute of the field

Returns:

  • (Boolean)

    Whether it doesn't exist



303
304
305
# File 'lib/capybara/node/matchers.rb', line 303

def has_no_field?(locator, options={})
  has_no_selector?(:field, locator, options)
end

#has_no_link?(locator, options = {}) ⇒ Boolean

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

Returns:

  • (Boolean)

    Whether it doesn't exist



239
240
241
# File 'lib/capybara/node/matchers.rb', line 239

def has_no_link?(locator, options={})
  has_no_selector?(:link, locator, options)
end

#has_no_select?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

    The label, name or id of a select box

  • options (Hash) (defaults to: {})

    a customizable set of options

Returns:

  • (Boolean)

    Whether it doesn't exist



399
400
401
# File 'lib/capybara/node/matchers.rb', line 399

def has_no_select?(locator, options={})
  has_no_selector?(:select, locator, options)
end

#has_no_selector?(*args) ⇒ Boolean

Checks if a given selector is not on the page or current node. Usage is identical to Capybara::Node::Matchers#has_selector?

Returns:

  • (Boolean)


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

def has_no_selector?(*args)
  assert_no_selector(*args)
rescue Capybara::ExpectationNotMet
  return false
end

#has_no_table?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

    The id or caption of a table

Returns:

  • (Boolean)

    Whether it doesn't exist



425
426
427
# File 'lib/capybara/node/matchers.rb', line 425

def has_no_table?(locator, options={})
  has_no_selector?(:table, locator, options)
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

    • 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

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

Returns:

  • (Boolean)

    Whether it doesn't exist



516
517
518
519
520
# File 'lib/capybara/node/matchers.rb', line 516

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

#has_no_unchecked_field?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

    The label, name or id of an unchecked field

Returns:

  • (Boolean)

    Whether it doesn't exist



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

def has_no_unchecked_field?(locator, options={})
  has_no_selector?(:field, locator, options.merge(:unchecked => true))
end

#has_no_xpath?(path, options = {}) ⇒ Boolean

Checks if a given XPath expression is not on the page or current node. Usage is identical to Capybara::Node::Matchers#has_xpath?

Returns:

  • (Boolean)


174
175
176
# File 'lib/capybara/node/matchers.rb', line 174

def has_no_xpath?(path, options={})
  has_no_selector?(:xpath, path, options)
end

#has_select?(locator, options = {}) ⇒ Boolean

Checks if the page or current node has a select field with the given label, name or id.

It can be specified which option should currently be selected:

page.has_select?('Language', :selected => 'German')

For multiple select boxes, several options may be specified:

page.has_select?('Language', :selected => ['English', 'German'])

It's also possible to check if the exact set of options exists for this select box:

page.has_select?('Language', :options => ['English', 'German', 'Spanish'])

You can also check for a partial set of options:

page.has_select?('Language', :with_options => ['English', 'German'])

Parameters:

  • locator (String)

    The label, name or id of a select box

  • options (Hash) (defaults to: {})

    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

Returns:

  • (Boolean)

    Whether it exists



387
388
389
# File 'lib/capybara/node/matchers.rb', line 387

def has_select?(locator, options={})
  has_selector?(:select, locator, options)
end

#has_selector?(*args) ⇒ Boolean

Checks if a given selector is on the page or current node.

page.has_selector?('p#foo')
page.has_selector?(:xpath, './/p[@id="foo"]')
page.has_selector?(:foo)

By default it will check if the expression occurs at least once, but a different number can be specified.

page.has_selector?('p.foo', :count => 4)

This will check if the expression occurs exactly 4 times.

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

page.has_selector?('li', :text => 'Horse', :visible => true)

has_selector? can also accept XPath expressions generated by the XPath gem:

page.has_selector?(:xpath, XPath.descendant(:p))

Parameters:

  • args

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)
  assert_selector(*args)
rescue Capybara::ExpectationNotMet
  return false
end

#has_table?(locator, options = {}) ⇒ Boolean

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

page.has_table?('People')

Parameters:

  • locator (String)

    The id or caption of a table

Returns:

  • (Boolean)

    Whether it exist



413
414
415
# File 'lib/capybara/node/matchers.rb', line 413

def has_table?(locator, options={})
  has_selector?(:table, locator, options)
end

#has_text?(type, text, options = {}) ⇒ Boolean #has_text?(text, options = {}) ⇒ Boolean Also known as: has_content?

Checks if the page or current node has the given text content, ignoring any HTML tags.

Whitespaces are normalized in both node's text and passed text parameter. Note that whitespace isn't normalized in passed regexp as normalizing whitespace in regexp isn't easy and doesn't seem to be worth it.

By default it will check if the text occurs at least once, but a different number can be specified.

page.has_text?('lorem ipsum', between: 2..4)

This will check if the text occurs from 2 to 4 times.

Overloads:

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

    Parameters:

    • type (:all, :visible)

      Whether to check for only visible or all text

    • 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

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

Returns:

  • (Boolean)

    Whether it exists



502
503
504
505
506
# File 'lib/capybara/node/matchers.rb', line 502

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

#has_unchecked_field?(locator, options = {}) ⇒ Boolean

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

Parameters:

  • locator (String)

    The label, name or id of an unchecked field

Returns:

  • (Boolean)

    Whether it exists



342
343
344
# File 'lib/capybara/node/matchers.rb', line 342

def has_unchecked_field?(locator, options={})
  has_selector?(:field, locator, options.merge(:unchecked => true))
end

#has_xpath?(path, options = {}) ⇒ Boolean

Checks if a given XPath expression is on the page or current node.

page.has_xpath?('.//p[@id="foo"]')

By default it will check if the expression occurs at least once, but a different number can be specified.

page.has_xpath?('.//p[@id="foo"]', :count => 4)

This will check if the expression occurs exactly 4 times.

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

page.has_xpath?('.//li', :text => 'Horse', :visible => true)

has_xpath? can also accept XPath expressions generate by the XPath gem:

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

Parameters:

  • path (String)

    An XPath expression

  • options (Hash) (defaults to: {})

    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



162
163
164
# File 'lib/capybara/node/matchers.rb', line 162

def has_xpath?(path, options={})
  has_selector?(:xpath, path, options)
end