Why not adopt me?
NAME
MooseX::Validation::Doctypes - validation of nested data structures with Moose type constraints
VERSION
version 0.05
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;
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 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.
FUNCTIONS
doctype $name, $doctype
Declares a new doctype type constraint. $name
is optional, and if it is not given, an anonymous type constraint is created instead.
maybe_doctype $name, $doctype
Identical to 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, { 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.
BUGS
No known bugs.
Please report any bugs through RT: email bug-moosex-validation-doctypes at rt.cpan.org
, or browse to http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MooseX-Validation-Doctypes.
SEE ALSO
SUPPORT
You can find this documentation for this module with the perldoc command.
perldoc MooseX::Validation::Doctypes
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooseX-Validation-Doctypes
Search CPAN
AUTHOR
Jesse Luehrs <doy at cpan dot org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2012 by Jesse Luehrs.
This is free software, licensed under:
The MIT (X11) License