package MooseX::Types::Structured;
+# ABSTRACT: Structured Type Constraints for Moose
use 5.008;
-use Moose::Util::TypeConstraints;
+use Moose::Util::TypeConstraints 1.06;
use MooseX::Meta::TypeConstraint::Structured;
-use MooseX::Types -declare => [qw(Dict Tuple Optional)];
-use Sub::Exporter -setup => { exports => [ qw(Dict Tuple Optional slurpy) ] };
-
-our $VERSION = '0.07';
-our $AUTHORITY = 'cpan:JJNAPIORK';
-
-=head1 NAME
-
-MooseX::Types::Structured - Structured Type Constraints for Moose
+use MooseX::Meta::TypeConstraint::Structured::Optional;
+use MooseX::Types::Structured::OverflowHandler;
+use MooseX::Types::Structured::MessageStack;
+use MooseX::Types 0.22 -declare => [qw(Dict Map Tuple Optional)];
+use Sub::Exporter 0.982 -setup => [ qw(Dict Map Tuple Optional slurpy) ];
+use Devel::PartialDump 0.13;
+use Scalar::Util qw(blessed);
=head1 SYNOPSIS
The following is example usage for this module.
package Person;
-
+
use Moose;
use MooseX::Types::Moose qw(Str Int HashRef);
use MooseX::Types::Structured qw(Dict Tuple Optional);
middle => Optional[Str],
],
);
-
+
## description is a string field followed by a HashRef of tagged data.
has description => (
isa=>Tuple[
],
);
+ ## Remainder of your class attributes and methods
+
Then you can instantiate this class with something like:
my $john = Person->new(
description => ['A great student!'],
);
-But all of these would cause a constraint error for the 'name' attribute:
+But all of these would cause a constraint error for the C<name> attribute:
## Value for 'name' not a HashRef
Person->new( name => 'John' );
-
+
## Value for 'name' has incorrect hash key and missing required keys
Person->new( name => {
first_name => 'John'
});
-
+
## Also incorrect keys
Person->new( name => {
first_name => 'John',
age => 39,
});
-
+
## key 'middle' incorrect type, should be a Str not a ArrayRef
Person->new( name => {
first => 'Vanessa',
middle => [1,2],
last => 'Li',
- });
+ });
-And these would cause a constraint error for the 'description' attribute:
+And these would cause a constraint error for the C<description> attribute:
## Should be an ArrayRef
Person->new( description => 'Hello I am a String' );
-
+
## First element must be a string not a HashRef.
Person->new (description => [{
tag1 => 'value1',
=head1 DESCRIPTION
A structured type constraint is a standard container L<Moose> type constraint,
-such as an ArrayRef or HashRef, which has been enhanced to allow you to
+such as an C<ArrayRef> or C<HashRef>, which has been enhanced to allow you to
explicitly name all the allowed type constraints inside the structure. The
generalized form is:
TypeConstraint[@TypeParameters or %TypeParameters]
-Where 'TypeParameters' is an array reference or hash references of
+Where C<TypeParameters> is an array reference or hash references of
L<Moose::Meta::TypeConstraint> objects.
This type library enables structured type constraints. It is built on top of the
=head2 Comparing Parameterized types to Structured types
Parameterized constraints are built into core Moose and you are probably already
-familar with the type constraints 'HashRef' and 'ArrayRef'. Structured types
+familiar with the type constraints C<HashRef> and C<ArrayRef>. Structured types
have similar functionality, so their syntax is likewise similar. For example,
you could define a parameterized constraint like:
subtype ArrayOfInts,
- as Arrayref[Int];
+ as ArrayRef[Int];
which would constrain a value to something like [1,2,3,...] and so on. On the
other hand, a structured type constraint explicitly names all it's allowed
subtype StringFollowedByInt,
as Tuple[Str,Int];
-
-would constrain it's value to things like ['hello', 111] but ['hello', 'world']
-would fail, as well as ['hello', 111, 'world'] and so on. Here's another
+
+would constrain its value to things like C<< ['hello', 111] >> but C<< ['hello', 'world'] >>
+would fail, as well as C<< ['hello', 111, 'world'] >> and so on. Here's another
example:
+ package MyApp::Types;
+
+ use MooseX::Types -declare [qw(StringIntOptionalHashRef)];
+ use MooseX::Types::Moose qw(Str Int);
+ use MooseX::Types::Structured qw(Tuple Optional);
+
subtype StringIntOptionalHashRef,
as Tuple[
Str, Int,
Optional[HashRef]
];
-
+
This defines a type constraint that validates values like:
['Hello', 100, {key1 => 'value1', key2 => 'value2'}];
['World', 200];
-
+
Notice that the last type constraint in the structure is optional. This is
-enabled via the helper Optional type constraint, which is a variation of the
-core Moose type constraint 'Maybe'. The main difference is that Optional type
-constraints are required to validate if they exist, while 'Maybe' permits
+enabled via the helper C<Optional> type constraint, which is a variation of the
+core Moose type constraint C<Maybe>. The main difference is that C<Optional> type
+constraints are required to validate if they exist, while C<Maybe> permits
undefined values. So the following example would not validate:
StringIntOptionalHashRef->validate(['Hello Undefined', 1000, undef]);
-
+
Please note the subtle difference between undefined and null. If you wish to
-allow both null and undefined, you should use the core Moose 'Maybe' type
+allow both null and undefined, you should use the core Moose C<Maybe> type
constraint instead:
+ package MyApp::Types;
+
use MooseX::Types -declare [qw(StringIntMaybeHashRef)];
- use MooseX::Types::Moose qw(Maybe);
+ use MooseX::Types::Moose qw(Str Int Maybe);
use MooseX::Types::Structured qw(Tuple);
subtype StringIntMaybeHashRef,
This would validate the following:
['Hello', 100, {key1 => 'value1', key2 => 'value2'}];
- ['World', 200, undef];
+ ['World', 200, undef];
['World', 200];
Structured constraints are not limited to arrays. You can define a structure
-against a HashRef with 'Dict' as in this example:
+against a C<HashRef> with the C<Dict> type constraint as in this example:
subtype FirstNameLastName,
as Dict[
lastname => Str,
];
-This would constrain a HashRef to something like:
+This would constrain a C<HashRef> that validates something like:
+
+ {firstname => 'Christopher', lastname => 'Parsons'};
- {firstname => 'Christopher', lastname= > 'Parsons'};
-
but all the following would fail validation:
## Incorrect keys
{first => 'Christopher', last => 'Parsons'};
-
+
## Too many keys
{firstname => 'Christopher', lastname => 'Parsons', middlename => 'Allen'};
-
+
## Not a HashRef
- ['Christopher', 'Christopher'];
+ ['Christopher', 'Parsons'];
These structures can be as simple or elaborate as you wish. You can even
combine various structured, parameterized and simple constraints all together:
Dict[name=>Str, age=>Int],
ArrayRef[Int]
];
-
-Which would match "[1, {name=>'John', age=>25},[10,11,12]]". Please notice how
-the type parameters can be visually arranged to your liking and to improve the
-clarity of your meaning. You don't need to run then altogether onto a single
-line.
+
+Which would match:
+
+ [1, {name=>'John', age=>25},[10,11,12]];
+
+Please notice how the type parameters can be visually arranged to your liking
+and to improve the clarity of your meaning. You don't need to run then
+altogether onto a single line. Additionally, since the C<Dict> type constraint
+defines a hash constraint, the key order is not meaningful. For example:
+
+ subtype AnyKeyOrder,
+ as Dict[
+ key1=>Int,
+ key2=>Str,
+ key3=>Int,
+ ];
+
+Would validate both:
+
+ {key1 => 1, key2 => "Hi!", key3 => 2};
+ {key2 => "Hi!", key1 => 100, key3 => 300};
+
+As you would expect, since underneath it's just a plain old Perl hash at work.
=head2 Alternatives
package MyApp::MyStruct;
use Moose;
-
+
## lazy way to make a bunch of attributes
has $_ for qw(full_name age_in_years);
-
+
package MyApp::MyClass;
use Moose;
-
- has person => (isa => 'MyApp::MyStruct');
-
+
+ has person => (isa => 'MyApp::MyStruct');
+
my $instance = MyApp::MyClass->new(
person=>MyApp::MyStruct->new(
full_name => 'John',
age_in_years => 39,
),
);
-
-This method may take some additional time to setup but will give you more
+
+This method may take some additional time to set up but will give you more
flexibility. However, structured constraints are highly compatible with this
method, granting some interesting possibilities for coercion. Try:
package MyApp::MyClass;
-
+
use Moose;
use MyApp::MyStruct;
-
+
## It's recommended your type declarations live in a separate class in order
## to promote reusability and clarity. Inlined here for brevity.
-
+
use MooseX::Types::DateTime qw(DateTime);
use MooseX::Types -declare [qw(MyStruct)];
use MooseX::Types::Moose qw(Str Int);
## Just a shorter version really.
subtype MyStruct,
as 'MyApp::MyStruct';
-
+
## Add the coercions.
coerce MyStruct,
from Dict[
], via {
my $name = $_->{firstname} .' '. $_->{lastname};
my $age = DateTime->now - $_->{dob};
-
+
MyApp::MyStruct->new(
full_name=>$name,
age_in_years=>$age->years,
);
};
-
- has person => (isa=>MyStruct);
-
+
+ has person => (isa=>MyStruct);
+
This would allow you to instantiate with something like:
my $obj = MyApp::MyClass->new( person => {
full_name=>'John Napiorkowski',
age_in_years=>39,
});
-
+
Or even:
my $obj = MyApp::MyClass->new( person => {
entry L<Moose::Cookbook::Recipe5> for an explanation. The section L</Coercions>
has additional examples and discussion.
+=for stopwords Subtyping
+
=head2 Subtyping a Structured type constraint
You need to exercise some care when you try to subtype a structured type as in
subtype Person,
as Dict[name => Str];
-
+
subtype FriendlyPerson,
as Person[
name => Str,
total_friends => Int,
];
-
+
This will actually work BUT you have to take care that the subtype has a
structure that does not contradict the structure of it's parent. For now the
above works, but I will clarify the syntax for this at a future point, so
name => Str,
age => Int
];
-
+
subtype Fullname,
as Dict[
first => Str,
last => Str
];
-
+
coerce Person,
## Coerce an object of a particular class
from BlessedPersonObject, via {
age=>$_->age,
};
},
-
+
## Coerce from [$name, $age]
from ArrayRef, via {
+{
age =>$age->years
}
};
-
+
And that should just work as expected. However, if there are any 'inner'
-coercions, such as a coercion on 'Fullname' or on 'DateTime', that coercion
+coercions, such as a coercion on C<Fullname> or on C<DateTime>, that coercion
won't currently get activated.
-Please see the test '07-coerce.t' for a more detailed example. Discussion on
+Please see the test F<07-coerce.t> for a more detailed example. Discussion on
extending coercions to support this welcome on the Moose development channel or
mailing list.
you can include a type constraint as a contained type constraint of itself. For
example:
- subtype Person,
- as Dict[
- name=>Str,
- friends=>Optional[
- ArrayRef[Person]
- ],
- ];
-
-This would declare a Person subtype that contains a name and an optional
-ArrayRef of Persons who are friends as in:
-
- {
- name => 'Mike',
- friends => [
- { name => 'John' },
- { name => 'Vincent' },
- {
- name => 'Tracey',
- friends => [
- { name => 'Stephenie' },
- { name => 'Ilya' },
- ],
- },
- ],
- };
-
-Please take care to make sure the recursion node is either Optional, or declare
-a Union with an non recursive option such as:
-
- subtype Value
- as Tuple[
- Str,
- Str|Tuple,
- ];
-
+ subtype Person,
+ as Dict[
+ name=>Str,
+ friends=>Optional[
+ ArrayRef[Person]
+ ],
+ ];
+
+This would declare a C<Person> subtype that contains a name and an optional
+C<ArrayRef> of C<Person>s who are friends as in:
+
+ {
+ name => 'Mike',
+ friends => [
+ { name => 'John' },
+ { name => 'Vincent' },
+ {
+ name => 'Tracey',
+ friends => [
+ { name => 'Stephenie' },
+ { name => 'Ilya' },
+ ],
+ },
+ ],
+ };
+
+Please take care to make sure the recursion node is either C<Optional>, or declare
+a union with an non-recursive option such as:
+
+ subtype Value
+ as Tuple[
+ Str,
+ Str|Tuple,
+ ];
+
Which validates:
- [
- 'Hello', [
- 'World', [
- 'Is', [
- 'Getting',
- 'Old',
- ],
- ],
- ],
- ];
-
-Otherwise you will define a subtype thatis impossible to validate since it is
+ [
+ 'Hello', [
+ 'World', [
+ 'Is', [
+ 'Getting',
+ 'Old',
+ ],
+ ],
+ ],
+ ];
+
+Otherwise you will define a subtype that is impossible to validate since it is
infinitely recursive. For more information about defining recursive types,
please see the documentation in L<MooseX::Types> and the test cases.
Tuple[Int,Str]; ## Validates [1,'hello']
Tuple[Str|Object, Int]; ## Validates ['hello', 1] or [$object, 2]
+The Values of @constraints should ideally be L<MooseX::Types> declared type
+constraints. We do support 'old style' L<Moose> string based constraints to a
+limited degree but these string type constraints are considered deprecated.
+There will be limited support for bugs resulting from mixing string and
+L<MooseX::Types> in your structures. If you encounter such a bug and really
+need it fixed, we will required a detailed test case at the minimum.
+
=head2 Dict[%constraints]
This defines a HashRef based constraint which allowed you to validate a specific
Dict[name=>Str, age=>Int]; ## Validates {name=>'John', age=>39}
+The keys in C<%constraints> follow the same rules as C<@constraints> in the above
+section.
+
+=head2 Map[ $key_constraint, $value_constraint ]
+
+This defines a C<HashRef>-based constraint in which both the keys and values are
+required to meet certain constraints. For example, to map hostnames to IP
+addresses, you might say:
+
+ Map[ HostName, IPAddress ]
+
+The type constraint would only be met if every key was a valid C<HostName> and
+every value was a valid C<IPAddress>.
+
=head2 Optional[$constraint]
-This is primarily a helper constraint for Dict and Tuple type constraints. What
-this allows if for you to assert that a given type constraint is allowed to be
+This is primarily a helper constraint for C<Dict> and C<Tuple> type constraints. What
+this allows is for you to assert that a given type constraint is allowed to be
null (but NOT undefined). If the value is null, then the type constraint passes
but if the value is defined it must validate against the type constraint. This
makes it easy to make a Dict where one or more of the keys doesn't have to exist
last=>Str,
middle=>Optional[Str],
];
-
-Creates a constraint that validates against a hashref with the keys 'first' and
+
+...creates a constraint that validates against a hashref with the keys 'first' and
'last' being strings and required while an optional key 'middle' is must be a
string if it appears but doesn't have to appear. So in this case both the
following are valid:
{first=>'John', middle=>'James', last=>'Napiorkowski'}
{first=>'Vanessa', last=>'Li'}
-
+
+If you use the C<Maybe> type constraint instead, your values will also validate
+against C<undef>, which may be incorrect for you.
+
+=head1 EXPORTABLE SUBROUTINES
+
+This type library makes available for export the following subroutines
+
+=for stopwords slurpy
+
+=head2 slurpy
+
+Structured type constraints by their nature are closed; that is validation will
+depend on an exact match between your structure definition and the arguments to
+be checked. Sometimes you might wish for a slightly looser amount of validation.
+For example, you may wish to validate the first 3 elements of an array reference
+and allow for an arbitrary number of additional elements. At first thought you
+might think you could do it this way:
+
+ # I want to validate stuff like: [1,"hello", $obj, 2,3,4,5,6,...]
+ subtype AllowTailingArgs,
+ as Tuple[
+ Int,
+ Str,
+ Object,
+ ArrayRef[Int],
+ ];
+
+However what this will actually validate are structures like this:
+
+ [10,"Hello", $obj, [11,12,13,...] ]; # Notice element 4 is an ArrayRef
+
+In order to allow structured validation of, "and then some", arguments, you can
+use the L</slurpy> method against a type constraint. For example:
+
+ use MooseX::Types::Structured qw(Tuple slurpy);
+
+ subtype AllowTailingArgs,
+ as Tuple[
+ Int,
+ Str,
+ Object,
+ slurpy ArrayRef[Int],
+ ];
+
+This will now work as expected, validating ArrayRef structures such as:
+
+ [1,"hello", $obj, 2,3,4,5,6,...]
+
+A few caveats apply. First, the slurpy type constraint must be the last one in
+the list of type constraint parameters. Second, the parent type of the slurpy
+type constraint must match that of the containing type constraint. That means
+that a C<Tuple> can allow a slurpy C<ArrayRef> (or children of C<ArrayRef>s, including
+another C<Tuple>) and a C<Dict> can allow a slurpy C<HashRef> (or children/subtypes of
+HashRef, also including other C<Dict> constraints).
+
+Please note the technical way this works 'under the hood' is that the
+slurpy keyword transforms the target type constraint into a coderef. Please do
+not try to create your own custom coderefs; always use the slurpy method. The
+underlying technology may change in the future but the slurpy keyword will be
+supported.
+
+=head1 ERROR MESSAGES
+
+Error reporting has been improved to return more useful debugging messages. Now
+I will stringify the incoming check value with L<Devel::PartialDump> so that you
+can see the actual structure that is tripping up validation. Also, I report the
+'internal' validation error, so that if a particular element inside the
+Structured Type is failing validation, you will see that. There's a limit to
+how deep this internal reporting goes, but you shouldn't see any of the "failed
+with ARRAY(XXXXXX)" that we got with earlier versions of this module.
+
+This support is continuing to expand, so it's best to use these messages for
+debugging purposes and not for creating messages that 'escape into the wild'
+such as error messages sent to the user.
+
+Please see the test '12-error.t' for a more lengthy example. Your thoughts and
+preferable tests or code patches very welcome!
+
=head1 EXAMPLES
Here are some additional example usage for structured types. All examples can
=head2 Normalize a HashRef
You need a hashref to conform to a canonical structure but are required accept a
-bunch of different incoming structures. You can normalize using the Dict type
+bunch of different incoming structures. You can normalize using the C<Dict> type
constraint and coercions. This example also shows structured types mixed which
-other MooseX::Types libraries.
+other L<MooseX::Types> libraries.
package Test::MooseX::Meta::TypeConstraint::Structured::Examples::Normalize;
-
+
use Moose;
use DateTime;
-
+
use MooseX::Types::Structured qw(Dict Tuple);
use MooseX::Types::DateTime qw(DateTime);
use MooseX::Types::Moose qw(Int Str Object);
use MooseX::Types -declare => [qw(Name Age Person)];
-
+
subtype Person,
as Dict[
- name=>Str,
- age=>Int,
+ name=>Str,
+ age=>Int,
];
-
+
coerce Person,
from Dict[
- first=>Str,
- last=>Str,
- years=>Int,
+ first=>Str,
+ last=>Str,
+ years=>Int,
], via { +{
name => "$_->{first} $_->{last}",
age => $_->{years},
}},
from Dict[
- fullname=>Dict[
- last=>Str,
- first=>Str,
- ],
- dob=>DateTime,
+ fullname=>Dict[
+ last=>Str,
+ first=>Str,
+ ],
+ dob=>DateTime,
],
## DateTime needs to be inside of single quotes here to disambiguate the
## class package from the DataTime type constraint imported via the
name => "$_->{fullname}{first} $_->{fullname}{last}",
age => ($_->{dob} - 'DateTime'->now)->years,
}};
-
+
has person => (is=>'rw', isa=>Person, coerce=>1);
-
+
And now you can instantiate with all the following:
__PACKAGE__->new(
- name=>'John Napiorkowski',
- age=>39,
+ person=>{
+ name=>'John Napiorkowski',
+ age=>39,
+ },
);
-
+
__PACKAGE__->new(
- first=>'John',
- last=>'Napiorkowski',
- years=>39,
+ person=>{
+ first=>'John',
+ last=>'Napiorkowski',
+ years=>39,
+ },
);
-
+
__PACKAGE__->new(
- fullname => {
- first=>'John',
- last=>'Napiorkowski'
+ person=>{
+ fullname => {
+ first=>'John',
+ last=>'Napiorkowski'
+ },
+ dob => 'DateTime'->new(
+ year=>1969,
+ month=>2,
+ day=>13
+ ),
},
- dob => 'DateTime'->new(
- year=>1969,
- month=>2,
- day=>13
- ),
);
-
+
This technique is a way to support various ways to instantiate your class in a
clean and declarative way.
=cut
+my $Optional = MooseX::Meta::TypeConstraint::Structured::Optional->new(
+ name => 'MooseX::Types::Structured::Optional',
+ package_defined_in => __PACKAGE__,
+ parent => find_type_constraint('Item'),
+ constraint => sub { 1 },
+ constraint_generator => sub {
+ my ($type_parameter, @args) = @_;
+ my $check = $type_parameter->_compiled_type_constraint();
+ return sub {
+ my (@args) = @_;
+ ## Does the arg exist? Something exists if it's a 'real' value
+ ## or if it is set to undef.
+ if(exists($args[0])) {
+ ## If it exists, we need to validate it
+ $check->($args[0]);
+ } else {
+ ## But it's is okay if the value doesn't exists
+ return 1;
+ }
+ }
+ }
+);
+
+my $IsType = sub {
+ my ($obj, $type) = @_;
+
+ return $obj->can('equals')
+ ? $obj->equals($type)
+ : undef;
+};
+
+my $CompiledTC = sub {
+ my ($obj) = @_;
+
+ my $method = '_compiled_type_constraint';
+ return(
+ $obj->$IsType('Any') ? undef
+ : $obj->can($method) ? $obj->$method
+ : sub { $obj->check(shift) },
+ );
+};
+
+Moose::Util::TypeConstraints::register_type_constraint($Optional);
+Moose::Util::TypeConstraints::add_parameterizable_type($Optional);
+
Moose::Util::TypeConstraints::get_type_constraint_registry->add_type_constraint(
- MooseX::Meta::TypeConstraint::Structured->new(
- name => "MooseX::Types::Structured::Tuple" ,
- parent => find_type_constraint('ArrayRef'),
- constraint_generator=> sub {
- ## Get the constraints and values to check
- my ($type_constraints, $values) = @_;
- my @type_constraints = defined $type_constraints ?
+ MooseX::Meta::TypeConstraint::Structured->new(
+ name => "MooseX::Types::Structured::Tuple" ,
+ parent => find_type_constraint('ArrayRef'),
+ constraint_generator=> sub {
+ ## Get the constraints and values to check
+ my ($self, $type_constraints) = @_;
+ $type_constraints ||= $self->type_constraints;
+ my @type_constraints = defined $type_constraints ?
@$type_constraints : ();
-
+
my $overflow_handler;
- if(ref $type_constraints[-1] eq 'CODE') {
+ if($type_constraints[-1] && blessed $type_constraints[-1]
+ && $type_constraints[-1]->isa('MooseX::Types::Structured::OverflowHandler')) {
$overflow_handler = pop @type_constraints;
}
-
- my @values = defined $values ? @$values: ();
- ## Perform the checking
- while(@type_constraints) {
- my $type_constraint = shift @type_constraints;
- if(@values) {
- my $value = shift @values;
- unless($type_constraint->check($value)) {
- return;
- }
- } else {
- ## Test if the TC supports null values
- unless($type_constraint->check()) {
- return;
- }
- }
- }
- ## Make sure there are no leftovers.
- if(@values) {
- if($overflow_handler) {
- return $overflow_handler->(@values);
+
+ my $length = $#type_constraints;
+ foreach my $idx (0..$length) {
+ unless(blessed $type_constraints[$idx]) {
+ ($type_constraints[$idx] = find_type_constraint($type_constraints[$idx]))
+ || die "$type_constraints[$idx] is not a registered type";
+ }
+ }
+
+ my (@checks, @optional, $o_check, $is_compiled);
+ return sub {
+ my ($values, $err) = @_;
+ my @values = defined $values ? @$values : ();
+
+ ## initialise on first time run
+ unless ($is_compiled) {
+ @checks = map { $_->$CompiledTC } @type_constraints;
+ @optional = map { $_->is_subtype_of($Optional) } @type_constraints;
+ $o_check = $overflow_handler->$CompiledTC
+ if $overflow_handler;
+ $is_compiled++;
+ }
+
+ ## Perform the checking
+ VALUE:
+ for my $type_index (0 .. $#checks) {
+
+ my $type_constraint = $checks[ $type_index ];
+
+ if(@values) {
+ my $value = shift @values;
+
+ next VALUE
+ unless $type_constraint;
+
+ unless($type_constraint->($value)) {
+ if($err) {
+ my $message = $type_constraints[ $type_index ]->validate($value,$err);
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
+ } else {
+ ## Test if the TC supports null values
+ unless ($optional[ $type_index ]) {
+ if($err) {
+ my $message = $type_constraints[ $type_index ]->get_message('NULL',$err);
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
+ }
+ }
+
+ ## Make sure there are no leftovers.
+ if(@values) {
+ if($overflow_handler) {
+ return $o_check->([@values], $err);
+ } else {
+ if($err) {
+ my $message = "More values than Type Constraints!";
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
} else {
- return;
+ return 1;
}
- } elsif(@type_constraints) {
- warn "I failed due to left over TC";
- return;
- } else {
- return 1;
- }
- }
- )
+ };
+ }
+ )
);
-
+
Moose::Util::TypeConstraints::get_type_constraint_registry->add_type_constraint(
- MooseX::Meta::TypeConstraint::Structured->new(
- name => "MooseX::Types::Structured::Dict",
- parent => find_type_constraint('HashRef'),
- constraint_generator=> sub {
- ## Get the constraints and values to check
- my ($type_constraints, $values) = @_;
- my @type_constraints = defined $type_constraints ?
+ MooseX::Meta::TypeConstraint::Structured->new(
+ name => "MooseX::Types::Structured::Dict",
+ parent => find_type_constraint('HashRef'),
+ constraint_generator => sub {
+ ## Get the constraints and values to check
+ my ($self, $type_constraints) = @_;
+ $type_constraints = $self->type_constraints;
+ my @type_constraints = defined $type_constraints ?
@$type_constraints : ();
-
+
my $overflow_handler;
- if(ref $type_constraints[-1] eq 'CODE') {
+ if($type_constraints[-1] && blessed $type_constraints[-1]
+ && $type_constraints[-1]->isa('MooseX::Types::Structured::OverflowHandler')) {
$overflow_handler = pop @type_constraints;
- }
- my (%type_constraints) = @type_constraints;
- my %values = defined $values ? %$values: ();
- ## Perform the checking
- while(%type_constraints) {
- my($key, $type_constraint) = each %type_constraints;
- delete $type_constraints{$key};
- if(exists $values{$key}) {
- my $value = $values{$key};
- delete $values{$key};
- unless($type_constraint->check($value)) {
- return;
- }
- } else {
- ## Test to see if the TC supports null values
- unless($type_constraint->check()) {
- return;
- }
- }
- }
- ## Make sure there are no leftovers.
- if(%values) {
- if($overflow_handler) {
- return $overflow_handler->(%values);
- } else {
- return;
+ }
+ my %type_constraints = @type_constraints;
+ foreach my $key (keys %type_constraints) {
+ unless(blessed $type_constraints{$key}) {
+ ($type_constraints{$key} = find_type_constraint($type_constraints{$key}))
+ || die "$type_constraints{$key} is not a registered type";
}
- } elsif(%type_constraints) {
- return;
- } else {
- return 1;
- }
- },
- )
-);
+ }
-OPTIONAL: {
- my $Optional = Moose::Meta::TypeConstraint::Parameterizable->new(
- name => 'MooseX::Types::Structured::Optional',
- package_defined_in => __PACKAGE__,
- parent => find_type_constraint('Item'),
- constraint => sub { 1 },
- constraint_generator => sub {
- my ($type_parameter, @args) = @_;
- my $check = $type_parameter->_compiled_type_constraint();
+ my (%check, %optional, $o_check, $is_compiled);
return sub {
- my (@args) = @_;
- ## Does the arg exist? Something exists if it's a 'real' value
- ## or if it is set to undef.
- if(exists($args[0])) {
- ## If it exists, we need to validate it
- $check->($args[0]);
+ my ($values, $err) = @_;
+ my %values = defined $values ? %$values: ();
+
+ unless ($is_compiled) {
+ %check = map { ($_ => $type_constraints{ $_ }->$CompiledTC) } keys %type_constraints;
+ %optional = map { ($_ => $type_constraints{ $_ }->is_subtype_of($Optional)) } keys %type_constraints;
+ $o_check = $overflow_handler->$CompiledTC
+ if $overflow_handler;
+ $is_compiled++;
+ }
+
+ ## Perform the checking
+ KEY:
+ for my $key (keys %check) {
+ my $type_constraint = $check{ $key };
+
+ if(exists $values{$key}) {
+ my $value = $values{$key};
+ delete $values{$key};
+
+ next KEY
+ unless $type_constraint;
+
+ unless($type_constraint->($value)) {
+ if($err) {
+ my $message = $type_constraints{ $key }->validate($value,$err);
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
+ } else {
+ ## Test to see if the TC supports null values
+ unless ($optional{ $key }) {
+ if($err) {
+ my $message = $type_constraints{ $key }->get_message('NULL',$err);
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
+ }
+ }
+
+ ## Make sure there are no leftovers.
+ if(%values) {
+ if($overflow_handler) {
+ return $o_check->(+{%values});
+ } else {
+ if($err) {
+ my $message = "More values than Type Constraints!";
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
} else {
- ## But it's is okay if the value doesn't exists
return 1;
}
}
- }
- );
+ },
+ )
+);
- Moose::Util::TypeConstraints::register_type_constraint($Optional);
- Moose::Util::TypeConstraints::add_parameterizable_type($Optional);
-}
+Moose::Util::TypeConstraints::get_type_constraint_registry->add_type_constraint(
+ MooseX::Meta::TypeConstraint::Structured->new(
+ name => "MooseX::Types::Structured::Map",
+ parent => find_type_constraint('HashRef'),
+ constraint_generator=> sub {
+ ## Get the constraints and values to check
+ my ($self, $type_constraints) = @_;
+ $type_constraints = $self->type_constraints;
+ my @constraints = defined $type_constraints ? @$type_constraints : ();
+
+ Carp::confess( "too many args for Map type" ) if @constraints > 2;
+
+ my ($key_type, $value_type) = @constraints == 2 ? @constraints
+ : @constraints == 1 ? (undef, @constraints)
+ : ();
+
+ my ($key_check, $value_check, $is_compiled);
+ return sub {
+ my ($values, $err) = @_;
+ my %values = defined $values ? %$values: ();
+
+ unless ($is_compiled) {
+ ($key_check, $value_check)
+ = map { $_ ? $_->$CompiledTC : undef }
+ $key_type, $value_type;
+ $is_compiled++;
+ }
+
+ ## Perform the checking
+ if ($value_check) {
+ for my $value (values %$values) {
+ unless ($value_check->($value)) {
+ if($err) {
+ my $message = $value_type->validate($value,$err);
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
+ }
+ }
+ if ($key_check) {
+ for my $key (keys %$values) {
+ unless ($key_check->($key)) {
+ if($err) {
+ my $message = $key_type->validate($key,$err);
+ $err->add_message({message=>$message,level=>$err->level});
+ }
+ return;
+ }
+ }
+ }
+
+ return 1;
+ };
+ },
+ )
+);
-sub slurpy($) {
- my $tc = shift @_;
- ## we don't want to force the TC to be a Moose::Meta::TypeConstraint, we
- ## just want to make sure it provides the minimum needed bits to function.
- if($tc and ref $tc and $tc->can('check') and $tc->can('is_subtype_of') ) {
- return sub {
- if($tc->is_subtype_of('HashRef')) {
- return $tc->check(+{@_});
- } elsif($tc->is_subtype_of('ArrayRef')) {
- return $tc->check([@_]);
- } else {
- return;
- }
- };
- } else {
- ## For now just pass it all to check and cross our fingers
- return sub {
- return $tc->check(@_);
- };
- }
+sub slurpy ($) {
+ my ($tc) = @_;
+ return MooseX::Types::Structured::OverflowHandler->new(
+ type_constraint => $tc,
+ );
}
=head1 SEE ALSO
L<Moose>, L<MooseX::Types>, L<Moose::Meta::TypeConstraint>,
L<MooseX::Meta::TypeConstraint::Structured>
-=head1 TODO
-
-Here's a list of stuff I would be happy to get volunteers helping with:
-
-All POD examples need test cases in t/documentation/*.t
-Want to break out the examples section to a separate cookbook style POD.
-Want more examples and best practice / usage guidance for authors
-Need to clarify deep coercions,
-Need to clarify subtypes of subtypes.
-
-=head1 AUTHOR
-
-John Napiorkowski, C<< <jjnapiork@cpan.org> >>
-
-=head1 COPYRIGHT & LICENSE
-
-This program is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
-
=cut
-
+
1;
projects / gitmo/MooseX-Types-Structured.git / blobdiff