Always load Mouse::Util first, which will be load Mouse::XS in the future
[gitmo/Mouse.git] / lib / Mouse / Meta / Attribute.pm
index f462add..429b6f9 100644 (file)
-#!/usr/bin/env perl
 package Mouse::Meta::Attribute;
 use strict;
 use warnings;
-require overload;
 
-use Carp 'confess';
-require Mouse::Util;
+use Mouse::Util;
 
-sub new {
-    my $class = shift;
-    my %args  = @_;
-
-    my $name = $args{name};
-
-    $args{init_arg} = $name
-        unless exists $args{init_arg};
-
-    $args{is} ||= '';
-
-    bless \%args, $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 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 find_type_constraint      { $_[0]->{find_type_constraint}  }
-sub type_constraint_as_string {
-    ref($_[0]->{type_constraint}) eq 'ARRAY' ? join '|', @{ $_[0]->{type_constraint} } : $_[0]->{type_constraint}
-}
-
-sub _create_args {
-    $_[0]->{_create_args} = $_[1] if @_ > 1;
-    $_[0]->{_create_args}
-}
-
-sub inlined_name {
-    my $self = shift;
-    my $name = $self->name;
-    my $key   = "'" . $name . "'";
-    return $key;
-}
+use Mouse::Meta::TypeConstraint;
+use Mouse::Meta::Method::Accessor;
 
-sub generate_accessor {
-    my $attribute = shift;
-
-    my $name          = $attribute->name;
-    my $default       = $attribute->default;
-    my $type          = $attribute->type_constraint_as_string;
-    my $constraint    = $attribute->find_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 $self  = '$_[0]';
-    my $key   = $attribute->inlined_name;
-
-    my $accessor = "sub {\n";
-    if ($attribute->_is_metadata eq 'rw') {
-        $accessor .= 'if (scalar(@_) >= 2) {' . "\n";
-
-        my $value = '$_[1]';
-
-        if ($constraint) {
-            $accessor .= 'my $val = ';
-            if ($should_coerce) {
-                $accessor .= '$attribute->coerce_constraint('.$value.');';
-            } else {
-                $accessor .= $value.';';
-            }
-            $accessor .= 'local $_ = $val;';
-            $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");
-            }' . "\n";
-            $value = '$val';
-        }
-
-        # if there's nothing left to do for the attribute we can return during
-        # this setter
-        $accessor .= 'return ' if !$is_weak && !$trigger && !$should_deref;
-
-        $accessor .= $self.'->{'.$key.'} = '.$value.';' . "\n";
-
-        if ($is_weak) {
-            $accessor .= 'Mouse::Util::weaken('.$self.'->{'.$key.'}) if ref('.$self.'->{'.$key.'});' . "\n";
-        }
+sub new {
+    my ($class, $name, %options) = @_;
 
-        if ($trigger) {
-            $accessor .= '$trigger->('.$self.', '.$value.', $attribute);' . "\n";
-        }
+    $options{name} = $name;
 
-        $accessor .= "}\n";
-    }
-    else {
-        $accessor .= 'confess "Cannot assign a value to a read-only accessor" if scalar(@_) >= 2;' . "\n";
-    }
+    $options{init_arg} = $name
+        unless exists $options{init_arg};
 
-    if ($attribute->is_lazy) {
-        $accessor .= $self.'->{'.$key.'} = ';
+    my $is = $options{is} ||= '';
 
-        $accessor .= $attribute->has_builder
-                ? $self.'->$builder'
-                    : ref($default) eq 'CODE'
-                    ? '$default->('.$self.')'
-                    : '$default';
-        $accessor .= ' if !exists '.$self.'->{'.$key.'};' . "\n";
+    if($is eq 'rw'){
+        $options{accessor} = $name if !exists $options{accessor};
     }
-
-    if ($should_deref) {
-        my $type_constraint = $attribute->type_constraint;
-        if (!ref($type_constraint) && $type_constraint eq 'ArrayRef') {
-            $accessor .= 'if (wantarray) {
-                return @{ '.$self.'->{'.$key.'} || [] };
-            }';
-        }
-        else {
-            $accessor .= 'if (wantarray) {
-                return %{ '.$self.'->{'.$key.'} || {} };
-            }';
-        }
+    elsif($is eq 'ro'){
+        $options{reader}   = $name if !exists $options{reader};
     }
 
-    $accessor .= 'return '.$self.'->{'.$key.'};
-    }';
-
-    my $sub = eval $accessor;
-    confess $@ if $@;
-    return $sub;
+    bless \%options, $class;
 }
 
