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
|
package MooseX::Validation::Doctypes;
use strict;
use warnings;
# ABSTRACT: validation of nested data structures with Moose type constraints
use MooseX::Meta::TypeConstraint::Doctype;
use Sub::Exporter -setup => {
exports => ['doctype', 'maybe_doctype'],
groups => {
default => ['doctype', 'maybe_doctype'],
},
};
=head1 SYNOPSIS
use MooseX::Validation::Doctypes;
doctype 'Location' => {
id => 'Str',
city => 'Str',
state => 'Str',
country => 'Str',
zipcode => 'Int',
};
doctype 'Person' => {
id => 'Str',
name => {
# ... nested data structures
first_name => 'Str',
last_name => 'Str',
},
title => 'Str',
# ... complex Moose types
friends => 'ArrayRef[Person]',
# ... using doctypes same as regular types
address => 'Maybe[Location]',
};
use JSON;
# note the lack of Location,
# which is fine because it
# was Maybe[Location]
my $data = decode_json(q[
{
"id": "1234-A",
"name": {
"first_name" : "Bob",
"last_name" : "Smith",
},
"title": "CIO",
"friends" : [],
}
]);
use Moose::Util::TypeConstraints;
my $person = find_type_constraint('Person');
my $errors = $person->validate($data);
use Data::Dumper;
warn Dumper($errors->errors) if $errors->has_errors;
warn Dumper($errors->extra_data) if $errors->has_extra_data;
=head1 DESCRIPTION
NOTE: The API for this module is still in flux as I try to decide on how it should work. You have been warned!
This module allows you to declare L<Moose> type constraints to validate nested
data structures as you may get back from a JSON web service or something along
those lines. The doctype declaration can be any arbitrarily nested structure of
hashrefs and arrayrefs, and will be used to validate a data structure which has
that same form. The leaf values in the doctype should be Moose type
constraints, which will be used to validate the leaf nodes in the given data
structure.
=cut
=func doctype $name, $doctype
Declares a new doctype type constraint. C<$name> is optional, and if it is not
given, an anonymous type constraint is created instead.
=cut
sub doctype {
my $name;
$name = shift if @_ > 1;
my ($doctype) = @_;
# XXX validate name
my $args = {
($name ? (name => $name) : ()),
doctype => $doctype,
package_defined_in => scalar(caller),
};
my $tc = MooseX::Meta::TypeConstraint::Doctype->new($args);
Moose::Util::TypeConstraints::register_type_constraint($tc)
if $name;
return $tc;
}
=func maybe_doctype $name, $doctype
Identical to C<doctype>, except that undefined values are also allowed. This is
useful when nesting doctypes, as in:
doctype 'Person' => {
id => 'Str',
name => maybe_doctype({
first => 'Str',
last => 'Str',
}),
address => 'Str',
};
This way, C<< { first => 'Bob', last => 'Smith' } >> is a valid name, and it's
also valid to not provide a name, but an invalid name will still throw an
error.
=cut
sub maybe_doctype {
my $name;
$name = shift if @_ > 1;
my ($doctype) = @_;
# XXX validate name
my $args = {
($name ? (name => $name) : ()),
doctype => $doctype,
package_defined_in => scalar(caller),
maybe => 1,
};
my $tc = MooseX::Meta::TypeConstraint::Doctype->new($args);
Moose::Util::TypeConstraints::register_type_constraint($tc)
if $name;
return $tc;
}
=head1 BUGS
No known bugs.
Please report any bugs through RT: email
C<bug-moosex-validation-doctypes at rt.cpan.org>, or browse to
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MooseX-Validation-Doctypes>.
=head1 SEE ALSO
L<Moose::Meta::TypeConstraint>
L<MooseX::Types::Structured>
=head1 SUPPORT
You can find this documentation for this module with the perldoc command.
perldoc MooseX::Validation::Doctypes
You can also look for information at:
=over 4
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/MooseX-Validation-Doctypes>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/MooseX-Validation-Doctypes>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooseX-Validation-Doctypes>
=item * Search CPAN
L<http://search.cpan.org/dist/MooseX-Validation-Doctypes>
=back
=cut
1;
|
