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=a4827e866074b05aa4a8ef6a2d49f8462133f3d4;hp=7d6d68e040d6af80a36c2b8e7d341a83b7375c6e;hb=f7e41edaceee0d549a2d664378cfcf85dcf9454b;hpb=7ca5c5fb6e084d9c57bc022b336458afc74c6847 diff --git a/lib/Mouse/Meta/Attribute.pm b/lib/Mouse/Meta/Attribute.pm index 7d6d68e..a4827e8 100644 --- a/lib/Mouse/Meta/Attribute.pm +++ b/lib/Mouse/Meta/Attribute.pm @@ -1,17 +1,23 @@ package Mouse::Meta::Attribute; -use strict; -use warnings; +use Mouse::Util qw(:meta); # enables strict and warnings use Carp (); -use Mouse::Util qw(:meta); - use Mouse::Meta::TypeConstraint; -use Mouse::Meta::Method::Accessor; + +#use Mouse::Meta::Method::Accessor; +use Mouse::Meta::Method::Delegation; + sub _process_options{ my($class, $name, $args) = @_; + + # 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) @@ -25,8 +31,12 @@ sub _process_options{ 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 ref $args->{builder} || !defined $args->{builder}; + if !defined $args->{builder}; $can_be_required++; } @@ -118,10 +128,6 @@ sub _process_options{ || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it"); } - # XXX: for backward compatibility (with method modifiers) - if($class->can('canonicalize_args') != \&canonicalize_args){ - %{$args} = $class->canonicalize_args($name, %{$args}); - } return; } @@ -135,11 +141,11 @@ sub new { $args{name} = $name; - my $instance = bless \%args, $class; + my $self = bless \%args, $class; # extra attributes if($class ne __PACKAGE__){ - $class->meta->_initialize_instance($instance,\%args); + $class->meta->_initialize_object($self, \%args); } # XXX: there is no fast way to check attribute validity @@ -149,62 +155,19 @@ sub new { # Carp::cluck("Found unknown argument(s) passed to '$name' attribute constructor in '$class': @bad"); # } - return $instance + 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} } - -sub get_read_method { $_[0]->{reader} || $_[0]->{accessor} } -sub get_write_method { $_[0]->{writer} || $_[0]->{accessor} } - -# 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 _create_args { +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; $_[0]->{_create_args} } sub interpolate_class{ - my($class, $name, $args) = @_; + my($class, $args) = @_; if(my $metaclass = delete $args->{metaclass}){ $class = Mouse::Util::resolve_metaclass_alias( Attribute => $metaclass ); @@ -237,83 +200,96 @@ sub interpolate_class{ return( $class, @traits ); } -sub canonicalize_args{ +sub canonicalize_args{ # DEPRECATED my ($self, $name, %args) = @_; Carp::cluck("$self->canonicalize_args has been deprecated." - . "Use \$self->_process_options instead."); + . "Use \$self->_process_options instead.") + if Mouse::Util::_MOUSE_VERBOSE; return %args; } -sub create { +sub create { # DEPRECATED my ($self, $class, $name, %args) = @_; Carp::cluck("$self->create has been deprecated." - . "Use \$meta->add_attribute and \$attr->install_accessors instead."); + . "Use \$meta->add_attribute and \$attr->install_accessors instead.") + if Mouse::Util::_MOUSE_VERBOSE; # noop return $self; } +sub _coerce_and_verify { + my($self, $value, $instance) = @_; + + my $type_constraint = $self->{type_constraint}; + return $value if !defined $type_constraint; + + if ($self->should_coerce && $type_constraint->has_coercion) { + $value = $type_constraint->coerce($value); + } + + $self->verify_against_type_constraint($value); + + return $value; +} + sub verify_against_type_constraint { my ($self, $value) = @_; - my $tc = $self->type_constraint; - return 1 unless $tc; - local $_ = $value; - return 1 if $tc->check($value); + my $type_constraint = $self->{type_constraint}; + return 1 if !$type_constraint; + return 1 if $type_constraint->check($value); - $self->verify_type_constraint_error($self->name, $value, $tc); + $self->verify_type_constraint_error($self->name, $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)); + $self->throw_error("Attribute ($name) does not pass the type constraint because: " + . $type->get_message($value)); } -sub coerce_constraint { ## my($self, $value) = @_; +sub coerce_constraint { # DEPRECATED my $type = $_[0]->{type_constraint} or return $_[1]; - return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $type, $_[1]); -} -sub _canonicalize_handles { - my $self = shift; - my $handles = shift; + Carp::cluck("coerce_constraint() has been deprecated, which was an internal utility anyway"); - if (ref($handles) eq 'HASH') { - return %$handles; - } - elsif (ref($handles) eq 'ARRAY') { - return map { $_ => $_ } @$handles; - } - else { - $self->throw_error("Unable to canonicalize the 'handles' option with $handles"); - } + return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $type, $_[1]); } sub clone_and_inherit_options{ - my $self = shift; - my $name = shift; + my($self, %args) = @_; + + my($attribute_class, @traits) = ref($self)->interpolate_class(\%args); - return ref($self)->new($name, %{$self}, (@_ == 1) ? %{$_[0]} : @_); + $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}; + } + } + return $attribute_class->new($self->name, %args); } -sub clone_parent { +sub clone_parent { # DEPRECATED my $self = shift; my $class = shift; my $name = shift; 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."); - + . "Use \$meta->add_attribute and \$attr->install_accessors instead.") + if Mouse::Util::_MOUSE_VERBOSE; $self->clone_and_inherited_args($class, $name, %args); } -sub get_parent_args { +sub get_parent_args { # DEPRECATED my $self = shift; my $class = shift; my $name = shift; @@ -327,21 +303,113 @@ sub get_parent_args { $self->throw_error("Could not find an attribute by the name of '$name' to inherit from"); } + +sub get_read_method { + $_[0]->reader || $_[0]->accessor +} +sub get_write_method { + $_[0]->writer || $_[0]->accessor +} + +sub get_read_method_ref{ + my($self) = @_; + + $self->{_read_method_ref} ||= do{ + my $metaclass = $self->associated_class + or $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); + } + }; +} + +sub get_write_method_ref{ + my($self) = @_; + + $self->{_write_method_ref} ||= do{ + my $metaclass = $self->associated_class + or $self->throw_error('No asocciated class for ' . $self->name); + + my $reader = $self->{writer} || $self->{accessor}; + if($reader){ + $metaclass->name->can($reader); + } + else{ + $self->accessor_metaclass->_generate_writer($self, $metaclass); + } + }; +} + +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 '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 associate_method{ + my ($attribute, $method_name) = @_; + $attribute->{associated_methods}++; + return; +} + + +sub delegation_metaclass() { 'Mouse::Meta::Method::Delegation' } + 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 handles)){ + foreach my $type(qw(accessor reader writer predicate clearer)){ if(exists $attribute->{$type}){ - my $installer = '_install_' . $type; + my $generator = '_generate_' . $type; + my $code = $accessor_class->$generator($attribute, $metaclass); + $metaclass->add_method($attribute->{$type} => $code); + $attribute->associate_method($attribute->{$type}); + } + } - Mouse::Meta::Method::Accessor->$installer($attribute, $attribute->{$type}, $metaclass); + # install delegation + if(exists $attribute->{handles}){ + my $delegation_class = $attribute->delegation_metaclass; + my %handles = $attribute->_canonicalize_handles($attribute->{handles}); + my $reader = $attribute->get_read_method_ref; - $attribute->{associated_methods}++; + while(my($handle_name, $method_to_call) = each %handles){ + my $code = $delegation_class->_generate_delegation($attribute, $metaclass, + $reader, $handle_name, $method_to_call); + + $metaclass->add_method($handle_name => $code); + $attribute->associate_method($handle_name); } } + if($attribute->can('create') != \&create){ # backword compatibility $attribute->create($metaclass, $attribute->name, %{$attribute}); @@ -363,7 +431,11 @@ __END__ =head1 NAME -Mouse::Meta::Attribute - attribute metaclass +Mouse::Meta::Attribute - The Mouse attribute metaclass + +=head1 VERSION + +This document describes Mouse version 0.40_08 =head1 METHODS @@ -375,7 +447,7 @@ It adds the following options to the constructor: =over 4 -=item * C<< is => 'ro', 'rw', 'bare' >> +=item C<< is => 'ro', 'rw', 'bare' >> This provides a shorthand for specifying the C, C, or C names. If the attribute is read-only ('ro') then it will @@ -391,7 +463,7 @@ Use 'bare' when you are deliberately not installing any methods Moose will issue a deprecation warning when this attribute is added to a metaclass. -=item * C<< isa => Type >> +=item C<< isa => Type >> This option accepts a type. The type can be a string, which should be a type name. If the type name is unknown, it is assumed to be a class @@ -403,14 +475,14 @@ If you I provide a C option, then your C option must be a class name, and that class must do the role specified with C. -=item * C<< does => Role >> +=item C<< does => Role >> This is short-hand for saying that the attribute's type must be an object which does the named role. B -=item * C<< coerce => Bool >> +=item C<< coerce => Bool >> This option is only valid for objects with a type constraint (C). If this is true, then coercions will be applied whenever @@ -418,12 +490,12 @@ this attribute is set. You can make both this and the C option true. -=item * C<< trigger => CodeRef >> +=item C<< trigger => CodeRef >> This option accepts a subroutine reference, which will be called after the attribute is set. -=item * C<< required => Bool >> +=item C<< required => Bool >> An attribute which is required must be provided to the constructor. An attribute which is required can also have a C or C, @@ -432,24 +504,24 @@ which will satisfy its required-ness. A required attribute must have a C, C or a non-C C -=item * C<< lazy => Bool >> +=item C<< lazy => Bool >> A lazy attribute must have a C or C. When an attribute is lazy, the default value will not be calculated until the attribute is read. -=item * C<< weak_ref => Bool >> +=item C<< weak_ref => Bool >> If this is true, the attribute's value will be stored as a weak reference. -=item * C<< auto_deref => Bool >> +=item C<< auto_deref => Bool >> If this is true, then the reader will dereference the value when it is called. The attribute must have a type constraint which defines the attribute as an array or hash reference. -=item * C<< lazy_build => Bool >> +=item C<< lazy_build => Bool >> Setting this to true makes the attribute lazy and provides a number of default methods. @@ -471,6 +543,13 @@ is equivalent to this: =back +=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. + =head2 C<< verify_against_type_constraint(Item) -> TRUE | ERROR >> Checks that the given value passes this attribute's type constraint. Returns C @@ -478,12 +557,23 @@ on success, otherwise Ces. =head2 C<< clone_and_inherit_options(options) -> Mouse::Meta::Attribute >> -Creates a new attribute in OwnerClass, inheriting options from parent classes. +Creates a new attribute in the owner class, inheriting options from parent classes. Accessors and helper methods are installed. Some error checking is done. +=head2 C<< get_read_method_ref >> + +=head2 C<< get_write_method_ref >> + +Returns the subroutine reference of a method suitable for reading or +writing the attribute's value in the associated class. These methods +always return a subroutine reference, regardless of whether or not the +attribute is read- or write-only. + =head1 SEE ALSO L +L + =cut