class RSpec::Expectations::FailureAggregator

@private

Attributes

block_label[R]
metadata[R]

Public Class Methods

new(block_label, metadata) click to toggle source
# File lib/rspec/expectations/failure_aggregator.rb, line 73
def initialize(block_label, metadata)
  @block_label     = block_label
  @metadata        = metadata
  @seen_source_ids = {} # don't want to load stdlib set
end

Public Instance Methods

aggregate() { || ... } click to toggle source
# File lib/rspec/expectations/failure_aggregator.rb, line 7
def aggregate
  RSpec::Support.with_failure_notifier(self) do
    begin
      yield
    rescue ExpectationNotMetError => e
      # Normally, expectation failures will be notified via the `call` method, below,
      # but since the failure notifier uses a thread local variable, failing expectations
      # in another thread will still raise. We handle that here and categorize it as part
      # of `failures` rather than letting it fall through and be categorized as part of
      # `other_errors`.
      failures << e
    rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e
      # While it is normally a bad practice to rescue `Exception`, it's important we do
      # so here. It's low risk (`notify_aggregated_failures` below will re-raise the exception,
      # or raise a `MultipleExpectationsNotMetError` that includes the exception), and it's
      # essential that the user is notified of expectation failures that may have already
      # occurred in the `aggregate_failures` block. Those expectation failures may provide
      # important diagnostics for understanding why this exception occurred, and if we simply
      # allowed this exception to be raised as-is, it would (wrongly) suggest to the user
      # that the expectation passed when it did not, which would be quite confusing.
      other_errors << e
    end
  end

  notify_aggregated_failures
end
call(failure, options) click to toggle source

This method is defined to satisfy the callable interface expected by ‘RSpec::Support.with_failure_notifier`.

# File lib/rspec/expectations/failure_aggregator.rb, line 44
def call(failure, options)
  source_id = options[:source_id]
  return if source_id && @seen_source_ids.key?(source_id)

  @seen_source_ids[source_id] = true
  assign_backtrace(failure) unless failure.backtrace
  failures << failure
end
failures() click to toggle source
# File lib/rspec/expectations/failure_aggregator.rb, line 34
def failures
  @failures ||= []
end
other_errors() click to toggle source
# File lib/rspec/expectations/failure_aggregator.rb, line 38
def other_errors
  @other_errors ||= []
end

Private Instance Methods

assign_backtrace(failure) click to toggle source

On JRuby 9.1.x.x and before, ‘caller` and `raise` produce different backtraces with regards to `.java` stack frames. It’s important that we use ‘raise` for JRuby to produce a backtrace that has a continuous common section with the raised `MultipleExpectationsNotMetError`, so that rspec-core’s truncation logic can work properly on it to list the backtrace relative to the ‘aggregate_failures` block.

# File lib/rspec/expectations/failure_aggregator.rb, line 61
def assign_backtrace(failure)
  raise failure
rescue failure.class => e
  failure.set_backtrace(e.backtrace)
end
notify_aggregated_failures() click to toggle source
# File lib/rspec/expectations/failure_aggregator.rb, line 79
def notify_aggregated_failures
  all_errors = failures + other_errors

  case all_errors.size
  when 0 then return true
  when 1 then RSpec::Support.notify_failure all_errors.first
  else RSpec::Support.notify_failure MultipleExpectationsNotMetError.new(self)
  end
end