X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMouse%2FMeta%2FAttribute.pm;h=77d935a03711d566f57d795db5a413d1b4c6ddab;hb=60b5c3be4d0b3bb705df1e8d977f2ce90db6668d;hp=af9e737602b1377a6048b6c5003d361bf42da1e3;hpb=f7b11a21869769d2b49bba4fa72d33fa54ad0c2e;p=gitmo%2FMouse.git diff --git a/lib/Mouse/Meta/Attribute.pm b/lib/Mouse/Meta/Attribute.pm index af9e737..77d935a 100644 --- a/lib/Mouse/Meta/Attribute.pm +++ b/lib/Mouse/Meta/Attribute.pm @@ -1,277 +1,201 @@ -#!/usr/bin/env perl package Mouse::Meta::Attribute; use strict; use warnings; -use Carp 'confess'; -use Scalar::Util 'blessed'; +use Mouse::Meta::TypeConstraint; +use Mouse::Meta::Method::Accessor; sub new { - my $class = shift; - my %args = @_; + my ($class, $name, %options) = @_; - my $name = $args{name}; + $options{name} = $name; - $args{init_arg} = $name - unless exists $args{init_arg}; + $options{init_arg} = $name + unless exists $options{init_arg}; - $args{is} ||= ''; + my $is = $options{is} ||= ''; - if ($args{lazy_build}) { - confess("You can not use lazy_build and default for the same attribute $name") - if exists $args{default}; - $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}); - } - else { - $args{clearer} = "clear_${name}" if !exists($args{clearer}); - $args{predicate} = "has_${name}" if !exists($args{predicate}); - } + if($is eq 'rw'){ + $options{accessor} = $name if !exists $options{accessor}; + } + elsif($is eq 'ro'){ + $options{reader} = $name if !exists $options{reader}; } - bless \%args, $class; + bless \%options, $class; } -sub name { $_[0]->{name} } -sub class { $_[0]->{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 trigger { $_[0]->{trigger} } -sub builder { $_[0]->{builder} } -sub should_auto_deref { $_[0]->{auto_deref} } - -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} } +# 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 find_type_constraint { + Carp::carp("This method was deprecated"); + $_[0]->type_constraint(); +} +sub trigger { $_[0]->{trigger} } +sub builder { $_[0]->{builder} } +sub should_auto_deref { $_[0]->{auto_deref} } +sub should_coerce { $_[0]->{should_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 _create_args { $_[0]->{_create_args} = $_[1] if @_ > 1; $_[0]->{_create_args} } -sub generate_accessor { - my $attribute = shift; - - my $name = $attribute->name; - my $key = $name; - my $default = $attribute->default; - my $trigger = $attribute->trigger; - my $type = $attribute->type_constraint; - my $constraint = $attribute->find_type_constraint; - my $builder = $attribute->builder; - - my $accessor = 'sub { - my $self = shift;'; - - if ($attribute->_is_metadata eq 'rw') { - $accessor .= 'if (@_) { - local $_ = $_[0];'; - - if ($constraint) { - $accessor .= 'do { - my $display = defined($_) ? overload::StrVal($_) : "undef"; - Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display") unless $constraint->(); - };' - } - - $accessor .= '$self->{$key} = $_;'; - - if ($attribute->is_weak_ref) { - $accessor .= 'Scalar::Util::weaken($self->{$key}) if ref($self->{$key});'; - } - - if ($trigger) { - $accessor .= '$trigger->($self, $_, $attribute);'; - } +sub accessor_metaclass { 'Mouse::Meta::Method::Accessor' } - $accessor .= '}'; - } - else { - $accessor .= 'confess "Cannot assign a value to a read-only accessor" if @_;'; - } +sub create { + my ($self, $class, $name, %args) = @_; - if ($attribute->is_lazy) { - $accessor .= '$self->{$key} = '; + $args{name} = $name; + $args{associated_class} = $class; - $accessor .= $attribute->has_builder - ? '$self->$builder' - : ref($default) eq 'CODE' - ? '$default->($self)' - : '$default'; + %args = $self->canonicalize_args($name, %args); + $self->validate_args($name, \%args); - $accessor .= ' if !exists($self->{$key});'; - } + $args{should_coerce} = delete $args{coerce} + if exists $args{coerce}; - if ($attribute->should_auto_deref) { - if ($attribute->type_constraint eq 'ArrayRef') { - $accessor .= 'if (wantarray) { - return @{ $self->{$key} || [] }; - }'; - } - else { - $accessor .= 'if (wantarray) { - return %{ $self->{$key} || {} }; - }'; - } + if (exists $args{isa}) { + my $type_constraint = delete $args{isa}; + $args{type_constraint}= Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($type_constraint); } - $accessor .= 'return $self->{$key}; - }'; - - return eval $accessor; -} - -sub generate_predicate { - my $attribute = shift; - my $key = $attribute->name; - - my $predicate = 'sub { exists($_[0]->{$key}) }'; + my $attribute = $self->new($name, %args); - return eval $predicate; -} - -sub generate_clearer { - my $attribute = shift; - my $key = $attribute->name; - - my $predicate = 'sub { delete($_[0]->{$key}) }'; - - return eval $predicate; -} + $attribute->_create_args(\%args); -sub generate_handles { - my $attribute = shift; - my $reader = $attribute->name; - my %handles = $attribute->_canonicalize_handles($attribute->handles); + $class->add_attribute($attribute); - my %method_map; + my $associated_methods = 0; - for my $local_method (keys %handles) { - my $remote_method = $handles{$local_method}; + my $generator_class = $self->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}, $class); + $associated_methods++; + } + } - my $method = 'sub { - my $self = shift; - $self->$reader->$remote_method(@_) - }'; + if($associated_methods == 0 && ($attribute->_is_metadata || '') ne 'bare'){ + Carp::cluck(qq{Attribute ($name) of class }.$class->name.qq{ has no associated methods (did you mean to provide an "is" argument?)}); - $method_map{$local_method} = eval $method; } - return \%method_map; + return $attribute; } -sub create { - my ($self, $class, $name, %args) = @_; - - $args{name} = $name; - $args{class} = $class; - - $self->validate_args($name, %args); - - $args{type_constraint} = delete $args{isa} - if exists $args{isa}; - - my $attribute = $self->new(%args); - $attribute->_create_args(\%args); - - my $meta = $class->meta; - - $meta->add_attribute($attribute); - - # install an accessor - if ($attribute->_is_metadata eq 'rw' || $attribute->_is_metadata eq 'ro') { - my $accessor = $attribute->generate_accessor; - no strict 'refs'; - *{ $class . '::' . $name } = $accessor; - } +sub canonicalize_args { + my $self = shift; + my $name = shift; + my %args = @_; - for my $method (qw/predicate clearer/) { - my $predicate = "has_$method"; - if ($attribute->$predicate) { - my $generator = "generate_$method"; - my $coderef = $attribute->$generator; - no strict 'refs'; - *{ $class . '::' . $attribute->$method } = $coderef; + 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}); } - } - - if ($attribute->has_handles) { - my $method_map = $attribute->generate_handles; - for my $method_name (keys %$method_map) { - no strict 'refs'; - *{ $class . '::' . $method_name } = $method_map->{$method_name}; + else { + $args{clearer} = "clear_${name}" if !exists($args{clearer}); + $args{predicate} = "has_${name}" if !exists($args{predicate}); } } - return $attribute; + return %args; } sub validate_args { my $self = shift; my $name = shift; - my %args = @_; + my $args = shift; - confess "You cannot have lazy attribute ($name) without specifying a default value for it" - if $args{lazy} && !exists($args{default}) && !exists($args{builder}); + $self->throw_error("You can not use lazy_build and default for the same attribute ($name)") + if $args->{lazy_build} && exists $args->{default}; - 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'; + $self->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it") + if $args->{lazy} + && !exists($args->{default}) + && !exists($args->{builder}); - confess "You cannot auto-dereference without specifying a type constraint on attribute $name" - if $args{auto_deref} && !exists($args{isa}); + $self->throw_error("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 anything other than a ArrayRef or HashRef on attribute $name" - if $args{auto_deref} - && $args{isa} ne 'ArrayRef' - && $args{isa} ne 'HashRef'; + $self->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)") + if $args->{auto_deref} && !exists($args->{isa}); - return 1; -} - -sub find_type_constraint { - my $self = shift; - my $type = $self->type_constraint; + $self->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)") + if $args->{auto_deref} + && $args->{isa} !~ /^(?:ArrayRef|HashRef)(?:\[.*\])?$/; - return unless $type; + if ($args->{trigger}) { + if (ref($args->{trigger}) eq 'HASH') { + $self->throw_error("HASH-based form of trigger has been removed. Only the coderef form of triggers are now supported."); + } - my $checker = Mouse::TypeRegistry->optimized_constraints->{$type}; - return $checker if $checker; + $self->throw_error("Trigger must be a CODE ref on attribute ($name)") + if ref($args->{trigger}) ne 'CODE'; + } - return sub { blessed($_) && blessed($_) eq $type }; + return 1; } -sub verify_type_constraint { - my $self = shift; - local $_ = shift; +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 = $self->type_constraint - or return 1; - my $constraint = $self->find_type_constraint; + $self->verify_type_constraint_error($self->name, $value, $tc); +} - return 1 if $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)); +} - my $name = $self->name; - my $display = defined($_) ? overload::StrVal($_) : 'undef'; - Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display"); +sub coerce_constraint { ## my($self, $value) = @_; + my $type = $_[0]->{type_constraint} + or return $_[1]; + return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $_[0]->type_constraint, $_[1]); } sub _canonicalize_handles { @@ -285,7 +209,7 @@ 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"); } } @@ -303,13 +227,20 @@ sub get_parent_args { my $class = shift; my $name = shift; - for my $super ($class->meta->linearized_isa) { + for my $super ($class->linearized_isa) { my $super_attr = $super->can("meta") && $super->meta->get_attribute($name) or next; 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 throw_error{ + my $self = shift; + + my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class'; + $metaclass->throw_error(@_, depth => 1); } 1; @@ -333,7 +264,7 @@ installed. Some error checking is done. =head2 name -> AttributeName -=head2 class -> OwnerClass +=head2 associated_class -> OwnerClass =head2 is_required -> Bool @@ -377,31 +308,20 @@ 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 +=head2 verify_against_type_constraint Item -> 1 | ERROR -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. +Checks that the given value passes this attribute's type constraint. Returns 1 +on success, otherwise Ces. -=head2 find_type_constraint -> CODE +=head2 canonicalize_args Name, %args -> %args -Returns a code reference which can be used to check that a given value passes -this attribute's type constraint; +Canonicalizes some arguments to create. In particular, C is +canonicalized into C, C, etc. -=head2 verify_type_constraint Item -> 1 | ERROR +=head2 validate_args Name, \%args -> 1 | ERROR -Checks that the given value passes this attribute's type constraint. Returns 1 -on success, otherwise Ces. +Checks that the arguments to create the attribute (ie those specified by +C) are valid. =head2 clone_parent OwnerClass, AttributeName, %args -> Mouse::Meta::Attribute