Class: Capybara::Queries::BaseQuery Private

Inherits:
Object
  • Object
show all
Defined in:
lib/capybara/queries/base_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

CurrentPathQuery, SelectorQuery, TextQuery, TitleQuery

Constant Summary collapse

COUNT_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.

%i[count minimum maximum between].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BaseQuery

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 BaseQuery



12
13
14
# File 'lib/capybara/queries/base_query.rb', line 12

def initialize(options)
  @session_options = options.delete(:session_options)
end

Instance Attribute Details

#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.



9
10
11
# File 'lib/capybara/queries/base_query.rb', line 9

def options
  @options
end

#session_optionsObject

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.



16
17
18
# File 'lib/capybara/queries/base_query.rb', line 16

def session_options
  @session_options || Capybara.session_options
end

Class Method Details

.wait(options, default = Capybara.default_max_wait_time) ⇒ 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.



24
25
26
# File 'lib/capybara/queries/base_query.rb', line 24

def self.wait(options, default = Capybara.default_max_wait_time)
  options.fetch(:wait, default) || 0
end

Instance Method Details

#expects_none?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.

Checks if a count of 0 is valid for the query Returns false if query does not have any count options specified.

Returns:

  • (Boolean)


33
34
35
36
37
38
39
# File 'lib/capybara/queries/base_query.rb', line 33

def expects_none?
  if COUNT_KEYS.any? { |k| options.key? k }
    matches_count?(0)
  else
    false
  end
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.

Generates a failure message from the query description and count options.



62
63
64
# File 'lib/capybara/queries/base_query.rb', line 62

def failure_message
  String.new("expected to find #{description}") << count_message
end

#matches_count?(count) ⇒ 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.

Checks if the given count matches the query count options. Defaults to true if no count options are specified. If multiple count options exist, it tests that all conditions are met; however, if :count is specified, all other options are ignored.

Parameters:

  • count (Integer)

    The actual number. Should be coercible via Integer()

Returns:

  • (Boolean)


50
51
52
53
54
55
56
# File 'lib/capybara/queries/base_query.rb', line 50

def matches_count?(count)
  return (Integer(options[:count]) == count) if options[:count]
  return false if options[:maximum] && (Integer(options[:maximum]) < count)
  return false if options[:minimum] && (Integer(options[:minimum]) > count)
  return false if options[:between] && !options[:between].include?(count)
  return true
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.



66
67
68
# File 'lib/capybara/queries/base_query.rb', line 66

def negative_failure_message
  String.new("expected not to find #{description}") << count_message
end

#waitObject

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.



20
21
22
# File 'lib/capybara/queries/base_query.rb', line 20

def wait
  self.class.wait(options, session_options.default_max_wait_time)
end