Module: Capybara::Node::Matchers

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

Instance Method Summary (collapse)

Instance Method Details

- (Object) ==(other)



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

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

- (Object) assert_no_selector(*args) 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:



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

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

- (true) assert_no_text(type, text, options = {}) - (true) assert_no_text(text, options = {})

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

Overloads:

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

    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_wait_time

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

  • - (true) assert_no_text(text, options = {})

    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_wait_time

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

Raises:



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

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

- (Object) assert_selector(*args)

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

Raises:



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

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

- (true) assert_text(type, text, options = {}) - (true) assert_text(text, options = {})

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

Overloads:

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

    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_wait_time

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

  • - (true) assert_text(text, options = {})

    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_wait_time

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

Raises:



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

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

- (Boolean) has_button?(locator, options = {})

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



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

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

- (Boolean) has_checked_field?(locator, options = {})

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



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

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

- (Boolean) has_css?(path, options = {})

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)

Options Hash (options):

  • :count (Integer) — default: nil

    Number of times the selector should occur



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

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

- (Boolean) has_field?(locator, options = {})

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.

Options Hash (options):

  • :with (String)

    The text content of the field

  • :type (String)

    The type attribute of the field



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

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

- (Boolean) has_link?(locator, options = {})

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

Options Hash (options):

  • :href (String)

    The value the href attribute must be



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

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

- (Boolean) has_no_button?(locator, options = {})

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



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

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

- (Boolean) has_no_checked_field?(locator, options = {})

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



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

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

- (Boolean) has_no_css?(path, options = {})

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



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

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

- (Boolean) has_no_field?(locator, options = {})

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

Options Hash (options):

  • :with (String)

    The text content of the field

  • :type (String)

    The type attribute of the field



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

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

- (Boolean) has_no_link?(locator, options = {})

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



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

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

- (Boolean) has_no_select?(locator, options = {})

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



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

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

- (Boolean) has_no_selector?(*args)

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



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

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

- (Boolean) has_no_table?(locator, options = {})

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



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

def has_no_table?(locator, options={})
  has_no_selector?(:table, locator, options)
end

- (Boolean) has_no_text?(type, text, options = {}) - (Boolean) has_no_text?(text, options = {}) 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:

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

    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_wait_time

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

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

    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_wait_time

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



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

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

- (Boolean) has_no_unchecked_field?(locator, options = {})

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



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

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

- (Boolean) has_no_xpath?(path, options = {})

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



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

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

- (Boolean) has_select?(locator, options = {})

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

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



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

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

- (Boolean) has_selector?(*args)

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

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



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

def has_selector?(*args)
  assert_selector(*args)
rescue Capybara::ExpectationNotMet
  return false
end

- (Boolean) has_table?(locator, options = {})

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

page.has_table?('People')


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

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

- (Boolean) has_text?(type, text, options = {}) - (Boolean) has_text?(text, options = {}) 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:

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

    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_wait_time

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

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

    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_wait_time

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



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

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

- (Boolean) has_unchecked_field?(locator, options = {})

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



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

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

- (Boolean) has_xpath?(path, options = {})

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)

Options Hash (options):

  • :count (Integer) — default: nil

    Number of times the expression should occur



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

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