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) ⇒ Object

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.



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

def close(_notification)
  return if output.closed?

  output.puts

  output.flush
end

#dump_failures(notification) ⇒ Object

Dumps detailed information about each example failure.



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

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

#dump_pending(notification) ⇒ Object



47
48
49
50
# File 'lib/rspec/core/formatters/base_text_formatter.rb', line 47

def dump_pending(notification)
  return if notification.pending_examples.empty?
  output.puts notification.fully_formatted_pending_examples
end

#dump_summary(summary) ⇒ Object

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



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

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

#message(notification) ⇒ Object

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



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

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

#seed(notification) ⇒ Object



53
54
55
56
# File 'lib/rspec/core/formatters/base_text_formatter.rb', line 53

def seed(notification)
  return unless notification.seed_used?
  output.puts notification.fully_formatted
end