Implement strict constructors, which will warn unkown constructor arguments
[gitmo/Mouse.git] / lib / Mouse / Meta / Class.pm
index 42f824e..7b03c6f 100644 (file)
-#!/usr/bin/env perl
 package Mouse::Meta::Class;
-use strict;
-use warnings;
+use Mouse::Util qw/:meta get_linear_isa not_supported/; # enables strict and warnings
 
-use Scalar::Util 'blessed';
+use Scalar::Util qw/blessed weaken/;
 
-use MRO::Compat;
+use Mouse::Meta::Module;
+our @ISA = qw(Mouse::Meta::Module);
 
-do {
-    my %METACLASS_CACHE;
+sub attribute_metaclass;
+sub method_metaclass;
 
-    # because Mouse doesn't introspect existing classes, we're forced to
-    # only pay attention to other Mouse classes
-    sub _metaclass_cache {
-        my $class = shift;
-        my $name  = shift;
-        return $METACLASS_CACHE{$name};
-    }
+sub constructor_class;
+sub destructor_class;
 
-    sub initialize {
-        my $class = shift;
-        my $name  = shift;
-        $METACLASS_CACHE{$name} = $class->new(name => $name)
-            if !exists($METACLASS_CACHE{$name});
-        return $METACLASS_CACHE{$name};
-    }
-};
+my @MetaClassTypes = qw(
+    attribute_metaclass
+    method_metaclass
+    constructor_class
+    destructor_class
+);
 
