X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FMeta%2FAttribute.pm;h=b4511d0a6d9f1166e3aca3fe53e349914fbc6e62;hp=415ad53bed1784699852b25934b6629309fda03d;hb=21ee5bbbc20a3366955be77a589206295b5c0f9e;hpb=ce5920b75da54ce1977fc44cd89b400175b6d034 diff --git a/lib/Mouse/Meta/Attribute.pm b/lib/Mouse/Meta/Attribute.pm index 415ad53..b4511d0 100644 --- a/lib/Mouse/Meta/Attribute.pm +++ b/lib/Mouse/Meta/Attribute.pm @@ -4,200 +4,94 @@ use Mouse::Util qw(:meta); # enables strict and warnings use Carp (); use Mouse::Meta::TypeConstraint; -use Mouse::Meta::Method::Accessor; +my %valid_options = map { $_ => undef } ( + 'accessor', + 'auto_deref', + 'builder', + 'clearer', + 'coerce', + 'default', + 'documentation', + 'does', + 'handles', + 'init_arg', + 'is', + 'isa', + 'lazy', + 'lazy_build', + 'name', + 'predicate', + 'reader', + 'required', + 'traits', + 'trigger', + 'type_constraint', + 'weak_ref', + 'writer', + + # internally used + 'associated_class', + 'associated_methods', + + # Moose defines, but Mouse doesn't + #'definition_context', + #'initializer', + #'insertion_order', + + # special case for AttributeHelpers + 'provides', + 'curries', +); -sub _process_options{ - my($class, $name, $args) = @_; +sub new { + my $class = shift; + my $name = shift; + my $args = $class->Mouse::Object::BUILDARGS(@_); # XXX: for backward compatibility (with method modifiers) if($class->can('canonicalize_args') != \&canonicalize_args){ %{$args} = $class->canonicalize_args($name, %{$args}); } - # taken from Class::MOP::Attribute::new - - defined($name) - or $class->throw_error('You must provide a name for the attribute'); - - if(!exists $args->{init_arg}){ - $args->{init_arg} = $name; - } - - # 'required' requires eigher 'init_arg', 'builder', or 'default' - my $can_be_required = defined( $args->{init_arg} ); - - if(exists $args->{builder}){ - # XXX: - # Moose refuses a CODE ref builder, but Mouse doesn't for backward compatibility - # This feature will be changed in a future. (gfx) - $class->throw_error('builder must be a defined scalar value which is a method name') - #if ref $args->{builder} || !defined $args->{builder}; - if !defined $args->{builder}; - - $can_be_required++; - } - elsif(exists $args->{default}){ - if(ref $args->{default} && ref($args->{default}) ne 'CODE'){ - $class->throw_error("References are not allowed as default values, you must " - . "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])"); - } - $can_be_required++; - } - - if( $args->{required} && !$can_be_required ) { - $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg"); - } - - # taken from Mouse::Meta::Attribute->new and _process_args-> - - if(exists $args->{is}){ - my $is = $args->{is}; - - if($is eq 'ro'){ - $args->{reader} ||= $name; - } - elsif($is eq 'rw'){ - if(exists $args->{writer}){ - $args->{reader} ||= $name; - } - else{ - $args->{accessor} ||= $name; - } - } - elsif($is eq 'bare'){ - # do nothing, but don't complain (later) about missing methods - } - else{ - $is = 'undef' if !defined $is; - $class->throw_error("I do not understand this option (is => $is) on attribute ($name)"); - } - } - - my $tc; - if(exists $args->{isa}){ - $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa}); - } - elsif(exists $args->{does}){ - $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does}); - } - $tc = $args->{type_constraint}; - - if($args->{coerce}){ - defined($tc) - || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)"); - - $args->{weak_ref} - && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)"); - } - - if ($args->{lazy_build}) { - exists($args->{default}) - && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)"); - - $args->{lazy} = 1; - $args->{builder} ||= "_build_${name}"; - if ($name =~ /^_/) { - $args->{clearer} ||= "_clear${name}"; - $args->{predicate} ||= "_has${name}"; - } - else { - $args->{clearer} ||= "clear_${name}"; - $args->{predicate} ||= "has_${name}"; - } - } + $class->_process_options($name, $args); - if ($args->{auto_deref}) { - defined($tc) - || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)"); + $args->{name} = $name; - ( $tc->is_a_type_of('ArrayRef') || $tc->is_a_type_of('HashRef') ) - || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)"); - } + # check options + # (1) known by core + my @bad = grep{ !exists $valid_options{$_} } keys %{$args}; - if (exists $args->{trigger}) { - ('CODE' eq ref $args->{trigger}) - || $class->throw_error("Trigger must be a CODE ref on attribute ($name)"); + # (2) known by subclasses + if(@bad && $class ne __PACKAGE__){ + my %valid_attrs = ( + map { $_ => undef } + grep { defined } + map { $_->init_arg() } + $class->meta->get_all_attributes() + ); + @bad = grep{ !exists $valid_attrs{$_} } @bad; } - if ($args->{lazy}) { - (exists $args->{default} || defined $args->{builder}) - || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it"); + # (3) bad options found + if(@bad){ + @bad = sort @bad; + Carp::cluck("Found unknown argument(s) passed to '$name' attribute constructor in '$class': @bad"); } - return; -} - -sub new { - my $class = shift; - my $name = shift; - - my %args = (@_ == 1) ? %{ $_[0] } : @_; - - $class->_process_options($name, \%args); - - $args{name} = $name; - - my $self = bless \%args, $class; + my $self = bless $args, $class; # extra attributes if($class ne __PACKAGE__){ - $class->meta->_initialize_object($self, \%args); + $class->meta->_initialize_object($self, $args); } -# XXX: there is no fast way to check attribute validity -# my @bad = ...; -# if(@bad){ -# @bad = sort @bad; -# Carp::cluck("Found unknown argument(s) passed to '$name' attribute constructor in '$class': @bad"); -# } - return $self; } -# readers - -sub name { $_[0]->{name} } -sub associated_class { $_[0]->{associated_class} } - -sub accessor { $_[0]->{accessor} } -sub reader { $_[0]->{reader} } -sub writer { $_[0]->{writer} } -sub predicate { $_[0]->{predicate} } -sub clearer { $_[0]->{clearer} } -sub handles { $_[0]->{handles} } - -sub _is_metadata { $_[0]->{is} } -sub is_required { $_[0]->{required} } -sub default { $_[0]->{default} } -sub is_lazy { $_[0]->{lazy} } -sub is_lazy_build { $_[0]->{lazy_build} } -sub is_weak_ref { $_[0]->{weak_ref} } -sub init_arg { $_[0]->{init_arg} } -sub type_constraint { $_[0]->{type_constraint} } - -sub trigger { $_[0]->{trigger} } -sub builder { $_[0]->{builder} } -sub should_auto_deref { $_[0]->{auto_deref} } -sub should_coerce { $_[0]->{coerce} } - -# predicates - -sub has_accessor { exists $_[0]->{accessor} } -sub has_reader { exists $_[0]->{reader} } -sub has_writer { exists $_[0]->{writer} } -sub has_predicate { exists $_[0]->{predicate} } -sub has_clearer { exists $_[0]->{clearer} } -sub has_handles { exists $_[0]->{handles} } - -sub has_default { exists $_[0]->{default} } -sub has_type_constraint { exists $_[0]->{type_constraint} } -sub has_trigger { exists $_[0]->{trigger} } -sub has_builder { exists $_[0]->{builder} } - -sub has_read_method { exists $_[0]->{reader} || exists $_[0]->{accessor} } -sub has_write_method { exists $_[0]->{writer} || exists $_[0]->{accessor} } +sub has_read_method { $_[0]->has_reader || $_[0]->has_accessor } +sub has_write_method { $_[0]->has_writer || $_[0]->has_accessor } sub _create_args { # DEPRECATED $_[0]->{_create_args} = $_[1] if @_ > 1; @@ -242,8 +136,7 @@ sub canonicalize_args{ # DEPRECATED my ($self, $name, %args) = @_; Carp::cluck("$self->canonicalize_args has been deprecated." - . "Use \$self->_process_options instead.") - if _MOUSE_VERBOSE; + . "Use \$self->_process_options instead."); return %args; } @@ -252,8 +145,7 @@ sub create { # DEPRECATED my ($self, $class, $name, %args) = @_; Carp::cluck("$self->create has been deprecated." - . "Use \$meta->add_attribute and \$attr->install_accessors instead.") - if _MOUSE_VERBOSE; + . "Use \$meta->add_attribute and \$attr->install_accessors instead."); # noop return $self; @@ -281,31 +173,41 @@ sub verify_against_type_constraint { return 1 if !$type_constraint; return 1 if $type_constraint->check($value); - $self->verify_type_constraint_error($self->name, $value, $type_constraint); + $self->_throw_type_constraint_error($value, $type_constraint); } -sub verify_type_constraint_error { - my($self, $name, $value, $type) = @_; - $self->throw_error("Attribute ($name) does not pass the type constraint because: " - . $type->get_message($value)); -} - -sub coerce_constraint { # DEPRECATED - my $type = $_[0]->{type_constraint} - or return $_[1]; +sub _throw_type_constraint_error { + my($self, $value, $type) = @_; - Carp::cluck("coerce_constraint() has been deprecated, which was an internal utility anyway"); - - return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $type, $_[1]); + $self->throw_error( + sprintf q{Attribute (%s) does not pass the type constraint because: %s}, + $self->name, + $type->get_message($value), + ); } sub clone_and_inherit_options{ - my($self, %args) = @_; + my $self = shift; + my $args = $self->Mouse::Object::BUILDARGS(@_); - my($attribute_class, @traits) = ref($self)->interpolate_class(\%args); + my($attribute_class, @traits) = ref($self)->interpolate_class($args); - $args{traits} = \@traits if @traits; - return $attribute_class->new($self->name, %{$self}, %args); + $args->{traits} = \@traits if @traits; + # do not inherit the 'handles' attribute + foreach my $name(keys %{$self}){ + if(!exists $args->{$name} && $name ne 'handles'){ + $args->{$name} = $self->{$name}; + } + } + + # remove temporary caches + foreach my $attr(keys %{$args}){ + if($attr =~ /\A _/xms){ + delete $args->{$attr}; + } + } + + return $attribute_class->new($self->name, $args); } sub clone_parent { # DEPRECATED @@ -315,8 +217,7 @@ sub clone_parent { # DEPRECATED my %args = ($self->get_parent_args($class, $name), @_); Carp::cluck("$self->clone_parent has been deprecated." - . "Use \$meta->add_attribute and \$attr->install_accessors instead.") - if _MOUSE_VERBOSE; + . "Use \$meta->add_attribute and \$attr->install_accessors instead."); $self->clone_and_inherited_args($class, $name, %args); } @@ -337,82 +238,74 @@ sub get_parent_args { # DEPRECATED sub get_read_method { - $_[0]->{reader} || $_[0]->{accessor} + return $_[0]->reader || $_[0]->accessor } sub get_write_method { - $_[0]->{writer} || $_[0]->{accessor} + return $_[0]->writer || $_[0]->accessor } -sub get_read_method_ref{ - my($self) = @_; +sub _get_accessor_method_ref { + my($self, $type, $generator) = @_; - $self->{_read_method_ref} ||= do{ - my $metaclass = $self->associated_class - or $self->throw_error('No asocciated class for ' . $self->name); + my $metaclass = $self->associated_class + || $self->throw_error('No asocciated class for ' . $self->name); - my $reader = $self->{reader} || $self->{accessor}; - if($reader){ - $metaclass->name->can($reader); - } - else{ - $self->accessor_metaclass->_generate_reader($self, $metaclass); - } - }; + my $accessor = $self->$type(); + if($accessor){ + return $metaclass->get_method_body($accessor); + } + else{ + return $self->accessor_metaclass->$generator($self, $metaclass); + } +} + +sub get_read_method_ref{ + my($self) = @_; + return $self->{_read_method_ref} ||= $self->_get_accessor_method_ref('get_read_method', '_generate_reader'); } sub get_write_method_ref{ my($self) = @_; + return $self->{_write_method_ref} ||= $self->_get_accessor_method_ref('get_write_method', '_generate_writer'); +} - $self->{_write_method_ref} ||= do{ - my $metaclass = $self->associated_class - or $self->throw_error('No asocciated class for ' . $self->name); +sub set_value { + my($self, $object, $value) = @_; + return $self->get_write_method_ref()->($object, $value); +} - my $reader = $self->{writer} || $self->{accessor}; - if($reader){ - $metaclass->name->can($reader); - } - else{ - $self->accessor_metaclass->_generate_writer($self, $metaclass); - } - }; +sub get_value { + my($self, $object) = @_; + return $self->get_read_method_ref()->($object); } -sub _canonicalize_handles { - my($self, $handles) = @_; +sub has_value { + my($self, $object) = @_; + my $accessor_ref = $self->{_predicate_ref} + ||= $self->_get_accessor_method_ref('predicate', '_generate_predicate'); - if (ref($handles) eq 'HASH') { - return %$handles; - } - elsif (ref($handles) eq 'ARRAY') { - return map { $_ => $_ } @$handles; - } - elsif (ref($handles) eq 'Regexp') { - my $class_or_role = ($self->{isa} || $self->{does}) - || $self->throw_error("Cannot delegate methods based on a Regexp without a type constraint (isa)"); + return $accessor_ref->($object); +} - my $meta = Mouse::Meta::Class->initialize("$class_or_role"); # "" for stringify - return map { $_ => $_ } - grep { $_ ne 'meta' && !Mouse::Object->can($_) && $_ =~ $handles } - $meta->isa('Mouse::Meta::Class') ? $meta->get_all_method_names : $meta->get_method_list; - } - else { - $self->throw_error("Unable to canonicalize the 'handles' option with $handles"); - } +sub clear_value { + my($self, $object) = @_; + my $accessor_ref = $self->{_crealer_ref} + ||= $self->_get_accessor_method_ref('clearer', '_generate_clearer'); + + return $accessor_ref->($object); } sub associate_method{ - my ($attribute, $method) = @_; + my ($attribute, $method_name) = @_; $attribute->{associated_methods}++; return; } -sub accessor_metaclass(){ 'Mouse::Meta::Method::Accessor' } - sub install_accessors{ my($attribute) = @_; - my $metaclass = $attribute->{associated_class}; + my $metaclass = $attribute->associated_class; my $accessor_class = $attribute->accessor_metaclass; foreach my $type(qw(accessor reader writer predicate clearer)){ @@ -420,25 +313,23 @@ sub install_accessors{ my $generator = '_generate_' . $type; my $code = $accessor_class->$generator($attribute, $metaclass); $metaclass->add_method($attribute->{$type} => $code); - $attribute->associate_method($code); + $attribute->associate_method($attribute->{$type}); } } # install delegation if(exists $attribute->{handles}){ my %handles = $attribute->_canonicalize_handles($attribute->{handles}); - my $reader = $attribute->get_read_method_ref; - while(my($handle_name, $method_to_call) = each %handles){ - my $code = $accessor_class->_generate_delegation($attribute, $metaclass, - $reader, $handle_name, $method_to_call); + while(my($handle, $method_to_call) = each %handles){ + $metaclass->add_method($handle => + $attribute->_make_delegation_method( + $handle, $method_to_call)); - $metaclass->add_method($handle_name => $code); - $attribute->associate_method($code); + $attribute->associate_method($handle); } } - if($attribute->can('create') != \&create){ # backword compatibility $attribute->create($metaclass, $attribute->name, %{$attribute}); @@ -447,6 +338,46 @@ sub install_accessors{ return; } +sub delegation_metaclass() { 'Mouse::Meta::Method::Delegation' } + +sub _canonicalize_handles { + my($self, $handles) = @_; + + if (ref($handles) eq 'HASH') { + return %$handles; + } + elsif (ref($handles) eq 'ARRAY') { + return map { $_ => $_ } @$handles; + } + elsif ( ref($handles) eq 'CODE' ) { + my $class_or_role = ( $self->{isa} || $self->{does} ) + || $self->throw_error( "Cannot find delegate metaclass for attribute " . $self->name ); + return $handles->( $self, Mouse::Meta::Class->initialize("$class_or_role")); + } + elsif (ref($handles) eq 'Regexp') { + my $class_or_role = ($self->{isa} || $self->{does}) + || $self->throw_error("Cannot delegate methods based on a Regexp without a type constraint (isa)"); + + my $meta = Mouse::Meta::Class->initialize("$class_or_role"); # "" for stringify + return map { $_ => $_ } + grep { !Mouse::Object->can($_) && $_ =~ $handles } + Mouse::Util::is_a_metarole($meta) + ? $meta->get_method_list + : $meta->get_all_method_names; + } + else { + $self->throw_error("Unable to canonicalize the 'handles' option with $handles"); + } +} + +sub _make_delegation_method { + my($self, $handle, $method_to_call) = @_; + my $delegator = $self->delegation_metaclass; + Mouse::Util::load_class($delegator); + + return $delegator->_generate_delegation($self, $handle, $method_to_call); +} + sub throw_error{ my $self = shift; @@ -455,13 +386,16 @@ sub throw_error{ } 1; - __END__ =head1 NAME Mouse::Meta::Attribute - The Mouse attribute metaclass +=head1 VERSION + +This document describes Mouse version 0.50_02 + =head1 METHODS =head2 C<< new(%options) -> Mouse::Meta::Attribute >> @@ -568,12 +502,12 @@ is equivalent to this: =back -=head2 C<< associate_method(Method) >> +=head2 C<< associate_method(MethodName) >> Associates a method with the attribute. Typically, this is called internally when an attribute generates its accessors. -Currently the argument I is ignored in Mouse. +Currently the argument I is ignored in Mouse. =head2 C<< verify_against_type_constraint(Item) -> TRUE | ERROR >>