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=8511bc2054933aeebf6ddd371e1f4340830176bf;hp=43b796a72967ad524c53f2c4a53c6e88bbdf98f4;hb=ef9070cc6ee59ca3691f3765ad96ef0922e064ca;hpb=9c3c9a02cbb960d8b8d53708afd84800e4a42765 diff --git a/lib/Mouse/Meta/Attribute.pm b/lib/Mouse/Meta/Attribute.pm index 43b796a..8511bc2 100644 --- a/lib/Mouse/Meta/Attribute.pm +++ b/lib/Mouse/Meta/Attribute.pm @@ -1,328 +1,275 @@ package Mouse::Meta::Attribute; use strict; use warnings; -require overload; -use Carp 'confess'; -use Scalar::Util (); -use Mouse::Meta::TypeConstraint; +use Carp (); +use Scalar::Util qw(weaken); -sub new { - my ($class, $name, %options) = @_; +use Mouse::Util; - $options{name} = $name; +use Mouse::Meta::TypeConstraint; +use Mouse::Meta::Method::Accessor; - $options{init_arg} = $name - unless exists $options{init_arg}; +sub BUILDARGS{ + my $class = shift; + my $name = shift; + my %args = (@_ == 1) ? %{$_[0]} : @_; - $options{is} ||= ''; + $args{name} = $name; - bless \%options, $class; -} + # XXX: for backward compatibility (with method modifiers) + if($class->can('canonicalize_args') != \&canonicalize_args){ + %args = $class->canonicalize_args($name, %args); + } -sub name { $_[0]->{name} } -sub associated_class { $_[0]->{associated_class} } -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 predicate { $_[0]->{predicate} } -sub clearer { $_[0]->{clearer} } -sub handles { $_[0]->{handles} } -sub is_weak_ref { $_[0]->{weak_ref} } -sub init_arg { $_[0]->{init_arg} } -sub type_constraint { $_[0]->{type_constraint} } -sub find_type_constraint { - Carp::carp("This method was deprecated"); - $_[0]->type_constraint(); + return \%args; } -sub trigger { $_[0]->{trigger} } -sub builder { $_[0]->{builder} } -sub should_auto_deref { $_[0]->{auto_deref} } -sub should_coerce { $_[0]->{should_coerce} } -sub has_default { exists $_[0]->{default} } -sub has_predicate { exists $_[0]->{predicate} } -sub has_clearer { exists $_[0]->{clearer} } -sub has_handles { exists $_[0]->{handles} } -sub has_type_constraint { exists $_[0]->{type_constraint} } -sub has_trigger { exists $_[0]->{trigger} } -sub has_builder { exists $_[0]->{builder} } +sub new { + my $class = shift; + my $args = $class->BUILDARGS(@_); -sub _create_args { - $_[0]->{_create_args} = $_[1] if @_ > 1; - $_[0]->{_create_args} -} + my $name = $args->{name}; -sub inlined_name { - my $self = shift; - my $name = $self->name; - my $key = "'" . $name . "'"; - return $key; -} + # taken from Class::MOP::Attribute::new -sub generate_accessor_method_inline { - my ($attribute) = @_; - - my $name = $attribute->name; - my $default = $attribute->default; - my $constraint = $attribute->type_constraint; - my $builder = $attribute->builder; - my $trigger = $attribute->trigger; - my $is_weak = $attribute->is_weak_ref; - my $should_deref = $attribute->should_auto_deref; - my $should_coerce = $attribute->should_coerce; - - my $compiled_type_constraint = $constraint ? $constraint->{_compiled_type_constraint} : undef; - - my $self = '$_[0]'; - my $key = $attribute->inlined_name; - - my $accessor = - '#line ' . __LINE__ . ' "' . __FILE__ . "\"\n" . - "sub {\n"; - if ($attribute->_is_metadata eq 'rw') { - $accessor .= - '#line ' . __LINE__ . ' "' . __FILE__ . "\"\n" . - 'if (scalar(@_) >= 2) {' . "\n"; - - my $value = '$_[1]'; - - if ($constraint) { - if ($should_coerce) { - $accessor .= - "\n". - '#line ' . __LINE__ . ' "' . __FILE__ . "\"\n" . - 'my $val = Mouse::Util::TypeConstraints->typecast_constraints("'.$attribute->associated_class->name.'", $attribute->{type_constraint}, '.$value.');'; - $value = '$val'; - } - if ($compiled_type_constraint) { - $accessor .= - "\n". - '#line ' . __LINE__ . ' "' . __FILE__ . "\"\n" . - 'unless ($compiled_type_constraint->('.$value.')) { - $attribute->verify_type_constraint_error($name, '.$value.', $attribute->{type_constraint}); - }' . "\n"; - } else { - $accessor .= - "\n". - '#line ' . __LINE__ . ' "' . __FILE__ . "\"\n" . - 'unless ($constraint->check('.$value.')) { - $attribute->verify_type_constraint_error($name, '.$value.', $attribute->{type_constraint}); - }' . "\n"; - } - } + defined($name) + or $class->throw_error('You must provide a name for the attribute'); + + if(!exists $args->{init_arg}){ + $args->{init_arg} = $name; + } - # if there's nothing left to do for the attribute we can return during - # this setter - $accessor .= 'return ' if !$is_weak && !$trigger && !$should_deref; + # 'required' requires eigher 'init_arg', 'builder', or 'default' + my $can_be_required = defined( $args->{init_arg} ); - $accessor .= $self.'->{'.$key.'} = '.$value.';' . "\n"; + if(exists $args->{builder}){ + $class->throw_error('builder must be a defined scalar value which is a method name') + if ref $args->{builder} || !(defined $args->{builder}); - if ($is_weak) { - $accessor .= 'Scalar::Util::weaken('.$self.'->{'.$key.'}) if ref('.$self.'->{'.$key.'});' . "\n"; + $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 ($trigger) { - $accessor .= '$trigger->('.$self.', '.$value.');' . "\n"; + 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)"); + } + } - $accessor .= "}\n"; + my $tc; + if(exists $args->{isa}){ + $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa}); } - else { - $accessor .= 'Carp::confess("Cannot assign a value to a read-only accessor") if scalar(@_) >= 2;' . "\n"; + elsif(exists $args->{does}){ + $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does}); } + $tc = $args->{type_constraint}; - if ($attribute->is_lazy) { - $accessor .= $self.'->{'.$key.'} = '; + if($args->{coerce}){ + defined($tc) + || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)"); - $accessor .= $attribute->has_builder - ? $self.'->$builder' - : ref($default) eq 'CODE' - ? '$default->('.$self.')' - : '$default'; - $accessor .= ' if !exists '.$self.'->{'.$key.'};' . "\n"; + $args->{weak_ref} + && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)"); } - if ($should_deref) { - if (ref($constraint) && $constraint->name =~ '^ArrayRef\b') { - $accessor .= 'if (wantarray) { - return @{ '.$self.'->{'.$key.'} || [] }; - }'; + 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 { - $accessor .= 'if (wantarray) { - return %{ '.$self.'->{'.$key.'} || {} }; - }'; + $args->{clearer} ||= "clear_${name}"; + $args->{predicate} ||= "has_${name}"; } } - $accessor .= 'return '.$self.'->{'.$key.'}; - }'; - - my $sub = eval $accessor; - Carp::confess($@) if $@; - return $sub; -} + if ($args->{auto_deref}) { + defined($tc) + || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($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)"); + } -sub generate_predicate { - my $attribute = shift; - my $key = $attribute->inlined_name; + if (exists $args->{trigger}) { + ('CODE' eq ref $args->{trigger}) + || $class->throw_error("Trigger must be a CODE ref on attribute ($name)"); + } - my $predicate = 'sub { exists($_[0]->{'.$key.'}) }'; + 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"); + } - my $sub = eval $predicate; - confess $@ if $@; - return $sub; -} + my $instance = bless $args, $class; -sub generate_clearer { - my $attribute = shift; - my $key = $attribute->inlined_name; + # extra attributes + if($class ne __PACKAGE__){ + $class->meta->_initialize_instance($instance, $args); + } - my $clearer = 'sub { delete($_[0]->{'.$key.'}) }'; +# 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"); +# } - my $sub = eval $clearer; - confess $@ if $@; - return $sub; + return $instance } -sub generate_handles { - my $attribute = shift; - my $reader = $attribute->name; - my %handles = $attribute->_canonicalize_handles($attribute->handles); +sub does { + my ($self, $role_name) = @_; + my $meta = Mouse::Meta::Class->initialize(ref($self) || $self); - my %method_map; + (defined $role_name) + || $meta->throw_error("You must supply a role name to does()"); - for my $local_method (keys %handles) { - my $remote_method = $handles{$local_method}; + return $meta->does_role($role_name); +}; - my $method = 'sub { - my $self = shift; - $self->'.$reader.'->'.$remote_method.'(@_) - }'; +# readers - $method_map{$local_method} = eval $method; - confess $@ if $@; - } +sub name { $_[0]->{name} } +sub associated_class { $_[0]->{associated_class} } - return \%method_map; -} +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 create { - my ($self, $class, $name, %args) = @_; +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} } - $args{name} = $name; - $args{associated_class} = $class; +sub trigger { $_[0]->{trigger} } +sub builder { $_[0]->{builder} } +sub should_auto_deref { $_[0]->{auto_deref} } +sub should_coerce { $_[0]->{coerce} } - %args = $self->canonicalize_args($name, %args); - $self->validate_args($name, \%args); +sub get_read_method { $_[0]->{reader} || $_[0]->{accessor} } +sub get_write_method { $_[0]->{writer} || $_[0]->{accessor} } - $args{should_coerce} = delete $args{coerce} - if exists $args{coerce}; +# predicates - if (exists $args{isa}) { - confess "Got isa => $args{isa}, but Mouse does not yet support parameterized types for containers other than ArrayRef and HashRef (rt.cpan.org #39795)" - if $args{isa} =~ /^([^\[]+)\[.+\]$/ && - $1 ne 'ArrayRef' && - $1 ne 'HashRef' && - $1 ne 'Maybe' - ; +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} } - my $type_constraint = delete $args{isa}; - $args{type_constraint}= Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($type_constraint); - } +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} } - my $attribute = $self->new($name, %args); +sub has_read_method { exists $_[0]->{reader} || exists $_[0]->{accessor} } +sub has_write_method { exists $_[0]->{writer} || exists $_[0]->{accessor} } - $attribute->_create_args(\%args); +sub _create_args { + $_[0]->{_create_args} = $_[1] if @_ > 1; + $_[0]->{_create_args} +} - $class->add_attribute($attribute); +sub accessor_metaclass { 'Mouse::Meta::Method::Accessor' } - # install an accessor - if ($attribute->_is_metadata eq 'rw' || $attribute->_is_metadata eq 'ro') { - my $code = $attribute->generate_accessor_method_inline(); - $class->add_method($name => $code); - } +sub interpolate_class_and_new{ + my($class, $name, $args) = @_; - for my $method (qw/predicate clearer/) { - my $predicate = "has_$method"; - if ($attribute->$predicate) { - my $generator = "generate_$method"; - my $coderef = $attribute->$generator; - $class->add_method($attribute->$method => $coderef); - } + if(my $metaclass = delete $args->{metaclass}){ + $class = Mouse::Util::resolve_metaclass_alias( Attribute => $metaclass ); } - if ($attribute->has_handles) { - my $method_map = $attribute->generate_handles; - for my $method_name (keys %$method_map) { - $class->add_method($method_name => $method_map->{$method_name}); - } - } - return $attribute; -} + if(my $traits_ref = delete $args->{traits}){ + my @traits; + for (my $i = 0; $i < @{$traits_ref}; $i++) { + my $trait = Mouse::Util::resolve_metaclass_alias(Attribute => $traits_ref->[$i], trait => 1); -sub canonicalize_args { - my $self = shift; - my $name = shift; - my %args = @_; + next if $class->does($trait); - if ($args{lazy_build}) { - $args{lazy} = 1; - $args{required} = 1; - $args{builder} = "_build_${name}" - if !exists($args{builder}); - if ($name =~ /^_/) { - $args{clearer} = "_clear${name}" if !exists($args{clearer}); - $args{predicate} = "_has${name}" if !exists($args{predicate}); + push @traits, $trait; + + # are there options? + push @traits, $traits_ref->[++$i] + if ref($traits_ref->[$i+1]); } - else { - $args{clearer} = "clear_${name}" if !exists($args{clearer}); - $args{predicate} = "has_${name}" if !exists($args{predicate}); + + if (@traits) { + $class = Mouse::Meta::Class->create_anon_class( + superclasses => [ $class ], + roles => \@traits, + cache => 1, + )->name; + + $args->{traits} = \@traits; } } - return %args; + return $class->new($name, $args); } -sub validate_args { - my $self = shift; - my $name = shift; - my $args = shift; - - confess "You can not use lazy_build and default for the same attribute ($name)" - if $args->{lazy_build} && exists $args->{default}; +sub canonicalize_args{ + my ($self, $name, %args) = @_; - confess "You cannot have lazy attribute ($name) without specifying a default value for it" - if $args->{lazy} - && !exists($args->{default}) - && !exists($args->{builder}); + Carp::cluck("$self->canonicalize_args has been deprecated." + . "Use \$self->BUILDARGS instead."); - confess "References are not allowed as default values, you must wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])" - if ref($args->{default}) - && ref($args->{default}) ne 'CODE'; - - confess "You cannot auto-dereference without specifying a type constraint on attribute ($name)" - if $args->{auto_deref} && !exists($args->{isa}); - - confess "You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)" - if $args->{auto_deref} - && $args->{isa} !~ /^(?:ArrayRef|HashRef)(?:\[.*\])?$/; + return %args; +} - if ($args->{trigger}) { - if (ref($args->{trigger}) eq 'HASH') { - Carp::carp "HASH-based form of trigger has been removed. Only the coderef form of triggers are now supported."; - } +sub create { + my ($self, $class, $name, %args) = @_; - confess "Trigger must be a CODE ref on attribute ($name)" - if ref($args->{trigger}) ne 'CODE'; - } + Carp::cluck("$self->create has been deprecated." + . "Use \$meta->add_attribute and \$attr->install_accessors instead."); - return 1; + # noop + return $self; } sub verify_against_type_constraint { @@ -338,7 +285,7 @@ sub verify_against_type_constraint { sub verify_type_constraint_error { my($self, $name, $value, $type) = @_; - Carp::confess("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) = @_; @@ -358,16 +305,27 @@ sub _canonicalize_handles { return map { $_ => $_ } @$handles; } else { - confess "Unable to canonicalize the 'handles' option with $handles"; + $self->throw_error("Unable to canonicalize the 'handles' option with $handles"); } } +sub clone_and_inherit_options{ + my $self = shift; + my $name = shift; + + return ref($self)->new($name, %{$self}, @_ == 1 ? %{$_[0]} : @_); +} + sub clone_parent { 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."); + + $self->create($class, $name, %args); } @@ -382,7 +340,35 @@ sub get_parent_args { return %{ $super_attr->_create_args }; } - confess "Could not find an attribute by the name of '$name' to inherit from"; + $self->throw_error("Could not find an attribute by the name of '$name' to inherit from"); +} + +sub install_accessors{ + my($attribute) = @_; + + my $metaclass = $attribute->{associated_class}; + my $generator_class = $attribute->accessor_metaclass; + + foreach my $type(qw(accessor reader writer predicate clearer handles)){ + if(exists $attribute->{$type}){ + my $installer = '_install_' . $type; + $generator_class->$installer($attribute, $attribute->{$type}, $metaclass); + $attribute->{associated_methods}++; + } + } + + if($attribute->can('create') != \&create){ + $attribute->create($metaclass, $attribute->name, %{$attribute}); + } + + return; +} + +sub throw_error{ + my $self = shift; + + my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class'; + $metaclass->throw_error(@_, depth => 1); } 1; @@ -450,22 +436,6 @@ installed. Some error checking is done. Informational methods. -=head2 generate_accessor -> CODE - -Creates a new code reference for the attribute's accessor. - -=head2 generate_predicate -> CODE - -Creates a new code reference for the attribute's predicate. - -=head2 generate_clearer -> CODE - -Creates a new code reference for the attribute's clearer. - -=head2 generate_handles -> { MethodName => CODE } - -Creates a new code reference for each of the attribute's handles methods. - =head2 verify_against_type_constraint Item -> 1 | ERROR Checks that the given value passes this attribute's type constraint. Returns 1