Class: Capybara::Queries::SelectorQuery Private

Inherits:
BaseQuery
  • Object
show all
Defined in:
lib/capybara/queries/selector_query.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Direct Known Subclasses

AncestorQuery, MatchQuery

Constant Summary collapse

VALID_KEYS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

COUNT_KEYS + %i[text id class visible exact exact_text normalize_ws match wait filter_set]
VALID_MATCH =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

%i[first smart prefer_exact one].freeze

Constants inherited from BaseQuery

BaseQuery::COUNT_KEYS

Instance Attribute Summary collapse

Attributes inherited from BaseQuery

#session_options

Instance Method Summary collapse

Methods inherited from BaseQuery

#expects_none?, #matches_count?, #wait, wait

Constructor Details

#initialize(*args, session_options:, enable_aria_label: session_options.enable_aria_label, test_id: session_options.test_id, **options, &filter_block) ⇒ SelectorQuery

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of SelectorQuery

Raises:

  • (ArgumentError)


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/capybara/queries/selector_query.rb', line 10

def initialize(*args,
               session_options:,
               enable_aria_label: session_options.enable_aria_label,
               test_id: session_options.test_id,
               **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?

  selector_config = { enable_aria_label: enable_aria_label, test_id: test_id }
  @expression = selector.call(@locator, @options.merge(selector_config: selector_config))

  warn_exact_usage

  assert_valid_keys
end

Instance Attribute Details

#expressionObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



6
7
8
# File 'lib/capybara/queries/selector_query.rb', line 6

def expression
  @expression
end

#locatorObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



6
7
8
# File 'lib/capybara/queries/selector_query.rb', line 6

def locator
  @locator
end

#optionsObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



6
7
8
# File 'lib/capybara/queries/selector_query.rb', line 6

def options
  @options
end

#selectorObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



6
7
8
# File 'lib/capybara/queries/selector_query.rb', line 6

def selector
  @selector
end

Instance Method Details

#applied_descriptionObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



59
60
61
# File 'lib/capybara/queries/selector_query.rb', line 59

def applied_description
  description(true)
end

#cssObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



97
98
99
# File 'lib/capybara/queries/selector_query.rb', line 97

def css
  filtered_expression(apply_expression_filters(@expression))
end

#description(only_applied = false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/capybara/queries/selector_query.rb', line 38

def description(only_applied = false)
  desc = +''
  show_for = show_for_stage(only_applied)

  if show_for[:any]
    desc << 'visible ' if visible == :visible
    desc << 'non-visible ' if visible == :hidden
  end
  desc << "#{label} #{locator.inspect}"
  if show_for[:any]
    desc << " with#{' exact' if exact_text == true} text #{options[:text].inspect}" if options[:text]
    desc << " with exact text #{exact_text}" if exact_text.is_a?(String)
  end
  desc << " with id #{options[:id]}" if options[:id]
  desc << " with classes [#{Array(options[:class]).join(',')}]" if options[:class]
  desc << selector.description(node_filters: show_for[:node], **options)
  desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]
  desc << " within #{@resolved_node.inspect}" if describe_within?
  desc
end

#exact?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)


82
83
84
# File 'lib/capybara/queries/selector_query.rb', line 82

def exact?
  supports_exact? ? options.fetch(:exact, session_options.exact) : false
end

#failure_messageObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



116
117
118
# File 'lib/capybara/queries/selector_query.rb', line 116

def failure_message
  +"expected to find #{applied_description}" << count_message
end

#labelObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



36
# File 'lib/capybara/queries/selector_query.rb', line 36

def label; selector.label || selector.name; end

#matchObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



86
87
88
# File 'lib/capybara/queries/selector_query.rb', line 86

def match
  options.fetch(:match, session_options.match)
end

#matches_filters?(node, node_filter_errors = []) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)


63
64
65
66
67
68
69
70
71
72
# File 'lib/capybara/queries/selector_query.rb', line 63

def matches_filters?(node, node_filter_errors = [])
  return true if (@resolved_node&.== node) && options[:allow_self]

  matches_locator_filter?(node) &&
    matches_system_filters?(node) &&
    matches_node_filters?(node, node_filter_errors) &&
    matches_filter_block?(node)
rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])
  false
end

#nameObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



35
# File 'lib/capybara/queries/selector_query.rb', line 35

def name; selector.name; end

#negative_failure_messageObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



120
121
122
# File 'lib/capybara/queries/selector_query.rb', line 120

def negative_failure_message
  +"expected not to find #{applied_description}" << count_message
end

#resolve_for(node, exact = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



102
103
104
105
106
107
108
109
# File 'lib/capybara/queries/selector_query.rb', line 102

def resolve_for(node, exact = nil)
  applied_filters.clear
  @resolved_node = node
  node.synchronize do
    children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))
    Capybara::Result.new(children, self)
  end
end

#supports_exact?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)


112
113
114
# File 'lib/capybara/queries/selector_query.rb', line 112

def supports_exact?
  @expression.respond_to? :to_xpath
end

#visibleObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



74
75
76
77
78
79
80
# File 'lib/capybara/queries/selector_query.rb', line 74

def visible
  case (vis = options.fetch(:visible) { default_visibility })
  when true then :visible
  when false then :all
  else vis
  end
end

#xpath(exact = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



90
91
92
93
94
95
# File 'lib/capybara/queries/selector_query.rb', line 90

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_expression(expr)
end