-sub new {
-    my $class = shift;
-    my %args = @_;
+sub _construct_meta {
+    my($class, %args) = @_;
 
     $args{attributes} = {};
+    $args{methods}    = {};
+    $args{roles}      = [];
+
     $args{superclasses} = do {
         no strict 'refs';
-        \@{ $args{name} . '::ISA' };
+        \@{ $args{package} . '::ISA' };
     };
 
-    bless \%args, $class;
+    my $self = bless \%args, ref($class) || $class;
+    if(ref($self) ne __PACKAGE__){
+        $self->meta->_initialize_object($self, \%args);
+    }
+    return $self;
 }
 
-sub name { $_[0]->{name} }
+sub create_anon_class{
+    my $self = shift;
+    return $self->create(undef, @_);
+}
+
+sub is_anon_class;
+
+sub roles;
+
+sub calculate_all_roles {
+    my $self = shift;
+    my %seen;
+    return grep { !$seen{ $_->name }++ }
+           map  { $_->calculate_all_roles } @{ $self->roles };
+}
 
 sub superclasses {
     my $self = shift;
 
     if (@_) {
-        Mouse::load_class($_) for @_;
+        foreach my $super(@_){
+            Mouse::Util::load_class($super);
+            my $meta = Mouse::Util::get_metaclass_by_name($super);
+
+            next if not defined $meta;
+
+            if(Mouse::Util::is_a_metarole($meta)){
+                $self->throw_error("You cannot inherit from a Mouse Role ($super)");
+            }
+
+            next if $self->isa(ref $meta); # _superclass_meta_is_compatible
+
+            $self->_reconcile_with_superclass_meta($meta);
+        }
         @{ $self->{superclasses} } = @_;
     }
 
-    @{ $self->{superclasses} };
+    return @{ $self->{superclasses} };
+}
+
+sub _reconcile_with_superclass_meta {
+    my($self, $super_meta) = @_;
+
+    # find incompatible traits
+    my @incompatibles;
+    foreach my $metaclass_type(@MetaClassTypes){
+        my $super_c = $super_meta->$metaclass_type();
+        my $self_c  = $self->$metaclass_type();
+
+        if(!$super_c->isa($self_c)){
+            push @incompatibles, ($metaclass_type => $super_c);
+        }
+    }
+
+    my @roles;
+    foreach my $role($super_meta->meta->calculate_all_roles){
+        if(!$self->meta->does_role($role->name)){
+            push @roles, $role->name;
+        }
+    }
+
+    #print "reconcile($self vs. $super_meta; @roles; @incompatibles)\n";
+
+    require Mouse::Util::MetaRole;
+    Mouse::Util::MetaRole::apply_metaclass_roles(
+        for_class       => $self,
+        metaclass       => ref $super_meta,
+        metaclass_roles => \@roles,
+        @incompatibles,
+    );
+    return;
+}
+
+sub find_method_by_name{
+    my($self, $method_name) = @_;
+    defined($method_name)
+        or $self->throw_error('You must define a method name to find');
+
+    foreach my $class( $self->linearized_isa ){
+        my $method = $self->initialize($class)->get_method($method_name);
+        return $method if defined $method;
+    }
+    return undef;
+}
+
+sub get_all_methods {
+    my($self) = @_;
+    return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
+}
+
+sub get_all_method_names {
+    my $self = shift;
+    my %uniq;
+    return grep { $uniq{$_}++ == 0 }
+            map { Mouse::Meta::Class->initialize($_)->get_method_list() }
+            $self->linearized_isa;
+}
+
+sub find_attribute_by_name{
+    my($self, $name) = @_;
+    my $attr;
+    foreach my $class($self->linearized_isa){
+        my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
+        $attr = $meta->get_attribute($name) and last;
+    }
+    return $attr;
 }
 
 sub add_attribute {
     my $self = shift;
-    my $attr = shift;
 
-    $self->{'attributes'}{$attr->name} = $attr;
+    my($attr, $name);
+
+    if(blessed $_[0]){
+        $attr = $_[0];
+
+        $attr->isa('Mouse::Meta::Attribute')
+            || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
+
+        $name = $attr->name;
+    }
+    else{
+        # _process_attribute
+        $name = shift;
+
+        my %args = (@_ == 1) ? %{$_[0]} : @_;
+
+        defined($name)
+            or $self->throw_error('You must provide a name for the attribute');
+
+        if ($name =~ s/^\+//) { # inherited attributes
+            my $inherited_attr = $self->find_attribute_by_name($name)
+                or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
+
+            $attr = $inherited_attr->clone_and_inherit_options(%args);
+        }
+        else{
+            my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
+            $args{traits} = \@traits if @traits;
+
+            $attr = $attribute_class->new($name, %args);
+        }
+    }
+
+    weaken( $attr->{associated_class} = $self );
+
+    $self->{attributes}{$attr->name} = $attr;
+    $attr->install_accessors();
+
+    if(Mouse::Util::_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
+        Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
+    }
+    return $attr;
 }
 
-sub compute_all_applicable_attributes {
+sub compute_all_applicable_attributes { # DEPRECATED
+    Carp::cluck('compute_all_applicable_attributes() has been deprecated. Use get_all_attributes() instead');
+
+    return shift->get_all_attributes(@_)
+}
+
+sub linearized_isa;
+
+sub new_object;
+
+sub clone_object {
+    my $class  = shift;
+    my $object = shift;
+    my $args   = $object->Mouse::Object::BUILDARGS(@_);
+
+    (blessed($object) && $object->isa($class->name))
+        || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
+
+    my $cloned = bless { %$object }, ref $object;
+    $class->_initialize_object($cloned, $args);
+
+    return $cloned;
+}
+
+sub clone_instance { # DEPRECATED
+    my ($class, $instance, %params) = @_;
+
+    Carp::cluck('clone_instance() has been deprecated. Use clone_object() instead');
+
+    return $class->clone_object($instance, %params);
+}
+
+
+sub immutable_options {
+    my ( $self, @args ) = @_;
+
+    return (
+        inline_constructor => 1,
+        inline_destructor  => 1,
+        constructor_name   => 'new',
+        @args,
+    );
+}
+
+
+sub make_immutable {
     my $self = shift;
-    my (@attr, %seen);
+    my %args = $self->immutable_options(@_);
+
+    $self->{is_immutable}++;
+
+    $self->{strict_constructor} = $args{strict_constructor};
+
+    if ($args{inline_constructor}) {
+        my $c = $self->constructor_class;
+        Mouse::Util::load_class($c);
+        $self->add_method($args{constructor_name} =>
+            $c->_generate_constructor($self, \%args));
+    }
+
+    if ($args{inline_destructor}) {
+        my $c = $self->destructor_class;
+        Mouse::Util::load_class($c);
+        $self->add_method(DESTROY =>
+            $c->_generate_destructor($self, \%args));
+    }
+
+    # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
+    # at the end of a source file. 
+    return 1;
+}
+
+sub make_mutable {
+    my($self) = @_;
+    $self->{is_immutable} = 0;
+    return;
+}
+
+sub is_immutable;
+sub is_mutable   { !$_[0]->is_immutable }
+
+sub _install_modifier_pp{
+    my( $self, $type, $name, $code ) = @_;
+    my $into = $self->name;
+
+    my $original = $into->can($name)
+        or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
+
+    my $modifier_table = $self->{modifiers}{$name};
+
+    if(!$modifier_table){
+        my(@before, @after, @around, $cache, $modified);
+
+        $cache = $original;
+
+        $modified = sub {
+            for my $c (@before) { $c->(@_) }
+
+            if(wantarray){ # list context
+                my @rval = $cache->(@_);
+
+                for my $c(@after){ $c->(@_) }
+                return @rval;
+            }
+            elsif(defined wantarray){ # scalar context
+                my $rval = $cache->(@_);
+
+                for my $c(@after){ $c->(@_) }
+                return $rval;
+            }
+            else{ # void context
+                $cache->(@_);
+
+                for my $c(@after){ $c->(@_) }
+                return;
+            }
+        };
+
+        $self->{modifiers}{$name} = $modifier_table = {
+            original => $original,
+
+            before   => \@before,
+            after    => \@after,
+            around   => \@around,
+
+            cache    => \$cache, # cache for around modifiers
+        };
+
+        $self->add_method($name => $modified);
+    }
+
+    if($type eq 'before'){
+        unshift @{$modifier_table->{before}}, $code;
+    }
+    elsif($type eq 'after'){
+        push @{$modifier_table->{after}}, $code;
+    }
+    else{ # around
+        push @{$modifier_table->{around}}, $code;
+
+        my $next = ${ $modifier_table->{cache} };
+        ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
+    }
+
+    return;
+}
+
+sub _install_modifier {
+    my ( $self, $type, $name, $code ) = @_;
+
+    # load Class::Method::Modifiers first
+    my $no_cmm_fast = do{
+        local $@;
+        eval q{ use Class::Method::Modifiers::Fast 0.041 () };
+        $@;
+    };
+
+    my $impl;
+    if($no_cmm_fast){
+        $impl = \&_install_modifier_pp;
+    }
+    else{
+        my $install_modifier = Class::Method::Modifiers::Fast->can('install_modifier');
+        $impl = sub {
+            my ( $self, $type, $name, $code ) = @_;
+            my $into = $self->name;
+            $install_modifier->($into, $type, $name, $code);
+
+            $self->add_method($name => do{
+                no strict 'refs';
+                \&{ $into . '::' . $name };
+            });
+            return;
+        };
+    }
+
+    # replace this method itself :)
+    {
+        no warnings 'redefine';
+        *_install_modifier = $impl;
+    }
+
+    $self->$impl( $type, $name, $code );
+}
+
+sub add_before_method_modifier {
+    my ( $self, $name, $code ) = @_;
+    $self->_install_modifier( 'before', $name, $code );
+}
+
+sub add_around_method_modifier {
+    my ( $self, $name, $code ) = @_;
+    $self->_install_modifier( 'around', $name, $code );
+}
+
+sub add_after_method_modifier {
+    my ( $self, $name, $code ) = @_;
+    $self->_install_modifier( 'after', $name, $code );
+}
+
+sub add_override_method_modifier {
+    my ($self, $name, $code) = @_;
+
+    if($self->has_method($name)){
+        $self->throw_error("Cannot add an override method if a local method is already present");
+    }
+
+    my $package = $self->name;
+
+    my $super_body = $package->can($name)
+        or $self->throw_error("You cannot override '$name' because it has no super method");
+
+    $self->add_method($name => sub {
+        local $Mouse::SUPER_PACKAGE = $package;
+        local $Mouse::SUPER_BODY    = $super_body;
+        local @Mouse::SUPER_ARGS    = @_;
+
+        $code->(@_);
+    });
+    return;
+}
+
+sub add_augment_method_modifier {
+    my ($self, $name, $code) = @_;
+    if($self->has_method($name)){
+        $self->throw_error("Cannot add an augment method if a local method is already present");
+    }
+
+    my $super = $self->find_method_by_name($name)
+        or $self->throw_error("You cannot augment '$name' because it has no super method");
+
+    my $super_package = $super->package_name;
+    my $super_body    = $super->body;
+
+    $self->add_method($name => sub{
+        local $Mouse::INNER_BODY{$super_package} = $code;
+        local $Mouse::INNER_ARGS{$super_package} = [@_];
+        $super_body->(@_);
+    });
+    return;
+}
+
+sub does_role {
+    my ($self, $role_name) = @_;
+
+    (defined $role_name)
+        || $self->throw_error("You must supply a role name to look for");
 
     for my $class ($self->linearized_isa) {
-        my $meta = $self->_metaclass_cache($class)
+        my $meta = Mouse::Util::get_metaclass_by_name($class)
             or next;
 
-        for my $name (keys %{ $meta->get_attribute_map }) {
-            next if $seen{$name}++;
-            push @attr, $meta->get_attribute($name);
+        for my $role (@{ $meta->roles }) {
+
+            return 1 if $role->does_role($role_name);
         }
     }
 
-    return @attr;
+    return 0;
 }
 
-sub get_attribute_map { $_[0]->{attributes} }
-sub has_attribute     { exists $_[0]->{attributes}->{$_[1]} }
-sub get_attribute     { $_[0]->{attributes}->{$_[1]} }
-
-sub linearized_isa { @{ mro::get_linear_isa($_[0]->name) } }
-
 1;
-
 __END__
 
 =head1 NAME
 
-Mouse::Meta::Class - hook into the Mouse MOP
+Mouse::Meta::Class - The Mouse class metaclass
 
-=head1 METHODS
+=head1 VERSION
 
-=head2 initialize ClassName -> Mouse::Meta::Class
+This document describes Mouse version 0.50_01
 
-Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
-one instance should exist for a given class.
+=head1 METHODS
 
-=head2 new %args -> Mouse::Meta::Class
+=head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
 
-Creates a new Mouse::Meta::Class. Don't call this directly.
+Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
+one instance should exist for a given class.
 
-=head2 name -> ClassName
+=head2 C<< name -> ClassName >>
 
 Returns the name of the owner class.
 
-=head2 superclasses -> [ClassName]
+=head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
 
 Gets (or sets) the list of superclasses of the owner class.
 
-=head2 add_attribute Mouse::Meta::Attribute
+=head2 C<< add_method(name => CodeRef) >>
+
+Adds a method to the owner class.
+
+=head2 C<< has_method(name) -> Bool >>
+
+Returns whether we have a method with the given name.
+
+=head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
+
+Returns a L<Mouse::Meta::Method> with the given name.
+
+Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
+
+=head2 C<< get_method_list -> Names >>
+
+Returns a list of method names which are defined in the local class.
+If you want a list of all applicable methods for a class, use the
+C<get_all_methods> method.
+
+=head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
+
+Return the list of all L<Mouse::Meta::Method> instances associated with
+the class and its superclasses.
+
+=head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
 
 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
 class.
 
-=head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
+=head2 C<< has_attribute(Name) -> Bool >>
+
+Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
+
+=head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
+
+Returns the L<Mouse::Meta::Attribute> with the given name.
+
+=head2 C<< get_attribute_list -> Names >>
+
+Returns a list of attribute names which are defined in the local
+class. If you want a list of all applicable attributes for a class,
+use the C<get_all_attributes> method.
+
+=head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
 
 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
 this class and its superclasses.
 
-=head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
+=head2 C<< linearized_isa -> [ClassNames] >>
 
-Returns a mapping of attribute names to their corresponding
-L<Mouse::Meta::Attribute> objects.
+Returns the list of classes in method dispatch order, with duplicates removed.
 
-=head2 has_attribute Name -> Boool
+=head2 C<< new_object(Parameters) -> Instance >>
 
-Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
+Creates a new instance.
 
-=head2 get_attribute Name -> Mouse::Meta::Attribute | undef
+=head2 C<< clone_object(Instance, Parameters) -> Instance >>
 
-Returns the L<Mouse::Meta::Attribute> with the given name.
+Clones the given instance which must be an instance governed by this
+metaclass.
 
-=head2 linearized_isa -> [ClassNames]
+=head2 C<< throw_error(Message, Parameters) >>
 
-Returns the list of classes in method dispatch order, with duplicates removed.
+Throws an error with the given message.
+
+=head1 SEE ALSO
+
+L<Mouse::Meta::Module>
+
+L<Moose::Meta::Class>
+
+L<Class::MOP::Class>
 
 =cut