X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FUtil%2FTypeConstraints.pm;h=d9840858e1f1cefe6e0c83dc11f1a069180b31c2;hb=8c4acc601eded1380a6496b9265a331afee580d6;hp=63ba714119a5e248447ed9a8f7bc251d36c1017e;hpb=76d37e5a93324c12abfa3c9c6c51dbc3bf31baa5;p=gitmo%2FMoose.git diff --git a/lib/Moose/Util/TypeConstraints.pm b/lib/Moose/Util/TypeConstraints.pm index 63ba714..d984085 100644 --- a/lib/Moose/Util/TypeConstraints.pm +++ b/lib/Moose/Util/TypeConstraints.pm @@ -6,44 +6,112 @@ use warnings; use Carp 'confess'; use Scalar::Util 'blessed'; - -our $VERSION = '0.03'; +use B 'svref_2object'; +use Sub::Exporter; + +our $VERSION = '0.12'; +our $AUTHORITY = 'cpan:STEVAN'; + +# Prototyped subs must be predeclared because we have a circular dependency +# with Moose::Meta::Attribute et. al. so in case of us being use'd first the +# predeclaration ensures the prototypes are in scope when consumers are +# compiled + +sub find_type_constraint ($); +sub _create_type_constraint ($$$;$$); +sub _install_type_coercions ($$); +sub create_type_constraint_union (@); +sub type ($$;$$); +sub subtype ($$;$$$); +sub coerce ($@); +sub as ($); +sub from ($); +sub where (&); +sub via (&); +sub message (&); +sub optimize_as (&); +sub enum ($;@); use Moose::Meta::TypeConstraint; use Moose::Meta::TypeCoercion; -sub import { - shift; - my $pkg = shift || caller(); - return if $pkg eq '-no-export'; - no strict 'refs'; - foreach my $export (qw(type subtype as where message coerce from via find_type_constraint)) { - *{"${pkg}::${export}"} = \&{"${export}"}; - } +my @exports = qw/ + type subtype as where message optimize_as + coerce from via + enum + find_type_constraint +/; + +Sub::Exporter::setup_exporter({ + exports => \@exports, + groups => { default => [':all'] } +}); + +sub unimport { + no strict 'refs'; + my $class = caller(); + # loop through the exports ... + foreach my $name (@exports) { + # if we find one ... + if (defined &{$class . '::' . $name}) { + my $keyword = \&{$class . '::' . $name}; + + # make sure it is from Moose + my $pkg_name = eval { svref_2object($keyword)->GV->STASH->NAME }; + next if $@; + next if $pkg_name ne 'Moose::Util::TypeConstraints'; + + # and if it is from Moose then undef the slot + delete ${$class . '::'}{$name}; + } + } } { my %TYPES; - sub find_type_constraint { $TYPES{$_[0]}->[1] } - - sub _create_type_constraint { - my ($name, $parent, $check, $message) = @_; - my $pkg_defined_in = scalar(caller(1)); + sub find_type_constraint ($) { + return $TYPES{$_[0]}->[1] + if exists $TYPES{$_[0]}; + return; + } + + sub _dump_type_constraints { + require Data::Dumper; + Data::Dumper::Dumper(\%TYPES); + } + + sub _create_type_constraint ($$$;$$) { + my $name = shift; + my $parent = shift; + my $check = shift;; + + my ($message, $optimized); + for (@_) { + $message = $_->{message} if exists $_->{message}; + $optimized = $_->{optimized} if exists $_->{optimized}; + } + + my $pkg_defined_in = scalar(caller(0)); + ($TYPES{$name}->[0] eq $pkg_defined_in) - || confess "The type constraint '$name' has already been created" - if defined $name && exists $TYPES{$name}; + || confess ("The type constraint '$name' has already been created in " + . $TYPES{$name}->[0] . " and cannot be created again in " + . $pkg_defined_in) + if defined $name && exists $TYPES{$name}; + $parent = find_type_constraint($parent) if defined $parent; my $constraint = Moose::Meta::TypeConstraint->new( name => $name || '__ANON__', parent => $parent, constraint => $check, message => $message, + optimized => $optimized, ); $TYPES{$name} = [ $pkg_defined_in, $constraint ] if defined $name; return $constraint; } - sub _install_type_coercions { + sub _install_type_coercions ($$) { my ($type_name, $coercion_map) = @_; my $type = find_type_constraint($type_name); (!$type->has_coercion) @@ -55,25 +123,38 @@ sub import { $type->coercion($type_coercion); } - sub export_type_contstraints_as_functions { + sub create_type_constraint_union (@) { + my (@type_constraint_names) = @_; + return Moose::Meta::TypeConstraint->union( + map { + find_type_constraint($_) + } @type_constraint_names + ); + } + + sub export_type_constraints_as_functions { my $pkg = caller(); no strict 'refs'; foreach my $constraint (keys %TYPES) { *{"${pkg}::${constraint}"} = find_type_constraint($constraint)->_compiled_type_constraint; } - } + } + + *Moose::Util::TypeConstraints::export_type_contstraints_as_functions = \&export_type_constraints_as_functions; + + sub list_all_type_constraints { keys %TYPES } } # type constructors -sub type ($$) { - my ($name, $check) = @_; - _create_type_constraint($name, undef, $check); +sub type ($$;$$) { + splice(@_, 1, 0, undef); + goto &_create_type_constraint; } -sub subtype ($$;$$) { - unshift @_ => undef if scalar @_ <= 2; - _create_type_constraint(@_); +sub subtype ($$;$$$) { + unshift @_ => undef if scalar @_ <= 2; + goto &_create_type_constraint; } sub coerce ($@) { @@ -85,27 +166,90 @@ sub as ($) { $_[0] } sub from ($) { $_[0] } sub where (&) { $_[0] } sub via (&) { $_[0] } -sub message (&) { $_[0] } + +sub message (&) { +{ message => $_[0] } } +sub optimize_as (&) { +{ optimized => $_[0] } } + +sub enum ($;@) { + my ($type_name, @values) = @_; + (scalar @values >= 2) + || confess "You must have at least two values to enumerate through"; + my $regexp = join '|' => @values; + _create_type_constraint( + $type_name, + 'Str', + sub { qr/^$regexp$/i } + ); +} # define some basic types -type 'Any' => where { 1 }; +type 'Any' => where { 1 }; # meta-type including all +type 'Item' => where { 1 }; # base-type -subtype 'Value' => as 'Any' => where { !ref($_) }; -subtype 'Ref' => as 'Any' => where { ref($_) }; +subtype 'Undef' => as 'Item' => where { !defined($_) }; +subtype 'Defined' => as 'Item' => where { defined($_) }; -subtype 'Int' => as 'Value' => where { Scalar::Util::looks_like_number($_) }; -subtype 'Str' => as 'Value' => where { !Scalar::Util::looks_like_number($_) }; +subtype 'Bool' + => as 'Item' + => where { !defined($_) || $_ eq "" || "$_" eq '1' || "$_" eq '0' }; -subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' }; -subtype 'ArrayRef' => as 'Ref' => where { ref($_) eq 'ARRAY' }; -subtype 'HashRef' => as 'Ref' => where { ref($_) eq 'HASH' }; -subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' }; -subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' }; +subtype 'Value' + => as 'Defined' + => where { !ref($_) } + => optimize_as { defined($_[0]) && !ref($_[0]) }; + +subtype 'Ref' + => as 'Defined' + => where { ref($_) } + => optimize_as { ref($_[0]) }; + +subtype 'Str' + => as 'Value' + => where { 1 } + => optimize_as { defined($_[0]) && !ref($_[0]) }; + +subtype 'Num' + => as 'Value' + => where { Scalar::Util::looks_like_number($_) } + => optimize_as { !ref($_[0]) && Scalar::Util::looks_like_number($_[0]) }; + +subtype 'Int' + => as 'Num' + => where { "$_" =~ /^-?[0-9]+$/ } + => optimize_as { defined($_[0]) && !ref($_[0]) && $_[0] =~ /^-?[0-9]+$/ }; + +subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' } => optimize_as { ref($_[0]) eq 'SCALAR' }; +subtype 'ArrayRef' => as 'Ref' => where { ref($_) eq 'ARRAY' } => optimize_as { ref($_[0]) eq 'ARRAY' }; +subtype 'HashRef' => as 'Ref' => where { ref($_) eq 'HASH' } => optimize_as { ref($_[0]) eq 'HASH' }; +subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' } => optimize_as { ref($_[0]) eq 'CODE' }; +subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' } => optimize_as { ref($_[0]) eq 'Regexp' }; +subtype 'GlobRef' => as 'Ref' => where { ref($_) eq 'GLOB' } => optimize_as { ref($_[0]) eq 'GLOB' }; + +# NOTE: +# scalar filehandles are GLOB refs, +# but a GLOB ref is not always a filehandle +subtype 'FileHandle' + => as 'GlobRef' + => where { Scalar::Util::openhandle($_) } + => optimize_as { ref($_[0]) eq 'GLOB' && Scalar::Util::openhandle($_[0]) }; # NOTE: # blessed(qr/.../) returns true,.. how odd -subtype 'Object' => as 'Ref' => where { blessed($_) && blessed($_) ne 'Regexp' }; +subtype 'Object' + => as 'Ref' + => where { blessed($_) && blessed($_) ne 'Regexp' } + => optimize_as { blessed($_[0]) && blessed($_[0]) ne 'Regexp' }; + +subtype 'Role' + => as 'Object' + => where { $_->can('does') } + => optimize_as { blessed($_[0]) && $_[0]->can('does') }; + +{ + my @BUILTINS = list_all_type_constraints(); + sub list_all_builtin_type_constraints { @BUILTINS } +} 1; @@ -121,25 +265,27 @@ Moose::Util::TypeConstraints - Type constraint system for Moose use Moose::Util::TypeConstraints; - type Num => where { Scalar::Util::looks_like_number($_) }; + type 'Num' => where { Scalar::Util::looks_like_number($_) }; - subtype Natural - => as Num + subtype 'Natural' + => as 'Num' => where { $_ > 0 }; - subtype NaturalLessThanTen - => as Natural - => where { $_ < 10 }; + subtype 'NaturalLessThanTen' + => as 'Natural' + => where { $_ < 10 } + => message { "This number ($_) is not less than ten!" }; - coerce Num - => from Str + coerce 'Num' + => from 'Str' => via { 0+$_ }; + + enum 'RGBColors' => qw(red green blue); =head1 DESCRIPTION -This module provides Moose with the ability to create type contraints -to be are used in both attribute definitions and for method argument -validation. +This module provides Moose with the ability to create custom type +contraints to be used in attribute definition. =head2 Important Caveat @@ -150,24 +296,93 @@ inference is performed, expression are not typed, etc. etc. etc. This is simply a means of creating small constraint functions which can be used to simplify your own type-checking code. +=head2 Slightly Less Important Caveat + +It is almost always a good idea to quote your type and subtype names. +This is to prevent perl from trying to execute the call as an indirect +object call. This issue only seems to come up when you have a subtype +the same name as a valid class, but when the issue does arise it tends +to be quite annoying to debug. + +So for instance, this: + + subtype DateTime => as Object => where { $_->isa('DateTime') }; + +will I, while this: + + use DateTime; + subtype DateTime => as Object => where { $_->isa('DateTime') }; + +will fail silently and cause many headaches. The simple way to solve +this, as well as future proof your subtypes from classes which have +yet to have been created yet, is to simply do this: + + use DateTime; + subtype 'DateTime' => as 'Object' => where { $_->isa('DateTime') }; + =head2 Default Type Constraints This module also provides a simple hierarchy for Perl 5 types, this could probably use some work, but it works for me at the moment. Any - Value - Int - Str - Ref - ScalarRef - ArrayRef - HashRef - CodeRef - RegexpRef - Object + Item + Bool + Undef + Defined + Value + Num + Int + Str + Ref + ScalarRef + ArrayRef + HashRef + CodeRef + RegexpRef + GlobRef + FileHandle + Object + Role Suggestions for improvement are welcome. + +B The C type constraint does not work correctly +in every occasion, please use it sparringly. + +=head2 Use with Other Constraint Modules + +This module should play fairly nicely with other constraint +modules with only some slight tweaking. The C clause +in types is expected to be a C reference which checks +it's first argument and returns a bool. Since most constraint +modules work in a similar way, it should be simple to adapt +them to work with Moose. + +For instance, this is how you could use it with +L to declare a completely new type. + + type 'HashOfArrayOfObjects' + => IsHashRef( + -keys => HasLength, + -values => IsArrayRef( IsObject )); + +For more examples see the F test file. + +Here is an example of using L and it's non-test +related C function. + + type 'ArrayOfHashOfBarsAndRandomNumbers' + => where { + eq_deeply($_, + array_each(subhashof({ + bar => isa('Bar'), + random_number => ignore() + }))) + }; + +For a complete example see the F +test file. =head1 FUNCTIONS @@ -180,12 +395,33 @@ Suggestions for improvement are welcome. This function can be used to locate a specific type constraint meta-object. What you do with it from there is up to you :) -=item B +=item B + +Given a list of C<@type_constraint_names>, this will return a +B instance. + +=item B This will export all the current type constraints as functions into the caller's namespace. Right now, this is mostly used for testing, but it might prove useful to others. +=item B + +Alias for the above function. + +=item B + +This will return a list of type constraint names, you can then +fetch them using C if you +want to. + +=item B + +This will return a list of builtin type constraints, meaning, +those which are defined in this module. See the section +labeled L for a complete list. + =back =head2 Type Constraint Constructors @@ -194,7 +430,7 @@ The following functions are used to create type constraints. They will then register the type constraints in a global store where Moose can get to them if it needs to. -See the L for an example of how to use these. +See the L for an example of how to use these. =over 4 @@ -202,16 +438,26 @@ See the L for an example of how to use these. This creates a base type, which has no parent. -=item B +=item B This creates a named subtype. -=item B +=item B This creates an unnamed subtype and will return the type constraint meta-object, which will be an instance of L. +=item B + +This will create a basic subtype for a given set of strings. +The resulting constraint will be a subtype of C and +will match any of the items in C<@values>. See the L +for a simple example. + +B This is not a true proper enum type, it is simple +a convient constraint builder. + =item B This is just sugar for the type constraint construction syntax. @@ -224,17 +470,27 @@ This is just sugar for the type constraint construction syntax. This is just sugar for the type constraint construction syntax. +=item B + +This can be used to define a "hand optimized" version of your +type constraint which can be used to avoid traversing a subtype +constraint heirarchy. + +B You should only use this if you know what you are doing, +all the built in types use this, so your subtypes (assuming they +are shallow) will not likely need to use this. + =back =head2 Type Coercion Constructors -Type constraints can also contain type coercions as well. In most -cases Moose will run the type-coercion code first, followed by the -type constraint check. This feature should be used carefully as it -is very powerful and could easily take off a limb if you are not -careful. +Type constraints can also contain type coercions as well. If you +ask your accessor too coerce, the Moose will run the type-coercion +code first, followed by the type constraint check. This feature +should be used carefully as it is very powerful and could easily +take off a limb if you are not careful. -See the L for an example of how to use these. +See the L for an example of how to use these. =over 4 @@ -250,6 +506,17 @@ This is just sugar for the type coercion construction syntax. =back +=head2 Namespace Management + +=over 4 + +=item B + +This will remove all the type constraint keywords from the +calling class namespace. + +=back + =head1 BUGS All complex software has bugs lurking in it, and this module is no @@ -262,11 +529,11 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006, 2007 by Infinity Interactive, Inc. L This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. -=cut \ No newline at end of file +=cut