X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FUtil%2FTypeConstraints.pm;h=855bd001dc1dfac039f73e4ce5bfe4b1a8ee2130;hb=b2ad68e3fbe4016e354980a636c1ed39e941162a;hp=659e95b4790008469963bfa17b4b8b474951769e;hpb=07b0f1a5599bf1a0ed99933200ca27290e9a468a;p=gitmo%2FMoose.git diff --git a/lib/Moose/Util/TypeConstraints.pm b/lib/Moose/Util/TypeConstraints.pm index 659e95b..855bd00 100644 --- a/lib/Moose/Util/TypeConstraints.pm +++ b/lib/Moose/Util/TypeConstraints.pm @@ -4,11 +4,13 @@ package Moose::Util::TypeConstraints; use strict; use warnings; -use Carp 'confess'; +use Carp (); +use List::MoreUtils qw( all ); use Scalar::Util 'blessed'; -use Sub::Exporter; +use Moose::Exporter; -our $VERSION = '0.51'; +our $VERSION = '0.67'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; ## -------------------------------------------------------- @@ -18,31 +20,11 @@ our $AUTHORITY = 'cpan:STEVAN'; # ensures the prototypes are in scope when consumers are # compiled. -# creation and location -sub find_type_constraint ($); -sub register_type_constraint ($); -sub find_or_create_type_constraint ($;$); -sub find_or_parse_type_constraint ($); -sub find_or_create_isa_type_constraint ($); -sub find_or_create_does_type_constraint ($); -sub create_type_constraint_union (@); -sub create_parameterized_type_constraint ($); -sub create_class_type_constraint ($;$); -sub create_role_type_constraint ($;$); -sub create_enum_type_constraint ($$); - # dah sugah! -sub type ($$;$$); -sub subtype ($$;$$$); -sub class_type ($;$); -sub coerce ($@); -sub as ($); -sub from ($); sub where (&); sub via (&); sub message (&); sub optimize_as (&); -sub enum ($;@); ## private stuff ... sub _create_type_constraint ($$$;$$); @@ -62,38 +44,18 @@ use Moose::Meta::TypeCoercion::Union; use Moose::Meta::TypeConstraint::Registry; use Moose::Util::TypeConstraints::OptimizedConstraints; -my @exports = qw/ - type subtype class_type role_type as where message optimize_as - coerce from via - enum - find_type_constraint - register_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) = Class::MOP::get_code_info($keyword); - next if $@; - next if $pkg_name ne 'Moose::Util::TypeConstraints'; - - # and if it is from Moose then undef the slot - delete ${$class . '::'}{$name}; - } - } -} +Moose::Exporter->setup_import_methods( + as_is => [ + qw( + type subtype class_type role_type maybe_type + as where message optimize_as + coerce from via + enum + find_type_constraint + register_type_constraint ) + ], + _export_to_main => 1, +); ## -------------------------------------------------------- ## type registry and some useful functions for it @@ -112,7 +74,7 @@ sub export_type_constraints_as_functions { } } -sub create_type_constraint_union (@) { +sub create_type_constraint_union { my @type_constraint_names; if (scalar @_ == 1 && _detect_type_constraint_union($_[0])) { @@ -121,48 +83,58 @@ sub create_type_constraint_union (@) { else { @type_constraint_names = @_; } - + (scalar @type_constraint_names >= 2) - || confess "You must pass in at least 2 type names to make a union"; + || __PACKAGE__->_throw_error("You must pass in at least 2 type names to make a union"); - ($REGISTRY->has_type_constraint($_)) - || confess "Could not locate type constraint ($_) for the union" - foreach @type_constraint_names; + my @type_constraints = map { + find_or_parse_type_constraint($_) || + __PACKAGE__->_throw_error("Could not locate type constraint ($_) for the union"); + } @type_constraint_names; return Moose::Meta::TypeConstraint::Union->new( - type_constraints => [ - map { - $REGISTRY->get_type_constraint($_) - } @type_constraint_names - ], + type_constraints => \@type_constraints ); } -sub create_parameterized_type_constraint ($) { +sub create_parameterized_type_constraint { my $type_constraint_name = shift; - my ($base_type, $type_parameter) = _parse_parameterized_type_constraint($type_constraint_name); (defined $base_type && defined $type_parameter) - || confess "Could not parse type name ($type_constraint_name) correctly"; + || __PACKAGE__->_throw_error("Could not parse type name ($type_constraint_name) correctly"); - ($REGISTRY->has_type_constraint($base_type)) - || confess "Could not locate the base type ($base_type)"; - - return Moose::Meta::TypeConstraint::Parameterized->new( - name => $type_constraint_name, - parent => $REGISTRY->get_type_constraint($base_type), - type_parameter => find_or_create_isa_type_constraint($type_parameter), - ); + if ($REGISTRY->has_type_constraint($base_type)) { + my $base_type_tc = $REGISTRY->get_type_constraint($base_type); + return _create_parameterized_type_constraint( + $base_type_tc, + $type_parameter + ); + } else { + __PACKAGE__->_throw_error("Could not locate the base type ($base_type)"); + } } +sub _create_parameterized_type_constraint { + my ( $base_type_tc, $type_parameter ) = @_; + if ( $base_type_tc->can('parameterize') ) { + return $base_type_tc->parameterize($type_parameter); + } else { + return Moose::Meta::TypeConstraint::Parameterized->new( + name => $base_type_tc->name . '[' . $type_parameter . ']', + parent => $base_type_tc, + type_parameter => find_or_create_isa_type_constraint($type_parameter), + ); + } +} + #should we also support optimized checks? -sub create_class_type_constraint ($;$) { +sub create_class_type_constraint { my ( $class, $options ) = @_; # too early for this check #find_type_constraint("ClassName")->check($class) - # || confess "Can't create a class type constraint because '$class' is not a class name"; + # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name"); my %options = ( class => $class, @@ -175,12 +147,12 @@ sub create_class_type_constraint ($;$) { Moose::Meta::TypeConstraint::Class->new( %options ); } -sub create_role_type_constraint ($;$) { +sub create_role_type_constraint { my ( $role, $options ) = @_; # too early for this check #find_type_constraint("ClassName")->check($class) - # || confess "Can't create a class type constraint because '$class' is not a class name"; + # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name"); my %options = ( role => $role, @@ -194,7 +166,7 @@ sub create_role_type_constraint ($;$) { } -sub find_or_create_type_constraint ($;$) { +sub find_or_create_type_constraint { my ( $type_constraint_name, $options_for_anon_type ) = @_; if ( my $constraint = find_or_parse_type_constraint($type_constraint_name) ) { @@ -221,28 +193,25 @@ sub find_or_create_type_constraint ($;$) { return; } -sub find_or_create_isa_type_constraint ($) { +sub find_or_create_isa_type_constraint { my $type_constraint_name = shift; find_or_parse_type_constraint($type_constraint_name) || create_class_type_constraint($type_constraint_name) } -sub find_or_create_does_type_constraint ($) { +sub find_or_create_does_type_constraint { my $type_constraint_name = shift; find_or_parse_type_constraint($type_constraint_name) || create_role_type_constraint($type_constraint_name) } -sub find_or_parse_type_constraint ($) { - my $type_constraint_name = shift; - - return $REGISTRY->get_type_constraint($type_constraint_name) - if $REGISTRY->has_type_constraint($type_constraint_name); - +sub find_or_parse_type_constraint { + my $type_constraint_name = normalize_type_constraint_name(shift); my $constraint; - - if (_detect_type_constraint_union($type_constraint_name)) { + + if ($constraint = find_type_constraint($type_constraint_name)) { + return $constraint; + } elsif (_detect_type_constraint_union($type_constraint_name)) { $constraint = create_type_constraint_union($type_constraint_name); - } - elsif (_detect_parameterized_type_constraint($type_constraint_name)) { + } elsif (_detect_parameterized_type_constraint($type_constraint_name)) { $constraint = create_parameterized_type_constraint($type_constraint_name); } else { return; @@ -252,49 +221,70 @@ sub find_or_parse_type_constraint ($) { return $constraint; } +sub normalize_type_constraint_name { + my $type_constraint_name = shift; + $type_constraint_name =~ s/\s//g; + return $type_constraint_name; +} + +sub _confess { + my $error = shift; + + local $Carp::CarpLevel = $Carp::CarpLevel + 1; + Carp::confess($error); +} + ## -------------------------------------------------------- ## exported functions ... ## -------------------------------------------------------- -sub find_type_constraint ($) { +sub find_type_constraint { my $type = shift; if ( blessed $type and $type->isa("Moose::Meta::TypeConstraint") ) { return $type; - } else { + } + else { + return unless $REGISTRY->has_type_constraint($type); return $REGISTRY->get_type_constraint($type); } } -sub register_type_constraint ($) { +sub register_type_constraint { my $constraint = shift; - confess "can't register an unnamed type constraint" unless defined $constraint->name; + __PACKAGE__->_throw_error("can't register an unnamed type constraint") unless defined $constraint->name; $REGISTRY->add_type_constraint($constraint); return $constraint; } # type constructors -sub type ($$;$$) { +sub type { splice(@_, 1, 0, undef); goto &_create_type_constraint; } -sub subtype ($$;$$$) { +sub subtype { # NOTE: # this adds an undef for the name # if this is an anon-subtype: # subtype(Num => where { $_ % 2 == 0 }) # anon 'even' subtype - # but if the last arg is not a code - # ref then it is a subtype alias: + # or + # subtype(Num => where { $_ % 2 == 0 }) message { "$_ must be an even number" } + # + # but if the last arg is not a code ref then it is a subtype + # alias: + # # subtype(MyNumbers => as Num); # now MyNumbers is the same as Num # ... yeah I know it's ugly code # - SL - unshift @_ => undef if scalar @_ <= 2 && ('CODE' eq ref($_[1])); + unshift @_ => undef if scalar @_ == 2 && ( 'CODE' eq ref( $_[-1] ) ); + unshift @_ => undef + if scalar @_ == 3 && all { ref($_) =~ /^(?:CODE|HASH)$/ } @_[ 1, 2 ]; goto &_create_type_constraint; } -sub class_type ($;$) { +sub class_type { register_type_constraint( create_class_type_constraint( $_[0], @@ -312,20 +302,28 @@ sub role_type ($;$) { ); } -sub coerce ($@) { +sub maybe_type { + my ($type_parameter) = @_; + + register_type_constraint( + $REGISTRY->get_type_constraint('Maybe')->parameterize($type_parameter) + ); +} + +sub coerce { my ($type_name, @coercion_map) = @_; _install_type_coercions($type_name, \@coercion_map); } -sub as ($) { $_[0] } -sub from ($) { $_[0] } +sub as { @_ } +sub from { @_ } sub where (&) { $_[0] } sub via (&) { $_[0] } sub message (&) { +{ message => $_[0] } } sub optimize_as (&) { +{ optimized => $_[0] } } -sub enum ($;@) { +sub enum { my ($type_name, @values) = @_; # NOTE: # if only an array-ref is passed then @@ -336,7 +334,7 @@ sub enum ($;@) { $type_name = undef; } (scalar @values >= 2) - || confess "You must have at least two values to enumerate through"; + || __PACKAGE__->_throw_error("You must have at least two values to enumerate through"); my %valid = map { $_ => 1 } @values; register_type_constraint( @@ -347,9 +345,9 @@ sub enum ($;@) { ); } -sub create_enum_type_constraint ($$) { +sub create_enum_type_constraint { my ( $type_name, $values ) = @_; - + Moose::Meta::TypeConstraint::Enum->new( name => $type_name || '__ANON__', values => $values, @@ -365,55 +363,48 @@ sub _create_type_constraint ($$$;$$) { my $parent = shift; my $check = shift; - my ($message, $optimized); + my ( $message, $optimized ); for (@_) { $message = $_->{message} if exists $_->{message}; $optimized = $_->{optimized} if exists $_->{optimized}; } - my $pkg_defined_in = scalar(caller(0)); + my $pkg_defined_in = scalar( caller(0) ); - if (defined $name) { + if ( defined $name ) { my $type = $REGISTRY->get_type_constraint($name); - ($type->_package_defined_in eq $pkg_defined_in) - || confess ("The type constraint '$name' has already been created in " - . $type->_package_defined_in . " and cannot be created again in " - . $pkg_defined_in) - if defined $type; - } - - my $class = "Moose::Meta::TypeConstraint"; - - # FIXME should probably not be a special case - if ( defined $parent and $parent = find_or_parse_type_constraint($parent) ) { - $class = "Moose::Meta::TypeConstraint::Parameterizable" - if $parent->isa("Moose::Meta::TypeConstraint::Parameterizable"); + ( $type->_package_defined_in eq $pkg_defined_in ) + || _confess( + "The type constraint '$name' has already been created in " + . $type->_package_defined_in + . " and cannot be created again in " + . $pkg_defined_in ) + if defined $type; + + $name =~ /^[\w:\.]+$/ + or die qq{$name contains invalid characters for a type name.} + . qq{Names can contain alphanumeric character, ":", and "."\n}; } - my $constraint = $class->new( - name => $name || '__ANON__', + my %opts = ( + name => $name, package_defined_in => $pkg_defined_in, - ($parent ? (parent => $parent ) : ()), - ($check ? (constraint => $check) : ()), - ($message ? (message => $message) : ()), - ($optimized ? (optimized => $optimized) : ()), + ( $check ? ( constraint => $check ) : () ), + ( $message ? ( message => $message ) : () ), + ( $optimized ? ( optimized => $optimized ) : () ), ); - # NOTE: - # if we have a type constraint union, and no - # type check, this means we are just aliasing - # the union constraint, which means we need to - # handle this differently. - # - SL - if (not(defined $check) - && $parent->isa('Moose::Meta::TypeConstraint::Union') - && $parent->has_coercion - ){ - $constraint->coercion(Moose::Meta::TypeCoercion::Union->new( - type_constraint => $parent - )); + my $constraint; + if ( defined $parent + and $parent + = blessed $parent ? $parent : find_or_create_isa_type_constraint($parent) ) + { + $constraint = $parent->create_child_type(%opts); + } + else { + $constraint = Moose::Meta::TypeConstraint->new(%opts); } $REGISTRY->add_type_constraint($constraint) @@ -424,9 +415,9 @@ sub _create_type_constraint ($$$;$$) { sub _install_type_coercions ($$) { my ($type_name, $coercion_map) = @_; - my $type = $REGISTRY->get_type_constraint($type_name); + my $type = find_type_constraint($type_name); (defined $type) - || confess "Cannot find type '$type_name', perhaps you forgot to load it."; + || __PACKAGE__->_throw_error("Cannot find type '$type_name', perhaps you forgot to load it."); if ($type->has_coercion) { $type->coercion->add_type_coercions(@$coercion_map); } @@ -452,14 +443,14 @@ sub _install_type_coercions ($$) { use re "eval"; - my $valid_chars = qr{[\w:]}; + my $valid_chars = qr{[\w:\.]}; my $type_atom = qr{ $valid_chars+ }; my $any; - my $type = qr{ $valid_chars+ (?: \[ (??{$any}) \] )? }x; - my $type_capture_parts = qr{ ($valid_chars+) (?: \[ ((??{$any})) \] )? }x; - my $type_with_parameter = qr{ $valid_chars+ \[ (??{$any}) \] }x; + my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x; + my $type_capture_parts = qr{ ($valid_chars+) (?: \[ \s* ((??{$any})) \s* \] )? }x; + my $type_with_parameter = qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x; my $op_union = qr{ \s* \| \s* }x; my $union = qr{ $type (?: $op_union $type )+ }x; @@ -485,11 +476,11 @@ sub _install_type_coercions ($$) { push @rv => $1; } (pos($given) eq length($given)) - || confess "'$given' didn't parse (parse-pos=" + || __PACKAGE__->_throw_error("'$given' didn't parse (parse-pos=" . pos($given) . " and str-length=" . length($given) - . ")"; + . ")"); @rv; } @@ -503,6 +494,27 @@ sub _install_type_coercions ($$) { # define some basic built-in types ## -------------------------------------------------------- +# By making these classes immutable before creating all the types we +# below, we avoid repeatedly calling the slow MOP-based accessors. +$_->make_immutable( + inline_constructor => 1, + constructor_name => "_new", + + # these are Class::MOP accessors, so they need inlining + inline_accessors => 1 + ) for grep { $_->is_mutable } + map { $_->meta } + qw( + Moose::Meta::TypeConstraint + Moose::Meta::TypeConstraint::Union + Moose::Meta::TypeConstraint::Parameterized + Moose::Meta::TypeConstraint::Parameterizable + Moose::Meta::TypeConstraint::Class + Moose::Meta::TypeConstraint::Role + Moose::Meta::TypeConstraint::Enum + Moose::Meta::TypeConstraint::Registry +); + type 'Any' => where { 1 }; # meta-type including all type 'Item' => where { 1 }; # base-type @@ -637,7 +649,7 @@ sub get_all_parameterizable_types { @PARAMETERIZABLE_TYPES } sub add_parameterizable_type { my $type = shift; (blessed $type && $type->isa('Moose::Meta::TypeConstraint::Parameterizable')) - || confess "Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type"; + || __PACKAGE__->_throw_error("Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type"); push @PARAMETERIZABLE_TYPES => $type; } @@ -650,6 +662,12 @@ sub add_parameterizable_type { sub list_all_builtin_type_constraints { @BUILTINS } } +sub _throw_error { + require Moose; + unshift @_, 'Moose'; + goto &Moose::throw_error; +} + 1; __END__ @@ -667,7 +685,7 @@ Moose::Util::TypeConstraints - Type constraint system for Moose type 'Num' => where { Scalar::Util::looks_like_number($_) }; subtype 'Natural' - => as 'Num' + => as 'Int' => where { $_ > 0 }; subtype 'NaturalLessThanTen' @@ -693,7 +711,7 @@ and they are not used by Moose unless you tell it to. No type 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, with the added +can be used to simplify your own type-checking code, with the added side benefit of making your intentions clearer through self-documentation. =head2 Slightly Less Important Caveat @@ -723,7 +741,7 @@ yet to have been created yet, is to simply do this: =head2 Default Type Constraints -This module also provides a simple hierarchy for Perl 5 types, here is +This module also provides a simple hierarchy for Perl 5 types, here is that hierarchy represented visually. Any @@ -746,15 +764,23 @@ that hierarchy represented visually. GlobRef FileHandle Object - Role + Role B Any type followed by a type parameter C<[`a]> can be parameterized, this means you can say: - ArrayRef[Int] # an array of intergers + ArrayRef[Int] # an array of integers HashRef[CodeRef] # a hash of str to CODE ref mappings Maybe[Str] # value may be a string, may be undefined +If Moose finds a name in brackets that it does not recognize as an +existing type, it assumes that this is a class name, for example +C. + +B Unless you parameterize a type, then it is invalid to +include the square brackets. I.e. C will be +literally interpreted as a type name. + B The C type constraint for the most part works correctly now, but edge cases may still exist, please use it sparringly. @@ -764,12 +790,15 @@ existence check. This means that your class B be loaded for this type constraint to pass. I know this is not ideal for all, but it is a saner restriction than most others. -=head2 Type Constraint Naming +=head2 Type Constraint Naming -Since the types created by this module are global, it is suggested -that you namespace your types just as you would namespace your +Type name declared via this module can only contain alphanumeric +characters, colons (:), and periods (.). + +Since the types created by this module are global, it is suggested +that you namespace your types just as you would namespace your modules. So instead of creating a I type for your B -module, you would call the type I instead. +module, you would call the type I instead. =head2 Use with Other Constraint Modules @@ -788,7 +817,7 @@ L to declare a completely new type. -keys => HasLength, -values => IsArrayRef( IsObject )); -For more examples see the F +For more examples see the F test file. Here is an example of using L and it's non-test @@ -803,7 +832,7 @@ related C function. }))) }; -For a complete example see the +For a complete example see the F test file. =head1 FUNCTIONS @@ -826,6 +855,9 @@ This creates a base type, which has no parent. This creates a named subtype. +If you provide a parent that Moose does not recognize, it will +automatically create a new class type constraint for this name. + =item B This creates an unnamed subtype and will return the type @@ -842,6 +874,11 @@ L. Creates a type constraint with the name C<$role> and the metaclass L. +=item B + +Creates a type constraint for either C or something of the +given type. + =item B This will create a basic subtype for a given set of strings. @@ -871,10 +908,20 @@ This is just sugar for the type constraint construction syntax. This is just sugar for the type constraint construction syntax. +Takes a block/code ref as an argument. When the type constraint is +tested, the supplied code is run with the value to be tested in +$_. This block should return true or false to indicate whether or not +the constraint check passed. + =item B This is just sugar for the type constraint construction syntax. +Takes a block/code ref as an argument. When the type constraint fails, +then the code block is run (with the value provided in $_). This code +ref should return a string, which will be used in the text of the +exception thrown. + =item B This can be used to define a "hand optimized" version of your @@ -915,6 +962,11 @@ This is just sugar for the type coercion construction syntax. =over 4 +=item B + +Given a string that is expected to match a type constraint, will normalize the +string so that extra whitespace and newlines are removed. + =item B Given string with C<$pipe_seperated_types> or a list of C<@type_constraint_names>, @@ -962,7 +1014,7 @@ C. =item B -Attempts to parse the type name using L and if +Attempts to parse the type name using C and if no appropriate constraint is found will create a new anonymous one. The C variant will use C and the C @@ -1034,7 +1086,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L