Module: Capybara::Node::Matchers

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

Instance Method Summary (collapse)

Instance Method Details

- (Object) ==(other) 



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

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

- (Object) assert_no_selector(*args)

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

Raises:



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

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

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

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:



83
84
85
86
87
88
89
 
# File 'lib/capybara/node/matchers.rb', line 83

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

- (Boolean) has_button?(locator)

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



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

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

- (Boolean) has_checked_field?(locator)

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



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

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

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



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

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

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



307
308
309
 
# File 'lib/capybara/node/matchers.rb', line 307

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.

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



247
248
249
 
# File 'lib/capybara/node/matchers.rb', line 247

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

- (Boolean) has_no_button?(locator)

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



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

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

- (Boolean) has_no_checked_field?(locator)

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



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

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

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/capybara/node/matchers.rb', line 187

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

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



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

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.

Returns:

  • (Boolean) —

    Whether it doesn't exist



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

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

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



417
418
419
 
# File 'lib/capybara/node/matchers.rb', line 417

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?

Returns:

  • (Boolean) 


48
49
50
51
52
 
# File 'lib/capybara/node/matchers.rb', line 48

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

Parameters:

  • locator (String) —

    The id or caption of a table

Returns:

  • (Boolean) —

    Whether it doesn't exist



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

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

- (Boolean) has_no_text?(content) 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.

This only matches displayable text and specifically excludes text contained within non-display nodes such as script or head tags.

Parameters:

  • content (String) —

    The text to check for

Returns:

  • (Boolean) —

    Whether it doesn't exist



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/capybara/node/matchers.rb', line 225

def has_no_text?(content)
  synchronize do
    if Capybara::Helpers.normalize_whitespace(text).match(Capybara::Helpers.to_regexp(content))
      raise ExpectationNotMet
    end
  end
  return true
rescue Capybara::ExpectationNotMet
  return false
end

- (Boolean) has_no_unchecked_field?(locator)

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



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

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

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/capybara/node/matchers.rb', line 148

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

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



405
406
407
 
# File 'lib/capybara/node/matchers.rb', line 405

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

Parameters:

  • options (Hash) —

    a customizable set of options

Returns:

  • (Boolean) —

    If the expression exists



34
35
36
37
38
 
# File 'lib/capybara/node/matchers.rb', line 34

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.

If the options :rows is given, it will check that the table contains the rows and columns given:

page.has_table?('People', :rows => [['Jonas', '24'], ['Peter', '32']])

Note that this option is quite strict, the order needs to be correct and the text needs to match exactly.

Parameters:

  • locator (String) —

    The id or caption of a table

Returns:

  • (Boolean) —

    Whether it exist



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

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

- (Boolean) has_text?(content) Also known as: has_content?

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

This only matches displayable text and specifically excludes text contained within non-display nodes such as script or head tags.

Parameters:

  • content (String) —

    The text to check for

Returns:

  • (Boolean) —

    Whether it exists



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/capybara/node/matchers.rb', line 202

def has_text?(content)
  synchronize do
    unless Capybara::Helpers.normalize_whitespace(text).match(Capybara::Helpers.to_regexp(content))
      raise ExpectationNotMet
    end
  end
  return true
rescue Capybara::ExpectationNotMet
  return false
end

- (Boolean) has_unchecked_field?(locator)

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



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

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

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



136
137
138
 
# File 'lib/capybara/node/matchers.rb', line 136

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