X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FAttribute.pm;h=627776965677b8551e60e8cbca39e91f8ba6e2a8;hb=aa7bbf26111ba4ed260458857f0a9cf007511bd4;hp=0fbc6af8d6fffa2c9573c44564e233bb5287d19e;hpb=173709cae51daa679e967f5d31f32645d17dc5fd;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Attribute.pm b/lib/Moose/Meta/Attribute.pm index 0fbc6af..6277769 100644 --- a/lib/Moose/Meta/Attribute.pm +++ b/lib/Moose/Meta/Attribute.pm @@ -5,13 +5,13 @@ use strict; use warnings; use Scalar::Util 'blessed', 'weaken'; -use Carp 'confess'; use overload (); -our $VERSION = '0.52'; +our $VERSION = '0.66'; our $AUTHORITY = 'cpan:STEVAN'; use Moose::Meta::Method::Accessor; +use Moose::Meta::Method::Delegation; use Moose::Util (); use Moose::Util::TypeConstraints (); @@ -61,7 +61,17 @@ sub does { Moose::Util::resolve_metatrait_alias(Attribute => $role_name) }; return 0 if !defined($name); # failed to load class - return Moose::Object::does($self, $name); + return $self->Moose::Object::does($name); +} + +sub throw_error { + my $self = shift; + my $class = ( ref $self && $self->associated_class ) || "Moose::Meta::Class"; + unshift @_, "message" if @_ % 2 == 1; + unshift @_, attr => $self if ref $self; + unshift @_, $class; + my $handler = $class->can("throw_error"); # to avoid incrementing depth by 1 + goto $handler; } sub new { @@ -98,11 +108,24 @@ sub interpolate_class { my @traits; if (my $traits = $options{traits}) { - if ( @traits = grep { not $class->does($_) } map { - Moose::Util::resolve_metatrait_alias( Attribute => $_ ) - or - $_ - } @$traits ) { + my $i = 0; + while ($i < @$traits) { + my $trait = $traits->[$i++]; + next if ref($trait); # options to a trait we discarded + + $trait = Moose::Util::resolve_metatrait_alias(Attribute => $trait) + || $trait; + + next if $class->does($trait); + + push @traits, $trait; + + # are there options? + push @traits, $traits->[$i++] + if $traits->[$i] && ref($traits->[$i]); + } + + if (@traits) { my $anon_class = Moose::Meta::Class->create_anon_class( superclasses => [ $class ], roles => [ @traits ], @@ -116,17 +139,55 @@ sub interpolate_class { return ( wantarray ? ( $class, @traits ) : $class ); } +# ... + +my @legal_options_for_inheritance = qw( + default coerce required + documentation lazy handles + builder type_constraint + definition_context +); + +sub legal_options_for_inheritance { @legal_options_for_inheritance } + +# NOTE/TODO +# This method *must* be able to handle +# Class::MOP::Attribute instances as +# well. Yes, I know that is wrong, but +# apparently we didn't realize it was +# doing that and now we have some code +# which is dependent on it. The real +# solution of course is to push this +# feature back up into Class::MOP::Attribute +# but I not right now, I am too lazy. +# However if you are reading this and +# looking for something to do,.. please +# be my guest. +# - stevan sub clone_and_inherit_options { my ($self, %options) = @_; + my %copy = %options; - # you can change default, required, coerce, documentation, lazy, handles, builder, type_constraint (explicitly or using isa/does), metaclass and traits + my %actual_options; - foreach my $legal_option (qw(default coerce required documentation lazy handles builder type_constraint)) { + + # NOTE: + # we may want to extends a Class::MOP::Attribute + # in which case we need to be able to use the + # core set of legal options that have always + # been here. But we allows Moose::Meta::Attribute + # instances to changes them. + # - SL + my @legal_options = $self->can('legal_options_for_inheritance') + ? $self->legal_options_for_inheritance + : @legal_options_for_inheritance; + + foreach my $legal_option (@legal_options) { if (exists $options{$legal_option}) { $actual_options{$legal_option} = $options{$legal_option}; delete $options{$legal_option}; } - } + } if ($options{isa}) { my $type_constraint; @@ -136,7 +197,7 @@ sub clone_and_inherit_options { else { $type_constraint = Moose::Util::TypeConstraints::find_or_create_isa_type_constraint($options{isa}); (defined $type_constraint) - || confess "Could not find the type constraint '" . $options{isa} . "'"; + || $self->throw_error("Could not find the type constraint '" . $options{isa} . "'", data => $options{isa}); } $actual_options{type_constraint} = $type_constraint; @@ -151,7 +212,7 @@ sub clone_and_inherit_options { else { $type_constraint = Moose::Util::TypeConstraints::find_or_create_does_type_constraint($options{does}); (defined $type_constraint) - || confess "Could not find the type constraint '" . $options{does} . "'"; + || $self->throw_error("Could not find the type constraint '" . $options{does} . "'", data => $options{does}); } $actual_options{type_constraint} = $type_constraint; @@ -173,7 +234,7 @@ sub clone_and_inherit_options { } (scalar keys %options == 0) - || confess "Illegal inherited options => (" . (join ', ' => keys %options) . ")"; + || $self->throw_error("Illegal inherited options => (" . (join ', ' => keys %options) . ")", data => \%options); $self->clone(%actual_options); @@ -221,7 +282,7 @@ sub _process_options { ### ------------------------- if ($options->{is} eq 'ro') { - confess "Cannot define an accessor name on a read-only attribute, accessors are read/write" + $class->throw_error("Cannot define an accessor name on a read-only attribute, accessors are read/write", data => $options) if exists $options->{accessor}; $options->{reader} ||= $name; } @@ -234,7 +295,7 @@ sub _process_options { } } else { - confess "I do not understand this option (is => " . $options->{is} . ") on attribute ($name)" + $class->throw_error("I do not understand this option (is => " . $options->{is} . ") on attribute ($name)", data => $options->{is}); } } @@ -242,10 +303,10 @@ sub _process_options { if (exists $options->{does}) { if (eval { $options->{isa}->can('does') }) { ($options->{isa}->does($options->{does})) - || confess "Cannot have an isa option and a does option if the isa does not do the does on attribute ($name)"; + || $class->throw_error("Cannot have an isa option and a does option if the isa does not do the does on attribute ($name)", data => $options); } else { - confess "Cannot have an isa option which cannot ->does() on attribute ($name)"; + $class->throw_error("Cannot have an isa option which cannot ->does() on attribute ($name)", data => $options); } } @@ -269,26 +330,26 @@ sub _process_options { if (exists $options->{coerce} && $options->{coerce}) { (exists $options->{type_constraint}) - || confess "You cannot have coercion without specifying a type constraint on attribute ($name)"; - confess "You cannot have a weak reference to a coerced value on attribute ($name)" + || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)", data => $options); + $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)", data => $options) if $options->{weak_ref}; } if (exists $options->{trigger}) { ('CODE' eq ref $options->{trigger}) - || confess "Trigger must be a CODE ref on attribute ($name)"; + || $class->throw_error("Trigger must be a CODE ref on attribute ($name)", data => $options->{trigger}); } if (exists $options->{auto_deref} && $options->{auto_deref}) { (exists $options->{type_constraint}) - || confess "You cannot auto-dereference without specifying a type constraint on attribute ($name)"; + || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)", data => $options); ($options->{type_constraint}->is_a_type_of('ArrayRef') || $options->{type_constraint}->is_a_type_of('HashRef')) - || confess "You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)"; + || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)", data => $options); } if (exists $options->{lazy_build} && $options->{lazy_build} == 1) { - confess("You can not use lazy_build and default for the same attribute ($name)") + $class->throw_error("You can not use lazy_build and default for the same attribute ($name)", data => $options) if exists $options->{default}; $options->{lazy} = 1; $options->{required} = 1; @@ -305,11 +366,11 @@ sub _process_options { if (exists $options->{lazy} && $options->{lazy}) { (exists $options->{default} || defined $options->{builder} ) - || confess "You cannot have lazy attribute ($name) without specifying a default value for it"; + || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it", data => $options); } if ( $options->{required} && !( ( !exists $options->{init_arg} || defined $options->{init_arg} ) || exists $options->{default} || defined $options->{builder} ) ) { - confess "You cannot have a required attribute ($name) without a default, builder, or an init_arg"; + $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg", data => $options); } } @@ -329,7 +390,7 @@ sub initialize_instance_slot { # skip it if it's lazy return if $self->is_lazy; # and die if it's required and doesn't have a default value - confess "Attribute (" . $self->name . ") is required" + $self->throw_error("Attribute (" . $self->name . ") is required", object => $instance, data => $params) if $self->is_required && !$self->has_default && !$self->has_builder; # if nothing was in the %params, we can use the @@ -339,13 +400,8 @@ sub initialize_instance_slot { $value_is_set = 1; } elsif ($self->has_builder) { - if (my $builder = $instance->can($self->builder)){ - $val = $instance->$builder; - $value_is_set = 1; - } - else { - confess(blessed($instance)." does not support builder method '".$self->builder."' for attribute '" . $self->name . "'"); - } + $val = $self->_call_builder($instance); + $value_is_set = 1; } } @@ -356,11 +412,7 @@ sub initialize_instance_slot { if ($self->should_coerce && $type_constraint->has_coercion) { $val = $type_constraint->coerce($val); } - $type_constraint->check($val) - || confess "Attribute (" - . $self->name - . ") does not pass the type constraint because: " - . $type_constraint->get_message($val); + $self->verify_against_type_constraint($val, instance => $instance); } $self->set_initial_value($instance, $val); @@ -368,6 +420,24 @@ sub initialize_instance_slot { if ref $val && $self->is_weak_ref; } +sub _call_builder { + my ( $self, $instance ) = @_; + + my $builder = $self->builder(); + + return $instance->$builder() + if $instance->can( $self->builder ); + + $self->throw_error( blessed($instance) + . " does not support builder method '" + . $self->builder + . "' for attribute '" + . $self->name + . "'", + object => $instance, + ); +} + ## Slot management # FIXME: @@ -394,11 +464,7 @@ sub _set_initial_slot_value { if ($type_constraint) { $val = $type_constraint->coerce($val) if $can_coerce; - $type_constraint->check($val) - || confess "Attribute (" - . $slot_name - . ") does not pass the type constraint because: " - . $type_constraint->get_message($val); + $self->verify_against_type_constraint($val, object => $instance); } $meta_instance->set_slot_value($instance, $slot_name, $val); }; @@ -416,7 +482,7 @@ sub set_value { my $attr_name = $self->name; if ($self->is_required and not @args) { - confess "Attribute ($attr_name) is required"; + $self->throw_error("Attribute ($attr_name) is required", object => $instance); } if ($self->has_type_constraint) { @@ -427,10 +493,10 @@ sub set_value { $value = $type_constraint->coerce($value); } $type_constraint->_compiled_type_constraint->($value) - || confess "Attribute (" + || $self->throw_error("Attribute (" . $self->name . ") does not pass the type constraint because " - . $type_constraint->get_message($value); + . $type_constraint->get_message($value), object => $instance, data => $value); } my $meta_instance = Class::MOP::Class->initialize(blessed($instance)) @@ -452,25 +518,19 @@ sub get_value { if ($self->is_lazy) { unless ($self->has_value($instance)) { + my $value; if ($self->has_default) { - my $default = $self->default($instance); - $self->set_initial_value($instance, $default); + $value = $self->default($instance); } elsif ( $self->has_builder ) { - if (my $builder = $instance->can($self->builder)){ - $self->set_initial_value($instance, $instance->$builder); - } - else { - confess(blessed($instance) - . " does not support builder method '" - . $self->builder - . "' for attribute '" - . $self->name - . "'"); - } - } - else { - $self->set_initial_value($instance, undef); + $value = $self->_call_builder($instance); + } + if ($self->has_type_constraint) { + my $type_constraint = $self->type_constraint; + $value = $type_constraint->coerce($value) + if ($self->should_coerce); + $self->verify_against_type_constraint($value); } + $self->set_initial_value($instance, $value); } } @@ -489,7 +549,7 @@ sub get_value { return wantarray ? %{ $rv } : $rv; } else { - confess "Can not auto de-reference the type constraint '" . $type_constraint->name . "'"; + $self->throw_error("Can not auto de-reference the type constraint '" . $type_constraint->name . "'", object => $instance, type_constraint => $type_constraint); } } @@ -510,6 +570,13 @@ sub install_accessors { return; } +sub remove_accessors { + my $self = shift; + $self->SUPER::remove_accessors(@_); + $self->remove_delegation if $self->has_handles; + return; +} + sub install_delegation { my $self = shift; @@ -518,12 +585,8 @@ sub install_delegation { # this will sort out any details and always # return an hash of methods which we want # to delagate to, see that method for details - my %handles = $self->_canonicalize_handles(); + my %handles = $self->_canonicalize_handles; - # find the accessor method for this attribute - my $accessor = $self->get_read_method_ref; - # then unpack it if we need too ... - $accessor = $accessor->body if blessed $accessor; # install the delegation ... my $associated_class = $self->associated_class; @@ -532,8 +595,8 @@ sub install_delegation { my $class_name = $associated_class->name; my $name = "${class_name}::${handle}"; - (!$associated_class->has_method($handle)) - || confess "You cannot overwrite a locally defined method ($handle) with a delegation"; + (!$associated_class->has_method($handle)) + || $self->throw_error("You cannot overwrite a locally defined method ($handle) with a delegation", method_name => $handle); # NOTE: # handles is not allowed to delegate @@ -545,31 +608,21 @@ sub install_delegation { #cluck("Not delegating method '$handle' because it is a core method") and next if $class_name->isa("Moose::Object") and $handle =~ /^BUILD|DEMOLISH$/ || Moose::Object->can($handle); - if ('CODE' eq ref($method_to_call)) { - $associated_class->add_method($handle => Class::MOP::subname($name, $method_to_call)); - } - else { - # NOTE: - # we used to do a goto here, but the - # goto didn't handle failure correctly - # (it just returned nothing), so I took - # that out. However, the more I thought - # about it, the less I liked it doing - # the goto, and I prefered the act of - # delegation being actually represented - # in the stack trace. - # - SL - $associated_class->add_method($handle => Class::MOP::subname($name, sub { - my $proxy = (shift)->$accessor(); - (defined $proxy) - || confess "Cannot delegate $handle to $method_to_call because " . - "the value of " . $self->name . " is not defined"; - $proxy->$method_to_call(@_); - })); - } + my $method = $self->_make_delegation_method($handle, $method_to_call); + + $self->associated_class->add_method($method->name, $method); } } +sub remove_delegation { + my $self = shift; + my %handles = $self->_canonicalize_handles; + my $associated_class = $self->associated_class; + foreach my $handle (keys %handles) { + $self->associated_class->remove_method($handle); + } +} + # private methods to help delegation ... sub _canonicalize_handles { @@ -584,7 +637,7 @@ sub _canonicalize_handles { } elsif ($handle_type eq 'Regexp') { ($self->has_type_constraint) - || confess "Cannot delegate methods based on a RegExpr without a type constraint (isa)"; + || $self->throw_error("Cannot delegate methods based on a Regexp without a type constraint (isa)", data => $handles); return map { ($_ => $_) } grep { /$handles/ } $self->_get_delegate_method_list; } @@ -592,18 +645,21 @@ sub _canonicalize_handles { return $handles->($self, $self->_find_delegate_metaclass); } else { - confess "Unable to canonicalize the 'handles' option with $handles"; + $self->throw_error("Unable to canonicalize the 'handles' option with $handles", data => $handles); } } else { + Class::MOP::load_class($handles) + unless Class::MOP::is_class_loaded($handles); + my $role_meta = eval { $handles->meta }; if ($@) { - confess "Unable to canonicalize the 'handles' option with $handles because : $@"; + $self->throw_error("Unable to canonicalize the 'handles' option with $handles because : $@", data => $handles, error => $@); } (blessed $role_meta && $role_meta->isa('Moose::Meta::Role')) - || confess "Unable to canonicalize the 'handles' option with $handles because ->meta is not a Moose::Meta::Role"; - + || $self->throw_error("Unable to canonicalize the 'handles' option with $handles because ->meta is not a Moose::Meta::Role", data => $handles); + return map { $_ => $_ } ( $role_meta->get_method_list, $role_meta->get_required_method_list @@ -629,7 +685,7 @@ sub _find_delegate_metaclass { return $role->meta; } else { - confess "Cannot find delegate metaclass for attribute " . $self->name; + $self->throw_error("Cannot find delegate metaclass for attribute " . $self->name); } } @@ -637,18 +693,51 @@ sub _get_delegate_method_list { my $self = shift; my $meta = $self->_find_delegate_metaclass; if ($meta->isa('Class::MOP::Class')) { - return map { $_->{name} } # NOTE: !never! delegate &meta - grep { $_->{class} ne 'Moose::Object' && $_->{name} ne 'meta' } - $meta->compute_all_applicable_methods; + return map { $_->name } # NOTE: !never! delegate &meta + grep { $_->package_name ne 'Moose::Object' && $_->name ne 'meta' } + $meta->get_all_methods; } elsif ($meta->isa('Moose::Meta::Role')) { return $meta->get_method_list; } else { - confess "Unable to recognize the delegate metaclass '$meta'"; + $self->throw_error("Unable to recognize the delegate metaclass '$meta'", data => $meta); } } +sub delegation_metaclass { 'Moose::Meta::Method::Delegation' } + +sub _make_delegation_method { + my ( $self, $handle_name, $method_to_call ) = @_; + + my $method_body; + + $method_body = $method_to_call + if 'CODE' eq ref($method_to_call); + + return $self->delegation_metaclass->new( + name => $handle_name, + package_name => $self->associated_class->name, + attribute => $self, + delegate_to_method => $method_to_call, + ); +} + +sub verify_against_type_constraint { + my $self = shift; + my $val = shift; + + return 1 if !$self->has_type_constraint; + + my $type_constraint = $self->type_constraint; + + $type_constraint->check($val) + || $self->throw_error("Attribute (" + . $self->name + . ") does not pass the type constraint because: " + . $type_constraint->get_message($val), data => $val, @_); +} + package Moose::Meta::Attribute::Custom::Moose; sub register_implementation { 'Moose::Meta::Attribute' } @@ -692,10 +781,16 @@ will behave just as L does. =item B +=item B + =item B +=item B + =item B +=item B + =item B =item B @@ -709,14 +804,14 @@ I Before setting the value, a check is made on the type constraint of the attribute, if it has one, to see if the value passes it. If the -value fails to pass, the set operation dies with a L. +value fails to pass, the set operation dies with a L. Any coercion to convert values is done before checking the type constraint. To check a value against a type constraint before setting it, fetch the attribute instance using L, fetch the type_constraint from the attribute using L -and call L. See L +and call L. See L for an example. =back @@ -728,6 +823,10 @@ creation and type coercion. =over 4 +=item B + +Delegates to C or C if there is none. + =item B =item B @@ -741,6 +840,11 @@ This is to support the C feature, it clones an attribute from a superclass and allows a very specific set of changes to be made to the attribute. +=item B + +Whitelist with options you can change. You can overload it in your custom +metaclass to allow your options be inheritable. + =item B Returns true if this meta-attribute has a type constraint. @@ -751,6 +855,11 @@ A read-only accessor for this meta-attribute's type constraint. For more information on what you can do with this, see the documentation for L. +=item B + +Verifies that the given value is valid under this attribute's type +constraint, otherwise throws an error. + =item B Returns true if this meta-attribute performs delegation. @@ -783,14 +892,14 @@ and predicate options for you using the following convention. #If your attribute name starts with an underscore: has '_foo' => (lazy_build => 1); #is the same as - has '_foo' => (lazy => 1, required => 1, predicate => '_has_foo', clearer => '_clear_foo', builder => '_build__foo); + has '_foo' => (lazy => 1, required => 1, predicate => '_has_foo', clearer => '_clear_foo', builder => '_build__foo'); # or has '_foo' => (lazy => 1, required => 1, predicate => '_has_foo', clearer => '_clear_foo', default => sub{shift->_build__foo}); #If your attribute name does not start with an underscore: has 'foo' => (lazy_build => 1); #is the same as - has 'foo' => (lazy => 1, required => 1, predicate => 'has_foo', clearer => 'clear_foo', builder => '_build_foo); + has 'foo' => (lazy => 1, required => 1, predicate => 'has_foo', clearer => 'clear_foo', builder => '_build_foo'); # or has 'foo' => (lazy => 1, required => 1, predicate => 'has_foo', clearer => 'clear_foo', default => sub{shift->_build_foo}); @@ -859,7 +968,7 @@ Yuval Kogman Enothingmuch@woobling.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L