Module: Capybara::Node::Matchers

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

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Object 



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

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:



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

def assert_no_selector(*args)
  synchronize 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
 
# File 'lib/capybara/node/matchers.rb', line 87

def assert_selector(*args)
  synchronize do
    result = all(*args)
    result.matches_count? or raise Capybara::ExpectationNotMet, result.failure_message
  end
  return true
end

#has_button?(locator) ⇒ 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



279
280
281
 
# File 'lib/capybara/node/matchers.rb', line 279

def has_button?(locator)
  has_selector?(:button, locator)
end

#has_checked_field?(locator) ⇒ 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



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

def has_checked_field?(locator)
  has_selector?(:field, locator, :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



179
180
181
 
# File 'lib/capybara/node/matchers.rb', line 179

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



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

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



255
256
257
 
# File 'lib/capybara/node/matchers.rb', line 255

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

#has_no_button?(locator) ⇒ 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



291
292
293
 
# File 'lib/capybara/node/matchers.rb', line 291

def has_no_button?(locator)
  has_no_selector?(:button, locator)
end

#has_no_checked_field?(locator) ⇒ 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 exists



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

def has_no_checked_field?(locator)
  has_no_selector?(:field, locator, :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) 


191
192
193
 
# File 'lib/capybara/node/matchers.rb', line 191

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



331
332
333
 
# File 'lib/capybara/node/matchers.rb', line 331

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



267
268
269
 
# File 'lib/capybara/node/matchers.rb', line 267

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



427
428
429
 
# File 'lib/capybara/node/matchers.rb', line 427

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



453
454
455
 
# File 'lib/capybara/node/matchers.rb', line 453

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



235
236
237
238
239
240
241
242
 
# File 'lib/capybara/node/matchers.rb', line 235

def has_no_text?(*args)
  synchronize do
    raise ExpectationNotMet if text_found?(*args)
  end
  return true
rescue Capybara::ExpectationNotMet
  return false
end

#has_no_unchecked_field?(locator) ⇒ 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 exists



383
384
385
 
# File 'lib/capybara/node/matchers.rb', line 383

def has_no_unchecked_field?(locator)
  has_no_selector?(:field, locator, :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) 


152
153
154
 
# File 'lib/capybara/node/matchers.rb', line 152

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



415
416
417
 
# File 'lib/capybara/node/matchers.rb', line 415

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



441
442
443
 
# File 'lib/capybara/node/matchers.rb', line 441

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



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

def has_text?(*args)
  synchronize do
    raise ExpectationNotMet unless text_found?(*args)
  end
  return true
rescue Capybara::ExpectationNotMet
  return false
end

#has_unchecked_field?(locator) ⇒ 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



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

def has_unchecked_field?(locator)
  has_selector?(:field, locator, :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



140
141
142
 
# File 'lib/capybara/node/matchers.rb', line 140

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