class RSpec::Core::Formatters::BaseTextFormatter

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.

@see RSpec::Core::Formatters::BaseFormatter @see RSpec::Core::Reporter

Public Instance Methods

close (_notification)

@api public

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.

@param _notification [NullNotification] (Ignored)

# File rspec-core/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)

@api public

Dumps detailed information about each example failure.

@param notification [NullNotification]

# File rspec-core/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)

@private

# File rspec-core/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)

@api public

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

@param summary [SummaryNotification] containing duration,

example_count, failure_count and pending_count

# File rspec-core/lib/rspec/core/formatters/base_text_formatter.rb, line 42
def dump_summary(summary)
  output.puts summary.fully_formatted
end

message (notification)

@api public

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

@param notification [MessageNotification] containing message

# File rspec-core/lib/rspec/core/formatters/base_text_formatter.rb, line 21
def message(notification)
  output.puts notification.message
end

seed (notification)

@private

# File rspec-core/lib/rspec/core/formatters/base_text_formatter.rb, line 53
def seed(notification)
  return unless notification.seed_used?
  output.puts notification.fully_formatted
end