teamcapybara--capybara/lib/capybara/queries/text_query.rb

102 lines
3.1 KiB
Ruby
Raw Normal View History

2016-03-08 00:52:19 +00:00
# frozen_string_literal: true
2018-01-08 20:23:54 +00:00
module Capybara
# @api private
module Queries
class TextQuery < BaseQuery
2018-01-09 22:05:50 +00:00
def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments
2018-01-13 21:06:03 +00:00
@type = if type.nil?
Capybara.ignore_hidden_elements || Capybara.visible_text_only ? :visible : :all
else
type
end
@expected_text = if expected_text.is_a?(Regexp)
expected_text
else
Capybara::Helpers.normalize_whitespace(expected_text)
end
2016-08-17 23:14:39 +00:00
@options = options
2017-05-28 15:54:55 +00:00
super(@options)
2016-08-17 23:14:39 +00:00
self.session_options = session_options
2018-01-13 21:06:03 +00:00
2016-12-23 20:17:45 +00:00
@search_regexp = Capybara::Helpers.to_regexp(@expected_text, nil, exact?)
2018-01-13 21:06:03 +00:00
assert_valid_keys
end
def resolve_for(node)
@node = node
@actual_text = text(node, @type)
@count = @actual_text.scan(@search_regexp).size
end
def failure_message
2016-08-30 18:37:54 +00:00
super << build_message(true)
end
def negative_failure_message
2016-08-30 18:37:54 +00:00
super << build_message(false)
end
def description
if @expected_text.is_a?(Regexp)
"text matching #{@expected_text.inspect}"
else
2016-12-23 20:17:45 +00:00
"#{"exact " if exact?}text #{@expected_text.inspect}"
2016-08-30 18:37:54 +00:00
end
end
2018-01-09 22:05:50 +00:00
private
2016-12-23 20:17:45 +00:00
def exact?
options.fetch(:exact, session_options.exact_text)
2016-12-23 20:17:45 +00:00
end
def build_message(report_on_invisible)
2018-01-09 22:05:50 +00:00
message = "".dup
unless (COUNT_KEYS & @options.keys).empty?
message << " but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}"
end
message << " in #{@actual_text.inspect}"
details_message = []
2018-01-12 00:45:50 +00:00
details_message << case_insensitive_message if @node and !@expected_text.is_a? Regexp
details_message << invisible_message if @node and check_visible_text? and report_on_invisible
details_message.compact!
2018-01-12 00:45:50 +00:00
message << ". (However, #{details_message.join(' and ')}.)" unless details_message.empty?
message
end
2018-01-12 00:45:50 +00:00
def case_insensitive_message
insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, Regexp::IGNORECASE)
insensitive_count = @actual_text.scan(insensitive_regexp).size
if insensitive_count != @count
"it was found #{insensitive_count} #{Capybara::Helpers.declension("time", "times", insensitive_count)} using a case insensitive search"
end
2018-01-12 00:45:50 +00:00
end
2018-01-12 00:45:50 +00:00
def invisible_message
invisible_text = text(@node, :all)
invisible_count = invisible_text.scan(@search_regexp).size
if invisible_count != @count
"it was found #{invisible_count} #{Capybara::Helpers.declension("time", "times", invisible_count)} including non-visible text"
end
rescue # An error getting the non-visible text (if element goes out of scope) should not affect the response
end
def valid_keys
2018-01-08 20:23:54 +00:00
COUNT_KEYS + %i[wait exact]
end
def check_visible_text?
@type == :visible
end
def text(node, query_type)
Capybara::Helpers.normalize_whitespace(node.text(query_type))
end
end
end
end