recalculating the method map updates the cache flag
[gitmo/Moose.git] / lib / Moose / Meta / Class.pm
index 9c99bfc..dcc2e09 100644 (file)
@@ -4,18 +4,77 @@ package Moose::Meta::Class;
 use strict;
 use warnings;
 
+use Class::MOP;
+
 use Carp         'confess';
 use Scalar::Util 'weaken', 'blessed';
 
-our $VERSION = '0.04';
+our $VERSION   = '0.56';
+our $AUTHORITY = 'cpan:STEVAN';
+
+use Moose::Meta::Method::Overriden;
+use Moose::Meta::Method::Augmented;
 
 use base 'Class::MOP::Class';
 
-__PACKAGE__->meta->add_attribute('@:roles' => (
+__PACKAGE__->meta->add_attribute('roles' => (
     reader  => 'roles',
     default => sub { [] }
 ));
 
+sub initialize {
+    my $class = shift;
+    my $pkg   = shift;
+    return Class::MOP::get_metaclass_by_name($pkg) 
+        || $class->SUPER::initialize($pkg,
+                'attribute_metaclass' => 'Moose::Meta::Attribute',
+                'method_metaclass'    => 'Moose::Meta::Method',
+                'instance_metaclass'  => 'Moose::Meta::Instance',
+                @_
+            );    
+}
+
+sub create {
+    my ($self, $package_name, %options) = @_;
+    
+    (ref $options{roles} eq 'ARRAY')
+        || confess "You must pass an ARRAY ref of roles"
+            if exists $options{roles};
+    
+    my $class = $self->SUPER::create($package_name, %options);
+    
+    if (exists $options{roles}) {
+        Moose::Util::apply_all_roles($class, @{$options{roles}});
+    }
+    
+    return $class;
+}
+
+my %ANON_CLASSES;
+
+sub create_anon_class {
+    my ($self, %options) = @_;
+
+    my $cache_ok = delete $options{cache};
+    
+    # something like Super::Class|Super::Class::2=Role|Role::1
+    my $cache_key = join '=' => (
+        join('|', sort @{$options{superclasses} || []}),
+        join('|', sort @{$options{roles}        || []}),
+    );
+    
+    if ($cache_ok && defined $ANON_CLASSES{$cache_key}) {
+        return $ANON_CLASSES{$cache_key};
+    }
+    
+    my $new_class = $self->SUPER::create_anon_class(%options);
+
+    $ANON_CLASSES{$cache_key} = $new_class
+        if $cache_ok;
+
+    return $new_class;
+}
+
 sub add_role {
     my ($self, $role) = @_;
     (blessed($role) && $role->isa('Moose::Meta::Role'))
@@ -23,130 +82,345 @@ sub add_role {
     push @{$self->roles} => $role;
 }
 
+sub calculate_all_roles {
+    my $self = shift;
+    my %seen;
+    grep { !$seen{$_->name}++ } map { $_->calculate_all_roles } @{ $self->roles };
+}
+
 sub does_role {
     my ($self, $role_name) = @_;
     (defined $role_name)
         || confess "You must supply a role name to look for";
-    foreach my $role (@{$self->roles}) {
-        return 1 if $role->name eq $role_name;
+    foreach my $class ($self->class_precedence_list) {
+        next unless $class->can('meta') && $class->meta->can('roles');
+        foreach my $role (@{$class->meta->roles}) {
+            return 1 if $role->does_role($role_name);
+        }
     }
     return 0;
 }
 
+sub excludes_role {
+    my ($self, $role_name) = @_;
+    (defined $role_name)
+        || confess "You must supply a role name to look for";
+    foreach my $class ($self->class_precedence_list) {
+        next unless $class->can('meta');
+        # NOTE:
+        # in the pretty rare instance when a Moose metaclass
+        # is itself extended with a role, this check needs to
+        # be done since some items in the class_precedence_list
+        # might in fact be Class::MOP based still.
+        next unless $class->meta->can('roles');
+        foreach my $role (@{$class->meta->roles}) {
+            return 1 if $role->excludes_role($role_name);
+        }
+    }
+    return 0;
+}
+
+sub new_object {
+    my ($class, %params) = @_;
+    my $self = $class->SUPER::new_object(%params);
+    foreach my $attr ($class->compute_all_applicable_attributes()) {
+        # if we have a trigger, then ...
+        if ($attr->can('has_trigger') && $attr->has_trigger) {
+            # make sure we have an init-arg ...
+            if (defined(my $init_arg = $attr->init_arg)) {
+                # now make sure an init-arg was passes ...
+                if (exists $params{$init_arg}) {
+                    # and if get here, fire the trigger
+                    $attr->trigger->(
+                        $self, 
+                        # check if there is a coercion
+                        ($attr->should_coerce
+                            # and if so, we need to grab the 
+                            # value that is actually been stored
+                            ? $attr->get_read_method_ref->($self)
+                            # otherwise, just get the value from
+                            # the constructor params
+                            : $params{$init_arg}), 
+                        $attr
+                    );
+                }
+            }       
+        }
+    }
+    return $self;
+}
+
 sub construct_instance {
     my ($class, %params) = @_;
-    my $instance = $params{'__INSTANCE__'} || {};
+    my $meta_instance = $class->get_meta_instance;
+    # FIXME:
+    # the code below is almost certainly incorrect
+    # but this is foreign inheritence, so we might
+    # have to kludge it in the end.
+    my $instance = $params{'__INSTANCE__'} || $meta_instance->create_instance();
     foreach my $attr ($class->compute_all_applicable_attributes()) {
-        my $init_arg = $attr->init_arg();
-        # try to fetch the init arg from the %params ...
-        my $val;        
-        if (exists $params{$init_arg}) {
-            $val = $params{$init_arg};
+        $attr->initialize_instance_slot($meta_instance, $instance, \%params);
+    }
+    return $instance;
+}
+
+# FIXME:
+# This is ugly
+sub get_method_map {
+    my $self = shift;
+
+    my $current = Class::MOP::check_package_cache_flag($self->name);
+
+    if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) {
+        return $self->{'methods'};
+    }
+
+    $self->{_package_cache_flag} = $current;
+
+    my $map  = $self->{'methods'};
+
+    my $class_name       = $self->name;
+    my $method_metaclass = $self->method_metaclass;
+
+    my %all_code = $self->get_all_package_symbols('CODE');
+
+    foreach my $symbol (keys %all_code) {
+        my $code = $all_code{$symbol};
+
+        next if exists  $map->{$symbol} &&
+                defined $map->{$symbol} &&
+                        $map->{$symbol}->body == $code;
+
+        my ($pkg, $name) = Class::MOP::get_code_info($code);
+
+        if ($pkg->can('meta')
+            # NOTE:
+            # we don't know what ->meta we are calling
+            # here, so we need to be careful cause it
+            # just might blow up at us, or just complain
+            # loudly (in the case of Curses.pm) so we
+            # just be a little overly cautious here.
+            # - SL
+            && eval { no warnings; blessed($pkg->meta) }
+            && $pkg->meta->isa('Moose::Meta::Role')) {
+            #my $role = $pkg->meta->name;
+            #next unless $self->does_role($role);
         }
         else {
-            # skip it if it's lazy
-            next if $attr->is_lazy;
-            # and die if it is required            
-            confess "Attribute (" . $attr->name . ") is required" 
-                if $attr->is_required
-        }
-        # if nothing was in the %params, we can use the 
-        # attribute's default value (if it has one)
-        if (!defined $val && $attr->has_default) {
-            $val = $attr->default($instance); 
-        }
-               if (defined $val) {
-                   if ($attr->has_type_constraint) {
-                   if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
-                       $val = $attr->type_constraint->coercion->coerce($val);
-                   }   
-                (defined($attr->type_constraint->check($val))) 
-                    || confess "Attribute (" . $attr->name . ") does not pass the type contraint with '$val'";                 
+            
+            # NOTE:
+            # in 5.10 constant.pm the constants show up 
+            # as being in the right package, but in pre-5.10
+            # they show up as constant::__ANON__ so we 
+            # make an exception here to be sure that things
+            # work as expected in both.
+            # - SL
+            unless ($pkg eq 'constant' && $name eq '__ANON__') {
+                next if ($pkg  || '') ne $class_name ||
+                        (($name || '') ne '__ANON__' && ($pkg  || '') ne $class_name);
             }
-               }
-        $instance->{$attr->name} = $val;
-        if (defined $val && $attr->is_weak_ref) {
-            weaken($instance->{$attr->name});
+
         }
+
+        $map->{$symbol} = $method_metaclass->wrap(
+            $code,
+            package_name => $class_name,
+            name         => $symbol
+        );
     }
-    return $instance;
+
+    return $map;
 }
 
-sub has_method {
-    my ($self, $method_name) = @_;
-    (defined $method_name && $method_name)
-        || confess "You must define a method name";    
+### ---------------------------------------------
 
-    my $sub_name = ($self->name . '::' . $method_name);   
-    
-    no strict 'refs';
-    return 0 if !defined(&{$sub_name});        
-       my $method = \&{$sub_name};
-       
-       return 1 if blessed($method) && $method->isa('Moose::Meta::Role::Method');
-    return $self->SUPER::has_method($method_name);    
+sub add_attribute {
+    my $self = shift;
+    $self->SUPER::add_attribute(
+        (blessed $_[0] && $_[0]->isa('Class::MOP::Attribute')
+            ? $_[0] 
+            : $self->_process_attribute(@_))    
+    );
 }
 
-
 sub add_override_method_modifier {
     my ($self, $name, $method, $_super_package) = @_;
-    # need this for roles ...
-    $_super_package ||= $self->name;
-    my $super = $self->find_next_method_by_name($name);
-    (defined $super)
-        || confess "You cannot override '$name' because it has no super method";    
-    $self->add_method($name => bless sub {
-        my @args = @_;
-        no strict   'refs';
-        no warnings 'redefine';
-        local *{$_super_package . '::super'} = sub { $super->(@args) };
-        return $method->(@args);
-    } => 'Moose::Meta::Method::Overriden');
+
+    (!$self->has_method($name))
+        || confess "Cannot add an override method if a local method is already present";
+
+    $self->add_method($name => Moose::Meta::Method::Overriden->new(
+        method  => $method,
+        class   => $self,
+        package => $_super_package, # need this for roles
+        name    => $name,
+    ));
 }
 
 sub add_augment_method_modifier {
-    my ($self, $name, $method) = @_;  
-    my $super = $self->find_next_method_by_name($name);
-    (defined $super)
-        || confess "You cannot augment '$name' because it has no super method";    
-    my $_super_package = $super->package_name;   
-    # BUT!,... if this is an overriden method ....     
-    if ($super->isa('Moose::Meta::Method::Overriden')) {
-        # we need to be sure that we actually 
-        # find the next method, which is not 
-        # an 'override' method, the reason is
-        # that an 'override' method will not 
-        # be the one calling inner()
-        my $real_super = $self->_find_next_method_by_name_which_is_not_overridden($name);        
-        $_super_package = $real_super->package_name;
-    }      
-    $self->add_method($name => sub {
-        my @args = @_;
-        no strict   'refs';
-        no warnings 'redefine';
-        local *{$_super_package . '::inner'} = sub { $method->(@args) };
-        return $super->(@args);
-    });    
+    my ($self, $name, $method) = @_;
+    (!$self->has_method($name))
+        || confess "Cannot add an augment method if a local method is already present";
+
+    $self->add_method($name => Moose::Meta::Method::Augmented->new(
+        method  => $method,
+        class   => $self,
+        name    => $name,
+    ));
 }
 
+## Private Utility methods ...
+
 sub _find_next_method_by_name_which_is_not_overridden {
     my ($self, $name) = @_;
-    my @methods = $self->find_all_methods_by_name($name);
-    foreach my $method (@methods) {
-        return $method->{code} 
+    foreach my $method ($self->find_all_methods_by_name($name)) {
+        return $method->{code}
             if blessed($method->{code}) && !$method->{code}->isa('Moose::Meta::Method::Overriden');
     }
     return undef;
 }
 
-package Moose::Meta::Method::Overriden;
+sub _fix_metaclass_incompatability {
+    my ($self, @superclasses) = @_;
+    foreach my $super (@superclasses) {
+        # don't bother if it does not have a meta.
+        next unless $super->can('meta');
+        next unless $super->meta->isa("Class::MOP::Class");
+        # get the name, make sure we take
+        # immutable classes into account
+        my $super_meta_name = ($super->meta->is_immutable
+                                ? $super->meta->get_mutable_metaclass_name
+                                : blessed($super->meta));
+        # if it's meta is a vanilla Moose,
+        # then we can safely ignore it.
+        next if $super_meta_name eq 'Moose::Meta::Class';
+        # but if we have anything else,
+        # we need to check it out ...
+        unless (# see if of our metaclass is incompatible
+                ($self->isa($super_meta_name) &&
+                 # and see if our instance metaclass is incompatible
+                 $self->instance_metaclass->isa($super->meta->instance_metaclass)) &&
+                # ... and if we are just a vanilla Moose
+                $self->isa('Moose::Meta::Class')) {
+            # re-initialize the meta ...
+            my $super_meta = $super->meta;
+            # NOTE:
+            # We might want to consider actually
+            # transfering any attributes from the
+            # original meta into this one, but in
+            # general you should not have any there
+            # at this point anyway, so it's very
+            # much an obscure edge case anyway
+            $self = $super_meta->reinitialize($self->name => (
+                'attribute_metaclass' => $super_meta->attribute_metaclass,
+                'method_metaclass'    => $super_meta->method_metaclass,
+                'instance_metaclass'  => $super_meta->instance_metaclass,
+            ));
+        }
+    }
+    return $self;
+}
 
-use strict;
-use warnings;
+# NOTE:
+# this was crap anyway, see
+# Moose::Util::apply_all_roles
+# instead
+sub _apply_all_roles { 
+    Carp::croak 'DEPRECATED: use Moose::Util::apply_all_roles($meta, @roles) instead' 
+}
+
+sub _process_attribute {
+    my ( $self, $name, @args ) = @_;
+
+    @args = %{$args[0]} if scalar @args == 1 && ref($args[0]) eq 'HASH';
+
+    if ($name =~ /^\+(.*)/) {
+        return $self->_process_inherited_attribute($1, @args);
+    }
+    else {
+        return $self->_process_new_attribute($name, @args);
+    }
+}
+
+sub _process_new_attribute {
+    my ( $self, $name, @args ) = @_;
+
+    $self->attribute_metaclass->interpolate_class_and_new($name, @args);
+}
+
+sub _process_inherited_attribute {
+    my ($self, $attr_name, %options) = @_;
+    my $inherited_attr = $self->find_attribute_by_name($attr_name);
+    (defined $inherited_attr)
+        || confess "Could not find an attribute by the name of '$attr_name' to inherit from";
+    if ($inherited_attr->isa('Moose::Meta::Attribute')) {
+        return $inherited_attr->clone_and_inherit_options(%options);
+    }
+    else {
+        # NOTE:
+        # kind of a kludge to handle Class::MOP::Attributes
+        return $inherited_attr->Moose::Meta::Attribute::clone_and_inherit_options(%options);
+    }
+}
 
-our $VERSION = '0.01';
+## -------------------------------------------------
+
+use Moose::Meta::Method::Constructor;
+use Moose::Meta::Method::Destructor;
+
+# This could be done by using SUPER and altering ->options
+# I am keeping it this way to make it more explicit.
+sub create_immutable_transformer {
+    my $self = shift;
+    my $class = Class::MOP::Immutable->new($self, {
+       read_only   => [qw/superclasses/],
+       cannot_call => [qw/
+           add_method
+           alias_method
+           remove_method
+           add_attribute
+           remove_attribute
+           remove_package_symbol
+           add_role
+       /],
+       memoize     => {
+           class_precedence_list             => 'ARRAY',
+           compute_all_applicable_attributes => 'ARRAY',
+           get_meta_instance                 => 'SCALAR',
+           get_method_map                    => 'SCALAR',
+           # maybe ....
+           calculate_all_roles               => 'ARRAY',
+       },
+       # NOTE:
+       # this is ugly, but so are typeglobs, 
+       # so whattayahgonnadoboutit
+       # - SL
+       wrapped => { 
+           add_package_symbol => sub {
+               my $original = shift;
+               confess "Cannot add package symbols to an immutable metaclass" 
+                   unless (caller(2))[3] eq 'Class::MOP::Package::get_package_symbol'; 
+               goto $original->body;
+           },
+       },       
+    });
+    return $class;
+}
 
-use base 'Class::MOP::Method';
+sub make_immutable {
+    my $self = shift;
+    $self->SUPER::make_immutable
+      (
+       constructor_class => 'Moose::Meta::Method::Constructor',
+       destructor_class  => 'Moose::Meta::Method::Destructor',
+       inline_destructor => 1,
+       # NOTE:
+       # no need to do this,
+       # Moose always does it
+       inline_accessors  => 0,
+       @_,
+      );
+}
 
 1;
 
@@ -160,48 +434,109 @@ Moose::Meta::Class - The Moose metaclass
 
 =head1 DESCRIPTION
 
-This is a subclass of L<Class::MOP::Class> with Moose specific 
+This is a subclass of L<Class::MOP::Class> with Moose specific
 extensions.
 
-For the most part, the only time you will ever encounter an 
-instance of this class is if you are doing some serious deep 
-introspection. To really understand this class, you need to refer 
+For the most part, the only time you will ever encounter an
+instance of this class is if you are doing some serious deep
+introspection. To really understand this class, you need to refer
 to the L<Class::MOP::Class> documentation.
 
 =head1 METHODS
 
 =over 4
 
+=item B<initialize>
+
+=item B<create>
+
+Overrides original to accept a list of roles to apply to
+the created class.
+
+   my $metaclass = Moose::Meta::Class->create( 'New::Class', roles => [...] );
+
+=item B<create_anon_class>
+
+Overrides original to support roles and caching.
+
+   my $metaclass = Moose::Meta::Class->create_anon_class(
+       superclasses => ['Foo'],
+       roles        => [qw/Some Roles Go Here/],
+       cache        => 1,
+   );
+
+=item B<make_immutable>
+
+Override original to add default options for inlining destructor
+and altering the Constructor metaclass.
+
+=item B<create_immutable_transformer>
+
+Override original to lock C<add_role> and memoize C<calculate_all_roles>
+
+=item B<new_object>
+
+We override this method to support the C<trigger> attribute option.
+
 =item B<construct_instance>
 
-This provides some Moose specific extensions to this method, you 
-almost never call this method directly unless you really know what 
-you are doing. 
+This provides some Moose specific extensions to this method, you
+almost never call this method directly unless you really know what
+you are doing.
 
 This method makes sure to handle the moose weak-ref, type-constraint
-and type coercion features. 
+and type coercion features.
 
-=item B<has_method ($name)>
+=item B<get_method_map>
 
-This accomidates Moose::Meta::Role::Method instances, which are 
-aliased, instead of added, but still need to be counted as valid 
+This accommodates Moose::Meta::Role::Method instances, which are
+aliased, instead of added, but still need to be counted as valid
 methods.
 
 =item B<add_override_method_modifier ($name, $method)>
 
+This will create an C<override> method modifier for you, and install
+it in the package.
+
 =item B<add_augment_method_modifier ($name, $method)>
 
+This will create an C<augment> method modifier for you, and install
+it in the package.
+
+=item B<calculate_all_roles>
+
 =item B<roles>
 
+This will return an array of C<Moose::Meta::Role> instances which are
+attached to this class.
+
 =item B<add_role ($role)>
 
+This takes an instance of C<Moose::Meta::Role> in C<$role>, and adds it
+to the list of associated roles.
+
 =item B<does_role ($role_name)>
 
+This will test if this class C<does> a given C<$role_name>. It will
+not only check it's local roles, but ask them as well in order to
+cascade down the role hierarchy.
+
+=item B<excludes_role ($role_name)>
+
+This will test if this class C<excludes> a given C<$role_name>. It will
+not only check it's local roles, but ask them as well in order to
+cascade down the role hierarchy.
+
+=item B<add_attribute ($attr_name, %params|$params)>
+
+This method does the same thing as L<Class::MOP::Class::add_attribute>, but adds
+support for taking the C<$params> as a HASH ref.
+
 =back
 
 =head1 BUGS
 
-All complex software has bugs lurking in it, and this module is no 
+All complex software has bugs lurking in it, and this module is no
 exception. If you find a bug please either email me, or add the bug
 to cpan-RT.
 
@@ -211,11 +546,12 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006-2008 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>
 
 This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself. 
+it under the same terms as Perl itself.
+
+=cut
 
-=cut
\ No newline at end of file