Class Spec::Runner::Formatter::BaseFormatter
In: lib/spec/runner/formatter/base_formatter.rb
Parent: Object

Baseclass for formatters that implements all required methods as no-ops.

Methods

Public Class methods

[Source]

   # File lib/spec/runner/formatter/base_formatter.rb, line 6
6:         def initialize(where)
7:           @where = where
8:         end

Public Instance methods

This method is invoked at the beginning of the execution of each behaviour. name is the name of the behaviour and first is true if it is the first behaviour - otherwise it‘s false.

The next method to be invoked after this is example_failed or example_finished

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 24
24:         def add_behaviour(name)
25:         end

This method is invoked at the very end. Allows the formatter to clean up, like closing open streams.

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 71
71:         def close
72:         end

Dumps detailed information about an example failure. This method is invoked for each failed example after all examples have run. counter is the sequence number of the associated example. failure is a Failure object, which contains detailed information about the failure.

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 59
59:         def dump_failure(counter, failure)
60:         end

This gets invoked after the summary if option is set to do so.

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 67
67:         def dump_pending
68:         end

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

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 63
63:         def dump_summary(duration, example_count, failure_count, pending_count)
64:         end

This method is invoked when an example fails, i.e. an exception occurred inside it (such as a failed should or other exception). counter is the sequence number of the failure (starting at 1) and failure is the associated Failure object.

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 39
39:         def example_failed(example, counter, failure)
40:         end

This method is invoked when an example passes.

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 32
32:         def example_passed(example)
33:         end

This method is invoked when an example is not yet implemented (i.e. has not been provided a block), or when an ExamplePendingError is raised. name is the name of the example. message is the message from the ExamplePendingError, if it exists, or the default value of "Not Yet Implemented"

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 47
47:         def example_pending(behaviour_name, example_name, message)
48:         end

This method is invoked when an example starts.

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 28
28:         def example_started(example)
29:         end

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 method will only be invoked once, and the next one to be invoked is add_behaviour

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 16
16:         def start(example_count)
17:         end

This method is invoked after all of the examples have executed. The next method to be invoked after this one is dump_failure (once for each failed example),

[Source]

    # File lib/spec/runner/formatter/base_formatter.rb, line 52
52:         def start_dump
53:         end

[Validate]