error tests and fixes
[gitmo/Moose.git] / lib / Moose / Meta / Class.pm
index 352400c..55e6d50 100644 (file)
@@ -6,10 +6,13 @@ use warnings;
 
 use Class::MOP;
 
-use Carp         'confess';
-use Scalar::Util 'weaken', 'blessed', 'reftype';
+use Carp ();
+use List::Util qw( first );
+use List::MoreUtils qw( any all );
+use Scalar::Util 'weaken', 'blessed';
 
-our $VERSION   = '0.23';
+our $VERSION   = '0.57';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use Moose::Meta::Method::Overriden;
@@ -22,6 +25,26 @@ __PACKAGE__->meta->add_attribute('roles' => (
     default => sub { [] }
 ));
 
+__PACKAGE__->meta->add_attribute('constructor_class' => (
+    accessor => 'constructor_class',
+    default  => sub { 'Moose::Meta::Method::Constructor' }
+));
+
+__PACKAGE__->meta->add_attribute('destructor_class' => (
+    accessor => 'destructor_class',
+    default  => sub { 'Moose::Meta::Method::Destructor' }
+));
+
+__PACKAGE__->meta->add_attribute('error_builder' => (
+    reader  => 'error_builder',
+    default => 'confess',
+));
+
+__PACKAGE__->meta->add_attribute('error_class' => (
+    reader  => 'error_class',
+));
+
+
 sub initialize {
     my $class = shift;
     my $pkg   = shift;
@@ -38,11 +61,11 @@ 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 $class = $self->SUPER::create($package_name, %options);
-    
+
     if (exists $options{roles}) {
         Moose::Util::apply_all_roles($class, @{$options{roles}});
     }
@@ -50,6 +73,16 @@ sub create {
     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 {
@@ -78,7 +111,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;
 }
 
@@ -91,7 +124,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}) {
@@ -104,7 +137,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:
@@ -121,15 +154,16 @@ sub excludes_role {
 }
 
 sub new_object {
-    my ($class, %params) = @_;
-    my $self = $class->SUPER::new_object(%params);
+    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}) {
+                if (exists $params->{$init_arg}) {
                     # and if get here, fire the trigger
                     $attr->trigger->(
                         $self, 
@@ -140,7 +174,7 @@ sub new_object {
                             ? $attr->get_read_method_ref->($self)
                             # otherwise, just get the value from
                             # the constructor params
-                            : $params{$init_arg}), 
+                            : $params->{$init_arg}), 
                         $attr
                     );
                 }
@@ -151,15 +185,16 @@ sub new_object {
 }
 
 sub construct_instance {
-    my ($class, %params) = @_;
+    my $class = shift;
+    my $params = @_ == 1 ? $_[0] : {@_};
     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();
+    my $instance = $params->{'__INSTANCE__'} || $meta_instance->create_instance();
     foreach my $attr ($class->compute_all_applicable_attributes()) {
-        $attr->initialize_instance_slot($meta_instance, $instance, \%params);
+        $attr->initialize_instance_slot($meta_instance, $instance, $params);
     }
     return $instance;
 }
@@ -169,12 +204,15 @@ sub construct_instance {
 sub get_method_map {
     my $self = shift;
 
-    if (defined $self->{'$!_package_cache_flag'} &&
-                $self->{'$!_package_cache_flag'} == Class::MOP::check_package_cache_flag($self->meta->name)) {
-        return $self->{'%!methods'};
+    my $current = Class::MOP::check_package_cache_flag($self->name);
+
+    if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) {
+        return $self->{'methods'};
     }
 
-    my $map  = $self->{'%!methods'};
+    $self->{_package_cache_flag} = $current;
+
+    my $map  = $self->{'methods'};
 
     my $class_name       = $self->name;
     my $method_metaclass = $self->method_metaclass;
@@ -244,7 +282,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,
@@ -257,7 +295,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,
@@ -277,43 +315,241 @@ 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.
-        next unless $super->can('meta');
-        # 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,
-            ));
+        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 );
+
+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 );
+
+    %$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 @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;
 }
 
@@ -348,7 +584,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", data => $attr_name);
     if ($inherited_attr->isa('Moose::Meta::Attribute')) {
         return $inherited_attr->clone_and_inherit_options(%options);
     }
@@ -381,10 +617,12 @@ sub create_immutable_transformer {
        /],
        memoize     => {
            class_precedence_list             => 'ARRAY',
+           linearized_isa                    => 'ARRAY', # FIXME perl 5.10 memoizes this on its own, no need?
+           get_all_methods                   => 'ARRAY',
+           #get_all_attributes               => 'ARRAY', # it's an alias, no need, but maybe in the future
            compute_all_applicable_attributes => 'ARRAY',
            get_meta_instance                 => 'SCALAR',
            get_method_map                    => 'SCALAR',
-           # maybe ....
            calculate_all_roles               => 'ARRAY',
        },
        # NOTE:
@@ -394,7 +632,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;
            },
@@ -407,8 +645,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,
@@ -418,6 +656,85 @@ sub make_immutable {
       );
 }
 
+#{ package Moose::Meta::Class::ErrorRoutines; %Carp::Internal?
+
+our $level;
+
+sub throw_error {
+    my ( $self, @args ) = @_;
+    local $level = 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 $level = $level + 1;
+
+
+    if ( @args % 2 == 1 ) {
+        unshift @args, "message";
+    }
+
+    my %args = ( Carp::caller_info($level), metaclass => $self, error => $@, @args );
+
+    if ( my $class = $args{class} || ( ref $self && $self->error_class ) ) {
+        return $self->create_error_object( %args, class => $class );
+    } else {
+        my $builder = $args{builder} || ( ref($self) ? $self->error_builder : "confess" );
+
+        my $builder_method = ( ( ref($builder) && ref($builder) eq 'CODE' ) 
+            ? $builder
+            : ( $self->can("create_error_$builder") || "create_error_confess" ));
+
+        return $self->$builder_method(%args);
+    }
+}
+
+sub create_error_object {
+    my ( $self, %args ) = @_;
+
+    my $class = delete $args{class};
+
+    $class->new(
+        %args,
+        depth => ( ($args{depth} || 1) + ( $level + 1 ) ),
+    );
+}
+
+sub create_error_croak {
+    my ( $self, @args ) = @_;
+    $self->_create_error_carpmess( @args );
+}
+
+sub create_error_confess {
+    my ( $self, @args ) = @_;
+    $self->_create_error_carpmess( @args, longmess => 1 );
+}
+
+sub _create_error_carpmess {
+    my ( $self, %args ) = @_;
+
+    my $carp_level = $level + 1 + ( $args{depth} || 1 );
+    local $Carp::MaxArgNums = 20;         # default is 8, usually we use named args which gets messier though
+
+    my @args = exists $args{message} ? $args{message} : ();
+
+    if ( $args{longmess} || $Carp::Verbose ) {
+        local $Carp::CarpLevel = ( $Carp::CarpLevel || 0 ) + $carp_level;
+        return Carp::longmess(@args);
+    } else {
+        return Carp::ret_summary($carp_level, @args);
+    }
+}
+
 1;
 
 __END__
@@ -528,6 +845,59 @@ 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<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. Has no 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