class Capybara::Queries::TextQuery

Public Class Methods

new(type = nil, expected_text, session_options:, **options) click to toggle source
Calls superclass method Capybara::Queries::BaseQuery::new
# File lib/capybara/queries/text_query.rb, line 7
def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments
  @type = type.nil? ? default_type : type
  @options = options
  super(@options)
  self.session_options = session_options

  if expected_text.nil? && !exact?
    warn 'Checking for expected text of nil is confusing and/or pointless since it will always match. '\
         'Please specify a string or regexp instead.'
  end

  @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s

  @search_regexp = Capybara::Helpers.to_regexp(@expected_text, exact: exact?)

  assert_valid_keys
end

Public Instance Methods

description() click to toggle source
# File lib/capybara/queries/text_query.rb, line 39
def description
  if @expected_text.is_a?(Regexp)
    "text matching #{@expected_text.inspect}"
  else
    "#{'exact ' if exact?}text #{@expected_text.inspect}"
  end
end
failure_message() click to toggle source
# File lib/capybara/queries/text_query.rb, line 31
def failure_message
  super << build_message(true)
end
negative_failure_message() click to toggle source
# File lib/capybara/queries/text_query.rb, line 35
def negative_failure_message
  super << build_message(false)
end
resolve_for(node) click to toggle source
# File lib/capybara/queries/text_query.rb, line 25
def resolve_for(node)
  @node = node
  @actual_text = text
  @count = @actual_text.scan(@search_regexp).size
end

Private Instance Methods

build_message(report_on_invisible) click to toggle source
# File lib/capybara/queries/text_query.rb, line 53
def build_message(report_on_invisible)
  message = +''
  unless (COUNT_KEYS & @options.keys).empty?
    message << " but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}"
  end
  message << " in #{@actual_text.inspect}"

  details_message = []
  details_message << case_insensitive_message if @node && check_case_insensitive?
  details_message << invisible_message if @node && check_visible_text? && report_on_invisible
  details_message.compact!

  message << ". (However, #{details_message.join(' and ')}.)" unless details_message.empty?
  message
end
case_insensitive_message() click to toggle source
# File lib/capybara/queries/text_query.rb, line 69
def case_insensitive_message
  insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, options: Regexp::IGNORECASE)
  insensitive_count = @actual_text.scan(insensitive_regexp).size
  return if insensitive_count == @count

  "it was found #{occurrences insensitive_count} using a case insensitive search"
end
check_case_insensitive?() click to toggle source
# File lib/capybara/queries/text_query.rb, line 96
def check_case_insensitive?
  !@expected_text.is_a?(Regexp)
end
check_visible_text?() click to toggle source
# File lib/capybara/queries/text_query.rb, line 92
def check_visible_text?
  @type == :visible
end
default_type() click to toggle source
# File lib/capybara/queries/text_query.rb, line 105
def default_type
  Capybara.ignore_hidden_elements || Capybara.visible_text_only ? :visible : :all
end
exact?() click to toggle source
# File lib/capybara/queries/text_query.rb, line 49
def exact?
  options.fetch(:exact, session_options.exact_text)
end
invisible_message() click to toggle source
# File lib/capybara/queries/text_query.rb, line 77
def invisible_message
  invisible_text = text(query_type: :all)
  invisible_count = invisible_text.scan(@search_regexp).size
  return if invisible_count == @count

  "it was found #{occurrences invisible_count} including non-visible text"
rescue StandardError
  # An error getting the non-visible text (if element goes out of scope) should not affect the response
  nil
end
text(node: @node, query_type: @type) click to toggle source
# File lib/capybara/queries/text_query.rb, line 100
def text(node: @node, query_type: @type)
  normalize_ws = options.fetch(:normalize_ws, session_options.default_normalize_ws)
  node.text(query_type, normalize_ws: normalize_ws)
end
valid_keys() click to toggle source
# File lib/capybara/queries/text_query.rb, line 88
def valid_keys
  COUNT_KEYS + %i[wait exact normalize_ws]
end