-sub generate_predicate {
-    my $attribute = shift;
-    my $key = $attribute->inlined_name;
-
-    my $predicate = 'sub { exists($_[0]->{'.$key.'}) }';
-
-    my $sub = eval $predicate;
-    confess $@ if $@;
-    return $sub;
-}
-
-sub generate_clearer {
-    my $attribute = shift;
-    my $key = $attribute->inlined_name;
-
-    my $clearer = 'sub { delete($_[0]->{'.$key.'}) }';
-
-    my $sub = eval $clearer;
-    confess $@ if $@;
-    return $sub;
+# 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}          }
 
-sub generate_handles {
-    my $attribute = shift;
-    my $reader = $attribute->name;
-    my %handles = $attribute->_canonicalize_handles($attribute->handles);
-
-    my %method_map;
+# predicates
 
-    for my $local_method (keys %handles) {
-        my $remote_method = $handles{$local_method};
+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 $method = 'sub {
-            my $self = shift;
-            $self->$reader->$remote_method(@_)
-        }';
-
-        $method_map{$local_method} = eval $method;
-        confess $@ if $@;
-    }
+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}         }
 
-    return \%method_map;
+sub _create_args {
+    $_[0]->{_create_args} = $_[1] if @_ > 1;
+    $_[0]->{_create_args}
 }
 
+sub accessor_metaclass { 'Mouse::Meta::Method::Accessor' }
+
 sub create {
     my ($self, $class, $name, %args) = @_;
 
-    $args{name} = $name;
+    $args{name}             = $name;
     $args{associated_class} = $class;
 
     %args = $self->canonicalize_args($name, %args);
@@ -213,58 +91,29 @@ sub create {
 
     if (exists $args{isa}) {
         my $type_constraint = delete $args{isa};
-        $type_constraint =~ s/\s//g;
-        my @type_constraints = split /\|/, $type_constraint;
-
-        my $code;
-        my $optimized_constraints = Mouse::TypeRegistry->optimized_constraints;
-        if (@type_constraints == 1) {
-            $code = $optimized_constraints->{$type_constraints[0]} ||
-                sub { Mouse::Util::blessed($_) && Mouse::Util::blessed($_) eq $type_constraints[0] };
-            $args{type_constraint} = $type_constraints[0];
-        } else {
-            my @code_list = map {
-                my $type = $_;
-                $optimized_constraints->{$type} ||
-                    sub { Mouse::Util::blessed($_) && Mouse::Util::blessed($_) eq $type }
-            } @type_constraints;
-            $code = sub {
-                for my $code (@code_list) {
-                    return 1 if $code->();
-                }
-                return 0;
-            };
-            $args{type_constraint} = \@type_constraints;
-        }
-        $args{find_type_constraint} = $code;
+        $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);
 
     $class->add_attribute($attribute);
 
-    # 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 $associated_methods = 0;
 
-    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);
+    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++;
         }
     }
 
-    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});
-        }
+    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?)});
+
     }
 
     return $attribute;
@@ -298,58 +147,57 @@ sub validate_args {
     my $name = shift;
     my $args = shift;
 
-    confess "You can not use lazy_build and default for the same attribute ($name)"
+    $self->throw_error("You can not use lazy_build and default for the same attribute ($name)")
         if $args->{lazy_build} && exists $args->{default};
 
-    confess "You cannot have lazy attribute ($name) without specifying a default value for it"
+    $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 "References are not allowed as default values, you must wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])"
+    $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 without specifying a type constraint on attribute ($name)"
+    $self->throw_error("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)"
+    $self->throw_error("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 'HASH') {
-            Carp::carp "HASH-based form of trigger has been removed. Only the coderef form of triggers are now supported.";
+            $self->throw_error("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)"
+        $self->throw_error("Trigger must be a CODE ref on attribute ($name)")
             if ref($args->{trigger}) ne 'CODE';
     }
 
     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;
 
-    my $type = $self->type_constraint_as_string
-        or return 1;
-    my $constraint = $self->find_type_constraint;
+    local $_ = $value;
+    return 1 if $tc->check($value);
 
-    return 1 if $constraint->($_);
+    $self->verify_type_constraint_error($self->name, $value, $tc);
+}
 
-    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 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 {
-    my($self, $value) = @_;
-    my $type = $self->type_constraint
-        or return $value;
-    return Mouse::TypeRegistry->typecast_constraints($self->associated_class->name, $self->find_type_constraint, $type, $value);
+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 {
@@ -363,7 +211,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");
     }
 }
 
@@ -387,7 +235,14 @@ 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 throw_error{
+    my $self = shift;
+
+    my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class';
+    $metaclass->throw_error(@_, depth => 1);
 }
 
 1;
@@ -455,28 +310,7 @@ 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 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.