X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FClass.pm;h=55e6d5066bc423bbb98ce999a85d0524f3dff41d;hb=18748ad69a205a0ae4acea224d69f10f3db53834;hp=fc551e8fd0531ba30e802eafe33d7c839881e05b;hpb=4c598161e5e1e76d6d18a5e28d5ec0cb9f6b113f;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Class.pm b/lib/Moose/Meta/Class.pm index fc551e8..55e6d50 100644 --- a/lib/Moose/Meta/Class.pm +++ b/lib/Moose/Meta/Class.pm @@ -6,10 +6,12 @@ use warnings; use Class::MOP; -use Carp 'confess'; +use Carp (); +use List::Util qw( first ); +use List::MoreUtils qw( any all ); use Scalar::Util 'weaken', 'blessed'; -our $VERSION = '0.55_01'; +our $VERSION = '0.57'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; @@ -33,6 +35,16 @@ __PACKAGE__->meta->add_attribute('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; @@ -49,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}}); } @@ -61,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 { @@ -89,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; } @@ -102,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}) { @@ -115,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: @@ -260,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, @@ -273,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, @@ -293,177 +315,242 @@ sub _find_next_method_by_name_which_is_not_overridden { return undef; } -# Right now, this method does not handle the case where two -# metaclasses differ only in roles applied against a common parent -# class. This can happen fairly easily when ClassA applies metaclass -# Role1, and then a subclass, ClassB, applies a metaclass Role2. In -# reality, the way to resolve the problem is to apply Role1 to -# ClassB's metaclass. However, we cannot currently detect this, and so -# we simply fail to fix the incompatibility. -# -# The algorithm for fixing it is not that complicated. -# -# First, we see if the two metaclasses share a common parent (probably -# Moose::Meta::Class). -# -# Second, we see if the metaclasses only differ in terms of roles -# applied. This second point is where things break down. There is no -# easy way to determine if the difference is from roles only. To do -# that, we'd need to able to reliably determine the origin of each -# method and attribute in each metaclass. If all the unshared methods -# & attributes come from roles, and there is no name collision, then -# we can apply the missing roles to the child's metaclass. -# -# Tracking the origin of these things will require some fairly -# invasive changes to various parts of Moose & Class::MOP. -# -# For now, the workaround is for ClassB to subclass ClassA _and then_ -# apply metaclass roles to its metaclass. -sub _fix_metaclass_incompatability { +sub _fix_metaclass_incompatibility { my ($self, @superclasses) = @_; - my $self_meta_name = ref($self); - foreach my $super (@superclasses) { - # don't bother if it does not have a meta. - my $super_meta = Class::MOP::Class->initialize($super) or next; - 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 - : ref($super_meta); - - next if - # if our metaclass is compatible - $self->isa($super_meta_name) - and - # and our instance metaclass is also compatible then no - # fixes are needed - $self->instance_metaclass->isa( $super_meta->instance_metaclass ); - - if ( $super_meta->isa($self_meta_name) ) { - $self->_require_pristine_to_reinitialize; - - $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); - $self->$_( $super_meta->$_ ) - for qw( constructor_class destructor_class ); + unless ( $self->is_pristine ) { + $self->throw_error( + "Cannot attempt to reinitialize metaclass for " + . $self->name + . ", it isn't pristine" ); } - elsif ( __difference_is_roles_only( $self, $super_meta ) ) { - $self->_require_pristine_to_reinitialize; - my @roles = map { $_->name } @{$self->meta->roles}; + $self->_reconcile_with_superclass_meta($super); + } +} - $self = $super_meta->reinitialize( - $self->name, - attribute_metaclass => $super_meta->attribute_metaclass, - method_metaclass => $super_meta->method_metaclass, - instance_metaclass => $super_meta->instance_metaclass, - ); +sub _superclass_meta_is_compatible { + my ($self, $super) = @_; - $self = Moose::Util::MetaRole::apply_metaclass_roles( - for_class => $self->name, - metaclass_roles => \@roles, - ); - } - } + my $super_meta = Class::MOP::Class->initialize($super) + or return 1; - return $self; + 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 ); } -sub _require_pristine_to_reinitialize { - my $self = shift; +# 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) = @_; - return if $self->is_pristine; + my $super_meta = $super->meta; - confess "Not reinitializing metaclass for " - . $self->name - . ", it isn't pristine"; + 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); + } } -# This stuff is called as functions because while it operates on -# metaclasses, it might get a Class::MOP::Class as opposed to a -# Moose::Meta::Class. -sub __difference_is_roles_only { - my ( $meta1, $meta2 ) = @_; +sub _reinitialize_with { + my ( $self, $new_meta ) = @_; - return - unless $meta1->meta->can('does_role') - || $meta2->meta->can('does_role'); + 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, + ); - return - if __arrays_differ( - __methods_excluding_roles( $meta1->meta ), - __methods_excluding_roles( $meta2->meta ) - ); + $new_self->$_( $new_meta->$_ ) for qw( constructor_class destructor_class ); - return - if __arrays_differ( - __attr_excluding_roles( $meta1->meta ), - __attr_excluding_roles( $meta2->meta ) - ); + %$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; } -sub __arrays_differ { - my ( $arr1, $arr2 ) = @_; +# 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 %arr1_vals = map { $_ => 1 } @{$arr1}; - delete @arr1_vals{ @{$arr2} }; + my %meta1_parents = map { $_ => 1 } $meta1->linearized_isa; - return keys %arr1_vals ? 1 : 0; + return first { $meta1_parents{$_} } $meta2->linearized_isa; } -sub __methods_excluding_roles { - my $meta = shift; +sub _is_role_only_subclass_of { + my ($meta, $ancestor) = @_; - my %map = map { $_->name => $_ } $meta->get_all_methods; + return 1 if $meta->name eq $ancestor; - delete $map{meta}; + my @roles = _all_roles_until( $meta, $ancestor ); - return values %map unless $meta->can('roles') && $meta->roles; + my %role_packages = map { $_->name => 1 } @roles; - for my $role ( @{$meta->roles} ) { - for my $role_meth ( values %{$role->get_method_map} ) { - next if $role_meth->name eq 'meta'; + my $ancestor_meta = Class::MOP::Class->initialize($ancestor); - my $meta_meth = $map{ $role_meth->name }; + my %shared_ancestors = map { $_ => 1 } $ancestor_meta->linearized_isa; - next unless $meta_meth; - next unless $meta_meth->body eq $role_meth->body; + for my $method ( $meta->get_all_methods() ) { + next if $method->name eq 'meta'; + next if $method->can('associated_attribute'); - delete $map{ $role_meth->name }; - } + next + if $role_packages{ $method->original_package_name } + || $shared_ancestors{ $method->original_package_name }; - for my $attr ( grep { defined } map { $meta->get_attribute($_) } $role->get_attribute_list ) { - delete @map{ map { $_->name } @{$attr->associated_methods} }; - } + 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 [ values %map ]; + return 1; } -sub __attr_excluding_roles { +sub _all_roles { my $meta = shift; - my %map = map { $_->name => $_ } $meta->get_all_attributes; + return _all_roles_until($meta); +} + +sub _all_roles_until { + my ($meta, $stop_at_class) = @_; - return values %map unless $meta->can('roles') && $meta->roles; + return unless $meta->can('calculate_all_roles'); - for my $role ( @{$meta->roles} ) { - delete @map{ $role->get_attribute_list }; + 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 [ values %map ]; + 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; } # NOTE: @@ -497,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); } @@ -545,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; }, @@ -569,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__ @@ -679,6 +845,59 @@ cascade down the role hierarchy. This method does the same thing as L, but adds support for taking the C<$params> as a HASH ref. +=item B + +=item B + +These are the names of classes used when making a class +immutable. These default to L and +L respectively. These accessors are +read-write, so you can use them to change the class name. + +=item B + +Moose overrides this method from C and attempts to +fix some incompatibilities before doing the check. + +=item B + +Throws the error created by C using C + +=item B + +Creates an error message or object. + +The default behavior is C. + +If C is set uses C. Otherwise uses +C (a code reference or variant name), and calls the appropriate +C method. + +=item B + +Get or set the error builder. Defaults to C. + +=item B + +Get or set the error class. Has no default. + +=item B + +Creates an error using L + +=item B + +Creates an error using L + +=item B + +Calls C on the C parameter in C<%args>. Usable with C +to support custom error objects for your meta class. + +=item B + +Dies with an error object or string. + =back =head1 BUGS