class RSpec::Matchers::BuiltIn::Compound

@api private Base class for ‘and` and `or` compound matchers.

Attributes

evaluator[R]

@private

matcher_1[R]

@private

matcher_2[R]

@private

Public Class Methods

new(matcher_1, matcher_2) click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 10
def initialize(matcher_1, matcher_2)
  @matcher_1 = matcher_1
  @matcher_2 = matcher_2
end

Public Instance Methods

description() click to toggle source

@api private @return [String]

# File lib/rspec/matchers/built_in/compound.rb, line 25
def description
  "#{matcher_1.description} #{conjunction} #{matcher_2.description}"
end
diffable?() click to toggle source

@api private @return [Boolean]

# File lib/rspec/matchers/built_in/compound.rb, line 49
def diffable?
  matcher_is_diffable?(matcher_1) || matcher_is_diffable?(matcher_2)
end
does_not_match?(_actual) click to toggle source

@private

# File lib/rspec/matchers/built_in/compound.rb, line 16
def does_not_match?(_actual)
  raise NotImplementedError, "`expect(...).not_to matcher.#{conjunction} matcher` " \
    "is not supported, since it creates a bit of an ambiguity. Instead, define negated versions " \
    "of whatever matchers you wish to negate with `RSpec::Matchers.define_negated_matcher` and " \
    "use `expect(...).to matcher.#{conjunction} matcher`."
end
expected() click to toggle source

@api private @return [RSpec::Matchers::MultiMatcherDiff]

# File lib/rspec/matchers/built_in/compound.rb, line 55
def expected
  return nil unless evaluator
  ::RSpec::Matchers::MultiMatcherDiff.for_many_matchers(diffable_matcher_list)
end
expects_call_stack_jump?() click to toggle source

@api private

# File lib/rspec/matchers/built_in/compound.rb, line 42
def expects_call_stack_jump?
  NestedEvaluator.matcher_expects_call_stack_jump?(matcher_1) ||
  NestedEvaluator.matcher_expects_call_stack_jump?(matcher_2)
end
supports_block_expectations?() click to toggle source

@api private

# File lib/rspec/matchers/built_in/compound.rb, line 30
def supports_block_expectations?
  matcher_supports_block_expectations?(matcher_1) &&
  matcher_supports_block_expectations?(matcher_2)
end
supports_value_expectations?() click to toggle source

@api private

# File lib/rspec/matchers/built_in/compound.rb, line 36
def supports_value_expectations?
  matcher_supports_value_expectations?(matcher_1) &&
  matcher_supports_value_expectations?(matcher_2)
end

Protected Instance Methods

diffable_matcher_list() click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 62
def diffable_matcher_list
  list = []
  list.concat(diffable_matcher_list_for(matcher_1)) unless matcher_1_matches?
  list.concat(diffable_matcher_list_for(matcher_2)) unless matcher_2_matches?
  list
end

Private Instance Methods

compound_failure_message() click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 96
def compound_failure_message
  "#{indent_multiline_message(matcher_1.failure_message.sub(/\n+\z/, ''))}" \
  "\n\n...#{conjunction}:" \
  "\n\n#{indent_multiline_message(matcher_2.failure_message.sub(/\A\n+/, ''))}"
end
diffable_matcher_list_for(matcher) click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 128
def diffable_matcher_list_for(matcher)
  return [] unless matcher_is_diffable?(matcher)
  return matcher.diffable_matcher_list if Compound === matcher
  [matcher]
end
indent_multiline_message(message) click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 90
def indent_multiline_message(message)
  message.lines.map do |line|
    line =~ /\S/ ? '   ' + line : line
  end.join
end
initialize_copy(other) click to toggle source
Calls superclass method
# File lib/rspec/matchers/built_in/compound.rb, line 71
def initialize_copy(other)
  @matcher_1 = @matcher_1.clone
  @matcher_2 = @matcher_2.clone
  super
end
match(_expected, actual) click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 77
def match(_expected, actual)
  evaluator_klass = if supports_block_expectations? && Proc === actual
                      NestedEvaluator
                    elsif supports_value_expectations?
                      SequentialEvaluator
                    else
                      # Can't raise an ArgumentError in this context, as it's rescued
                      raise "Block and value matchers can't be combined in a compound expectation (#{matcher_1.description}, #{matcher_2.description})"
                    end

  @evaluator = evaluator_klass.new(actual, matcher_1, matcher_2)
end
matcher_1_matches?() click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 102
def matcher_1_matches?
  evaluator.matcher_matches?(matcher_1)
end
matcher_2_matches?() click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 106
def matcher_2_matches?
  evaluator.matcher_matches?(matcher_2)
end
matcher_is_diffable?(matcher) click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 122
def matcher_is_diffable?(matcher)
  matcher.diffable?
rescue NoMethodError
  false
end
matcher_supports_block_expectations?(matcher) click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 110
def matcher_supports_block_expectations?(matcher)
  matcher.supports_block_expectations?
rescue NoMethodError
  false
end
matcher_supports_value_expectations?(matcher) click to toggle source
# File lib/rspec/matchers/built_in/compound.rb, line 116
def matcher_supports_value_expectations?(matcher)
  matcher.supports_value_expectations?
rescue NoMethodError
  true
end