Class: RSpec::Core::Formatters::Protocol
| Relationships & Source Files | |
| Inherits: | Object |
| Defined in: | rspec-core/lib/rspec/core/formatters/protocol.rb |
Overview
This class isn’t loaded at runtime but serves to document all of the notifications implemented as part of the standard interface. The reporter will issue these during a normal test suite run, but a formatter will only receive those notifications it has registered itself to receive. To register a formatter call:
‘::RSpec::Core::Formatters.register class, :list, :of, :notifications`
e.g.
‘::RSpec::Core::Formatters.register self, :start, :example_started`
Suite Notifications
-
#close(notification)
Invoked at the end of a suite run.
-
#dump_failures(notification)
Dumps detailed information about each example failure.
-
#dump_pending(notification)
Outputs a report of pending examples.
-
#dump_profile(profile)
This method is invoked after the dumping the summary if profiling is enabled.
-
#dump_summary(summary)
This method is invoked after the dumping of examples and failures.
-
#message(notification)
Used by the reporter to send messages to the output stream.
-
#start(notification)
This method is invoked before any examples are run, right after they have all been collected.
-
#start_dump(notification)
This method is invoked after all of the examples have executed.
-
#stop(notification)
Invoked after all examples have executed, before dumping post-run reports.
Group Notifications
-
#example_group_finished(notification)
Invoked at the end of the execution of each example group.
-
#example_group_started(notification)
This method is invoked at the beginning of the execution of each example group.
Example Notifications
-
#example_failed(notification)
Invoked when an example fails.
-
#example_finished(notification)
Invoked at the end of the execution of each example.
-
#example_passed(notification)
Invoked when an example passes.
-
#example_pending(notification)
Invoked when an example is pending.
-
#example_started(notification)
Invoked at the beginning of the execution of each example.
Class Method Summary
- .new(output) constructor
Constructor Details
.new(output)
Instance Method Details
#close(notification)
Invoked at the end of a suite run. Allows the formatter to do any tidying up, but be aware that formatter output streams may be used elsewhere so don’t actually close them.
#dump_failures(notification)
Dumps detailed information about each example failure.
#dump_pending(notification)
Outputs a report of pending examples. This gets invoked after the summary if option is set to do so.
#dump_profile(profile)
This method is invoked after the dumping the summary if profiling is enabled.
#dump_summary(summary)
This method is invoked after the dumping of examples and failures. Each parameter is assigned to a corresponding attribute.
#example_failed(notification)
Invoked when an example fails.
#example_finished(notification)
Invoked at the end of the execution of each example.
#example_group_finished(notification)
Invoked at the end of the execution of each example group.
#example_group_started(notification)
This method is invoked at the beginning of the execution of each example group.
The next method to be invoked after this is #example_passed, #example_pending, or #example_group_finished.
#example_passed(notification)
Invoked when an example passes.
#example_pending(notification)
Invoked when an example is pending.
#example_started(notification)
Invoked at the beginning of the execution of each example.
#message(notification)
Used by the reporter to send messages to the output stream.
#start(notification)
This method is invoked before any examples are run, right after they have all been collected. This can be useful for special formatters that need to provide progress on feedback (graphical ones).
This will only be invoked once, and the next one to be invoked is #example_group_started.
#start_dump(notification)
This method is invoked after all of the examples have executed. The next method to be invoked after this one is #dump_failures (BaseTextFormatter then calls #dump_failures once for each failed example).
#stop(notification)
Invoked after all examples have executed, before dumping post-run reports.