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
202
203
204
205
206
|
package Perl::Critic::PolicyParameter::Behavior::Integer;
use 5.010001;
use strict;
use warnings;
use Perl::Critic::Utils qw{ :characters };
use parent qw{ Perl::Critic::PolicyParameter::Behavior };
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
sub initialize_parameter {
my (undef, $parameter, $specification) = @_;
my $minimum = $specification->{integer_minimum};
my $maximum = $specification->{integer_maximum};
$parameter->_get_behavior_values()->{minimum} = $minimum;
$parameter->_get_behavior_values()->{maximum} = $maximum;
$parameter->_set_parser(
sub {
# Normally bad thing, obscuring a variable in an outer scope
# with a variable with the same name is being done here in
# order to remain consistent with the parser function interface.
my ($policy, $parameter, $config_string) = @_; ## no critic(Variables::ProhibitReusedNames)
my $value_string = $config_string // $parameter->get_default_string();
my $value;
if ( defined $value_string ) {
if (
$value_string !~ m/ \A [-+]? [1-9] [\d_]* \z /xms
and $value_string ne '0'
) {
$policy->throw_parameter_value_exception(
$parameter->get_name(),
$value_string,
undef,
'does not look like an integer.',
);
}
$value_string =~ tr/_//d;
$value = $value_string + 0;
if ( defined $minimum and $minimum > $value ) {
$policy->throw_parameter_value_exception(
$parameter->get_name(),
$value_string,
undef,
qq{is less than $minimum.},
);
}
if ( defined $maximum and $maximum < $value ) {
$policy->throw_parameter_value_exception(
$parameter->get_name(),
$value_string,
undef,
qq{is greater than $maximum.},
);
}
}
$policy->__set_parameter_value($parameter, $value);
return;
}
);
return;
}
#-----------------------------------------------------------------------------
sub generate_parameter_description {
my (undef, $parameter) = @_;
my $minimum = $parameter->_get_behavior_values()->{minimum};
my $maximum = $parameter->_get_behavior_values()->{maximum};
my $description = $parameter->_get_description_with_trailing_period();
if ( $description ) {
$description .= qq{\n};
}
if (defined $minimum or defined $maximum) {
if (defined $minimum) {
$description .= "Minimum value $minimum. ";
} else {
$description .= 'No minimum. ';
}
if (defined $maximum) {
$description .= "Maximum value $maximum.";
} else {
$description .= 'No maximum.';
}
} else {
$description .= 'No limits.';
}
return $description;
}
#-----------------------------------------------------------------------------
1;
__END__
#-----------------------------------------------------------------------------
=pod
=for stopwords
=head1 NAME
Perl::Critic::PolicyParameter::Behavior::Integer - Actions appropriate for an integer parameter.
=head1 DESCRIPTION
Provides a standard set of functionality for an integer
L<Perl::Critic::PolicyParameter|Perl::Critic::PolicyParameter> so that
the developer of a policy does not have to provide it her/himself.
The parser provided by this behavior allows underscores ("_") in input
values as in a Perl numeric literal.
NOTE: Do not instantiate this class. Use the singleton instance held
onto by
L<Perl::Critic::PolicyParameter|Perl::Critic::PolicyParameter>.
=head1 INTERFACE SUPPORT
This is considered to be a non-public class. Its interface is subject
to change without notice.
=head1 METHODS
=over
=item C<initialize_parameter( $parameter, $specification )>
Plug in the functionality this behavior provides into the parameter,
based upon the configuration provided by the specification.
This behavior looks for two configuration items:
=over
=item integer_minimum
Optional. The minimum acceptable value. Inclusive.
=item integer_maximum
Optional. The maximum acceptable value. Inclusive.
=back
=item C<generate_parameter_description( $parameter )>
Create a description of the parameter, based upon the description on
the parameter itself, but enhancing it with information from this
behavior.
In this case, this means including the minimum and maximum values.
=back
=head1 AUTHOR
Elliot Shank <perl@galumph.com>
=head1 COPYRIGHT
Copyright (c) 2007-2011 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 :
|
