File Coverage

blib/lib/Test2/EventFacet/Amnesty.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 5 5 100.0
pod 1 1 100.0
total 18 18 100.0


line stmt bran cond sub pod time code
1             package Test2::EventFacet::Amnesty;
2 246     246   1902 use strict;
  246         516  
  246         6944  
3 246     246   1183 use warnings;
  246         468  
  246         16679  
4              
5             our $VERSION = '1.302181';
6              
7 41     41 1 135 sub is_list { 1 }
8              
9 246     246   1576 BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
  246         10527  
10 246     246   1692 use Test2::Util::HashBase qw{ -tag -inherited };
  246         605  
  246         1676  
11              
12             1;
13              
14             __END__
15              
16             =pod
17              
18             =encoding UTF-8
19              
20             =head1 NAME
21              
22             Test2::EventFacet::Amnesty - Facet for assertion amnesty.
23              
24             =head1 DESCRIPTION
25              
26             This package represents what is expected in units of amnesty.
27              
28             =head1 NOTES
29              
30             This facet appears in a list instead of being a single item.
31              
32             =head1 FIELDS
33              
34             =over 4
35              
36             =item $string = $amnesty->{details}
37              
38             =item $string = $amnesty->details()
39              
40             Human readable explanation of why amnesty was granted.
41              
42             Example: I<Not implemented yet, will fix>
43              
44             =item $short_string = $amnesty->{tag}
45              
46             =item $short_string = $amnesty->tag()
47              
48             Short string (usually 10 characters or less, not enforced, but may be truncated
49             by renderers) categorizing the amnesty.
50              
51             =item $bool = $amnesty->{inherited}
52              
53             =item $bool = $amnesty->inherited()
54              
55             This will be true if the amnesty was granted to a parent event and inherited by
56             this event, which is a child, such as an assertion within a subtest that is
57             marked todo.
58              
59             =back
60              
61             =head1 SOURCE
62              
63             The source code repository for Test2 can be found at
64             F<http://github.com/Test-More/test-more/>.
65              
66             =head1 MAINTAINERS
67              
68             =over 4
69              
70             =item Chad Granum E<lt>exodist@cpan.orgE<gt>
71              
72             =back
73              
74             =head1 AUTHORS
75              
76             =over 4
77              
78             =item Chad Granum E<lt>exodist@cpan.orgE<gt>
79              
80             =back
81              
82             =head1 COPYRIGHT
83              
84             Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
85              
86             This program is free software; you can redistribute it and/or
87             modify it under the same terms as Perl itself.
88              
89             See F<http://dev.perl.org/licenses/>
90              
91             =cut