class Capybara::Result

A {Capybara::Result} represents a collection of {Capybara::Node::Element} on the page. It is possible to interact with this collection similar to an Array because it implements Enumerable and offers the following Array methods through delegation:

@see Capybara::Node::Element

Public Class Methods

new(elements, query) click to toggle source
# File lib/capybara/result.rb, line 28
def initialize(elements, query)
  @elements = elements
  @result_cache = []
  @filter_errors = []
  @results_enum = lazy_select_elements { |node| query.matches_filters?(node, @filter_errors) }
  @query = query
end

Public Instance Methods

[](*args) click to toggle source
# File lib/capybara/result.rb, line 52
def [](*args)
  idx, length = args
  max_idx = case idx
  when Integer
    if !idx.negative?
      length.nil? ? idx : idx + length - 1
    else
      nil
    end
  when Range
    idx.end && idx.max # endless range will have end == nil
  end

  if max_idx.nil?
    full_results[*args]
  else
    load_up_to(max_idx + 1)
    @result_cache[*args]
  end
end
Also aliased as: at
at(*args)
Alias for: []
compare_count() click to toggle source
# File lib/capybara/result.rb, line 78
def compare_count
  return 0 unless @query

  count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)

  # Only check filters for as many elements as necessary to determine result
  if count && (count = Integer(count))
    return load_up_to(count + 1) <=> count
  end

  if min && (min = Integer(min))
    return -1 if load_up_to(min) < min
  end

  if max && (max = Integer(max))
    return 1 if load_up_to(max + 1) > max
  end

  if between
    min, max = between.min, (between.end && between.max)
    size = load_up_to(max ? max + 1 : min)
    return size <=> min unless between.include?(size)
  end

  0
end
each() { |next_result| ... } click to toggle source
# File lib/capybara/result.rb, line 40
def each(&block)
  return enum_for(:each) unless block_given?

  @result_cache.each(&block)
  loop do
    next_result = @results_enum.next
    @result_cache << next_result
    yield next_result
  end
  self
end
empty?() click to toggle source
# File lib/capybara/result.rb, line 74
def empty?
  !any?
end
failure_message() click to toggle source
# File lib/capybara/result.rb, line 109
def failure_message
  message = @query.failure_message
  if count.zero?
    message << ' but there were no matches'
  else
    message << ", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: " \
            << full_results.map(&:text).map(&:inspect).join(', ')
  end
  unless rest.empty?
    elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier
    message << '. Also found ' << elements << ', which matched the selector but not all filters. '
    message << @filter_errors.join('. ') if (rest.size == 1) && count.zero?
  end
  message
end
matches_count?() click to toggle source
# File lib/capybara/result.rb, line 105
def matches_count?
  compare_count.zero?
end
negative_failure_message() click to toggle source
# File lib/capybara/result.rb, line 125
def negative_failure_message
  failure_message.sub(/(to find)/, 'not \1')
end
unfiltered_size() click to toggle source
# File lib/capybara/result.rb, line 129
def unfiltered_size
  @elements.length
end

Private Instance Methods

full_results() click to toggle source
# File lib/capybara/result.rb, line 144
def full_results
  loop { @result_cache << @results_enum.next }
  @result_cache
end
lazy_select_elements(&block) click to toggle source
# File lib/capybara/result.rb, line 153
def lazy_select_elements(&block)
  # JRuby < 9.2.8.0 has an issue with lazy enumerators which
  # causes a concurrency issue with network requests here
  # https://github.com/jruby/jruby/issues/4212
  if (RUBY_PLATFORM == 'java') && (Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.2.8.0'))
    # :nocov:
    @elements.select(&block).to_enum # non-lazy evaluation
    # :nocov:
  else
    @elements.lazy.select(&block)
  end
end
load_up_to(num) click to toggle source
# File lib/capybara/result.rb, line 135
def load_up_to(num)
  loop do
    break if @result_cache.size >= num

    @result_cache << @results_enum.next
  end
  @result_cache.size
end
rest() click to toggle source
# File lib/capybara/result.rb, line 149
def rest
  @rest ||= @elements - full_results
end