1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
package Perl::Critic::PolicyListing;
use 5.010001;
use strict;
use warnings;
use Perl::Critic::Policy qw();
use overload ( q<""> => 'to_string' );
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
sub new {
my ($class, %args) = @_;
my $self = bless {}, $class;
my $policies = $args{-policies} || [];
$self->{_policies} = [ sort _by_type @{ $policies } ];
return $self;
}
#-----------------------------------------------------------------------------
sub to_string {
my ($self) = @_;
Perl::Critic::Policy::set_format( "%s %p [%t]\n" );
return join q{}, map { "$_" } @{ $self->{_policies} };
}
#-----------------------------------------------------------------------------
sub _by_type { return ref $a cmp ref $b }
1;
__END__
=pod
=head1 NAME
Perl::Critic::PolicyListing - Display minimal information about Policies.
=head1 DESCRIPTION
This is a helper class that formats a set of Policy objects for
pretty-printing. There are no user-serviceable parts here.
=head1 INTERFACE SUPPORT
This is considered to be a non-public class. Its interface is subject
to change without notice.
=head1 CONSTRUCTOR
=over
=item C<< new( -policies => \@POLICY_OBJECTS ) >>
Returns a reference to a new C<Perl::Critic::PolicyListing> object.
=back
=head1 METHODS
=over
=item to_string()
Returns a string representation of this C<PolicyListing>. See
L<"OVERLOADS"> for more information.
=back
=head1 OVERLOADS
When a L<Perl::Critic::PolicyListing|Perl::Critic::PolicyListing> is
evaluated in string context, it produces a one-line summary of the
default severity, policy name, and default themes for each
L<Perl::Critic::Policy|Perl::Critic::Policy> object that was given to
the constructor of this C<PolicyListing>.
=head1 AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>
=head1 COPYRIGHT
Copyright (c) 2005-2023 Imaginative Software Systems.
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself. The full text of this license
can be found in the LICENSE file included with this module.
=cut
# Local Variables:
# mode: cperl
# cperl-indent-level: 4
# fill-column: 78
# indent-tabs-mode: nil
# c-indentation-style: bsd
# End:
# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
|
