class Capybara::Queries::TextQuery

Public Class Methods

new(*args) click to toggle source
Calls superclass method Capybara::Queries::BaseQuery.new
# File lib/capybara/queries/text_query.rb, line 5
def initialize(*args)
  @type = (args.first.is_a?(Symbol) || args.first.nil?) ? args.shift : nil
  # @type = (Capybara.ignore_hidden_elements or Capybara.visible_text_only) ? :visible : :all if @type.nil?
  @options = if args.last.is_a?(Hash) then args.pop.dup else {} end
  super(@options)

  @type = (session_options.ignore_hidden_elements or session_options.visible_text_only) ? :visible : :all if @type.nil?

  @expected_text = args.shift
  unless @expected_text.is_a?(Regexp)
    @expected_text = Capybara::Helpers.normalize_whitespace(@expected_text)
  end
  @search_regexp = Capybara::Helpers.to_regexp(@expected_text, nil, exact?)
  warn "Unused parameters passed to #{self.class.name} : #{args.to_s}" unless args.empty?
  assert_valid_keys
end

Public Instance Methods

description() click to toggle source
# File lib/capybara/queries/text_query.rb, line 36
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 28
def failure_message
  super << build_message(true)
end
negative_failure_message() click to toggle source
# File lib/capybara/queries/text_query.rb, line 32
def negative_failure_message
  super << build_message(false)
end
resolve_for(node) click to toggle source
# File lib/capybara/queries/text_query.rb, line 22
def resolve_for(node)
  @node = node
  @actual_text = text(node, @type)
  @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 50
def build_message(report_on_invisible)
  message = String.new()
  unless (COUNT_KEYS & @options.keys).empty?
    message << " but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}"
  end
  message << " in #{@actual_text.inspect}"

  details_message = []

  if @node and !@expected_text.is_a? Regexp
    insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, Regexp::IGNORECASE)
    insensitive_count = @actual_text.scan(insensitive_regexp).size
    if insensitive_count != @count
      details_message << "it was found #{insensitive_count} #{Capybara::Helpers.declension("time", "times", insensitive_count)} using a case insensitive search"
    end
  end

  if @node and check_visible_text? and report_on_invisible
    begin
      invisible_text = text(@node, :all)
      invisible_count = invisible_text.scan(@search_regexp).size
      if invisible_count != @count
        details_message << ". 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
  end

  message << ". (However, #{details_message.join(' and ')}.)" unless details_message.empty?

  message
end
check_visible_text?() click to toggle source
# File lib/capybara/queries/text_query.rb, line 88
def check_visible_text?
  @type == :visible
end
exact?() click to toggle source
# File lib/capybara/queries/text_query.rb, line 46
def exact?
  options.fetch(:exact, session_options.exact_text)
end
text(node, query_type) click to toggle source
# File lib/capybara/queries/text_query.rb, line 92
def text(node, query_type)
  Capybara::Helpers.normalize_whitespace(node.text(query_type))
end
valid_keys() click to toggle source
# File lib/capybara/queries/text_query.rb, line 84
def valid_keys
  COUNT_KEYS + [:wait, :exact]
end