X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FAttribute.pm;h=3e4bf749fc88f1a5fc6795b3f689883bfe831fdb;hb=9fa3924018dc60275270bca32a5f1357d61167e0;hp=a4b6a10b3f6fc9dfd4ed6fef4d3153a92351ffff;hpb=23cb3f2168d1a06a17da178379d0da9e445861d3;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Attribute.pm b/lib/Moose/Meta/Attribute.pm index a4b6a10..3e4bf74 100644 --- a/lib/Moose/Meta/Attribute.pm +++ b/lib/Moose/Meta/Attribute.pm @@ -7,10 +7,11 @@ use warnings; use Scalar::Util 'blessed', 'weaken'; use overload (); -our $VERSION = '0.50'; +our $VERSION = '0.60'; our $AUTHORITY = 'cpan:STEVAN'; use Moose::Meta::Method::Accessor; +use Moose::Meta::Method::Delegation; use Moose::Util (); use Moose::Util::TypeConstraints (); @@ -60,7 +61,7 @@ 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 { @@ -69,7 +70,8 @@ sub throw_error { unshift @_, "message" if @_ % 2 == 1; unshift @_, attr => $self if ref $self; unshift @_, $class; - goto $class->can("throw_error"); # to avoid incrementing depth by 1 + my $handler = $class->can("throw_error"); # to avoid incrementing depth by 1 + goto $handler; } sub new { @@ -124,17 +126,54 @@ sub interpolate_class { return ( wantarray ? ( $class, @traits ) : $class ); } +# ... + +my @legal_options_for_inheritance = qw( + default coerce required + documentation lazy handles + builder type_constraint +); + +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; @@ -242,7 +281,7 @@ sub _process_options { } } else { - $class->throw_error("I do not understand this option (is => " . $options->{is} . ") on attribute $name", data => $options->{is}); + $class->throw_error("I do not understand this option (is => " . $options->{is} . ") on attribute ($name)", data => $options->{is}); } } @@ -250,10 +289,10 @@ sub _process_options { if (exists $options->{does}) { if (eval { $options->{isa}->can('does') }) { ($options->{isa}->does($options->{does})) - || $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); + || $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 { - $class->throw_error("Cannot have an isa option which cannot ->does() on attribute $name", data => $options); + $class->throw_error("Cannot have an isa option which cannot ->does() on attribute ($name)", data => $options); } } @@ -277,26 +316,26 @@ sub _process_options { if (exists $options->{coerce} && $options->{coerce}) { (exists $options->{type_constraint}) - || $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) + || $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}) - || $class->throw_error("Trigger must be a CODE ref", data => $options->{trigger}); + || $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}) - || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute $name", data => $options); + || $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')) - || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute $name", data => $options); + || $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) { - $class->throw_error("You can not use lazy_build and default for the same attribute $name", data => $options) + $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; @@ -347,13 +386,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 { - $self->throw_error(blessed($instance)." does not support builder method '".$self->builder."' for attribute '" . $self->name . "'", object => $instance, data => $params); - } + $val = $self->_call_builder($instance); + $value_is_set = 1; } } @@ -376,6 +410,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: @@ -460,25 +512,22 @@ 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 { - $self->throw_error(blessed($instance) - . " does not support builder method '" - . $self->builder - . "' for attribute '" - . $self->name - . "'", object => $instance); - } - } - 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); + $type_constraint->check($value) + || $self->throw_error("Attribute (" . $self->name + . ") does not pass the type constraint because: " + . $type_constraint->get_message($value), type_constraint => $type_constraint, data => $value); } + $self->set_initial_value($instance, $value); } } @@ -497,7 +546,7 @@ sub get_value { return wantarray ? %{ $rv } : $rv; } else { - $self->throw_error("Can not auto de-reference the type constraint '" . $type_constraint->name . "'", object => $instance, data => $type_constraint); + $self->throw_error("Can not auto de-reference the type constraint '" . $type_constraint->name . "'", object => $instance, type_constraint => $type_constraint); } } @@ -514,68 +563,45 @@ sub accessor_metaclass { 'Moose::Meta::Method::Accessor' } sub install_accessors { my $self = shift; $self->SUPER::install_accessors(@_); + $self->install_delegation if $self->has_handles; + return; +} + +sub install_delegation { + my $self = shift; - if ($self->has_handles) { + # NOTE: + # Here we canonicalize the 'handles' option + # 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; - # NOTE: - # Here we canonicalize the 'handles' option - # 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(); - - # 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; - foreach my $handle (keys %handles) { - my $method_to_call = $handles{$handle}; - my $class_name = $associated_class->name; - my $name = "${class_name}::${handle}"; + + # install the delegation ... + my $associated_class = $self->associated_class; + foreach my $handle (keys %handles) { + my $method_to_call = $handles{$handle}; + my $class_name = $associated_class->name; + my $name = "${class_name}::${handle}"; (!$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 - # any of these methods, as they will - # override the ones in your class, which - # is almost certainly not what you want. + # NOTE: + # handles is not allowed to delegate + # any of these methods, as they will + # override the ones in your class, which + # is almost certainly not what you want. - # FIXME warn when $handle was explicitly specified, but not if the source is a regex or something - #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); + # FIXME warn when $handle was explicitly specified, but not if the source is a regex or something + #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 $instance = shift; - my $proxy = $instance->$accessor(); - (defined $proxy) - || $self->throw_error("Cannot delegate $handle to $method_to_call because " . - "the value of " . $self->name . " is not defined", method_name => $method_to_call, object => $instance); - $proxy->$method_to_call(@_); - })); - } - } - } + my $method = $self->_make_delegation_method($handle, $method_to_call); - return; + $self->associated_class->add_method($method->name, $method); + } } # private methods to help delegation ... @@ -604,6 +630,9 @@ sub _canonicalize_handles { } } else { + Class::MOP::load_class($handles) + unless Class::MOP::is_class_loaded($handles); + my $role_meta = eval { $handles->meta }; if ($@) { $self->throw_error("Unable to canonicalize the 'handles' option with $handles because : $@", data => $handles, error => $@); @@ -611,7 +640,7 @@ sub _canonicalize_handles { (blessed $role_meta && $role_meta->isa('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 @@ -645,9 +674,9 @@ 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; @@ -657,6 +686,22 @@ sub _get_delegate_method_list { } } +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 Moose::Meta::Method::Delegation->new( + name => $handle_name, + package_name => $self->associated_class->name, + attribute => $self, + delegate_to_method => $method_to_call, + ); +} + package Moose::Meta::Attribute::Custom::Moose; sub register_implementation { 'Moose::Meta::Attribute' } @@ -700,6 +745,8 @@ will behave just as L does. =item B +=item B + =item B =item B @@ -715,14 +762,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 @@ -751,6 +798,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. @@ -793,14 +845,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});