File Coverage

blib/lib/Dist/Zilla/dumpphases/Role/Theme.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1 10     10   16030 use 5.006;
  10         24  
  10         316  
2 10     10   39 use strict;
  10         13  
  10         258  
3 10     10   47 use warnings;
  10         9  
  10         519  
4              
5             package Dist::Zilla::dumpphases::Role::Theme;
6              
7             our $VERSION = '1.000007';
8              
9             # ABSTRACT: Output formatting themes for dzil dumpphases
10              
11             our $AUTHORITY = 'cpan:KENTNL'; # AUTHORITY
12              
13 10     10   451 use Role::Tiny qw( requires );
  10         2556  
  10         49  
14              
15              
16              
17              
18              
19              
20              
21              
22              
23              
24              
25              
26             requires 'print_star_assoc';
27             requires 'print_section_prelude';
28             requires 'print_section_header';
29              
30              
31              
32              
33              
34              
35              
36              
37              
38              
39              
40              
41              
42              
43              
44              
45              
46              
47              
48              
49              
50              
51              
52              
53              
54              
55              
56              
57              
58              
59              
60              
61              
62              
63              
64              
65              
66              
67              
68              
69              
70              
71              
72              
73              
74              
75              
76             1;
77              
78             __END__
79              
80             =pod
81              
82             =encoding UTF-8
83              
84             =head1 NAME
85              
86             Dist::Zilla::dumpphases::Role::Theme - Output formatting themes for dzil dumpphases
87              
88             =head1 VERSION
89              
90             version 1.000007
91              
92             =begin MetaPOD::JSON v1.1.0
93              
94             {
95             "namespace":"Dist::Zilla::dumpphases::Role::Theme",
96             "interface":"role"
97             }
98              
99              
100             =end MetaPOD::JSON
101              
102             =head1 REQUIRED METHODS
103              
104             =head2 C<print_star_assoc>
105              
106             Print some kind of associated data.
107              
108             $theme->print_star_assoc($label, $value);
109              
110             e.g.:
111              
112             $theme->print_star_assoc('@Author::KENTNL/Test::CPAN::Changes', 'Dist::Zilla::Plugin::Test::CPAN::Changes');
113              
114             recommended formatting is:
115              
116             \s * \s label \s => \s $value
117              
118             Most of the time, C<$label> will be an alias of some kind (e.g: an instance name), and $value will be the thing that alias
119             refers to (e.g.: an instances class).
120              
121             =head2 C<print_section_prelude>
122              
123             Will be passed meta-info pertaining to the section currently being dumped, such as section descriptions, or applicable roles
124             for sections.
125              
126             $theme->print_section_prelude($label, $value);
127              
128             Recommended format is simply
129              
130             \s-\s$label$value
131              
132             =head2 C<print_section_header>
133              
134             Will be passed context about a dump stage that is about to be detailed.
135              
136             $theme->print_section_header($label, $value);
137              
138             C<$label> will be a the "kind" of dump that is, for detailing specific phases, C<$label> will be "Phase", and C<$value> will be
139             a simple descriptor for that phase. ( e.g.: Phase , Prune files , or something like that ).
140              
141             Recommended format is simply
142              
143             \n$label$value\n
144              
145             =head1 AUTHOR
146              
147             Kent Fredric <kentnl@cpan.org>
148              
149             =head1 COPYRIGHT AND LICENSE
150              
151             This software is copyright (c) 2015 by Kent Fredric <kentnl@cpan.org>.
152              
153             This is free software; you can redistribute it and/or modify it under
154             the same terms as the Perl 5 programming language system itself.
155              
156             =cut