Module: Capybara::Node::Matchers

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

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Object



629
630
631
# File 'lib/capybara/node/matchers.rb', line 629

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

#assert_matches_selector(*args) ⇒ 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)

Raises:



218
219
220
221
222
223
224
225
226
227
# File 'lib/capybara/node/matchers.rb', line 218

def assert_matches_selector(*args)
  query = Capybara::Queries::MatchQuery.new(*args)
  synchronize(query.wait) do
    result = query.resolve_for(self.query_scope)
    unless result.include? self
      raise Capybara::ExpectationNotMet, "Item does not match the provided selector"
    end
  end
  return true
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:



190
191
192
193
194
195
196
197
198
199
# File 'lib/capybara/node/matchers.rb', line 190

def assert_no_selector(*args)
  query = Capybara::Queries::SelectorQuery.new(*args)
  synchronize(query.wait) do
    result = query.resolve_for(self)
    if result.matches_count? && ((!result.empty?) || query.expects_none?)
      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

    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

    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

Raises:



579
580
581
582
583
584
585
586
587
588
# File 'lib/capybara/node/matchers.rb', line 579

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

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



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

def assert_not_matches_selector(*args)
  query = Capybara::Queries::MatchQuery.new(*args)
  synchronize(query.wait) do
    result = query.resolve_for(self.query_scope)
    if result.include? self
      raise Capybara::ExpectationNotMet, 'Item matched the provided selector'
    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))

Raises:



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

def assert_selector(*args)
  query = Capybara::Queries::SelectorQuery.new(*args)
  synchronize(query.wait) do
    result = query.resolve_for(self)
    unless result.matches_count? && ((!result.empty?) || query.expects_none?)
      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

    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

    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

Raises:



560
561
562
563
564
565
566
567
568
569
# File 'lib/capybara/node/matchers.rb', line 560

def assert_text(*args)
  query = Capybara::Queries::TextQuery.new(*args)
  synchronize(query.wait) do
    count = query.resolve_for(self)
    unless query.matches_count?(count) && ((count > 0) || query.expects_none?)
      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.



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

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.



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

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)

Options Hash (options):

  • :count (Integer) — default: nil

    Number of times the selector should occur



309
310
311
# File 'lib/capybara/node/matchers.rb', line 309

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.

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



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

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.

Options Hash (options):

  • :href (String, Regexp)

    The value the href attribute must be



335
336
337
# File 'lib/capybara/node/matchers.rb', line 335

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.



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

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.



437
438
439
# File 'lib/capybara/node/matchers.rb', line 437

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?



321
322
323
# File 'lib/capybara/node/matchers.rb', line 321

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

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



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

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.



347
348
349
# File 'lib/capybara/node/matchers.rb', line 347

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



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

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?



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



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

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

    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

    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



622
623
624
625
626
# File 'lib/capybara/node/matchers.rb', line 622

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.



463
464
465
# File 'lib/capybara/node/matchers.rb', line 463

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?



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

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

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



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

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

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



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


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

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

    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

    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



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

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.



450
451
452
# File 'lib/capybara/node/matchers.rb', line 450

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)

Options Hash (options):

  • :count (Integer) — default: nil

    Number of times the expression should occur



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

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

#matches_css?(css, options = {}) ⇒ Boolean

Checks if the current node matches given CSS selector



90
91
92
# File 'lib/capybara/node/matchers.rb', line 90

def matches_css?(css, options={})
  matches_selector?(:css, css, options)
end

#matches_selector?(*args) ⇒ Boolean

Checks if the current node matches given selector



66
67
68
69
70
# File 'lib/capybara/node/matchers.rb', line 66

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

#matches_xpath?(xpath, options = {}) ⇒ Boolean

Checks if the current node matches given XPath expression



79
80
81
# File 'lib/capybara/node/matchers.rb', line 79

def matches_xpath?(xpath, options={})
  matches_selector?(:xpath, xpath, options)
end

#not_matches_css?(css, options = {}) ⇒ Boolean

Checks if the current node does not match given CSS selector



126
127
128
# File 'lib/capybara/node/matchers.rb', line 126

def not_matches_css?(css, options={})
  not_matches_selector?(:css, css, options)
end

#not_matches_selector?(*args) ⇒ Boolean

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



102
103
104
105
106
# File 'lib/capybara/node/matchers.rb', line 102

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

#not_matches_xpath?(xpath, options = {}) ⇒ Boolean

Checks if the current node does not match given XPath expression



115
116
117
# File 'lib/capybara/node/matchers.rb', line 115

def not_matches_xpath?(xpath, options={})
  not_matches_selector?(:xpath, xpath, options)
end