module RSpec::Core::Notifications

The ‘DeprecationNotification` is issued by the reporter when a deprecated part of RSpec is encountered. It represents information about the deprecated call site.

@attr message [String] A custom message about the deprecation @attr deprecated [String] A custom message about the deprecation (alias of

message)

@attr replacement [String] An optional replacement for the deprecation @attr call_site [String] An optional call site from which the deprecation

was issued

The ‘ExampleNotification` represents notifications sent by the reporter which contain information about the current (or soon to be) example. It is used by formatters to access information about that example.

@example

def example_started(notification)
  puts "Hey I started #{notification.example.description}"
end

@attr example [RSpec::Core::Example] the current example

The ‘GroupNotification` represents notifications sent by the reporter which contain information about the currently running (or soon to be) example group. It is used by formatters to access information about that group.

@example

def example_group_started(notification)
  puts "Hey I started #{notification.group.description}"
end

@attr group [RSpec::Core::ExampleGroup] the current group

The ‘MessageNotification` encapsulates generic messages that the reporter sends to formatters.

@attr message [String] the message

The ‘SeedNotification` holds the seed used to randomize examples and whether that seed has been used or not.

@attr seed [Fixnum] the seed used to randomize ordering @attr used [Boolean] whether the seed has been used or not

The ‘StartNotification` represents a notification sent by the reporter when the suite is started. It contains the expected amount of examples to be executed, and the load time of RSpec.

@attr count [Fixnum] the number counted @attr load_time [Float] the number of seconds taken to boot RSpec

and load the spec files

The ‘SummaryNotification` holds information about the results of running a test suite. It is used by formatters to provide information at the end of the test run.

@attr duration [Float] the time taken (in seconds) to run the suite @attr examples [Array<RSpec::Core::Example>] the examples run @attr failed_examples [Array<RSpec::Core::Example>] the failed examples @attr pending_examples [Array<RSpec::Core::Example>] the pending examples @attr load_time [Float] the number of seconds taken to boot RSpec

and load the spec files

@attr errors_outside_of_examples_count [Integer] the number of errors that

have occurred processing
the spec suite