adding lazy and handles to the has +foo form
[gitmo/Moose.git] / lib / Moose / Meta / Attribute.pm
index 2c5e01c..c1613da 100644 (file)
@@ -7,8 +7,10 @@ use warnings;
 use Scalar::Util 'blessed', 'weaken', 'reftype';
 use Carp         'confess';
 
-our $VERSION = '0.06';
+our $VERSION   = '0.11';
+our $AUTHORITY = 'cpan:STEVAN';
 
+use Moose::Meta::Method::Accessor;
 use Moose::Util::TypeConstraints ();
 
 use base 'Class::MOP::Attribute';
@@ -37,6 +39,10 @@ __PACKAGE__->meta->add_attribute('handles' => (
     reader    => 'handles',
     predicate => 'has_handles',
 ));
+__PACKAGE__->meta->add_attribute('documentation' => (
+    reader    => 'documentation',
+    predicate => 'has_documentation',
+));
 
 sub new {
        my ($class, $name, %options) = @_;
@@ -46,14 +52,23 @@ sub new {
 
 sub clone_and_inherit_options {
     my ($self, %options) = @_;
-    # you can change default, required and coerce 
+    # you can change default, required, coerce, documentation and lazy
     my %actual_options;
-    foreach my $legal_option (qw(default coerce required)) {
+    foreach my $legal_option (qw(default coerce required documentation lazy)) {
         if (exists $options{$legal_option}) {
             $actual_options{$legal_option} = $options{$legal_option};
             delete $options{$legal_option};
         }
     }
+    
+    # handles can only be added, not changed
+    if ($options{handles}) {
+        confess "You can only add the 'handles' option, you cannot change it"
+            if $self->has_handles;
+        $actual_options{handles} = $options{handles};
+        delete $options{handles};
+    }
+    
     # isa can be changed, but only if the 
     # new type is a subtype    
     if ($options{isa}) {
@@ -66,9 +81,14 @@ sub clone_and_inherit_options {
                    (defined $type_constraint)
                        || confess "Could not find the type constraint '" . $options{isa} . "'";
                }
+               # NOTE:
+               # check here to see if the new type 
+               # is a subtype of the old one
                ($type_constraint->is_subtype_of($self->type_constraint->name))
                    || confess "New type constraint setting must be a subtype of inherited one"
+                       # iff we have a type constraint that is ...
                        if $self->has_type_constraint;
+               # then we use it :)
                $actual_options{type_constraint} = $type_constraint;
         delete $options{isa};
     }
@@ -82,7 +102,7 @@ sub _process_options {
     
        if (exists $options->{is}) {
                if ($options->{is} eq 'ro') {
-                       $options->{reader} = $name;
+                       $options->{reader} ||= $name;
                        (!exists $options->{trigger})
                            || confess "Cannot have a trigger on a read-only attribute";
                }
@@ -160,9 +180,7 @@ sub _process_options {
        
        if (exists $options->{coerce} && $options->{coerce}) {
            (exists $options->{type_constraint})
-               || confess "You cannot have coercion without specifying a type constraint";
-           (!$options->{type_constraint}->isa('Moose::Meta::TypeConstraint::Union'))
-               || confess "You cannot have coercion with a type constraint union";             
+               || confess "You cannot have coercion without specifying a type constraint";             
         confess "You cannot have a weak reference to a coerced value"
             if $options->{weak_ref};           
        }       
@@ -170,17 +188,11 @@ sub _process_options {
        if (exists $options->{auto_deref} && $options->{auto_deref}) {
            (exists $options->{type_constraint})
                || confess "You cannot auto-dereference without specifying a type constraint";      
-           ($options->{type_constraint}->name =~ /^ArrayRef|HashRef$/)
+           ($options->{type_constraint}->is_a_type_of('ArrayRef') ||
+         $options->{type_constraint}->is_a_type_of('HashRef'))
                || confess "You cannot auto-dereference anything other than a ArrayRef or HashRef";             
        }
        
-    if (exists $options->{type_constraint} && $options->{type_constraint}->name =~ /^ArrayRef|HashRef$/) {
-        unless (exists $options->{default}) {
-            $options->{default} = sub { [] } if $options->{type_constraint}->name eq 'ArrayRef';
-            $options->{default} = sub { {} } if $options->{type_constraint}->name eq 'HashRef';            
-        }
-    }
-       
        if (exists $options->{lazy} && $options->{lazy}) {
            (exists $options->{default})
                || confess "You cannot have lazy attribute without specifying a default value for it";      
@@ -209,11 +221,12 @@ sub initialize_instance_slot {
     if (!defined $val && $self->has_default) {
         $val = $self->default($instance); 
     }
+    
        if (defined $val) {
            if ($self->has_type_constraint) {
                my $type_constraint = $self->type_constraint;
                    if ($self->should_coerce && $type_constraint->has_coercion) {
-                       $val = $type_constraint->coercion->coerce($val);
+                       $val = $type_constraint->coerce($val);
                    }   
             (defined($type_constraint->check($val))) 
                 || confess "Attribute (" . 
@@ -229,139 +242,88 @@ sub initialize_instance_slot {
         if ref $val && $self->is_weak_ref;
 }
 
-## Accessor inline subroutines
-
-sub _inline_check_constraint {
-       my ($self, $value) = @_;
-       return '' unless $self->has_type_constraint;
-       
-       # FIXME - remove 'unless defined($value) - constraint Undef
-       return sprintf <<'EOF', $value, $value, $value, $value
-defined($attr->type_constraint->check(%s))
-       || confess "Attribute (" . $attr->name . ") does not pass the type constraint ("
-       . $attr->type_constraint->name . ") with " . (defined(%s) ? "'%s'" : "undef")
-  if defined(%s);
-EOF
-}
-
-sub _inline_check_coercion {
-    my $self = shift;
-       return '' unless $self->should_coerce;
-    return 'my $val = $attr->type_constraint->coercion->coerce($_[1]);'
-}
-
-sub _inline_check_required {
-    my $self = shift;
-       return '' unless $self->is_required;
-    return 'defined($_[1]) || confess "Attribute ($attr_name) is required, so cannot be set to undef";'
-}
-
-sub _inline_check_lazy {
-    my $self = shift;
-       return '' unless $self->is_lazy;
-    return '$_[0]->{$attr_name} = ($attr->has_default ? $attr->default($_[0]) : undef)'
-         . 'unless exists $_[0]->{$attr_name};';
-}
+## Slot management
 
-
-sub _inline_store {
-       my ($self, $instance, $value) = @_;
-
-       my $mi = $self->associated_class->get_meta_instance;
-       my $slot_name = sprintf "'%s'", $self->slots;
-
-    my $code = $mi->inline_set_slot_value($instance, $slot_name, $value)    . ";";
-       $code   .= $mi->inline_weaken_slot_value($instance, $slot_name, $value) . ";"
-           if $self->is_weak_ref;
-    return $code;
-}
-
-sub _inline_trigger {
-       my ($self, $instance, $value) = @_;
-       return '' unless $self->has_trigger;
-       return sprintf('$attr->trigger->(%s, %s, $attr);', $instance, $value);
-}
-
-sub _inline_get {
-       my ($self, $instance) = @_;
-
-       my $mi = $self->associated_class->get_meta_instance;
-       my $slot_name = sprintf "'%s'", $self->slots;
-
-    return $mi->inline_get_slot_value($instance, $slot_name);
-}
-
-sub _inline_auto_deref {
-    my ( $self, $ref_value ) = @_;
-
-    return $ref_value unless $self->should_auto_deref;
-
-    my $type = $self->type_constraint->name;
-
-    my $sigil;
-    if ($type eq "ArrayRef") {
-        $sigil = '@';
-    } 
-    elsif ($type eq 'HashRef') {
-        $sigil = '%';
-    } 
-    else {
-        confess "Can not auto de-reference the type constraint '$type'";
+sub set_value {
+    my ($self, $instance, $value) = @_;
+    
+    my $attr_name = $self->name;
+    
+    if ($self->is_required) {
+        defined($value) 
+            || confess "Attribute ($attr_name) is required, so cannot be set to undef";
+    }
+    
+    if ($self->has_type_constraint) {
+        
+        my $type_constraint = $self->type_constraint;
+        
+        if ($self->should_coerce) {
+            $value = $type_constraint->coerce($value);           
+        }
+        defined($type_constraint->_compiled_type_constraint->($value))
+               || confess "Attribute ($attr_name) does not pass the type constraint ("
+               . $type_constraint->name . ") with " . (defined($value) ? ("'" . $value . "'") : "undef")
+          if defined($value);
+    }
+    
+    my $meta_instance = Class::MOP::Class->initialize(blessed($instance))
+                                         ->get_meta_instance;
+                                         
+    $meta_instance->set_slot_value($instance, $attr_name, $value);  
+      
+    if (ref $value && $self->is_weak_ref) {
+        $meta_instance->weaken_slot_value($instance, $attr_name);            
+    }
+    
+    if ($self->has_trigger) {
+        $self->trigger->($instance, $value, $self);
     }
-
-    "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
 }
 
-sub generate_accessor_method {
-    my ($attr, $attr_name) = @_;
-    my $value_name = $attr->should_coerce ? '$val' : '$_[1]';
-       my $mi = $attr->associated_class->get_meta_instance;
-       my $slot_name = sprintf "'%s'", $attr->slots;
-       my $inv = '$_[0]';
-    my $code = 'sub { '
-    . 'if (scalar(@_) == 2) {'
-        . $attr->_inline_check_required
-        . $attr->_inline_check_coercion
-        . $attr->_inline_check_constraint($value_name)
-               . $attr->_inline_store($inv, $value_name)
-               . $attr->_inline_trigger($inv, $value_name)
-    . ' }'
-    . $attr->_inline_check_lazy
-    . 'return ' . $attr->_inline_auto_deref($attr->_inline_get($inv))
-    . ' }';
-    my $sub = eval $code;
-    confess "Could not create accessor for '$attr_name' because $@ \n code: $code" if $@;
-    return $sub;    
+sub get_value {
+    my ($self, $instance) = @_;
+    
+    if ($self->is_lazy) {
+           unless ($self->has_value($instance)) {
+               if ($self->has_default) {
+                   my $default = $self->default($instance);
+                   $self->set_value($instance, $default);
+               }
+               else {
+                $self->set_value($instance, undef);
+               }
+           }   
+    }
+    
+    if ($self->should_auto_deref) {
+        
+        my $type_constraint = $self->type_constraint;
+
+        if ($type_constraint->is_a_type_of('ArrayRef')) {
+            my $rv = $self->SUPER::get_value($instance);
+            return unless defined $rv;
+            return wantarray ? @{ $rv } : $rv;
+        } 
+        elsif ($type_constraint->is_a_type_of('HashRef')) {
+            my $rv = $self->SUPER::get_value($instance);
+            return unless defined $rv;
+            return wantarray ? %{ $rv } : $rv;
+        } 
+        else {
+            confess "Can not auto de-reference the type constraint '" . $type_constraint->name . "'";
+        }
+               
+    }
+    else {
+        
+        return $self->SUPER::get_value($instance);
+    }    
 }
 
-sub generate_writer_method {
-    my ($attr, $attr_name) = @_; 
-    my $value_name = $attr->should_coerce ? '$val' : '$_[1]';
-       my $inv = '$_[0]';
-    my $code = 'sub { '
-    . $attr->_inline_check_required
-    . $attr->_inline_check_coercion
-       . $attr->_inline_check_constraint($value_name)
-       . $attr->_inline_store($inv, $value_name)
-       . $attr->_inline_trigger($inv, $value_name)
-    . ' }';
-    my $sub = eval $code;
-    confess "Could not create writer for '$attr_name' because $@ \n code: $code" if $@;
-    return $sub;    
-}
+## installing accessors 
 
-sub generate_reader_method {
-    my $attr = shift;
-    my $attr_name = $attr->slots;
-    my $code = 'sub {'
-    . 'confess "Cannot assign a value to a read-only accessor" if @_ > 1;'
-    . $attr->_inline_check_lazy
-    . 'return ' . $attr->_inline_auto_deref( '$_[0]->{$attr_name}' ) . ';'
-    . '}';
-    my $sub = eval $code;
-    confess "Could not create reader for '$attr_name' because $@ \n code: $code" if $@;
-    return $sub;
-}
+sub accessor_metaclass { 'Moose::Meta::Method::Accessor' }
 
 sub install_accessors {
     my $self = shift;
@@ -393,6 +355,13 @@ sub install_accessors {
             (!$associated_class->has_method($handle))
                 || confess "You cannot overwrite a locally defined method ($handle) with a delegation";
             
+            # NOTE:
+            # handles is not allowed to delegate
+            # any of these methods, as they will 
+            # override the ones in your class, which 
+            # is almost certainly not what you want.
+            next if $handle =~ /^BUILD|DEMOLISH$/ || Moose::Object->can($handle);
+            
             if ((reftype($method_to_call) || '') eq 'CODE') {
                 $associated_class->add_method($handle => $method_to_call);                
             }
@@ -402,7 +371,9 @@ sub install_accessors {
                     # we should check for lack of 
                     # a callable return value from 
                     # the accessor here 
-                    ((shift)->$accessor_name())->$method_to_call(@_);
+                    my $proxy = (shift)->$accessor_name();
+                    @_ = ($proxy, @_);
+                    goto &{ $proxy->can($method_to_call)};
                 });
             }
         }
@@ -416,23 +387,39 @@ sub install_accessors {
 sub _canonicalize_handles {
     my $self    = shift;
     my $handles = $self->handles;
-    if (ref($handles) eq 'HASH') {
-        return %{$handles};
-    }
-    elsif (ref($handles) eq 'ARRAY') {
-        return map { $_ => $_ } @{$handles};
-    }
-    elsif (ref($handles) eq 'Regexp') {
-        ($self->has_type_constraint)
-            || confess "Cannot delegate methods based on a RegExpr without a type constraint (isa)";
-        return map  { ($_ => $_) } 
-               grep {  $handles  } $self->_get_delegate_method_list;
-    }
-    elsif (ref($handles) eq 'CODE') {
-        return $handles->($self, $self->_find_delegate_metaclass);
+    if (my $handle_type = ref($handles)) {
+        if ($handle_type eq 'HASH') {
+            return %{$handles};
+        }
+        elsif ($handle_type eq 'ARRAY') {
+            return map { $_ => $_ } @{$handles};
+        }
+        elsif ($handle_type eq 'Regexp') {
+            ($self->has_type_constraint)
+                || confess "Cannot delegate methods based on a RegExpr without a type constraint (isa)";
+            return map  { ($_ => $_) } 
+                   grep { /$handles/ } $self->_get_delegate_method_list;
+        }
+        elsif ($handle_type eq 'CODE') {
+            return $handles->($self, $self->_find_delegate_metaclass);
+        }
+        else {
+            confess "Unable to canonicalize the 'handles' option with $handles";
+        }
     }
     else {
-        confess "Unable to canonicalize the 'handles' option with $handles";
+        my $role_meta = eval { $handles->meta };
+        if ($@) {
+            confess "Unable to canonicalize the 'handles' option with $handles because : $@";            
+        }
+
+        (blessed $role_meta && $role_meta->isa('Moose::Meta::Role'))
+            || confess "Unable to canonicalize the 'handles' option with $handles because ->meta is not a Moose::Meta::Role";
+        
+        return map { $_ => $_ } (
+            $role_meta->get_method_list, 
+            $role_meta->get_required_method_list
+        );
     }
 }
 
@@ -508,13 +495,13 @@ will behave just as L<Class::MOP::Attribute> does.
 
 =item B<initialize_instance_slot>
 
-=item B<generate_accessor_method>
+=item B<install_accessors>
 
-=item B<generate_writer_method>
+=item B<accessor_metaclass>
 
-=item B<generate_reader_method>
+=item B<get_value>
 
-=item B<install_accessors>
+=item B<set_value>
 
 =back
 
@@ -586,6 +573,16 @@ value of an attribute is assigned. The CODE ref will get two values,
 the invocant and the new value. This can be used to handle I<basic> 
 bi-directional relations.
 
+=item B<documentation>
+
+This is a string which contains the documentation for this attribute. 
+It serves no direct purpose right now, but it might in the future
+in some kind of automated documentation system perhaps.
+
+=item B<has_documentation>
+
+Returns true if this meta-attribute has any documentation.
+
 =back
 
 =head1 BUGS
@@ -602,7 +599,7 @@ Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006, 2007 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>