bump version and update changes for next release
[gitmo/Moose.git] / lib / Moose / Meta / Class.pm
index 42e842d..707abc0 100644 (file)
@@ -6,15 +6,18 @@ use warnings;
 
 use Class::MOP;
 
-use Carp         'confess';
+use Carp ();
+use List::Util qw( first );
+use List::MoreUtils qw( any all uniq );
 use Scalar::Util 'weaken', 'blessed';
 
-our $VERSION   = '0.55_01';
+our $VERSION   = '0.67';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use Moose::Meta::Method::Overriden;
 use Moose::Meta::Method::Augmented;
+use Moose::Error::Default;
 
 use base 'Class::MOP::Class';
 
@@ -23,6 +26,22 @@ __PACKAGE__->meta->add_attribute('roles' => (
     default => sub { [] }
 ));
 
+__PACKAGE__->meta->add_attribute('constructor_class' => (
+    accessor => 'constructor_class',
+    default  => 'Moose::Meta::Method::Constructor',
+));
+
+__PACKAGE__->meta->add_attribute('destructor_class' => (
+    accessor => 'destructor_class',
+    default  => 'Moose::Meta::Method::Destructor',
+));
+
+__PACKAGE__->meta->add_attribute('error_class' => (
+    accessor => 'error_class',
+    default  => 'Moose::Error::Default',
+));
+
+
 sub initialize {
     my $class = shift;
     my $pkg   = shift;
@@ -39,18 +58,29 @@ sub create {
     my ($self, $package_name, %options) = @_;
     
     (ref $options{roles} eq 'ARRAY')
-        || confess "You must pass an ARRAY ref of roles"
+        || $self->throw_error("You must pass an ARRAY ref of roles", data => $options{roles})
             if exists $options{roles};
-    
+    my $roles = delete $options{roles};
+
     my $class = $self->SUPER::create($package_name, %options);
-    
-    if (exists $options{roles}) {
-        Moose::Util::apply_all_roles($class, @{$options{roles}});
+
+    if ($roles) {
+        Moose::Util::apply_all_roles( $class, @$roles );
     }
     
     return $class;
 }
 
+sub check_metaclass_compatibility {
+    my $self = shift;
+
+    if ( my @supers = $self->superclasses ) {
+        $self->_fix_metaclass_incompatibility(@supers);
+    }
+
+    $self->SUPER::check_metaclass_compatibility(@_);
+}
+
 my %ANON_CLASSES;
 
 sub create_anon_class {
@@ -60,8 +90,8 @@ sub create_anon_class {
     
     # something like Super::Class|Super::Class::2=Role|Role::1
     my $cache_key = join '=' => (
-        join('|', sort @{$options{superclasses} || []}),
-        join('|', sort @{$options{roles}        || []}),
+        join('|', @{$options{superclasses} || []}),
+        join('|', sort @{$options{roles}   || []}),
     );
     
     if ($cache_ok && defined $ANON_CLASSES{$cache_key}) {
@@ -79,7 +109,7 @@ sub create_anon_class {
 sub add_role {
     my ($self, $role) = @_;
     (blessed($role) && $role->isa('Moose::Meta::Role'))
-        || confess "Roles must be instances of Moose::Meta::Role";
+        || $self->throw_error("Roles must be instances of Moose::Meta::Role", data => $role);
     push @{$self->roles} => $role;
 }
 
@@ -92,7 +122,7 @@ sub calculate_all_roles {
 sub does_role {
     my ($self, $role_name) = @_;
     (defined $role_name)
-        || confess "You must supply a role name to look for";
+        || $self->throw_error("You must supply a role name to look for");
     foreach my $class ($self->class_precedence_list) {
         next unless $class->can('meta') && $class->meta->can('roles');
         foreach my $role (@{$class->meta->roles}) {
@@ -105,7 +135,7 @@ sub does_role {
 sub excludes_role {
     my ($self, $role_name) = @_;
     (defined $role_name)
-        || confess "You must supply a role name to look for";
+        || $self->throw_error("You must supply a role name to look for");
     foreach my $class ($self->class_precedence_list) {
         next unless $class->can('meta');
         # NOTE:
@@ -122,33 +152,31 @@ sub excludes_role {
 }
 
 sub new_object {
-    my $class = shift;
+    my $class  = shift;
     my $params = @_ == 1 ? $_[0] : {@_};
-    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
-                    );
-                }
-            }       
-        }
+    my $self   = $class->SUPER::new_object($params);
+
+    foreach my $attr ( $class->compute_all_applicable_attributes() ) {
+
+        next unless $attr->can('has_trigger') && $attr->has_trigger;
+
+        my $init_arg = $attr->init_arg;
+
+        next unless defined $init_arg;
+
+        next unless exists $params->{$init_arg};
+
+        $attr->trigger->(
+            $self,
+            (
+                  $attr->should_coerce
+                ? $attr->get_read_method_ref->($self)
+                : $params->{$init_arg}
+            ),
+            $attr
+        );
     }
+
     return $self;
 }
 
@@ -167,74 +195,6 @@ sub construct_instance {
     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 {
-            
-            # 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);
-            }
-
-        }
-
-        $map->{$symbol} = $method_metaclass->wrap(
-            $code,
-            package_name => $class_name,
-            name         => $symbol
-        );
-    }
-
-    return $map;
-}
-
 ### ---------------------------------------------
 
 sub add_attribute {
@@ -250,7 +210,7 @@ sub add_override_method_modifier {
     my ($self, $name, $method, $_super_package) = @_;
 
     (!$self->has_method($name))
-        || confess "Cannot add an override method if a local method is already present";
+        || $self->throw_error("Cannot add an override method if a local method is already present");
 
     $self->add_method($name => Moose::Meta::Method::Overriden->new(
         method  => $method,
@@ -263,7 +223,7 @@ sub add_override_method_modifier {
 sub add_augment_method_modifier {
     my ($self, $name, $method) = @_;
     (!$self->has_method($name))
-        || confess "Cannot add an augment method if a local method is already present";
+        || $self->throw_error("Cannot add an augment method if a local method is already present");
 
     $self->add_method($name => Moose::Meta::Method::Augmented->new(
         method  => $method,
@@ -283,52 +243,243 @@ sub _find_next_method_by_name_which_is_not_overridden {
     return undef;
 }
 
-sub _fix_metaclass_incompatability {
+sub _fix_metaclass_incompatibility {
     my ($self, @superclasses) = @_;
+
     foreach my $super (@superclasses) {
-        # don't bother if it does not have a meta.
-        my $meta = Class::MOP::Class->initialize($super) or next;
-        next unless $meta->isa("Class::MOP::Class");
-
-        # get the name, make sure we take
-        # immutable classes into account
-        my $super_meta_name = ($meta->is_immutable
-            ? $meta->get_mutable_metaclass_name
-            : ref($meta));
-
-        # 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
-            # and see if our instance metaclass is incompatible
-            $self->instance_metaclass->isa($meta->instance_metaclass)
-        ) {
-            if ( $meta->isa(ref($self)) ) {
-                unless ( $self->is_pristine ) {
-                    confess "Not reinitializing metaclass for " . $self->name . ", it isn't pristine";
-                }
-                # also check values %{ $self->get_method_map } for any generated methods
-
-                # 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 = $meta->reinitialize(
-                    $self->name,
-                    attribute_metaclass => $meta->attribute_metaclass,
-                    method_metaclass    => $meta->method_metaclass,
-                    instance_metaclass  => $meta->instance_metaclass,
-                );
-            } else {
-                # this will be called soon enough, for now we let it slide
-                # $self->check_metaclass_compatability()
-            }
+        next if $self->_superclass_meta_is_compatible($super);
+
+        unless ( $self->is_pristine ) {
+            $self->throw_error(
+                      "Cannot attempt to reinitialize metaclass for "
+                    . $self->name
+                    . ", it isn't pristine" );
         }
+
+        $self->_reconcile_with_superclass_meta($super);
+    }
+}
+
+sub _superclass_meta_is_compatible {
+    my ($self, $super) = @_;
+
+    my $super_meta = Class::MOP::Class->initialize($super)
+        or return 1;
+
+    next unless $super_meta->isa("Class::MOP::Class");
+
+    my $super_meta_name
+        = $super_meta->is_immutable
+        ? $super_meta->get_mutable_metaclass_name
+        : ref($super_meta);
+
+    return 1
+        if $self->isa($super_meta_name)
+            and
+           $self->instance_metaclass->isa( $super_meta->instance_metaclass );
+}
+
+# I don't want to have to type this >1 time
+my @MetaClassTypes =
+    qw( attribute_metaclass method_metaclass instance_metaclass
+        constructor_class destructor_class error_class );
+
+sub _reconcile_with_superclass_meta {
+    my ($self, $super) = @_;
+
+    my $super_meta = $super->meta;
+
+    my $super_meta_name
+        = $super_meta->is_immutable
+        ? $super_meta->get_mutable_metaclass_name
+        : ref($super_meta);
+
+    my $self_metaclass = ref $self;
+
+    # If neither of these is true we have a more serious
+    # incompatibility that we just cannot fix (yet?).
+    if ( $super_meta_name->isa( ref $self )
+        && all { $super_meta->$_->isa( $self->$_ ) } @MetaClassTypes ) {
+        $self->_reinitialize_with($super_meta);
+    }
+    elsif ( $self->_all_metaclasses_differ_by_roles_only($super_meta) ) {
+        $self->_reconcile_role_differences($super_meta);
+    }
+}
+
+sub _reinitialize_with {
+    my ( $self, $new_meta ) = @_;
+
+    my $new_self = $new_meta->reinitialize(
+        $self->name,
+        attribute_metaclass => $new_meta->attribute_metaclass,
+        method_metaclass    => $new_meta->method_metaclass,
+        instance_metaclass  => $new_meta->instance_metaclass,
+    );
+
+    $new_self->$_( $new_meta->$_ )
+        for qw( constructor_class destructor_class error_class );
+
+    %$self = %$new_self;
+
+    bless $self, ref $new_self;
+
+    # We need to replace the cached metaclass instance or else when it
+    # goes out of scope Class::MOP::Class destroy's the namespace for
+    # the metaclass's class, causing much havoc.
+    Class::MOP::store_metaclass_by_name( $self->name, $self );
+    Class::MOP::weaken_metaclass( $self->name ) if $self->is_anon_class;
+}
+
+# In the more complex case, we share a common ancestor with our
+# superclass's metaclass, but each metaclass (ours and the parent's)
+# has a different set of roles applied. We reconcile this by first
+# reinitializing into the parent class, and _then_ applying our own
+# roles.
+sub _all_metaclasses_differ_by_roles_only {
+    my ($self, $super_meta) = @_;
+
+    for my $pair (
+        [ ref $self, ref $super_meta ],
+        map { [ $self->$_, $super_meta->$_ ] } @MetaClassTypes
+        ) {
+
+        next if $pair->[0] eq $pair->[1];
+
+        my $self_meta_meta  = Class::MOP::Class->initialize( $pair->[0] );
+        my $super_meta_meta = Class::MOP::Class->initialize( $pair->[1] );
+
+        my $common_ancestor
+            = _find_common_ancestor( $self_meta_meta, $super_meta_meta );
+
+        return unless $common_ancestor;
+
+        return
+            unless _is_role_only_subclass_of(
+            $self_meta_meta,
+            $common_ancestor,
+            )
+            && _is_role_only_subclass_of(
+            $super_meta_meta,
+            $common_ancestor,
+            );
+    }
+
+    return 1;
+}
+
+# This, and some other functions, could be called as methods, but
+# they're not for two reasons. One, we just end up ignoring the first
+# argument, because we can't call these directly on one of the real
+# arguments, because one of them could be a Class::MOP::Class object
+# and not a Moose::Meta::Class. Second, only a completely insane
+# person would attempt to subclass this stuff!
+sub _find_common_ancestor {
+    my ($meta1, $meta2) = @_;
+
+    # FIXME? This doesn't account for multiple inheritance (not sure
+    # if it needs to though). For example, is somewhere in $meta1's
+    # history it inherits from both ClassA and ClassB, and $meta
+    # inherits from ClassB & ClassA, does it matter? And what crazy
+    # fool would do that anyway?
+
+    my %meta1_parents = map { $_ => 1 } $meta1->linearized_isa;
+
+    return first { $meta1_parents{$_} } $meta2->linearized_isa;
+}
+
+sub _is_role_only_subclass_of {
+    my ($meta, $ancestor) = @_;
+
+    return 1 if $meta->name eq $ancestor;
+
+    my @roles = _all_roles_until( $meta, $ancestor );
+
+    my %role_packages = map { $_->name => 1 } @roles;
+
+    my $ancestor_meta = Class::MOP::Class->initialize($ancestor);
+
+    my %shared_ancestors = map { $_ => 1 } $ancestor_meta->linearized_isa;
+
+    for my $method ( $meta->get_all_methods() ) {
+        next if $method->name eq 'meta';
+        next if $method->can('associated_attribute');
+
+        next
+            if $role_packages{ $method->original_package_name }
+                || $shared_ancestors{ $method->original_package_name };
+
+        return 0;
+    }
+
+    # FIXME - this really isn't right. Just because an attribute is
+    # defined in a role doesn't mean it isn't _also_ defined in the
+    # subclass.
+    for my $attr ( $meta->get_all_attributes ) {
+        next if $shared_ancestors{ $attr->associated_class->name };
+
+        next if any { $_->has_attribute( $attr->name ) } @roles;
+
+        return 0;
+    }
+
+    return 1;
+}
+
+sub _all_roles {
+    my $meta = shift;
+
+    return _all_roles_until($meta);
+}
+
+sub _all_roles_until {
+    my ($meta, $stop_at_class) = @_;
+
+    return unless $meta->can('calculate_all_roles');
+
+    my @roles = $meta->calculate_all_roles;
+
+    for my $class ( $meta->linearized_isa ) {
+        last if $stop_at_class && $stop_at_class eq $class;
+
+        my $meta = Class::MOP::Class->initialize($class);
+        last unless $meta->can('calculate_all_roles');
+
+        push @roles, $meta->calculate_all_roles;
+    }
+
+    return uniq @roles;
+}
+
+sub _reconcile_role_differences {
+    my ($self, $super_meta) = @_;
+
+    my $self_meta = $self->meta;
+
+    my %roles;
+
+    if ( my @roles = map { $_->name } _all_roles($self_meta) ) {
+        $roles{metaclass_roles} = \@roles;
     }
+
+    for my $thing (@MetaClassTypes) {
+        my $name = $self->$thing();
+
+        my $thing_meta = Class::MOP::Class->initialize($name);
+
+        my @roles = map { $_->name } _all_roles($thing_meta)
+            or next;
+
+        $roles{ $thing . '_roles' } = \@roles;
+    }
+
+    $self->_reinitialize_with($super_meta);
+
+    Moose::Util::MetaRole::apply_metaclass_roles(
+        for_class => $self->name,
+        %roles,
+    );
+
     return $self;
 }
 
@@ -345,7 +496,7 @@ sub _process_attribute {
 
     @args = %{$args[0]} if scalar @args == 1 && ref($args[0]) eq 'HASH';
 
-    if ($name =~ /^\+(.*)/) {
+    if (($name || '') =~ /^\+(.*)/) {
         return $self->_process_inherited_attribute($1, @args);
     }
     else {
@@ -363,7 +514,7 @@ 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";
+        || $self->throw_error("Could not find an attribute by the name of '$attr_name' to inherit from in ${\$self->name}", data => $attr_name);
     if ($inherited_attr->isa('Moose::Meta::Attribute')) {
         return $inherited_attr->clone_and_inherit_options(%options);
     }
@@ -411,7 +562,7 @@ sub create_immutable_transformer {
        wrapped => { 
            add_package_symbol => sub {
                my $original = shift;
-               confess "Cannot add package symbols to an immutable metaclass" 
+               $self->throw_error("Cannot add package symbols to an immutable metaclass")
                    unless (caller(2))[3] eq 'Class::MOP::Package::get_package_symbol'; 
                goto $original->body;
            },
@@ -424,8 +575,8 @@ sub make_immutable {
     my $self = shift;
     $self->SUPER::make_immutable
       (
-       constructor_class => 'Moose::Meta::Method::Constructor',
-       destructor_class  => 'Moose::Meta::Method::Destructor',
+       constructor_class => $self->constructor_class,
+       destructor_class  => $self->destructor_class,
        inline_destructor => 1,
        # NOTE:
        # no need to do this,
@@ -435,6 +586,44 @@ sub make_immutable {
       );
 }
 
+our $error_level;
+
+sub throw_error {
+    my ( $self, @args ) = @_;
+    local $error_level = ($error_level || 0) + 1;
+    $self->raise_error($self->create_error(@args));
+}
+
+sub raise_error {
+    my ( $self, @args ) = @_;
+    die @args;
+}
+
+sub create_error {
+    my ( $self, @args ) = @_;
+
+    require Carp::Heavy;
+
+    local $error_level = ($error_level || 0 ) + 1;
+
+    if ( @args % 2 == 1 ) {
+        unshift @args, "message";
+    }
+
+    my %args = ( metaclass => $self, last_error => $@, @args );
+
+    $args{depth} += $error_level;
+
+    my $class = ref $self ? $self->error_class : "Moose::Error::Default";
+
+    Class::MOP::load_class($class);
+
+    $class->new(
+        Carp::caller_info($args{depth}),
+        %args
+    );
+}
+
 1;
 
 __END__
@@ -545,6 +734,65 @@ cascade down the role hierarchy.
 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.
 
+=item B<constructor_class ($class_name)>
+
+=item B<destructor_class ($class_name)>
+
+These are the names of classes used when making a class
+immutable. These default to L<Moose::Meta::Method::Constructor> and
+L<Moose::Meta::Method::Destructor> respectively. These accessors are
+read-write, so you can use them to change the class name.
+
+=item B<error_class ($class_name)>
+
+The name of the class used to throw errors. This default to
+L<Moose::Error::Default>, which generates an error with a stacktrace
+just like C<Carp::confess>.
+
+=item B<check_metaclass_compatibility>
+
+Moose overrides this method from C<Class::MOP::Class> and attempts to
+fix some incompatibilities before doing the check.
+
+=item B<throw_error $message, %extra>
+
+Throws the error created by C<create_error> using C<raise_error>
+
+=item B<create_error $message, %extra>
+
+Creates an error message or object.
+
+The default behavior is C<create_error_confess>.
+
+If C<error_class> is set uses C<create_error_object>. Otherwise uses
+C<error_builder> (a code reference or variant name), and calls the appropriate
+C<create_error_$builder> method.
+
+=item B<error_builder $builder_name>
+
+Get or set the error builder. Defaults to C<confess>.
+
+=item B<error_class $class_name>
+
+Get or set the error class. This defaults to L<Moose::Error::Default>.
+
+=item B<create_error_confess %args>
+
+Creates an error using L<Carp/longmess>
+
+=item B<create_error_croak %args>
+
+Creates an error using L<Carp/shortmess>
+
+=item B<create_error_object %args>
+
+Calls C<new> on the C<class> parameter in C<%args>. Usable with C<error_class>
+to support custom error objects for your meta class.
+
+=item B<raise_error $error>
+
+Dies with an error object or string.
+
 =back
 
 =head1 BUGS
@@ -559,7 +807,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>