Move MethodAccessor stuff to Attribute
[gitmo/Mouse.git] / lib / Mouse / Meta / Attribute.pm
index 230efb5..43b796a 100644 (file)
-#!/usr/bin/env perl
 package Mouse::Meta::Attribute;
 use strict;
 use warnings;
+require overload;
 
 use Carp 'confess';
-use Scalar::Util qw/blessed weaken/;
+use Scalar::Util ();
+use Mouse::Meta::TypeConstraint;
 
 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} ||= '';
+    $options{is} ||= '';
 
-    bless \%args, $class;
+    bless \%options, $class;
 }
 
-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 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}         }
+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();
+}
+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 _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 $type       = $attribute->type_constraint;
-    my $constraint = $attribute->find_type_constraint;
-    my $builder    = $attribute->builder;
-
-    my $trigger = $attribute->trigger;
-    my $before  = $trigger->{before};
-    my $after   = $trigger->{after};
-    my $around  = $trigger->{around};
+sub inlined_name {
+    my $self = shift;
+    my $name = $self->name;
+    my $key   = "'" . $name . "'";
+    return $key;
+}
 
-    my $accessor = 'sub {
-        my $self = shift;';
+sub generate_accessor_method_inline {
+    my ($attribute) = @_;
 
-    if ($attribute->_is_metadata eq 'rw') {
-        $accessor .= 'if (@_) {
-            local $_ = $_[0];';
+    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;
 
-        if ($before) {
-            $accessor .= '$before->($self, $_, $attribute);';
-        }
+    my $compiled_type_constraint    = $constraint ? $constraint->{_compiled_type_constraint} : undef;
 
-        if ($around) {
-            $accessor .= '$around->(sub {
-                my $self = shift;
-                $_ = $_[0];
-            ';
-        }
+    my $self  = '$_[0]';
+    my $key   = $attribute->inlined_name;
 
-            if ($constraint) {
-                $accessor .= 'unless ($constraint->()) {
-                        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");
-                }'
+    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";
             }
+        }
 
-            $accessor .= '$self->{$key} = $_;';
+        # if there's nothing left to do for the attribute we can return during
+        # this setter
+        $accessor .= 'return ' if !$is_weak && !$trigger && !$should_deref;
 
-            if ($attribute->is_weak_ref) {
-                $accessor .= 'Scalar::Util::weaken($self->{$key}) if ref($self->{$key});';
-            }
+        $accessor .= $self.'->{'.$key.'} = '.$value.';' . "\n";
 
-        if ($around) {
-            $accessor .= '}, $self, $_, $attribute);';
+        if ($is_weak) {
+            $accessor .= 'Scalar::Util::weaken('.$self.'->{'.$key.'}) if ref('.$self.'->{'.$key.'});' . "\n";
         }
 
-        if ($after) {
-            $accessor .= '$after->($self, $_, $attribute);';
+        if ($trigger) {
+            $accessor .= '$trigger->('.$self.', '.$value.');' . "\n";
         }
 
-        $accessor .= '}';
+        $accessor .= "}\n";
     }
     else {
-        $accessor .= 'confess "Cannot assign a value to a read-only accessor" if @_;';
+        $accessor .= 'Carp::confess("Cannot assign a value to a read-only accessor") if scalar(@_) >= 2;' . "\n";
     }
 
     if ($attribute->is_lazy) {
-        $accessor .= '$self->{$key} = ';
+        $accessor .= $self.'->{'.$key.'} = ';
 
         $accessor .= $attribute->has_builder
-                   ? '$self->$builder'
-                     : ref($default) eq 'CODE'
-                     ? '$default->($self)'
-                     : '$default';
-
-        $accessor .= ' if !exists($self->{$key});';
+                ? $self.'->$builder'
+                    : ref($default) eq 'CODE'
+                    ? '$default->('.$self.')'
+                    : '$default';
+        $accessor .= ' if !exists '.$self.'->{'.$key.'};' . "\n";
     }
 
-    if ($attribute->should_auto_deref) {
-        if ($attribute->type_constraint eq 'ArrayRef') {
+    if ($should_deref) {
+        if (ref($constraint) && $constraint->name =~ '^ArrayRef\b') {
             $accessor .= 'if (wantarray) {
-                return @{ $self->{$key} || [] };
+                return @{ '.$self.'->{'.$key.'} || [] };
             }';
         }
         else {
             $accessor .= 'if (wantarray) {
-                return %{ $self->{$key} || {} };
+                return %{ '.$self.'->{'.$key.'} || {} };
             }';
         }
     }
 
-    $accessor .= 'return $self->{$key};
+    $accessor .= 'return '.$self.'->{'.$key.'};
     }';
 
