mirror of
https://github.com/teamcapybara/capybara.git
synced 2022-11-09 12:08:07 -05:00
4b8b52eac4
As with links, button elements may consistent entirely of an image. In such cases, one may identify the button using the value of the descendant image's alt attribute (as a screen reader would).
507 lines
17 KiB
Ruby
507 lines
17 KiB
Ruby
# frozen_string_literal: true
|
|
require 'capybara/selector/selector'
|
|
Capybara::Selector::FilterSet.add(:_field) do
|
|
filter(:checked, :boolean) { |node, value| not(value ^ node.checked?) }
|
|
filter(:unchecked, :boolean) { |node, value| (value ^ node.checked?) }
|
|
filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
|
filter(:multiple, :boolean) { |node, value| !(value ^ node.multiple?) }
|
|
|
|
describe do |options|
|
|
desc, states = String.new, []
|
|
states << 'checked' if options[:checked] || (options[:unchecked] === false)
|
|
states << 'not checked' if options[:unchecked] || (options[:checked] === false)
|
|
states << 'disabled' if options[:disabled] == true
|
|
desc << " that is #{states.join(' and ')}" unless states.empty?
|
|
desc << " with the multiple attribute" if options[:multiple] == true
|
|
desc << " without the multiple attribute" if options[:multiple] === false
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Select elements by XPath expression
|
|
#
|
|
# @locator An XPath expression
|
|
#
|
|
Capybara.add_selector(:xpath) do
|
|
xpath { |xpath| xpath }
|
|
end
|
|
|
|
##
|
|
#
|
|
# Select elements by CSS selector
|
|
#
|
|
# @locator A CSS selector
|
|
#
|
|
Capybara.add_selector(:css) do
|
|
css { |css| css }
|
|
end
|
|
|
|
##
|
|
#
|
|
# Select element by id
|
|
#
|
|
# @locator The id of the element to match
|
|
#
|
|
Capybara.add_selector(:id) do
|
|
xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
|
|
end
|
|
|
|
##
|
|
#
|
|
# Select field elements (input [not of type submit, image, or hidden], textarea, select)
|
|
#
|
|
# @locator Matches against the id, name, or placeholder
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :name Matches the name attribute
|
|
# @filter [String] :placeholder Matches the placeholder attribute
|
|
# @filter [String] :type Matches the type attribute of the field or element type for 'textarea' and 'select'
|
|
# @filter [Boolean] :readonly
|
|
# @filter [String] :with Matches the current value of the field
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
# @filter [Boolean] :checked Match checked fields?
|
|
# @filter [Boolean] :unchecked Match unchecked fields?
|
|
# @filter [Boolean] :disabled Match disabled field?
|
|
# @filter [Boolean] :multiple Match fields that accept multiple values
|
|
Capybara.add_selector(:field) do
|
|
xpath(:name, :placeholder, :type) do |locator, options|
|
|
xpath = XPath.descendant(:input, :textarea, :select)[~XPath.attr(:type).one_of('submit', 'image', 'hidden')]
|
|
if options[:type]
|
|
type=options[:type].to_s
|
|
if ['textarea', 'select'].include?(type)
|
|
xpath = XPath.descendant(type.to_sym)
|
|
else
|
|
xpath = xpath[XPath.attr(:type).equals(type)]
|
|
end
|
|
end
|
|
xpath=locate_field(xpath, locator, options)
|
|
xpath
|
|
end
|
|
|
|
filter_set(:_field) # checked/unchecked/disabled/multiple
|
|
|
|
filter(:readonly, :boolean) { |node, value| not(value ^ node.readonly?) }
|
|
filter(:with) do |node, with|
|
|
with.is_a?(Regexp) ? node.value =~ with : node.value == with.to_s
|
|
end
|
|
describe do |options|
|
|
desc = String.new
|
|
(expression_filters - [:type]).each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
|
|
desc << " of type #{options[:type].inspect}" if options[:type]
|
|
desc << " with value #{options[:with].to_s.inspect}" if options.has_key?(:with)
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Select fieldset elements
|
|
#
|
|
# @locator Matches id or contents of wrapped legend
|
|
#
|
|
# @filter [String] :id Matches id attribute
|
|
# @filter [String] :legend Matches contents of wrapped legend
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
#
|
|
Capybara.add_selector(:fieldset) do
|
|
xpath(:legend) do |locator, options|
|
|
xpath = XPath.descendant(:fieldset)
|
|
xpath = xpath[XPath.attr(:id).equals(locator.to_s) | XPath.child(:legend)[XPath.string.n.is(locator.to_s)]] unless locator.nil?
|
|
xpath = xpath[XPath.child(:legend)[XPath.string.n.is(options[:legend])]] if options[:legend]
|
|
xpath
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find links ( <a> elements with an href attribute )
|
|
#
|
|
# @locator Matches the id or title attributes, or the string content of the link, or the alt attribute of a contained img element
|
|
#
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :title Matches the title attribute
|
|
# @filter [String] :alt Matches the alt attribute of a contained img element
|
|
# @filter [String] :class Matches the class(es) provided
|
|
# @filter [String, Regexp] :href Matches the normalized href of the link
|
|
#
|
|
Capybara.add_selector(:link) do
|
|
xpath(:title, :alt) do |locator, options={}|
|
|
xpath = XPath.descendant(:a)[XPath.attr(:href)]
|
|
unless locator.nil?
|
|
locator = locator.to_s
|
|
matchers = XPath.attr(:id).equals(locator) |
|
|
XPath.string.n.is(locator) |
|
|
XPath.attr(:title).is(locator) |
|
|
XPath.descendant(:img)[XPath.attr(:alt).is(locator)]
|
|
matchers |= XPath.attr(:'aria-label').is(locator) if Capybara.enable_aria_label
|
|
xpath = xpath[matchers]
|
|
end
|
|
xpath = [:title].inject(xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
|
|
xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt).equals(options[:alt])]] if options[:alt]
|
|
xpath
|
|
end
|
|
|
|
filter(:href) do |node, href|
|
|
if href.is_a? Regexp
|
|
node[:href].match href
|
|
else
|
|
node.first(:xpath, XPath.axis(:self)[XPath.attr(:href).equals(href.to_s)], minimum: 0)
|
|
end
|
|
end
|
|
|
|
describe { |options| " with href #{options[:href].inspect}" if options[:href] }
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find buttons ( input [of type submit, reset, image, button] or button elements )
|
|
#
|
|
# @locator Matches the id, value, or title attributes, string content of a button, or the alt attribute of an image type button or of a descendant image of a button
|
|
#
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :title Matches the title attribute
|
|
# @filter [String] :class Matches the class(es) provided
|
|
# @filter [String] :value Matches the value of an input button
|
|
#
|
|
Capybara.add_selector(:button) do
|
|
xpath(:value, :title) do |locator, options={}|
|
|
input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]
|
|
btn_xpath = XPath.descendant(:button)
|
|
image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).equals('image')]
|
|
|
|
unless locator.nil?
|
|
locator = locator.to_s
|
|
locator_matches = XPath.attr(:id).equals(locator) | XPath.attr(:value).is(locator) | XPath.attr(:title).is(locator)
|
|
locator_matches |= XPath.attr(:'aria-label').is(locator) if Capybara.enable_aria_label
|
|
|
|
input_btn_xpath = input_btn_xpath[locator_matches]
|
|
|
|
btn_xpath = btn_xpath[locator_matches | XPath.string.n.is(locator) | XPath.descendant(:img)[XPath.attr(:alt).is(locator)]]
|
|
|
|
alt_matches = XPath.attr(:alt).is(locator)
|
|
alt_matches |= XPath.attr(:'aria-label').is(locator) if Capybara.enable_aria_label
|
|
image_btn_xpath = image_btn_xpath[alt_matches]
|
|
end
|
|
|
|
res_xpath = input_btn_xpath + btn_xpath + image_btn_xpath
|
|
|
|
res_xpath = expression_filters.inject(res_xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
|
|
|
|
res_xpath
|
|
end
|
|
|
|
filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " that is disabled" if options[:disabled] == true
|
|
expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find links or buttons
|
|
#
|
|
Capybara.add_selector(:link_or_button) do
|
|
label "link or button"
|
|
xpath do |locator, options|
|
|
self.class.all.values_at(:link, :button).map {|selector| selector.xpath.call(locator, options)}.reduce(:+)
|
|
end
|
|
|
|
filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| node.tag_name == "a" or not(value ^ node.disabled?) }
|
|
|
|
describe { |options| " that is disabled" if options[:disabled] }
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find text fillable fields ( textarea, input [not of type submit, image, radio, checkbox, hidden, file] )
|
|
#
|
|
# @locator Matches against the id, name, or placeholder
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :name Matches the name attribute
|
|
# @filter [String] :placeholder Matches the placeholder attribute
|
|
# @filter [String] :with Matches the current value of the field
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
# @filter [Boolean] :disabled Match disabled field?
|
|
# @filter [Boolean] :multiple Match fields that accept multiple values
|
|
#
|
|
Capybara.add_selector(:fillable_field) do
|
|
label "field"
|
|
xpath(:name, :placeholder) do |locator, options|
|
|
xpath = XPath.descendant(:input, :textarea)[~XPath.attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')]
|
|
locate_field(xpath, locator, options)
|
|
end
|
|
|
|
filter_set(:_field, [:disabled, :multiple])
|
|
|
|
filter(:with) do |node, with|
|
|
with.is_a?(Regexp) ? node.value =~ with : node.value == with.to_s
|
|
end
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
|
|
desc << " with value #{options[:with].to_s.inspect}" if options.has_key?(:with)
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find radio buttons
|
|
#
|
|
# @locator Match id, name, or associated label text
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :name Matches the name attribute
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
# @filter [Boolean] :checked Match checked fields?
|
|
# @filter [Boolean] :unchecked Match unchecked fields?
|
|
# @filter [Boolean] :disabled Match disabled field?
|
|
# @filter [String] :option Match the value
|
|
#
|
|
Capybara.add_selector(:radio_button) do
|
|
label "radio button"
|
|
xpath(:name) do |locator, options|
|
|
xpath = XPath.descendant(:input)[XPath.attr(:type).equals('radio')]
|
|
locate_field(xpath, locator, options)
|
|
end
|
|
|
|
filter_set(:_field, [:checked, :unchecked, :disabled])
|
|
|
|
filter(:option) { |node, value| node.value == value.to_s }
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " with value #{options[:option].inspect}" if options[:option]
|
|
expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find checkboxes
|
|
#
|
|
# @locator Match id, name, or associated label text
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :name Matches the name attribute
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
# @filter [Boolean] :checked Match checked fields?
|
|
# @filter [Boolean] :unchecked Match unchecked fields?
|
|
# @filter [Boolean] :disabled Match disabled field?
|
|
# @filter [String] :option Match the value
|
|
#
|
|
Capybara.add_selector(:checkbox) do
|
|
xpath(:name) do |locator, options|
|
|
xpath = XPath.descendant(:input)[XPath.attr(:type).equals('checkbox')]
|
|
locate_field(xpath, locator, options)
|
|
end
|
|
|
|
filter_set(:_field, [:checked, :unchecked, :disabled])
|
|
|
|
filter(:option) { |node, value| node.value == value.to_s }
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " with value #{options[:option].inspect}" if options[:option]
|
|
expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find select elements
|
|
#
|
|
# @locator Match id, name, placeholder, or associated label text
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :name Matches the name attribute
|
|
# @filter [String] :placeholder Matches the placeholder attribute
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
# @filter [Boolean] :disabled Match disabled field?
|
|
# @filter [Boolean] :multiple Match fields that accept multiple values
|
|
# @filter [Array<String>] :options Exact match options
|
|
# @filter [Array<String>] :with_options Partial match options
|
|
# @filter [String, Array<String>] :selected Match the selection(s)
|
|
#
|
|
Capybara.add_selector(:select) do
|
|
label "select box"
|
|
xpath(:name, :placeholder) do |locator, options|
|
|
xpath = XPath.descendant(:select)
|
|
locate_field(xpath, locator, options)
|
|
end
|
|
|
|
filter_set(:_field, [:disabled, :multiple])
|
|
|
|
filter(:options) do |node, options|
|
|
if node.visible?
|
|
actual = node.all(:xpath, './/option').map { |option| option.text }
|
|
else
|
|
actual = node.all(:xpath, './/option', visible: false).map { |option| option.text(:all) }
|
|
end
|
|
options.sort == actual.sort
|
|
end
|
|
filter(:with_options) do |node, options|
|
|
finder_settings = { minimum: 0 }
|
|
if !node.visible?
|
|
finder_settings[:visible] = false
|
|
end
|
|
options.all? { |option| node.first(:option, option, finder_settings) }
|
|
end
|
|
filter(:selected) do |node, selected|
|
|
actual = node.all(:xpath, './/option', visible: false).select { |option| option.selected? }.map { |option| option.text(:all) }
|
|
[selected].flatten.sort == actual.sort
|
|
end
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " with options #{options[:options].inspect}" if options[:options]
|
|
desc << " with at least options #{options[:with_options].inspect}" if options[:with_options]
|
|
desc << " with #{options[:selected].inspect} selected" if options[:selected]
|
|
expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find option elements
|
|
#
|
|
# @locator Match text of option
|
|
# @filter [Boolean] :disabled Match disabled option
|
|
# @filter [Boolean] :selected Match selected option
|
|
#
|
|
Capybara.add_selector(:option) do
|
|
xpath do |locator|
|
|
xpath = XPath.descendant(:option)
|
|
xpath = xpath[XPath.string.n.is(locator.to_s)] unless locator.nil?
|
|
xpath
|
|
end
|
|
|
|
filter(:disabled, :boolean) { |node, value| not(value ^ node.disabled?) }
|
|
filter(:selected, :boolean) { |node, value| not(value ^ node.selected?) }
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " that is#{' not' unless options[:disabled]} disabled" if options.has_key?(:disabled)
|
|
desc << " that is#{' not' unless options[:selected]} selected" if options.has_key?(:selected)
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find file input elements
|
|
#
|
|
# @locator Match id, name, or associated label text
|
|
# @filter [String] :id Matches the id attribute
|
|
# @filter [String] :name Matches the name attribute
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
# @filter [Boolean] :disabled Match disabled field?
|
|
# @filter [Boolean] :multiple Match field that accepts multiple values
|
|
#
|
|
Capybara.add_selector(:file_field) do
|
|
label "file field"
|
|
xpath(:name) do |locator, options|
|
|
xpath = XPath.descendant(:input)[XPath.attr(:type).equals('file')]
|
|
locate_field(xpath, locator, options)
|
|
end
|
|
|
|
filter_set(:_field, [:disabled, :multiple])
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find label elements
|
|
#
|
|
# @locator Match id or text contents
|
|
# @filter [Element, String] :for The element or id of the element associated with the label
|
|
#
|
|
Capybara.add_selector(:label) do
|
|
label "label"
|
|
xpath(:for) do |locator, options|
|
|
xpath = XPath.descendant(:label)
|
|
xpath = xpath[XPath.string.n.is(locator.to_s) | XPath.attr(:id).equals(locator.to_s)] unless locator.nil?
|
|
if options.has_key?(:for) && !options[:for].is_a?(Capybara::Node::Element)
|
|
xpath = xpath[XPath.attr(:for).equals(options[:for].to_s).or((~XPath.attr(:for)).and(XPath.descendant()[XPath.attr(:id).equals(options[:for].to_s)]))]
|
|
end
|
|
xpath
|
|
end
|
|
|
|
filter(:for) do |node, field_or_value|
|
|
if field_or_value.is_a? Capybara::Node::Element
|
|
if node[:for]
|
|
field_or_value[:id] == node[:for]
|
|
else
|
|
field_or_value.find_xpath('./ancestor::label[1]').include? node.base
|
|
end
|
|
else
|
|
#Non element values were handled through the expression filter
|
|
true
|
|
end
|
|
end
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " for #{options[:for]}" if options[:for]
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find table elements
|
|
#
|
|
# @locator id or caption text of table
|
|
# @filter [String] :id Match id attribute of table
|
|
# @filter [String] :caption Match text of associated caption
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
#
|
|
Capybara.add_selector(:table) do
|
|
xpath(:caption) do |locator, options|
|
|
xpath = XPath.descendant(:table)
|
|
xpath = xpath[XPath.attr(:id).equals(locator.to_s) | XPath.descendant(:caption).is(locator.to_s)] unless locator.nil?
|
|
xpath = xpath[XPath.descendant(:caption).equals(options[:caption])] if options[:caption]
|
|
xpath
|
|
end
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " with caption #{options[:caption]}" if options[:caption]
|
|
desc
|
|
end
|
|
end
|
|
|
|
##
|
|
#
|
|
# Find frame/iframe elements
|
|
#
|
|
# @locator Match id or name
|
|
# @filter [String] :id Match id attribute
|
|
# @filter [String] :name Match name attribute
|
|
# @filter [String, Array<String>] :class Matches the class(es) provided
|
|
#
|
|
Capybara.add_selector(:frame) do
|
|
xpath(:name) do |locator, options|
|
|
xpath = XPath.descendant(:iframe) + XPath.descendant(:frame)
|
|
xpath = xpath[XPath.attr(:id).equals(locator.to_s) | XPath.attr(:name).equals(locator)] unless locator.nil?
|
|
xpath = expression_filters.inject(xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
|
|
xpath
|
|
end
|
|
|
|
describe do |options|
|
|
desc = String.new
|
|
desc << " with name #{options[:name]}" if options[:name]
|
|
desc
|
|
end
|
|
end
|