Mojolicious/Validator.pm

filter: Statementstmt 60.4% 29 / 48 Branchbran 0.0% 0 / 16 Conditioncond 0.0% 0 / 21 MC/DCmcdc 0.0% 0 / 10 Subroutinesub 42.1% 8 / 19 Podpod 100% 4 / 4 totaltotal 34.7% 41 / 118 CC 17 SCAR 24.7
CC
17
Cov
34%
_num
30.0
_size
30.0
_in
12.0
CRAP 11.8
« Mojolicious/Command/routes.pm ↑ Summary Mojolicious/Command/get.pm »
1 package Mojolicious::Validator;
2 20 ▶use Mojo::Base -base;
Subroutine BEGIN: called CC=1 SCAR=0.0
3  
4 20 ▶use Mojo::DynamicMethods;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 20 ▶use Mojo::Util qw(trim);
Subroutine BEGIN: called CC=1 SCAR=0.0
6 20 ▶use Mojolicious::Validator::Validation;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 3 ▶has checks => sub { {} };
Subroutine __ANON__: called CC=1 SCAR=0.0
9 0 ▶has filters => sub { {comma_separated => \&_comma_separated, not_empty => \&_not_empty, trim => \&_trim} };
Subroutine __ANON__: not called CC=1 SCAR=1.2
10  
11 18 ▶sub add_check {
Subroutine add_check: called CC=1 SCAR=0.0
Pod documented
12 18 my ($self, $name, $cb) = @_;
13 18 $self->checks->{$name} = $cb;
14 18 Mojo::DynamicMethods::register 'Mojolicious::Validator::Validation', $self, $name, $cb;
15 18 return $self;
16 }
17  
18 0 ▶sub add_filter { $_[0]->filters->{$_[1]} = $_[2] and return $_[0] }
Subroutine add_filter: not called CC=2 SCAR=17.9
Pod documented
Branch: 1 branch
BranchTrueFalseTotal
$_[0]->filters->{$_[1]} = $_[2] and return $_[0] 0 0 0
19  
20 3 ▶sub new {
Subroutine new: called CC=1 SCAR=0.6
Pod documented
21 3 my $self = shift->SUPER::new(@_);
22  
23 3 $self->add_check(equal_to => \&_equal_to);
24 3 $self->add_check(in => \&_in);
25 0 ▶ $self->add_check(like => sub { $_[2] !~ $_[3] });
Subroutine __ANON__: not called CC=1 SCAR=1.2
26 3 $self->add_check(num => \&_num);
27 3 $self->add_check(size => \&_size);
28 0 ▶ $self->add_check(upload => sub { !ref $_[2] || !$_[2]->isa('Mojo::Upload') });
Subroutine __ANON__: not called CC=2 SCAR=14.0
Condition0%0/3
ref $_[2] && $_[2]->isa('Mojo::Upload')
!ll&&!rl&&r
000
MC/DC0%0/2
ref $_[2] && $_[2]->isa('Mojo::Upload')
ref $_[2] $_[2]->isa('Mojo::Upload')
Truth table0%0/3
A && B
A= ref $_[2]B= $_[2]->isa('Mojo::Upload')
ABresult
0X0
100
111
29  
30 3 return $self;
31 }
32  
33 11 ▶sub validation { Mojolicious::Validator::Validation->new(validator => shift) }
Subroutine validation: called CC=1 SCAR=0.0
Pod documented
34  
35 0 ▶sub _comma_separated { defined $_[2] ? split(/\s*,\s*/, $_[2], -1) : undef }
Subroutine _comma_separated: not called CC=2 SCAR=17.9
Branch: 1 branch
BranchTrueFalseTotal
defined $_[2] ? : 0 0 0
36  
37 0 ▶sub _equal_to {
Subroutine _equal_to: not called CC=2 SCAR=17.9
38 0 my ($v, $name, $value, $to) = @_;
39 0 ▶ return 1 unless defined(my $other = $v->input->{$to});
Branch: 1 branch
BranchTrueFalseTotal
unless defined(my $other = $v->input->{$to}) 0 0 0
40 0 return $value ne $other;
41 }
42  
43 0 ▶sub _in {
Subroutine _in: not called CC=3 SCAR=24.8
44 0 my ($v, $name, $value) = (shift, shift, shift);
45 0 ▶ $value eq $_ && return undef for @_;
Branch: 1 branch
BranchTrueFalseTotal
$value eq $_ and return undef 0 0 0
46 0 return 1;
47 }
48  
49 0 ▶sub _not_empty { length $_[2] ? $_[2] : () }
Subroutine _not_empty: not called CC=2 SCAR=17.9
Branch: 1 branch
BranchTrueFalseTotal
length $_[2] ? : 0 0 0
50  
51 0 ▶sub _num {
Subroutine _num: not called CC=5 SCAR=34.0
52 0 my ($v, $name, $value, $min, $max) = @_;
53 0 ▶ return 1 if $value !~ /^-?[0-9]+$/;
Branch: 1 branch
BranchTrueFalseTotal
unless $value =~ /^-?[0-9]+$/u 0 0 0
54 0 ▶ return defined $min && $min > $value || defined $max && $max < $value;
Condition0%0/9
defined $min && $min > $value || defined $max && $max < $value
l!l&&r!l&&!r
000
defined $min and $min > $value
!ll&&!rl&&r
000
defined $max and $max < $value
!ll&&!rl&&r
000
MC/DC0%0/4
defined $min && $min > $value || defined $max && $max < $value
defined $min $min > $value defined $max $max < $value
Truth table0%0/7
A and B || C and D
A= defined $minB= $min > $valueC= defined $maxD= $max < $value
ABCDresult
11XX1
0X111
10111
0X0X0
0X100
100X0
10100
55 }
56  
57 0 ▶sub _size {
Subroutine _size: not called CC=5 SCAR=34.0
58 0 my ($v, $name, $value, $min, $max) = @_;
59 0 ▶ my $len = ref $value ? $value->size : length $value;
Branch: 1 branch
BranchTrueFalseTotal
ref $value ? : 0 0 0
60 0 ▶ return (defined $min && $len < $min) || (defined $max && $len > $max);
Condition0%0/9
defined $min && $len < $min || defined $max && $len > $max
l!l&&r!l&&!r
000
defined $min and $len < $min
!ll&&!rl&&r
000
defined $max and $len > $max
!ll&&!rl&&r
000
MC/DC0%0/4
defined $min && $len < $min || defined $max && $len > $max
defined $min $len < $min defined $max $len > $max
Truth table0%0/7
A and B || C and D
A= defined $minB= $len < $minC= defined $maxD= $len > $max
ABCDresult
11XX1
0X111
10111
0X0X0
0X100
100X0
10100
61 }
62  
63 0 ▶sub _trim { defined $_[2] ? trim $_[2] : undef }
Subroutine _trim: not called CC=2 SCAR=17.9
Branch: 1 branch
BranchTrueFalseTotal
defined $_[2] ? : 0 0 0
64  
65 20 1;
66  
67 =encoding utf8
68  
69 =head1 NAME
70  
71 Mojolicious::Validator - Validate values
72  
73 =head1 SYNOPSIS
74  
75 use Mojolicious::Validator;
76  
77 my $validator = Mojolicious::Validator->new;
78 my $v = $validator->validation;
79 $v->input({foo => 'bar'});
80 $v->required('foo')->like(qr/ar$/);
81 say $v->param('foo');
82  
83 =head1 DESCRIPTION
84  
85 L<Mojolicious::Validator> validates values for L<Mojolicious>.
86  
87 =head1 CHECKS
88  
89 These validation checks are available by default.
90  
91 =head2 equal_to
92  
93 $v = $v->equal_to('foo');
94  
95 String value needs to be equal to the value of another field.
96  
97 =head2 in
98  
99 $v = $v->in('foo', 'bar', 'baz');
100  
101 String value needs to match one of the values in the list.
102  
103 =head2 like
104  
105 $v = $v->like(qr/^[A-Z]/);
106  
107 String value needs to match the regular expression.
108  
109 =head2 num
110  
111 $v = $v->num;
112 $v = $v->num(2, 5);
113 $v = $v->num(-3, 7);
114 $v = $v->num(2, undef);
115 $v = $v->num(undef, 5);
116  
117 String value needs to be a non-fractional number (positive or negative) and if provided in the given range.
118  
119 =head2 size
120  
121 $v = $v->size(2, 5);
122 $v = $v->size(2, undef);
123 $v = $v->size(undef, 5);
124  
125 String value length or size of L<Mojo::Upload> object in bytes needs to be between these two values.
126  
127 =head2 upload
128  
129 $v = $v->upload;
130  
131 Value needs to be a L<Mojo::Upload> object, representing a file upload.
132  
133 =head1 FILTERS
134  
135 These filters are available by default.
136  
137 =head2 comma_separated
138  
139 $v = $v->optional('foo', 'comma_separated');
140  
141 Split string of comma separated values into separate values.
142  
143 =head2 not_empty
144  
145 $v = $v->optional('foo', 'not_empty');
146  
147 Remove empty string values and treat them as if they had not been submitted.
148  
149 =head2 trim
150  
151 $v = $v->optional('foo', 'trim');
152  
153 Trim whitespace characters from both ends of string value with L<Mojo::Util/"trim">.
154  
155 =head1 ATTRIBUTES
156  
157 L<Mojolicious::Validator> implements the following attributes.
158  
159 =head2 checks
160  
161 my $checks = $validator->checks;
162 $validator = $validator->checks({size => sub ($v, $name, $value, @args) {...}});
163  
164 Registered validation checks, by default only L</"equal_to">, L</"in">, L</"like">, L</"num">, L</"size"> and
165 L</"upload"> are already defined.
166  
167 =head2 filters
168  
169 my $filters = $validator->filters;
170 $validator = $validator->filters({trim => sub {...}});
171  
172 Registered filters, by default only L</"comma_separated">, L</"not_empty"> and L</"trim"> are already defined.
173  
174 =head1 METHODS
175  
176 L<Mojolicious::Validator> inherits all methods from L<Mojo::Base> and implements the following new ones.
177  
178 =head2 add_check
179  
180 $validator = $validator->add_check(size => sub ($v, $name, $value, @args) {...});
181  
182 Register a validation check.
183  
184 $validator->add_check(foo => sub ($v, $name, $value, @args) {
185 ...
186 return undef;
187 });
188  
189 =head2 add_filter
190  
191 $validator = $validator->add_filter(trim => sub ($v, $name, $value) {...});
192  
193 Register a new filter.
194  
195 $validator->add_filter(foo => sub ($v, $name, $value) {
196 ...
197 return $value;
198 });
199  
200 =head2 new
201  
202 my $validator = Mojolicious::Validator->new;
203  
204 Construct a new L<Mojolicious::Validator> object.
205  
206 =head2 validation
207  
208 my $v = $validator->validation;
209  
210 Build L<Mojolicious::Validator::Validation> object to perform validations.
211  
212 my $v = $validator->validation;
213 $v->input({foo => 'bar'});
214 $v->required('foo')->size(1, 5);
215 say $v->param('foo');
216  
217 =head1 SEE ALSO
218  
219 L<Mojolicious>, L<Mojolicious::Guides>, L<https://mojolicious.org>.
220  
221 =cut
« Mojolicious/Command/routes.pm ↑ Summary Mojolicious/Command/get.pm »