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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
package Perl::Critic::Exception::AggregateConfiguration;
use 5.010001;
use strict;
use warnings;
use Carp qw{ confess };
use Readonly;
use Perl::Critic::Utils qw{ :characters };
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
use Exception::Class (
'Perl::Critic::Exception::AggregateConfiguration' => {
isa => 'Perl::Critic::Exception',
description => 'A collected set of configuration exceptions.',
fields => [ qw{ exceptions } ],
alias => 'throw_aggregate',
},
);
#-----------------------------------------------------------------------------
Readonly::Array our @EXPORT_OK => qw< throw_aggregate >;
#-----------------------------------------------------------------------------
sub new {
my ($class, %options) = @_;
my $exceptions = $options{exceptions};
if (not $exceptions) {
$options{exceptions} = [];
}
return $class->SUPER::new(%options);
}
#-----------------------------------------------------------------------------
sub add_exception {
my ( $self, $exception ) = @_;
push @{ $self->exceptions() }, $exception;
return;
}
#-----------------------------------------------------------------------------
sub add_exceptions_from {
my ( $self, $aggregate ) = @_;
push @{ $self->exceptions() }, @{ $aggregate->exceptions() };
return;
}
#-----------------------------------------------------------------------------
sub add_exception_or_rethrow {
my ( $self, $eval_error ) = @_;
return if not $eval_error;
confess $eval_error if not ref $eval_error;
if ( $eval_error->isa('Perl::Critic::Exception::Configuration') ) {
$self->add_exception($eval_error);
}
elsif (
$eval_error->isa('Perl::Critic::Exception::AggregateConfiguration')
) {
$self->add_exceptions_from($eval_error);
}
else {
die $eval_error; ## no critic (RequireCarping)
}
return;
}
#-----------------------------------------------------------------------------
sub has_exceptions {
my ( $self ) = @_;
return @{ $self->exceptions() } ? 1 : 0;
}
#-----------------------------------------------------------------------------
Readonly::Scalar my $MESSAGE_PREFIX => $EMPTY;
Readonly::Scalar my $MESSAGE_SUFFIX => "\n";
Readonly::Scalar my $MESSAGE_SEPARATOR => $MESSAGE_SUFFIX . $MESSAGE_PREFIX;
sub full_message {
my ( $self ) = @_;
my $message = $MESSAGE_PREFIX;
$message .= join $MESSAGE_SEPARATOR, @{ $self->exceptions() };
$message .= $MESSAGE_SUFFIX;
return $message;
}
1;
#-----------------------------------------------------------------------------
__END__
=pod
=for stopwords
=head1 NAME
Perl::Critic::Exception::AggregateConfiguration - A collection of a set of problems found in the configuration and/or command-line options.
=head1 DESCRIPTION
A set of configuration settings can have multiple problems. This is
an object for collecting all the problems found so that the user can
see them in one run.
=head1 INTERFACE SUPPORT
This is considered to be a public class. Any changes to its interface
will go through a deprecation cycle.
=head1 METHODS
=over
=item C<add_exception( $exception )>
Accumulate the parameter with rest of the exceptions.
=item C<add_exceptions_from( $aggregate )>
Accumulate the exceptions from another instance of this class.
=item C<exceptions()>
Returns a reference to an array of the collected exceptions.
=item C<add_exception_or_rethrow( $eval_error )>
If the parameter is an instance of
L<Perl::Critic::Exception::Configuration|Perl::Critic::Exception::Configuration>
or
L<Perl::Critic::Exception::AggregateConfiguration|Perl::Critic::Exception::AggregateConfiguration>,
add it. Otherwise, C<die> with the parameter, if it is a reference,
or C<confess> with it. If the parameter is false, simply returns.
=item C<has_exceptions()>
Answer whether any configuration problems have been found.
=item C<full_message()>
Concatenate the exception messages. See
L<Exception::Class/"full_message">.
=back
=head1 AUTHOR
Elliot Shank <perl@galumph.com>
=head1 COPYRIGHT
Copyright (c) 2007-2023 Elliot Shank
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 :
|
