FM / Event

/usr/local/share/perl5/Test2/Event

Name	Size	Mode	Actions
Bail.pm	1536	0444	edit dl rm
Diag.pm	1206	0444	edit dl rm
Exception.pm	1371	0444	edit dl rm
Generic.pm	5552	0444	edit dl rm
Info.pm	2359	0444	edit dl rm
Note.pm	1168	0444	edit dl rm
Ok.pm	2433	0444	edit dl rm
Plan.pm	3117	0444	edit dl rm
Skip.pm	1695	0444	edit dl rm
Subtest.pm	1622	0444	edit dl rm
Waiting.pm	988	0444	edit dl rm

Edit: /usr/local/share/perl5/Test2/Event/Plan.pm (3117B)

package Test2::Event::Plan;
use strict;
use warnings;

our $VERSION = '1.302062';

BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
use Test2::Util::HashBase qw{max directive reason};

use Carp qw/confess/;

my %ALLOWED = (
    'SKIP'    => 1,
    'NO PLAN' => 1,
);

sub init {
    if ($_[0]->{+DIRECTIVE}) {
        $_[0]->{+DIRECTIVE} = 'SKIP'    if $_[0]->{+DIRECTIVE} eq 'skip_all';
        $_[0]->{+DIRECTIVE} = 'NO PLAN' if $_[0]->{+DIRECTIVE} eq 'no_plan';

confess "'" . $_[0]->{+DIRECTIVE} . "' is not a valid plan directive"
            unless $ALLOWED{$_[0]->{+DIRECTIVE}};
    }
    else {
        confess "Cannot have a reason without a directive!"
            if defined $_[0]->{+REASON};

confess "No number of tests specified"
            unless defined $_[0]->{+MAX};

confess "Plan test count '" . $_[0]->{+MAX}  . "' does not appear to be a valid positive integer"
            unless $_[0]->{+MAX} =~ m/^\d+$/;

$_[0]->{+DIRECTIVE} = '';
    }
}

sub sets_plan {
    my $self = shift;
    return (
        $self->{+MAX},
        $self->{+DIRECTIVE},
        $self->{+REASON},
    );
}

sub callback {
    my $self = shift;
    my ($hub) = @_;

$hub->plan($self->{+DIRECTIVE} || $self->{+MAX});

return unless $self->{+DIRECTIVE};

$hub->set_skip_reason($self->{+REASON} || 1) if $self->{+DIRECTIVE} eq 'SKIP';
}

sub terminate {
    my $self = shift;
    # On skip_all we want to terminate the hub
    return 0 if $self->{+DIRECTIVE} && $self->{+DIRECTIVE} eq 'SKIP';
    return undef;
}

sub summary {
    my $self = shift;
    my $max = $self->{+MAX};
    my $directive = $self->{+DIRECTIVE};
    my $reason = $self->{+REASON};

return "Plan is $max assertions"
        if $max || !$directive;

return "Plan is '$directive', $reason"
        if $reason;

return "Plan is '$directive'";
}

__END__

=pod

=encoding UTF-8

=head1 NAME

Test2::Event::Plan - The event of a plan

=head1 DESCRIPTION

Plan events are fired off whenever a plan is declared, done testing is called,
or a subtext completes.

=head1 SYNOPSIS

use Test2::API qw/context/;
    use Test2::Event::Plan;

my $ctx = context();

# Plan for 10 tests to run
    my $event = $ctx->plan(10);

# Plan to skip all tests (will exit 0)
    $ctx->plan(0, skip_all => "These tests need to be skipped");

=head1 ACCESSORS

=over 4

=item $num = $plan->max

Get the number of expected tests

=item $dir = $plan->directive

Get the directive (such as TODO, skip_all, or no_plan).

=item $reason = $plan->reason

Get the reason for the directive.

=back

=head1 SOURCE

The source code repository for Test2 can be found at
F<http://github.com/Test-More/test-more/>.

=head1 MAINTAINERS

=over 4

=item Chad Granum E<lt>exodist@cpan.orgE<gt>

=back

=head1 AUTHORS

=over 4

=item Chad Granum E<lt>exodist@cpan.orgE<gt>

=back

=head1 COPYRIGHT

This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

See F<http://dev.perl.org/licenses/>

=cut

cmd: