Class: RSpec::Core::Formatters::BaseTextFormatter

Inherits:
BaseFormatter
  • Object
show all
Defined in:
lib/rspec/core/formatters/base_text_formatter.rb

Overview

Base for all of RSpec's built-in formatters. See RSpec::Core::Formatters::BaseFormatter to learn more about all of the methods called by the reporter.

Instance Attribute Summary

Attributes inherited from BaseFormatter

#example_group, #output

Instance Method Summary collapse

Methods inherited from BaseFormatter

#example_group_started, #initialize, #start

Constructor Details

This class inherits a constructor from RSpec::Core::Formatters::BaseFormatter

Instance Method Details

#close(_notification) ⇒ void

Invoked at the very end, close allows the formatter to clean up resources, e.g. open streams, etc.

Parameters:

  • _notification (NullNotification)

    (Ignored)



65
66
67
68
69
70
71
72
# File 'lib/rspec/core/formatters/base_text_formatter.rb', line 65

def close(_notification)
  return unless IO === output
  return if output.closed?

  output.puts

  output.close unless output == $stdout
end

#dump_failures(notification) ⇒ void

Dumps detailed information about each example failure.

Parameters:

  • notification (NullNotification)


31
32
33
34
# File 'lib/rspec/core/formatters/base_text_formatter.rb', line 31

def dump_failures(notification)
  return if notification.failure_notifications.empty?
  output.puts notification.fully_formatted_failed_examples
end

#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 (SummaryNotification)

    containing duration, example_count, failure_count and pending_count



43
44
45
# File 'lib/rspec/core/formatters/base_text_formatter.rb', line 43

def dump_summary(summary)
  output.puts summary.fully_formatted
end

#message(notification) ⇒ void

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

Parameters:

  • notification (MessageNotification)

    containing message



22
23
24
# File 'lib/rspec/core/formatters/base_text_formatter.rb', line 22

def message(notification)
  output.puts notification.message
end