class Spectator::Formatting::DocumentFormatter

Overview

Produces an indented document-style output. Each nested group of examples increases the indent. Example names are output in a color based on their result.

Included Modules

Defined in:

spectator/formatting/document_formatter.cr

Constructors

Instance Method Summary

Instance methods inherited from module Spectator::Formatting::Summary

dump_failures(notification) dump_failures, dump_pending(notification) dump_pending, dump_profile(notification) dump_profile, dump_summary(notification) dump_summary, start_dump start_dump

Instance methods inherited from class Spectator::Formatting::Formatter

close close, dump_failures(_notification) dump_failures, dump_pending(_notification) dump_pending, dump_profile(_notification) dump_profile, dump_summary(_notification) dump_summary, example_error(_notification) example_error, example_failed(_notification) example_failed, example_finished(_notification) example_finished, example_passed(_notification) example_passed, example_pending(_notification) example_pending, example_started(_notification) example_started, message(_notification) message, start(_notification) start, start_dump start_dump, stop stop

Instance methods inherited from class Object

should(matcher : Spectator::Matchers::TypeMatcher(U), message = nil, *, _file = __FILE__, _line = __LINE__) forall U
should(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should, should_eventually(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should_eventually, should_never(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should_never, should_not(matcher : Spectator::Matchers::TypeMatcher(U), message = nil, *, _file = __FILE__, _line = __LINE__) forall U
should_not(matcher : Spectator::Matchers::NilMatcher, message = nil, *, _file = __FILE__, _line = __LINE__)
should_not(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should_not

Constructor Detail

def self.new(io : IO = STDOUT) #

Creates the formatter. By default, output is sent to STDOUT.


[View source]

Instance Method Detail

def example_error(notification) #

Invoked after an example fails from an unexpected error. Produces a failure example line.


[View source]
def example_failed(notification) #

Invoked after an example fails. Produces a failure example line.


[View source]
def example_passed(notification) #

Invoked after an example completes successfully. Produces a successful example line.


[View source]
def example_pending(notification) #

Invoked after an example is skipped or marked as pending. Produces a pending example line.


[View source]
def example_started(notification) #

Invoked just before an example runs. Prints the example group hierarchy if it changed.


[View source]