class Capybara::Queries::SelectorQuery
Constants
- VALID_KEYS
- VALID_MATCH
Attributes
expression[RW]
find[RW]
locator[RW]
negative[RW]
options[RW]
selector[RW]
Public Class Methods
new(*args, session_options:, **options, &filter_block)
click to toggle source
Calls superclass method
Capybara::Queries::BaseQuery.new
# File lib/capybara/queries/selector_query.rb, line 11 def initialize(*args, session_options:, **options, &filter_block) @resolved_node = nil @options = options.dup super(@options) self.session_options = session_options @selector = find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]) @locator = args.shift @filter_block = filter_block raise ArgumentError, "Unused parameters passed to #{self.class.name} : #{args}" unless args.empty? @expression = @selector.call(@locator, @options.merge(enable_aria_label: session_options.enable_aria_label)) warn_exact_usage assert_valid_keys end
Public Instance Methods
css()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 85 def css filtered_css(apply_expression_filters(@expression)) end
description()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 33 def description @description = "".dup @description << "visible " if visible == :visible @description << "non-visible " if visible == :hidden @description << "#{label} #{locator.inspect}" @description << " with#{" exact" if exact_text == true} text #{options[:text].inspect}" if options[:text] @description << " with exact text #{options[:exact_text]}" if options[:exact_text].is_a?(String) @description << " with id #{options[:id]}" if options[:id] @description << " with classes [#{Array(options[:class]).join(',')}]" if options[:class] @description << selector.description(options) @description << " that also matches the custom filter block" if @filter_block @description << " within #{@resolved_node.inspect}" if describe_within? @description end
exact?()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 70 def exact? supports_exact? ? options.fetch(:exact, session_options.exact) : false end
label()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 31 def label; selector.label || selector.name; end
match()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 74 def match options.fetch(:match, session_options.match) end
matches_filters?(node)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 48 def matches_filters?(node) return false if options[:text] && !matches_text_filter(node, options[:text]) return false if exact_text.is_a?(String) && !matches_exact_text_filter(node, exact_text) case visible when :visible then return false unless node.visible? when :hidden then return false if node.visible? end matches_node_filters?(node) && matches_filter_block?(node) rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : []) return false end
name()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 30 def name; selector.name; end
resolve_for(node, exact = nil)
click to toggle source
@api private
# File lib/capybara/queries/selector_query.rb, line 90 def resolve_for(node, exact = nil) @resolved_node = node node.synchronize do children = if selector.format == :css node.find_css(css) else node.find_xpath(xpath(exact)) end.map do |child| if node.is_a?(Capybara::Node::Base) Capybara::Node::Element.new(node.session, child, node, self) else Capybara::Node::Simple.new(child) end end Capybara::Result.new(children, self) end end
supports_exact?()
click to toggle source
@api private
# File lib/capybara/queries/selector_query.rb, line 109 def supports_exact? @expression.respond_to? :to_xpath end
visible()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 62 def visible case (vis = options.fetch(:visible) { @selector.default_visibility(session_options.ignore_hidden_elements) }) when true then :visible when false then :all else vis end end
xpath(exact = nil)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 78 def xpath(exact = nil) exact = exact? if exact.nil? expr = apply_expression_filters(@expression) expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath) filtered_xpath(expr) end
Private Instance Methods
apply_expression_filters(expr)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 201 def apply_expression_filters(expr) expression_filters.inject(expr) do |memo, (name, ef)| if options.key?(name) ef.apply_filter(memo, options[name]) elsif ef.default? ef.apply_filter(memo, ef.default) else memo end end end
assert_valid_keys()
click to toggle source
Calls superclass method
Capybara::Queries::BaseQuery#assert_valid_keys
# File lib/capybara/queries/selector_query.rb, line 168 def assert_valid_keys super unless VALID_MATCH.include?(match) raise ArgumentError, "invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(", ")}" end end
custom_keys()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 164 def custom_keys @custom_keys ||= node_filters.keys + expression_filters.keys end
describe_within?()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 222 def describe_within? @resolved_node && !(@resolved_node.is_a?(::Capybara::Node::Document) || (@resolved_node.is_a?(::Capybara::Node::Simple) && @resolved_node.path == '/')) end
exact_text()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 218 def exact_text options.fetch(:exact_text, session_options.exact_text) end
expression_filters()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 158 def expression_filters filters = @selector.expression_filters filters.merge ::Capybara::Selector::FilterSet.all[options[:filter_set]].expression_filters if options.key?(:filter_set) filters end
filtered_css(expr)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 189 def filtered_css(expr) if options.key?(:id) || options.key?(:class) css_selectors = expr.split(',').map(&:rstrip) expr = css_selectors.map do |sel| sel += "##{Capybara::Selector::CSS.escape(options[:id])}" if options.key?(:id) && !custom_keys.include?(:id) sel += Array(options[:class]).map { |k| ".#{Capybara::Selector::CSS.escape(k)}" }.join if options.key?(:class) && !custom_keys.include?(:class) sel end.join(", ") end expr end
filtered_xpath(expr)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 175 def filtered_xpath(expr) if options.key?(:id) || options.key?(:class) expr = "(#{expr})" expr = "#{expr}[#{XPath.attr(:id) == options[:id]}]" if options.key?(:id) && !custom_keys.include?(:id) if options.key?(:class) && !custom_keys.include?(:class) class_xpath = Array(options[:class]).map do |klass| XPath.attr(:class).contains_word(klass) end.reduce(:&) expr = "#{expr}[#{class_xpath}]" end end expr end
find_selector(locator)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 115 def find_selector(locator) selector = if locator.is_a?(Symbol) Selector.all.fetch(locator) { |sel_type| raise ArgumentError, "Unknown selector type (:#{sel_type})" } else Selector.all.values.find { |s| s.match?(locator) } end selector || Selector.all[session_options.default_selector] end
matches_exact_text_filter(node, exact_text_option)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 240 def matches_exact_text_filter(node, exact_text_option) regexp = /\A#{Regexp.escape(exact_text_option)}\z/ text_visible = visible text_visible = :all if text_visible == :hidden node.text(text_visible).match(regexp) end
matches_filter_block?(node)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 140 def matches_filter_block?(node) return true unless @filter_block if node.respond_to?(:session) node.session.using_wait_time(0) { @filter_block.call(node) } else @filter_block.call(node) end end
matches_node_filters?(node)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 128 def matches_node_filters?(node) node_filters.all? do |name, filter| if options.key?(name) filter.matches?(node, options[name]) elsif filter.default? filter.matches?(node, filter.default) else true end end end
matches_text_filter(node, text_option)
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 227 def matches_text_filter(node, text_option) regexp = if text_option.is_a?(Regexp) text_option elsif exact_text == true /\A#{Regexp.escape(text_option.to_s)}\z/ else Regexp.escape(text_option.to_s) end text_visible = visible text_visible = :all if text_visible == :hidden node.text(text_visible).match(regexp) end
node_filters()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 150 def node_filters if options.key?(:filter_set) ::Capybara::Selector::FilterSet.all[options[:filter_set]].node_filters else @selector.node_filters end end
valid_keys()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 124 def valid_keys VALID_KEYS + custom_keys end
warn_exact_usage()
click to toggle source
# File lib/capybara/queries/selector_query.rb, line 213 def warn_exact_usage return unless options.key?(:exact) && !supports_exact? warn "The :exact option only has an effect on queries using the XPath#is method. Using it with the query \"#{expression}\" has no effect." end