-    return eval $accessor;
+    my $sub = eval $accessor;
+    Carp::confess($@) if $@;
+    return $sub;
 }
 
+
 sub generate_predicate {
     my $attribute = shift;
-    my $key = $attribute->name;
+    my $key = $attribute->inlined_name;
 
-    my $predicate = 'sub { exists($_[0]->{$key}) }';
+    my $predicate = 'sub { exists($_[0]->{'.$key.'}) }';
 
-    return eval $predicate;
+    my $sub = eval $predicate;
+    confess $@ if $@;
+    return $sub;
 }
 
 sub generate_clearer {
     my $attribute = shift;
-    my $key = $attribute->name;
+    my $key = $attribute->inlined_name;
 
-    my $predicate = 'sub { delete($_[0]->{$key}) }';
+    my $clearer = 'sub { delete($_[0]->{'.$key.'}) }';
 
-    return eval $predicate;
+    my $sub = eval $clearer;
+    confess $@ if $@;
+    return $sub;
 }
 
 sub generate_handles {
@@ -171,10 +201,11 @@ sub generate_handles {
 
         my $method = 'sub {
             my $self = shift;
-            $self->$reader->$remote_method(@_)
+            $self->'.$reader.'->'.$remote_method.'(@_)
         }';
 
         $method_map{$local_method} = eval $method;
+        confess $@ if $@;
     }
 
     return \%method_map;
@@ -189,10 +220,22 @@ sub create {
     %args = $self->canonicalize_args($name, %args);
     $self->validate_args($name, \%args);
 
-    $args{type_constraint} = delete $args{isa}
-        if exists $args{isa};
+    $args{should_coerce} = delete $args{coerce}
+        if exists $args{coerce};
+
+    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'
+        ;
+
+        my $type_constraint = delete $args{isa};
+        $args{type_constraint}= Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($type_constraint);
+    }
 
-    my $attribute = $self->new(%args);
+    my $attribute = $self->new($name, %args);
 
     $attribute->_create_args(\%args);
 
@@ -200,8 +243,8 @@ sub create {
 
     # install an accessor
     if ($attribute->_is_metadata eq 'rw' || $attribute->_is_metadata eq 'ro') {
-        my $accessor = $attribute->generate_accessor;
-        $class->add_method($name => $accessor);
+        my $code = $attribute->generate_accessor_method_inline();
+        $class->add_method($name => $code);
     }
 
     for my $method (qw/predicate clearer/) {
@@ -268,51 +311,40 @@ sub validate_args {
 
     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';
+        && $args->{isa} !~ /^(?:ArrayRef|HashRef)(?:\[.*\])?$/;
 
     if ($args->{trigger}) {
-        if (ref($args->{trigger}) eq 'CODE') {
-            $args->{trigger} = {
-                after => $args->{trigger},
-            };
-        }
-        elsif (ref($args->{trigger}) eq 'HASH') {
-            Carp::carp "HASH-based form of trigger is deprecated. Please switch back to using the coderef form of 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.";
         }
 
         confess "Trigger must be a CODE ref on attribute ($name)"
-            if ref($args->{trigger}) ne 'HASH';
+            if ref($args->{trigger}) ne 'CODE';
     }
 
     return 1;
 }
 
-sub find_type_constraint {
-    my $self = shift;
-    my $type = $self->type_constraint;
-
-    return unless $type;
+sub verify_against_type_constraint {
+    my ($self, $value) = @_;
+    my $tc = $self->type_constraint;
+    return 1 unless $tc;
 
-    my $checker = Mouse::TypeRegistry->optimized_constraints->{$type};
-    return $checker if $checker;
+    local $_ = $value;
+    return 1 if $tc->check($value);
 
-    return sub { blessed($_) && blessed($_) eq $type };
+    $self->verify_type_constraint_error($self->name, $value, $tc);
 }
 
-sub verify_type_constraint {
-    my $self = shift;
-    local $_ = shift;
-
-    my $type = $self->type_constraint
-        or return 1;
-    my $constraint = $self->find_type_constraint;
-
-    return 1 if $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));
+}
 
-    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 {
@@ -434,12 +466,7 @@ Creates a new code reference for the attribute's clearer.
 
 Creates a new code reference for each of the attribute's handles methods.
 
-=head2 find_type_constraint -> CODE
-
-Returns a code reference which can be used to check that a given value passes
-this attribute's type constraint;
-
-=head2 verify_type_constraint Item -> 1 | ERROR
+=head2 verify_against_type_constraint Item -> 1 | ERROR
 
 Checks that the given value passes this attribute's type constraint. Returns 1
 on success, otherwise C<confess>es.