Module: Capybara::Node::Matchers

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

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Object 



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

def ==(other)
  self.eql?(other) or (other.respond_to?(:base) and base == other.base)
end

#assert_no_selector(*args) ⇒ Object

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

Raises:



104
105
106
107
108
109
110
111
 
# File 'lib/capybara/node/matchers.rb', line 104

def assert_no_selector(*args)
  query = Capybara::Query.new(*args)
  synchronize(query.wait) do
    result = all(*args)
    result.matches_count? and raise Capybara::ExpectationNotMet, result.negative_failure_message
  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.

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:



87
88
89
90
91
92
93
94
 
# File 'lib/capybara/node/matchers.rb', line 87

def assert_selector(*args)
  query = Capybara::Query.new(*args)
  synchronize(query.wait) do
    result = all(*args)
    result.matches_count? or raise Capybara::ExpectationNotMet, result.failure_message
  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



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

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



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

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



181
182
183
 
# File 'lib/capybara/node/matchers.rb', line 181

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



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

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

    The value the href attribute must be

Returns:

  • (Boolean) —

    Whether it exists



259
260
261
 
# File 'lib/capybara/node/matchers.rb', line 259

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



295
296
297
 
# File 'lib/capybara/node/matchers.rb', line 295

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



361
362
363
 
# File 'lib/capybara/node/matchers.rb', line 361

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) 


193
194
195
 
# File 'lib/capybara/node/matchers.rb', line 193

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



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

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



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

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



431
432
433
 
# File 'lib/capybara/node/matchers.rb', line 431

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) 


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

#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



457
458
459
 
# File 'lib/capybara/node/matchers.rb', line 457

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

#has_no_text?(*args) ⇒ 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.

Returns:

  • (Boolean) —

    Whether it doesn’t exist



238
239
240
241
242
243
244
245
246
 
# File 'lib/capybara/node/matchers.rb', line 238

def has_no_text?(*args)
  query = Capybara::Query.new(*args)
  synchronize(query.wait) do
    raise ExpectationNotMet if text_found?(*args)
  end
  return true
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



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

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) 


154
155
156
 
# File 'lib/capybara/node/matchers.rb', line 154

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



419
420
421
 
# File 'lib/capybara/node/matchers.rb', line 419

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



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

#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



445
446
447
 
# File 'lib/capybara/node/matchers.rb', line 445

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

#has_text?([type], text, [options]) ⇒ Boolean Also known as: has_content?

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

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.

Returns Whether it exists.

Parameters:

  • type (:all, :visible) —

    Whether to check for only visible or all text

  • text (String, Regexp) —

    The text/regexp to check for

  • options (Hash) —

    additional options

Returns:

  • (Boolean) —

    Whether it exists



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

def has_text?(*args)
  query = Capybara::Query.new(*args)
  synchronize(query.wait) do
    raise ExpectationNotMet unless text_found?(*args)
  end
  return true
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



374
375
376
 
# File 'lib/capybara/node/matchers.rb', line 374

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



142
143
144
 
# File 'lib/capybara/node/matchers.rb', line 142

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