2010-08-27 18:37:39 +00:00
|
|
|
module Capybara
|
|
|
|
class Selector
|
2013-03-08 13:18:56 +00:00
|
|
|
class Filter
|
|
|
|
def initialize(name, block, options={})
|
|
|
|
@name = name
|
|
|
|
@block = block
|
|
|
|
@options = options
|
2014-07-02 18:17:53 +00:00
|
|
|
@options[:valid_values] = [true,false] if options[:boolean]
|
2013-03-08 13:18:56 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def default?
|
|
|
|
@options.has_key?(:default)
|
|
|
|
end
|
|
|
|
|
|
|
|
def default
|
|
|
|
@options[:default]
|
|
|
|
end
|
2010-08-27 18:37:39 +00:00
|
|
|
|
2013-03-08 13:18:56 +00:00
|
|
|
def matches?(node, value)
|
2015-09-19 18:42:45 +00:00
|
|
|
return true if skip?(value)
|
|
|
|
|
2014-07-02 18:17:53 +00:00
|
|
|
if @options.has_key?(:valid_values) && !Array(@options[:valid_values]).include?(value)
|
2015-09-19 18:42:45 +00:00
|
|
|
msg = "Invalid value #{value.inspect} passed to filter #{@name} - "
|
|
|
|
if default?
|
|
|
|
warn msg + "defaulting to #{default}"
|
|
|
|
value = default
|
|
|
|
else
|
|
|
|
warn msg + "skipping"
|
|
|
|
return true
|
|
|
|
end
|
2015-09-19 03:22:19 +00:00
|
|
|
end
|
2015-09-19 18:42:45 +00:00
|
|
|
|
|
|
|
@block.call(node, value)
|
|
|
|
end
|
|
|
|
|
|
|
|
def skip?(value)
|
|
|
|
@options.has_key?(:skip_if) && value == @options[:skip_if]
|
2013-03-08 13:18:56 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
attr_reader :name, :custom_filters, :format
|
2011-02-10 15:59:26 +00:00
|
|
|
|
2010-08-27 18:37:39 +00:00
|
|
|
class << self
|
|
|
|
def all
|
|
|
|
@selectors ||= {}
|
|
|
|
end
|
|
|
|
|
2013-02-18 22:41:44 +00:00
|
|
|
def add(name, &block)
|
|
|
|
all[name.to_sym] = Capybara::Selector.new(name.to_sym, &block)
|
2010-08-27 18:37:39 +00:00
|
|
|
end
|
|
|
|
|
2016-01-07 01:11:00 +00:00
|
|
|
def update(name, &block)
|
|
|
|
all[name.to_sym].instance_eval(&block)
|
|
|
|
end
|
|
|
|
|
2010-08-27 18:37:39 +00:00
|
|
|
def remove(name)
|
|
|
|
all.delete(name.to_sym)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2013-02-18 22:41:44 +00:00
|
|
|
def initialize(name, &block)
|
2010-08-27 18:37:39 +00:00
|
|
|
@name = name
|
2012-01-02 11:46:04 +00:00
|
|
|
@custom_filters = {}
|
2012-01-08 13:50:41 +00:00
|
|
|
@match = nil
|
2012-12-02 06:13:37 +00:00
|
|
|
@label = nil
|
2012-01-08 13:50:55 +00:00
|
|
|
@failure_message = nil
|
2014-07-02 18:17:53 +00:00
|
|
|
@description = nil
|
2010-10-22 11:29:08 +00:00
|
|
|
instance_eval(&block)
|
|
|
|
end
|
|
|
|
|
|
|
|
def xpath(&block)
|
2016-01-07 01:11:00 +00:00
|
|
|
if block
|
|
|
|
@format = :xpath
|
|
|
|
@xpath, @css = block, nil
|
|
|
|
end
|
2010-10-22 11:29:08 +00:00
|
|
|
@xpath
|
|
|
|
end
|
|
|
|
|
2011-09-29 20:04:51 +00:00
|
|
|
# Same as xpath, but wrap in XPath.css().
|
|
|
|
def css(&block)
|
2016-01-07 01:11:00 +00:00
|
|
|
if block
|
|
|
|
@format = :css
|
|
|
|
@css, @xpath = block, nil
|
|
|
|
end
|
2013-02-19 17:30:16 +00:00
|
|
|
@css
|
2011-09-29 20:04:51 +00:00
|
|
|
end
|
|
|
|
|
2010-10-22 11:29:08 +00:00
|
|
|
def match(&block)
|
|
|
|
@match = block if block
|
|
|
|
@match
|
2010-08-27 18:37:39 +00:00
|
|
|
end
|
|
|
|
|
2012-06-08 13:53:25 +00:00
|
|
|
def label(label=nil)
|
|
|
|
@label = label if label
|
|
|
|
@label
|
2011-02-04 15:16:46 +00:00
|
|
|
end
|
|
|
|
|
2014-07-02 18:17:53 +00:00
|
|
|
def description(options={})
|
|
|
|
(@description && @description.call(options)).to_s
|
|
|
|
end
|
|
|
|
|
2012-01-03 18:33:39 +00:00
|
|
|
def call(locator)
|
2013-02-19 17:30:16 +00:00
|
|
|
if @format==:css
|
|
|
|
@css.call(locator)
|
|
|
|
else
|
|
|
|
@xpath.call(locator)
|
|
|
|
end
|
2010-08-27 18:37:39 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def match?(locator)
|
2010-10-22 11:29:08 +00:00
|
|
|
@match and @match.call(locator)
|
2010-08-27 18:37:39 +00:00
|
|
|
end
|
2012-01-02 11:46:04 +00:00
|
|
|
|
2013-03-08 13:18:56 +00:00
|
|
|
def filter(name, options={}, &block)
|
|
|
|
@custom_filters[name] = Filter.new(name, block, options)
|
2012-01-02 11:46:04 +00:00
|
|
|
end
|
2014-07-02 18:17:53 +00:00
|
|
|
|
|
|
|
def describe &block
|
|
|
|
@description = block
|
|
|
|
end
|
2010-08-27 18:37:39 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2010-10-22 11:29:08 +00:00
|
|
|
Capybara.add_selector(:xpath) do
|
2011-09-05 16:14:10 +00:00
|
|
|
xpath { |xpath| xpath }
|
2010-10-22 11:29:08 +00:00
|
|
|
end
|
|
|
|
|
2013-02-18 22:41:44 +00:00
|
|
|
Capybara.add_selector(:css) do
|
2011-09-29 20:17:32 +00:00
|
|
|
css { |css| css }
|
2010-10-22 11:29:08 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:id) do
|
2011-09-05 16:14:10 +00:00
|
|
|
xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
|
2010-10-22 11:29:08 +00:00
|
|
|
end
|
2011-08-27 02:16:15 +00:00
|
|
|
|
|
|
|
Capybara.add_selector(:field) do
|
2011-09-05 16:14:10 +00:00
|
|
|
xpath { |locator| XPath::HTML.field(locator) }
|
2014-07-02 18:17:53 +00:00
|
|
|
filter(:checked, boolean: true) { |node, value| not(value ^ node.checked?) }
|
|
|
|
filter(:unchecked, boolean: true) { |node, value| (value ^ node.checked?) }
|
2015-09-19 18:42:45 +00:00
|
|
|
filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
2015-08-25 21:25:42 +00:00
|
|
|
filter(:readonly, boolean: true) { |node, value| not(value ^ node[:readonly]) }
|
2013-09-25 13:07:02 +00:00
|
|
|
filter(:with) { |node, with| node.value == with.to_s }
|
2013-03-07 17:59:16 +00:00
|
|
|
filter(:type) do |node, type|
|
|
|
|
if ['textarea', 'select'].include?(type)
|
|
|
|
node.tag_name == type
|
|
|
|
else
|
|
|
|
node[:type] == type
|
|
|
|
end
|
|
|
|
end
|
2016-02-03 19:02:19 +00:00
|
|
|
filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
|
2014-07-02 18:17:53 +00:00
|
|
|
describe do |options|
|
2016-03-01 21:53:19 +00:00
|
|
|
desc, states = String.new, []
|
2014-07-02 18:17:53 +00:00
|
|
|
desc << " of type #{options[:type].inspect}" if options[:type]
|
|
|
|
desc << " with value #{options[:with].to_s.inspect}" if options.has_key?(:with)
|
|
|
|
states << 'checked' if options[:checked] || (options.has_key?(:unchecked) && !options[:unchecked])
|
|
|
|
states << 'not checked' if options[:unchecked] || (options.has_key?(:checked) && !options[:checked])
|
2015-09-19 03:22:19 +00:00
|
|
|
states << 'disabled' if options[:disabled] == true
|
2014-07-02 18:17:53 +00:00
|
|
|
desc << " that is #{states.join(' and ')}" unless states.empty?
|
2016-02-03 19:02:19 +00:00
|
|
|
desc << " with the multiple attribute" if options[:multiple] == true
|
|
|
|
desc << " without the multiple attribute" if options[:multiple] === false
|
2014-07-02 18:17:53 +00:00
|
|
|
desc
|
|
|
|
end
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
2011-08-27 21:57:12 +00:00
|
|
|
Capybara.add_selector(:fieldset) do
|
2011-09-05 16:14:10 +00:00
|
|
|
xpath { |locator| XPath::HTML.fieldset(locator) }
|
2011-08-27 21:57:12 +00:00
|
|
|
end
|
|
|
|
|
2011-08-27 02:16:15 +00:00
|
|
|
Capybara.add_selector(:link_or_button) do
|
2012-06-08 13:53:25 +00:00
|
|
|
label "link or button"
|
2011-09-05 16:14:10 +00:00
|
|
|
xpath { |locator| XPath::HTML.link_or_button(locator) }
|
2014-07-02 18:17:53 +00:00
|
|
|
filter(:disabled, default: false, boolean: true) { |node, value| node.tag_name == "a" or not(value ^ node.disabled?) }
|
|
|
|
describe { |options| " that is disabled" if options[:disabled] }
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:link) do
|
2012-01-03 12:14:26 +00:00
|
|
|
xpath { |locator| XPath::HTML.link(locator) }
|
2015-08-25 21:25:42 +00:00
|
|
|
filter(:href) do |node, href|
|
2015-04-28 00:33:39 +00:00
|
|
|
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
|
2012-01-03 08:43:11 +00:00
|
|
|
end
|
2014-07-02 18:17:53 +00:00
|
|
|
describe { |options| " with href #{options[:href].inspect}" if options[:href] }
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:button) do
|
2011-09-05 16:14:10 +00:00
|
|
|
xpath { |locator| XPath::HTML.button(locator) }
|
2015-09-19 18:42:45 +00:00
|
|
|
filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
2015-09-19 03:22:19 +00:00
|
|
|
describe { |options| " that is disabled" if options[:disabled] == true }
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:fillable_field) do
|
2012-06-08 15:07:12 +00:00
|
|
|
label "field"
|
2012-01-03 12:14:26 +00:00
|
|
|
xpath { |locator| XPath::HTML.fillable_field(locator) }
|
2015-09-19 18:42:45 +00:00
|
|
|
filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
2016-02-03 19:02:19 +00:00
|
|
|
filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
|
|
|
|
describe do |options|
|
2016-03-01 21:53:19 +00:00
|
|
|
desc = String.new
|
2016-02-03 19:02:19 +00:00
|
|
|
desc << " that is disabled" if options[:disabled] == true
|
|
|
|
desc << " with the multiple attribute" if options[:multiple] == true
|
|
|
|
desc << " without the multiple attribute" if options[:multiple] === false
|
|
|
|
desc
|
|
|
|
end
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:radio_button) do
|
2012-06-08 15:07:12 +00:00
|
|
|
label "radio button"
|
2012-01-03 12:14:26 +00:00
|
|
|
xpath { |locator| XPath::HTML.radio_button(locator) }
|
2014-07-02 18:17:53 +00:00
|
|
|
filter(:checked, boolean: true) { |node, value| not(value ^ node.checked?) }
|
|
|
|
filter(:unchecked, boolean: true) { |node, value| (value ^ node.checked?) }
|
2013-10-20 17:59:07 +00:00
|
|
|
filter(:option) { |node, value| node.value == value.to_s }
|
2015-09-19 18:42:45 +00:00
|
|
|
filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
2014-07-02 18:17:53 +00:00
|
|
|
describe do |options|
|
2016-03-01 21:53:19 +00:00
|
|
|
desc, states = String.new, []
|
2014-07-02 18:17:53 +00:00
|
|
|
desc << " with value #{options[:option].inspect}" if options[:option]
|
|
|
|
states << 'checked' if options[:checked] || (options.has_key?(:unchecked) && !options[:unchecked])
|
|
|
|
states << 'not checked' if options[:unchecked] || (options.has_key?(:checked) && !options[:checked])
|
2015-09-19 03:22:19 +00:00
|
|
|
states << 'disabled' if options[:disabled] == true
|
2014-07-02 18:17:53 +00:00
|
|
|
desc << " that is #{states.join(' and ')}" unless states.empty?
|
|
|
|
desc
|
|
|
|
end
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:checkbox) do
|
2012-01-03 12:14:26 +00:00
|
|
|
xpath { |locator| XPath::HTML.checkbox(locator) }
|
2014-07-02 18:17:53 +00:00
|
|
|
filter(:checked, boolean: true) { |node, value| not(value ^ node.checked?) }
|
|
|
|
filter(:unchecked, boolean: true) { |node, value| (value ^ node.checked?) }
|
2013-10-20 17:59:07 +00:00
|
|
|
filter(:option) { |node, value| node.value == value.to_s }
|
2015-09-19 18:42:45 +00:00
|
|
|
filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
2014-07-02 18:17:53 +00:00
|
|
|
describe do |options|
|
2016-03-01 21:53:19 +00:00
|
|
|
desc, states = String.new, []
|
2014-07-02 18:17:53 +00:00
|
|
|
desc << " with value #{options[:option].inspect}" if options[:option]
|
|
|
|
states << 'checked' if options[:checked] || (options.has_key?(:unchecked) && !options[:unchecked])
|
|
|
|
states << 'not checked' if options[:unchecked] || (options.has_key?(:checked) && !options[:checked])
|
2015-09-19 03:22:19 +00:00
|
|
|
states << 'disabled' if options[:disabled] == true
|
2014-07-02 18:17:53 +00:00
|
|
|
desc << " that is #{states.join(' and ')}" unless states.empty?
|
|
|
|
desc
|
|
|
|
end
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:select) do
|
2012-06-08 15:07:12 +00:00
|
|
|
label "select box"
|
2012-01-03 12:14:26 +00:00
|
|
|
xpath { |locator| XPath::HTML.select(locator) }
|
2012-03-16 03:14:47 +00:00
|
|
|
filter(:options) do |node, options|
|
2015-10-06 20:42:45 +00:00
|
|
|
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
|
2012-03-16 03:14:47 +00:00
|
|
|
options.sort == actual.sort
|
|
|
|
end
|
2015-10-06 20:42:45 +00:00
|
|
|
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
|
2012-01-02 16:12:21 +00:00
|
|
|
filter(:selected) do |node, selected|
|
2015-10-06 20:42:45 +00:00
|
|
|
actual = node.all(:xpath, './/option', visible: false).select { |option| option.selected? }.map { |option| option.text(:all) }
|
2012-03-25 04:29:24 +00:00
|
|
|
[selected].flatten.sort == actual.sort
|
2012-01-02 16:12:21 +00:00
|
|
|
end
|
2015-09-19 18:42:45 +00:00
|
|
|
filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
2016-02-03 19:02:19 +00:00
|
|
|
filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
|
2014-07-02 18:17:53 +00:00
|
|
|
describe do |options|
|
2016-03-01 21:53:19 +00:00
|
|
|
desc = String.new
|
2014-07-02 18:17:53 +00:00
|
|
|
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]
|
2015-09-19 03:22:19 +00:00
|
|
|
desc << " that is disabled" if options[:disabled] == true
|
2016-02-03 19:02:19 +00:00
|
|
|
desc << " that allows multiple selection" if options[:multiple] == true
|
|
|
|
desc << " that only allows single selection" if options[:multiple] === false
|
2014-07-02 18:17:53 +00:00
|
|
|
desc
|
|
|
|
end
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:option) do
|
2011-09-05 16:14:10 +00:00
|
|
|
xpath { |locator| XPath::HTML.option(locator) }
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Capybara.add_selector(:file_field) do
|
2012-06-08 15:07:12 +00:00
|
|
|
label "file field"
|
2012-01-03 12:14:26 +00:00
|
|
|
xpath { |locator| XPath::HTML.file_field(locator) }
|
2015-09-19 18:42:45 +00:00
|
|
|
filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
|
2016-02-03 19:02:19 +00:00
|
|
|
filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
|
|
|
|
describe do |options|
|
2016-03-01 21:53:19 +00:00
|
|
|
desc = String.new
|
2016-02-03 19:02:19 +00:00
|
|
|
desc << " that is disabled" if options[:disabled] == true
|
|
|
|
desc << " that allows multiple files" if options[:multiple] == true
|
|
|
|
desc << " that only allows a single file" if options[:multiple] === false
|
|
|
|
desc
|
|
|
|
end
|
2011-08-27 02:16:15 +00:00
|
|
|
end
|
2011-08-27 21:54:55 +00:00
|
|
|
|
|
|
|
Capybara.add_selector(:table) do
|
2012-01-03 12:14:26 +00:00
|
|
|
xpath { |locator| XPath::HTML.table(locator) }
|
2011-08-27 21:54:55 +00:00
|
|
|
end
|