use warnings;
use metaclass;
-use Sub::Name 'subname';
-use Carp 'confess';
-use Scalar::Util 'blessed';
+use overload '""' => sub { shift->name }, # stringify to tc name
+ fallback => 1;
-our $VERSION = '0.06';
+use Scalar::Util qw(blessed refaddr);
-__PACKAGE__->meta->add_attribute('name' => (reader => 'name' ));
-__PACKAGE__->meta->add_attribute('parent' => (reader => 'parent' ));
-__PACKAGE__->meta->add_attribute('constraint' => (reader => 'constraint'));
+use base qw(Class::MOP::Object);
+
+our $VERSION = '0.72';
+$VERSION = eval $VERSION;
+our $AUTHORITY = 'cpan:STEVAN';
+
+__PACKAGE__->meta->add_attribute('name' => (reader => 'name'));
+__PACKAGE__->meta->add_attribute('parent' => (
+ reader => 'parent',
+ predicate => 'has_parent',
+));
+
+my $null_constraint = sub { 1 };
+__PACKAGE__->meta->add_attribute('constraint' => (
+ reader => 'constraint',
+ writer => '_set_constraint',
+ default => sub { $null_constraint }
+));
__PACKAGE__->meta->add_attribute('message' => (
accessor => 'message',
predicate => 'has_message'
predicate => 'has_coercion'
));
-# private accessor
+__PACKAGE__->meta->add_attribute('hand_optimized_type_constraint' => (
+ init_arg => 'optimized',
+ accessor => 'hand_optimized_type_constraint',
+ predicate => 'has_hand_optimized_type_constraint',
+));
+
+sub parents {
+ my $self;
+ $self->parent;
+}
+
+# private accessors
+
__PACKAGE__->meta->add_attribute('compiled_type_constraint' => (
- accessor => '_compiled_type_constraint'
+ accessor => '_compiled_type_constraint',
+ predicate => '_has_compiled_type_constraint'
+));
+__PACKAGE__->meta->add_attribute('package_defined_in' => (
+ accessor => '_package_defined_in'
));
-sub new {
+sub new {
my $class = shift;
- my $self = $class->meta->new_object(@_);
- $self->compile_type_constraint();
+ my ($first, @rest) = @_;
+ my %args = ref $first ? %$first : $first ? ($first, @rest) : ();
+ $args{name} = $args{name} ? "$args{name}" : "__ANON__";
+
+ my $self = $class->_new(%args);
+ $self->compile_type_constraint()
+ unless $self->_has_compiled_type_constraint;
return $self;
}
-sub coerce {
- ((shift)->coercion || confess "Cannot coerce without a type coercion")->coerce(@_)
-}
-sub _collect_all_parents {
+
+sub coerce {
my $self = shift;
- my @parents;
- my $current = $self->parent;
- while (defined $current) {
- unshift @parents => $current;
- $current = $current->parent;
+
+ my $coercion = $self->coercion;
+
+ unless ($coercion) {
+ require Moose;
+ Moose->throw_error("Cannot coerce without a type coercion");
}
- return @parents;
+
+ return $coercion->coerce(@_);
}
-sub compile_type_constraint {
- my $self = shift;
- my $check = $self->constraint;
- (defined $check)
- || confess "Could not compile type constraint '" . $self->name . "' because no constraint check";
- my $parent = $self->parent;
- if (defined $parent) {
- # we have a subtype ...
- # so we gather all the parents in order
- # and grab their constraints ...
- my @parents = map { $_->constraint } $self->_collect_all_parents;
- # then we compile them to run without
- # having to recurse as we did before
- $self->_compiled_type_constraint(subname $self->name => sub {
- local $_ = $_[0];
- foreach my $parent (@parents) {
- return undef unless $parent->($_[0]);
- }
- return undef unless $check->($_[0]);
- 1;
- });
-
+sub check {
+ my ($self, @args) = @_;
+ my $constraint_subref = $self->_compiled_type_constraint;
+ return $constraint_subref->(@args) ? 1 : undef;
+}
+
+sub validate {
+ my ($self, $value) = @_;
+ if ($self->_compiled_type_constraint->($value)) {
+ return undef;
}
else {
- # we have a type ....
- $self->_compiled_type_constraint(subname $self->name => sub {
- local $_ = $_[0];
- return undef unless $check->($_[0]);
- 1;
- });
+ $self->get_message($value);
}
}
-sub check { $_[0]->_compiled_type_constraint->($_[1]) }
-
-sub validate {
+sub get_message {
my ($self, $value) = @_;
- if ($self->_compiled_type_constraint->($value)) {
- return undef;
+ if (my $msg = $self->message) {
+ local $_ = $value;
+ return $msg->($value);
}
else {
- if ($self->has_message) {
- local $_ = $value;
- return $self->message->($value);
- }
- else {
- return "Validation failed for '" . $self->name . "' failed";
- }
+ $value = (defined $value ? overload::StrVal($value) : 'undef');
+ return "Validation failed for '" . $self->name . "' failed with value $value";
+ }
+}
+
+## type predicates ...
+
+sub equals {
+ my ( $self, $type_or_name ) = @_;
+
+ my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name) or return;
+
+ return 1 if refaddr($self) == refaddr($other);
+
+ if ( $self->has_hand_optimized_type_constraint and $other->has_hand_optimized_type_constraint ) {
+ return 1 if $self->hand_optimized_type_constraint == $other->hand_optimized_type_constraint;
+ }
+
+ return unless $self->constraint == $other->constraint;
+
+ if ( $self->has_parent ) {
+ return unless $other->has_parent;
+ return unless $self->parent->equals( $other->parent );
+ } else {
+ return if $other->has_parent;
}
+
+ return 1;
}
sub is_a_type_of {
- my ($self, $type_name) = @_;
- ($self->name eq $type_name || $self->is_subtype_of($type_name));
+ my ($self, $type_or_name) = @_;
+
+ my $type = Moose::Util::TypeConstraints::find_type_constraint($type_or_name) or return;
+
+ ($self->equals($type) || $self->is_subtype_of($type));
}
sub is_subtype_of {
- my ($self, $type_name) = @_;
+ my ($self, $type_or_name) = @_;
+
+ my $type = Moose::Util::TypeConstraints::find_type_constraint($type_or_name) or return;
+
my $current = $self;
+
while (my $parent = $current->parent) {
- return 1 if $parent->name eq $type_name;
+ return 1 if $parent->equals($type);
$current = $parent;
}
+
return 0;
}
-sub union {
- my ($class, @type_constraints) = @_;
- (scalar @type_constraints >= 2)
- || confess "You must pass in at least 2 Moose::Meta::TypeConstraint instances to make a union";
- (blessed($_) && $_->isa('Moose::Meta::TypeConstraint'))
- || confess "You must pass in only Moose::Meta::TypeConstraint instances to make unions"
- foreach @type_constraints;
- return Moose::Meta::TypeConstraint::Union->new(
- type_constraints => \@type_constraints,
- );
-}
+## compiling the type constraint
-package Moose::Meta::TypeConstraint::Union;
+sub compile_type_constraint {
+ my $self = shift;
+ $self->_compiled_type_constraint($self->_actually_compile_type_constraint);
+}
-use strict;
-use warnings;
-use metaclass;
+## type compilers ...
-our $VERSION = '0.03';
+sub _actually_compile_type_constraint {
+ my $self = shift;
-__PACKAGE__->meta->add_attribute('type_constraints' => (
- accessor => 'type_constraints',
- default => sub { [] }
-));
+ return $self->_compile_hand_optimized_type_constraint
+ if $self->has_hand_optimized_type_constraint;
-sub new {
- my $class = shift;
- my $self = $class->meta->new_object(@_);
- return $self;
-}
+ my $check = $self->constraint;
+ unless ( defined $check ) {
+ require Moose;
+ Moose->throw_error( "Could not compile type constraint '"
+ . $self->name
+ . "' because no constraint check" );
+ }
-sub name { join ' | ' => map { $_->name } @{$_[0]->type_constraints} }
+ return $self->_compile_subtype($check)
+ if $self->has_parent;
-# NOTE:
-# this should probably never be used
-# but we include it here for completeness
-sub constraint {
- my $self = shift;
- sub { $self->check($_[0]) };
+ return $self->_compile_type($check);
}
-# conform to the TypeConstraint API
-sub parent { undef }
-sub message { undef }
-sub has_message { 0 }
+sub _compile_hand_optimized_type_constraint {
+ my $self = shift;
-# FIXME:
-# not sure what this should actually do here
-sub coercion { undef }
+ my $type_constraint = $self->hand_optimized_type_constraint;
-# this should probably be memoized
-sub has_coercion {
- my $self = shift;
- foreach my $type (@{$self->type_constraints}) {
- return 1 if $type->has_coercion
+ unless ( ref $type_constraint ) {
+ require Moose;
+ Carp::confess ("Hand optimized type constraint for " . $self->name . " is not a code reference");
+ Moose->throw_error("Hand optimized type constraint is not a code reference");
}
- return 0;
+
+ return $type_constraint;
}
-# NOTE:
-# this feels too simple, and may not always DWIM
-# correctly, especially in the presence of
-# close subtype relationships, however it should
-# work for a fair percentage of the use cases
-sub coerce {
- my $self = shift;
- my $value = shift;
- foreach my $type (@{$self->type_constraints}) {
- if ($type->has_coercion) {
- my $temp = $type->coerce($value);
- return $temp if $self->check($temp);
+sub _compile_subtype {
+ my ($self, $check) = @_;
+
+ # gather all the parent constraintss in order
+ my @parents;
+ my $optimized_parent;
+ foreach my $parent ($self->_collect_all_parents) {
+ # if a parent is optimized, the optimized constraint already includes
+ # all of its parents tcs, so we can break the loop
+ if ($parent->has_hand_optimized_type_constraint) {
+ push @parents => $optimized_parent = $parent->hand_optimized_type_constraint;
+ last;
+ }
+ else {
+ push @parents => $parent->constraint;
}
}
- return undef;
-}
-sub _compiled_type_constraint {
- my $self = shift;
- return sub {
- my $value = shift;
- foreach my $type (@{$self->type_constraints}) {
- return 1 if $type->check($value);
+ @parents = grep { $_ != $null_constraint } reverse @parents;
+
+ unless ( @parents ) {
+ return $self->_compile_type($check);
+ } elsif( $optimized_parent and @parents == 1 ) {
+ # the case of just one optimized parent is optimized to prevent
+ # looping and the unnecessary localization
+ if ( $check == $null_constraint ) {
+ return $optimized_parent;
+ } else {
+ return Class::MOP::subname($self->name, sub {
+ return undef unless $optimized_parent->($_[0]);
+ my (@args) = @_;
+ local $_ = $args[0];
+ $check->(@args);
+ });
}
- return undef;
+ } else {
+ # general case, check all the constraints, from the first parent to ourselves
+ my @checks = @parents;
+ push @checks, $check if $check != $null_constraint;
+ return Class::MOP::subname($self->name => sub {
+ my (@args) = @_;
+ local $_ = $args[0];
+ foreach my $check (@checks) {
+ return undef unless $check->(@args);
+ }
+ return 1;
+ });
}
}
-sub check {
- my $self = shift;
- my $value = shift;
- $self->_compiled_type_constraint->($value);
-}
+sub _compile_type {
+ my ($self, $check) = @_;
-sub validate {
- my $self = shift;
- my $value = shift;
- my $message;
- foreach my $type (@{$self->type_constraints}) {
- my $err = $type->validate($value);
- return unless defined $err;
- $message .= ($message ? ' and ' : '') . $err
- if defined $err;
- }
- return ($message . ' in (' . $self->name . ')') ;
+ return $check if $check == $null_constraint; # Item, Any
+
+ return Class::MOP::subname($self->name => sub {
+ my (@args) = @_;
+ local $_ = $args[0];
+ $check->(@args);
+ });
}
-sub is_a_type_of {
- my ($self, $type_name) = @_;
- foreach my $type (@{$self->type_constraints}) {
- return 1 if $type->is_a_type_of($type_name);
+## other utils ...
+
+sub _collect_all_parents {
+ my $self = shift;
+ my @parents;
+ my $current = $self->parent;
+ while (defined $current) {
+ push @parents => $current;
+ $current = $current->parent;
}
- return 0;
+ return @parents;
}
-sub is_subtype_of {
- my ($self, $type_name) = @_;
- foreach my $type (@{$self->type_constraints}) {
- return 1 if $type->is_subtype_of($type_name);
- }
- return 0;
+sub create_child_type {
+ my ($self, %opts) = @_;
+ my $class = ref $self;
+ return $class->new(%opts, parent => $self);
}
+## this should get deprecated actually ...
+
+sub union { Carp::croak "DEPRECATED" }
+
1;
__END__
=head1 DESCRIPTION
-For the most part, the only time you will ever encounter an
-instance of this class is if you are doing some serious deep
-introspection. This API should not be considered final, but
-it is B<highly unlikely> that this will matter to a regular
-Moose user.
-
-If you wish to use features at this depth, please come to the
-#moose IRC channel on irc.perl.org and we can talk :)
+This class represents a single type constraint. Moose's built-in type
+constraints, as well as constraints you define, are all store in a
+L<Moose::Meta::TypeConstraint::Registry> object as objects of this
+class.
=head1 METHODS
=over 4
-=item B<meta>
+=item B<< Moose::Meta::TypeConstraint->new(%options) >>
-=item B<new>
+This creates a new type constraint based on the provided C<%options>:
-=item B<is_a_type_of ($type_name)>
+=over 8
-This checks the current type name, and if it does not match,
-checks if it is a subtype of it.
+=item * name
-=item B<is_subtype_of ($type_name)>
+The constraint name. If a name is not provided, it will be set to
+"__ANON__".
-=item B<compile_type_constraint>
+=item * parent
-=item B<coerce ($value)>
+A C<Moose::Meta::TypeConstraint> object which is the parent type for
+the type being created. This is optional.
-This will apply the type-coercion if applicable.
+=item * constraint
-=item B<check ($value)>
+This is the subroutine reference that implements the actual constraint
+check. This defaults to a subroutine which always returns true.
-This method will return a true (C<1>) if the C<$value> passes the
-constraint, and false (C<0>) otherwise.
+=item * message
-=item B<validate ($value)>
+A subroutine reference which is used to generate an error message when
+the constraint fails. This is optional.
-This method is similar to C<check>, but it deals with the error
-message. If the C<$value> passes the constraint, C<undef> will be
-returned. If the C<$value> does B<not> pass the constraint, then
-the C<message> will be used to construct a custom error message.
+=item * coercion
-=item B<name>
+A L<Moose::Meta::TypeCoercion> object representing the coercions to
+the type. This is optional.
-=item B<parent>
+=item * optimized
-=item B<constraint>
+This is a variant of the C<constraint> parameter that is somehow
+optimized. Typically, this means incorporating both the type's
+constraint and all of its parents' constraints into a single
+subroutine reference.
-=item B<has_message>
+=back
-=item B<message>
+=item B<< $constraint->equals($type_name_or_object) >>
-=item B<has_coercion>
+Returns true if the supplied name or type object is the same as the
+current type.
-=item B<coercion>
+=item B<< $constraint->is_subtype_of($type_name_or_object) >>
-=back
+Returns true if the supplied name or type object is a parent of the
+current type.
-=over 4
+=item B<< $constraint->is_a_type_of($type_name_or_object) >>
+
+Returns true if the given type is the same as the current type, or is
+a parent of the current type. This is a shortcut for checking
+C<equals> and C<is_subtype_of>.
+
+=item B<< $constraint->coerce($value) >>
+
+This will attempt to coerce the value to the type. If the type does
+have any defined coercions this will throw an error.
+
+=item B<< $constraint->check($value) >>
+
+Returns true if the given value passes the constraint for the type.
+
+=item B<< $constraint->validate($value) >>
+
+This is similar to C<check>. However, if the type I<is valid> then the
+method returns an explicit C<undef>. If the type is not valid, we call
+C<< $self->get_message($value) >> internally to generate an error
+message.
+
+=item B<< $constraint->name >>
+
+Returns the type's name, as provided to the constructor.
+
+=item B<< $constraint->parent >>
+
+Returns the type's parent, as provided to the constructor, if any.
+
+=item B<< $constraint->has_parent >>
+
+Returns true if the type has a parent type.
+
+=item B<< $constraint->parents >>
+
+A synonym for C<parent>. This is useful for polymorphism with types
+that can have more than one parent.
+
+=item B<< $constraint->constraint >>
+
+Returns the type's constraint, as provided to the constructor.
+
+=item B<< $constraint->get_message($value) >>
+
+This generates a method for the given value. If the type does not have
+an explicit message, we generate a default message.
+
+=item B<< $constraint->has_message >>
+
+Returns true if the type has a message.
+
+=item B<< $constraint->message >>
+
+Returns the type's message as a subroutine reference.
+
+=item B<< $constraint->coercion >>
+
+Returns the type's L<Moose::Meta::TypeCoercion> object, if one
+exists.
+
+=item B<< $constraint->has_coercion >>
+
+Returns true if the type has a coercion.
+
+=item B<< $constraint->hand_optimized_type_constraint >>
+
+Returns the type's hand optimized constraint, as provided to the
+constructor via the C<optimized> option.
+
+=item B<< $constraint->has_hand_optimized_type_constraint >>
+
+Returns true if the type has an optimized constraint.
+
+=item B<< $constraint->create_child_type(%options) >>
+
+This returns a new type constraint of the same class using the
+provided C<%options>. The C<parent> option will be the current type.
-=item B<union (@type_constraints)>
+This method exists so that subclasses of this class can override this
+behavior and change how child types are created.
=back
=head1 BUGS
-All complex software has bugs lurking in it, and this module is no
+All complex software has bugs lurking in it, and this module is no
exception. If you find a bug please either email me, or add the bug
to cpan-RT.
=head1 COPYRIGHT AND LICENSE
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+it under the same terms as Perl itself.
-=cut
\ No newline at end of file
+=cut
projects / gitmo/Moose.git / blobdiff