NAME

Test::Builder2::Formatter - Base class for formating test results

SYNOPSIS

  package Test::Builder2::Formatter::SomeFormat;

  use Test::Builder2::Mouse;
  extends "Test::Builder2::Formatter;

DESCRIPTION

Test::Builder2 delegates the actual formating of test results to a Test::Builder2::Formatter object. This can then decide if it's going to formatter TAP or XML or send email or whatever.

METHODS

Attributes

streamer_class

Contains the class to use to make a Streamer.

Defaults to $formatter->default_streamer_class

streamer

Contains the Streamer object to write to. One will be created for you using $formatter->streamer_class.

new

  my $formatter = Test::Builder2::Formatter->new(%args);

Creates a new formatter object to feed results to.

You want to call this on a subclass.

accept_event

  $formatter->accept_event($event, $event_coordinator);

Accept Events as they happen.

See Test::Builder2::EventWatcher for details.

accept_result

  $formatter->accept_result($result, $event_coordinator);

Formats a $result (an instance of Test::Builder2::Result).

See Test::Builder2::EventWatcher for details.

write

  $output->write($destination, @text);

Outputs @text to the named $destination.

@text is treated like print, so it is simply concatenated.

In reality, this is a hand off to $formatter->streamer->write.