Class: RSpec::Core::Formatters::Protocol

Inherits:

Object

• Object
• RSpec::Core::Formatters::Protocol

Defined in:

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

See Also:

• BaseFormatter
• BaseTextFormatter
• Reporter

Suite Notifications

• #close(notification) ⇒ void

  Invoked at the end of a suite run.

• #dump_failures(notification) ⇒ void

  Dumps detailed information about each example failure.

• #dump_pending(notification) ⇒ void

  Outputs a report of pending examples.

• #dump_profile(profile) ⇒ void

  This method is invoked after the dumping the summary if profiling is enabled.

• #dump_summary(summary) ⇒ void

  This method is invoked after the dumping of examples and failures.

• #message(notification) ⇒ void

  Used by the reporter to send messages to the output stream.

• #start(notification) ⇒ void

  This method is invoked before any examples are run, right after they have all been collected.

• #start_dump(notification) ⇒ void

  This method is invoked after all of the examples have executed.

• #stop(notification) ⇒ void

  Invoked after all examples have executed, before dumping post-run reports.

Group Notifications

• #example_group_finished(notification) ⇒ void

  Invoked at the end of the execution of each example group.

• #example_group_started(notification) ⇒ void

  This method is invoked at the beginning of the execution of each example group.

Example Notifications

• #example_failed(notification) ⇒ void

  Invoked when an example fails.

• #example_finished(notification) ⇒ void

  Invoked at the end of the execution of each example.

• #example_passed(notification) ⇒ void

  Invoked when an example passes.

• #example_pending(notification) ⇒ void

  Invoked when an example is pending.

• #example_started(notification) ⇒ void

  Invoked at the beginning of the execution of each example.

Instance Method Summary

• #initialize(output) ⇒ void constructor

Constructor Details

#initialize(output) ⇒ void

Parameters:

• output (IO) —

  the formatter output

# File 'lib/rspec/core/formatters/protocol.rb', line 20

Instance Method Details

#close(notification) ⇒ void

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.

Parameters:

• notification (Notifications::NullNotification)

# File 'lib/rspec/core/formatters/protocol.rb', line 170

#dump_failures(notification) ⇒ void

Dumps detailed information about each example failure.

Parameters:

• notification (Notifications::NullNotification)

# File 'lib/rspec/core/formatters/protocol.rb', line 133

#dump_pending(notification) ⇒ void

Outputs a report of pending examples. This gets invoked after the summary if option is set to do so.

Parameters:

• notification (Notifications::NullNotification)

# File 'lib/rspec/core/formatters/protocol.rb', line 161

#dump_profile(profile) ⇒ void

This method is invoked after the dumping the summary if profiling is enabled.

Parameters:

• profile (Notifications::ProfileNotification) —

  containing duration, slowest_examples and slowest_example_groups

# File 'lib/rspec/core/formatters/protocol.rb', line 151

#dump_summary(summary) ⇒ void

This method is invoked after the dumping of examples and failures. Each parameter is assigned to a corresponding attribute.

Parameters:

• summary (Notifications::SummaryNotification) —

  containing duration, example_count, failure_count and pending_count

# File 'lib/rspec/core/formatters/protocol.rb', line 141

#example_failed(notification) ⇒ void

Invoked when an example fails.

Parameters:

• notification (Notifications::ExampleNotification) —

  containing example subclass of Example

# File 'lib/rspec/core/formatters/protocol.rb', line 96

#example_finished(notification) ⇒ void

Invoked at the end of the execution of each example.

Parameters:

• notification (Notifications::ExampleNotification) —

  containing example subclass of Example

# File 'lib/rspec/core/formatters/protocol.rb', line 69

#example_group_finished(notification) ⇒ void

Invoked at the end of the execution of each example group.

Parameters:

• notification (Notifications::GroupNotification) —

  containing example_group subclass of ExampleGroup

# File 'lib/rspec/core/formatters/protocol.rb', line 51

#example_group_started(notification) ⇒ void

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.

Parameters:

• notification (Notifications::GroupNotification) —

  containing example_group subclass of ExampleGroup

# File 'lib/rspec/core/formatters/protocol.rb', line 38

#example_passed(notification) ⇒ void

Invoked when an example passes.

Parameters:

• notification (Notifications::ExampleNotification) —

  containing example subclass of Example

# File 'lib/rspec/core/formatters/protocol.rb', line 78

#example_pending(notification) ⇒ void

Invoked when an example is pending.

Parameters:

• notification (Notifications::ExampleNotification) —

  containing example subclass of Example

# File 'lib/rspec/core/formatters/protocol.rb', line 87

#example_started(notification) ⇒ void

Invoked at the beginning of the execution of each example.

Parameters:

• notification (Notifications::ExampleNotification) —

  containing example subclass of Example

# File 'lib/rspec/core/formatters/protocol.rb', line 60

#message(notification) ⇒ void

Used by the reporter to send messages to the output stream.

Parameters:

• notification (Notifications::MessageNotification) —

  containing message

# File 'lib/rspec/core/formatters/protocol.rb', line 105

#start(notification) ⇒ void

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.

Parameters:

• notification (Notifications::StartNotification)

# File 'lib/rspec/core/formatters/protocol.rb', line 25

#start_dump(notification) ⇒ void

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

Parameters:

• notification (Notifications::NullNotification)

# File 'lib/rspec/core/formatters/protocol.rb', line 122

#stop(notification) ⇒ void

Invoked after all examples have executed, before dumping post-run reports.

Parameters:

• notification (Notifications::NullNotification)

# File 'lib/rspec/core/formatters/protocol.rb', line 113