1
0
Fork 0
mirror of https://github.com/teamcapybara/capybara.git synced 2022-11-09 12:08:07 -05:00
teamcapybara--capybara/lib/capybara/node/matchers.rb

426 lines
14 KiB
Ruby
Raw Normal View History

module Capybara
module Node
module Matchers
2010-08-24 06:37:35 -04:00
##
#
2010-10-12 07:26:24 -04:00
# Checks if a given selector is on the page or current node.
2010-08-24 06:37:35 -04:00
#
2010-10-12 07:26:24 -04:00
# page.has_selector?('p#foo')
# page.has_selector?(:xpath, './/p[@id="foo"]')
# page.has_selector?(:foo)
2010-08-24 06:37:35 -04:00
#
# By default it will check if the expression occurs at least once,
# but a different number can be specified.
#
2010-10-12 07:26:24 -04:00
# page.has_selector?('p#foo', :count => 4)
2010-08-24 06:37:35 -04:00
#
# This will check if the expression occurs exactly 4 times.
#
# It also accepts all options that {Capybara::Node::Finders#all} accepts,
# such as :text and :visible.
#
2010-10-12 07:26:24 -04:00
# page.has_selector?('li', :text => 'Horse', :visible => true)
2010-08-24 06:37:35 -04:00
#
2010-10-12 07:26:24 -04:00
# has_selector? can also accept XPath expressions generated by the
2010-08-24 06:37:35 -04:00
# XPath gem:
#
# xpath = XPath.generate { |x| x.descendant(:p) }
2010-10-12 07:26:24 -04:00
# page.has_selector?(:xpath, xpath)
2010-08-24 06:37:35 -04:00
#
2010-10-12 07:26:24 -04:00
# @param (see Capybara::Node::Finders#all)
2010-08-24 06:37:35 -04:00
# @option options [Integer] :count (nil) Number of times the expression should occur
# @return [Boolean] If the expression exists
#
2010-10-12 07:26:24 -04:00
def has_selector?(*args)
synchronize do
2010-10-12 07:26:24 -04:00
results = all(*args)
2012-01-31 11:24:34 -05:00
query(*args).matches_count?(results) or raise Capybara::ExpectationNotMet
2012-01-31 09:55:26 -05:00
results
end
rescue Capybara::ExpectationNotMet
return false
end
2010-08-24 06:37:35 -04:00
##
#
2010-10-12 07:26:24 -04:00
# Checks if a given selector is not on the page or current node.
# Usage is identical to Capybara::Node::Matchers#has_selector?
2010-08-24 06:37:35 -04:00
#
2010-10-12 07:26:24 -04:00
# @param (see Capybara::Node::Finders#has_selector?)
2010-08-24 06:37:35 -04:00
# @return [Boolean]
#
2010-10-12 07:26:24 -04:00
def has_no_selector?(*args)
synchronize do
2010-10-12 07:26:24 -04:00
results = all(*args)
2012-01-31 11:24:34 -05:00
query(*args).matches_count?(results) and raise Capybara::ExpectationNotMet
2012-01-31 09:55:26 -05:00
results
end
rescue Capybara::ExpectationNotMet
return false
end
2010-10-12 07:26:24 -04:00
##
#
# 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 {Capybara::Node::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)
#
# @param [String] path An XPath expression
# @param options (see Capybara::Node::Finders#all)
# @option options [Integer] :count (nil) Number of times the expression should occur
# @return [Boolean] If the expression exists
#
def has_xpath?(path, options={})
has_selector?(:xpath, path, options)
end
##
#
# Checks if a given XPath expression is not on the page or current node.
# Usage is identical to Capybara::Node::Matchers#has_xpath?
#
# @param (see Capybara::Node::Finders#has_xpath?)
# @return [Boolean]
#
def has_no_xpath?(path, options={})
has_no_selector?(:xpath, path, options)
end
2010-08-24 06:37:35 -04:00
##
#
# 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 {Capybara::Node::Finders#all} accepts,
# such as :text and :visible.
#
# page.has_css?('li', :text => 'Horse', :visible => true)
#
# @param [String] path A CSS selector
# @param options (see Capybara::Node::Finders#all)
# @option options [Integer] :count (nil) Number of times the selector should occur
# @return [Boolean] If the selector exists
#
def has_css?(path, options={})
has_selector?(:css, path, options)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if a given CSS selector is not on the page or current node.
# Usage is identical to Capybara::Node::Matchers#has_css?
#
# @param (see Capybara::Node::Finders#has_css?)
# @return [Boolean]
#
def has_no_css?(path, options={})
has_no_selector?(:css, path, options)
end
##
#
# Checks if the page or current node has the given text content,
# ignoring any HTML tags and normalizing whitespace.
#
# Unlike has_content this only matches displayable text and specifically
# excludes text contained within non-display nodes such as script or head tags.
#
# @param [String] content The text to check for
# @return [Boolean] Whether it exists
#
def has_text?(content)
normalized_content = normalize_whitespace(content)
synchronize do
normalize_whitespace(text).include?(normalized_content) or
raise ExpectationNotMet
end
rescue Capybara::ExpectationNotMet
return false
end
alias_method :has_content?, :has_text?
##
#
# Checks if the page or current node does not have the given text
# content, ignoring any HTML tags and normalizing whitespace.
#
# Unlike has_content this only matches displayable text and specifically
# excludes text contained within non-display nodes such as script or head tags.
#
# @param [String] content The text to check for
# @return [Boolean] Whether it exists
#
def has_no_text?(content)
normalized_content = normalize_whitespace(content)
synchronize do
!normalize_whitespace(text).include?(normalized_content) or
raise ExpectationNotMet
end
rescue Capybara::ExpectationNotMet
return false
end
alias_method :has_no_content?, :has_no_text?
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has a link with the given
# text or id.
#
# @param [String] locator The text or id of a link to check for
# @param options
# @option options [String] :href The value the href attribute must be
# @return [Boolean] Whether it exists
2010-08-24 06:37:35 -04:00
#
def has_link?(locator, options={})
has_selector?(:link, locator, options)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has no link with the given
# text or id.
#
# @param (see Capybara::Node::Finders#has_link?)
2010-08-24 06:37:35 -04:00
# @return [Boolean] Whether it doesn't exist
#
def has_no_link?(locator, options={})
has_no_selector?(:link, locator, options)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has a button with the given
# text, value or id.
#
# @param [String] locator The text, value or id of a button to check for
# @return [Boolean] Whether it exists
#
def has_button?(locator)
has_selector?(:button, locator)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has no button with the given
# text, value or id.
#
# @param [String] locator The text, value or id of a button to check for
# @return [Boolean] Whether it doesn't exist
#
def has_no_button?(locator)
has_no_selector?(:button, locator)
end
2010-08-24 06:37:35 -04:00
##
#
# 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')
#
2010-08-24 06:37:35 -04:00
# @param [String] locator The label, name or id of a field to check for
# @option options [String] :with The text content of the field
# @option options [String] :type The type attribute of the field
2010-08-24 06:37:35 -04:00
# @return [Boolean] Whether it exists
#
def has_field?(locator, options={})
has_selector?(:field, locator, options)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has no form field with the given
# label, name or id. See {Capybara::Node::Matchers#has_field?}.
#
# @param [String] locator The label, name or id of a field to check for
# @option options [String] :with The text content of the field
# @option options [String] :type The type attribute of the field
2010-08-24 06:37:35 -04:00
# @return [Boolean] Whether it doesn't exist
#
def has_no_field?(locator, options={})
has_no_selector?(:field, locator, options)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has a radio button or
# checkbox with the given label, value or id, that is currently
# checked.
#
# @param [String] locator The label, name or id of a checked field
# @return [Boolean] Whether it exists
#
def has_checked_field?(locator)
has_selector?(:field, locator, :checked => true)
end
##
#
# Checks if the page or current node has no radio button or
# checkbox with the given label, value or id, that is currently
# checked.
#
# @param [String] locator The label, name or id of a checked field
# @return [Boolean] Whether it doesn't exists
#
def has_no_checked_field?(locator)
has_no_selector?(:field, locator, :checked => true)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has a radio button or
# checkbox with the given label, value or id, that is currently
# unchecked.
#
# @param [String] locator The label, name or id of an unchecked field
# @return [Boolean] Whether it exists
#
def has_unchecked_field?(locator)
has_selector?(:field, locator, :unchecked => true)
end
##
#
# Checks if the page or current node has no radio button or
# checkbox with the given label, value or id, that is currently
# unchecked.
#
# @param [String] locator The label, name or id of an unchecked field
# @return [Boolean] Whether it doesn't exists
#
def has_no_unchecked_field?(locator)
has_no_selector?(:field, locator, :unchecked => true)
end
2010-08-24 06:37:35 -04:00
##
#
# 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
2010-08-24 06:37:35 -04:00
# 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'])
2010-08-24 06:37:35 -04:00
#
# @param [String] locator The label, name or id of a select box
# @option options [Array] :options Options which should be contained in this select box
# @option options [Array] :with_options Partial set of options which should be contained in this select box
2010-08-24 06:37:35 -04:00
# @option options [String, Array] :selected Options which should be selected
# @return [Boolean] Whether it exists
#
def has_select?(locator, options={})
has_selector?(:select, locator, options)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has no select field with the
# given label, name or id. See {Capybara::Node::Matchers#has_select?}.
#
# @param (see Capybara::Node::Matchers#has_select?)
# @return [Boolean] Whether it doesn't exist
#
def has_no_select?(locator, options={})
has_no_selector?(:select, locator, options)
end
2010-08-24 06:37:35 -04:00
##
#
# 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.
#
# @param [String] locator The id or caption of a table
# @return [Boolean] Whether it exist
#
def has_table?(locator, options={})
has_selector?(:table, locator, options)
end
2010-08-24 06:37:35 -04:00
##
#
# Checks if the page or current node has no table with the given id
2010-08-27 14:52:06 -04:00
# or caption. See {Capybara::Node::Matchers#has_table?}.
2010-08-24 06:37:35 -04:00
#
# @param (see Capybara::Node::Matchers#has_table?)
# @return [Boolean] Whether it doesn't exist
#
def has_no_table?(locator, options={})
has_no_selector?(:table, locator, options)
end
private
##
#
# Normalizes whitespace space by stripping leading and trailing
# whitespace and replacing sequences of whitespace characters
# with a single space.
#
# @param [String] text Text to normalize
# @return [String] Normalized text
#
def normalize_whitespace(text)
text.gsub(/\s+/, ' ').strip
end
end
end
end