15759b3d2Safresh1package Test2::EventFacet::Plan; 25759b3d2Safresh1use strict; 35759b3d2Safresh1use warnings; 45759b3d2Safresh1 5*5486feefSafresh1our $VERSION = '1.302199'; 65759b3d2Safresh1 75759b3d2Safresh1BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) } 85759b3d2Safresh1use Test2::Util::HashBase qw{ -count -skip -none }; 95759b3d2Safresh1 105759b3d2Safresh11; 115759b3d2Safresh1 125759b3d2Safresh1__END__ 135759b3d2Safresh1 145759b3d2Safresh1=pod 155759b3d2Safresh1 165759b3d2Safresh1=encoding UTF-8 175759b3d2Safresh1 185759b3d2Safresh1=head1 NAME 195759b3d2Safresh1 205759b3d2Safresh1Test2::EventFacet::Plan - Facet for setting the plan 215759b3d2Safresh1 225759b3d2Safresh1=head1 DESCRIPTION 235759b3d2Safresh1 245759b3d2Safresh1Events use this facet when they need to set the plan. 255759b3d2Safresh1 265759b3d2Safresh1=head1 FIELDS 275759b3d2Safresh1 285759b3d2Safresh1=over 4 295759b3d2Safresh1 305759b3d2Safresh1=item $string = $plan->{details} 315759b3d2Safresh1 325759b3d2Safresh1=item $string = $plan->details() 335759b3d2Safresh1 345759b3d2Safresh1Human readable explanation for the plan being set. This is normally not 355759b3d2Safresh1rendered by most formatters except when the C<skip> field is also set. 365759b3d2Safresh1 375759b3d2Safresh1=item $positive_int = $plan->{count} 385759b3d2Safresh1 395759b3d2Safresh1=item $positive_int = $plan->count() 405759b3d2Safresh1 415759b3d2Safresh1Set the number of expected assertions. This should usually be set to C<0> when 425759b3d2Safresh1C<skip> or C<none> are also set. 435759b3d2Safresh1 445759b3d2Safresh1=item $bool = $plan->{skip} 455759b3d2Safresh1 465759b3d2Safresh1=item $bool = $plan->skip() 475759b3d2Safresh1 485759b3d2Safresh1When true the entire test should be skipped. This is usually paired with an 495759b3d2Safresh1explanation in the C<details> field, and a C<control> facet that has 505759b3d2Safresh1C<terminate> set to C<0>. 515759b3d2Safresh1 525759b3d2Safresh1=item $bool = $plan->{none} 535759b3d2Safresh1 545759b3d2Safresh1=item $bool = $plan->none() 555759b3d2Safresh1 565759b3d2Safresh1This is mainly used by legacy L<Test::Builder> tests which set the plan to C<no 575759b3d2Safresh1plan>, a construct that predates the much better C<done_testing()>. 585759b3d2Safresh1 595759b3d2Safresh1If you are using this in non-legacy code you may need to reconsider the course 605759b3d2Safresh1of your life, maybe a hermitage would suite you? 615759b3d2Safresh1 625759b3d2Safresh1=back 635759b3d2Safresh1 645759b3d2Safresh1=head1 SOURCE 655759b3d2Safresh1 665759b3d2Safresh1The source code repository for Test2 can be found at 67*5486feefSafresh1L<https://github.com/Test-More/test-more/>. 685759b3d2Safresh1 695759b3d2Safresh1=head1 MAINTAINERS 705759b3d2Safresh1 715759b3d2Safresh1=over 4 725759b3d2Safresh1 735759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt> 745759b3d2Safresh1 755759b3d2Safresh1=back 765759b3d2Safresh1 775759b3d2Safresh1=head1 AUTHORS 785759b3d2Safresh1 795759b3d2Safresh1=over 4 805759b3d2Safresh1 815759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt> 825759b3d2Safresh1 835759b3d2Safresh1=back 845759b3d2Safresh1 855759b3d2Safresh1=head1 COPYRIGHT 865759b3d2Safresh1 87256a93a4Safresh1Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>. 885759b3d2Safresh1 895759b3d2Safresh1This program is free software; you can redistribute it and/or 905759b3d2Safresh1modify it under the same terms as Perl itself. 915759b3d2Safresh1 92*5486feefSafresh1See L<https://dev.perl.org/licenses/> 935759b3d2Safresh1 945759b3d2Safresh1=cut 95