Class Spec::Runner::Formatter::BaseFormatter

  1. lib/spec/runner/formatter/base_formatter.rb
Parent: Object

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

Attributes

example_group [RW]
options [RW]
where [RW]

Public class methods

new (options, where)
[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 7
        def initialize(options, where)
          @options = options
          @where = where
        end

Public instance methods

add_example_group (example_group)

This method is invoked at the beginning of the execution of each example_group. example_group is the example_group.

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

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 25
        def add_example_group(example_group)
          @example_group = example_group
        end
close ()

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

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 74
        def close
        end
dump_failure (counter, failure)

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.

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 62
        def dump_failure(counter, failure)
        end
dump_pending ()

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

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 70
        def dump_pending
        end
dump_summary (duration, example_count, failure_count, pending_count)

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

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 66
        def dump_summary(duration, example_count, failure_count, pending_count)
        end
example_failed (example, counter, failure)

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.

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 41
        def example_failed(example, counter, failure)
        end
example_passed (example)

This method is invoked when an example passes.

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 34
        def example_passed(example)
        end
example_pending (example, message, pending_caller)

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. message is the message from the ExamplePendingError, if it exists, or the default value of “Not Yet Implemented” pending_caller is the file and line number of the spec which has called the pending method

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 50
        def example_pending(example, message, pending_caller)
        end
example_started (example)

This method is invoked when an example starts.

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 30
        def example_started(example)
        end
start (example_count)

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_example_group

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 18
        def start(example_count)
        end
start_dump ()

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),

[show source]
# File lib/spec/runner/formatter/base_formatter.rb, line 55
        def start_dump
        end