improve the warning for unknown attribute parameters (mjd)
[gitmo/Moose.git] / lib / Moose / Role.pm
index 3b607a3..3cc3467 100644 (file)
@@ -4,13 +4,10 @@ use warnings;
 
 use Scalar::Util 'blessed';
 use Carp         'croak';
+use Class::Load  'is_class_loaded';
 
 use Sub::Exporter;
 
-our $VERSION   = '1.07';
-$VERSION = eval $VERSION;
-our $AUTHORITY = 'cpan:STEVAN';
-
 use Moose       ();
 use Moose::Util ();
 
@@ -42,7 +39,10 @@ sub has {
     my $meta = shift;
     my $name = shift;
     croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1;
-    my %options = ( definition_context => Moose::Util::_caller_info(), @_ );
+    my %context = Moose::Util::_caller_info;
+    $context{context} = 'has declaration';
+    $context{type} = 'role';
+    my %options = ( definition_context => \%context, @_ );
     my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ];
     $meta->add_attribute( $_, %options ) for @$attrs;
 }
@@ -50,16 +50,13 @@ sub has {
 sub _add_method_modifier {
     my $type = shift;
     my $meta = shift;
-    my $code = pop @_;
-
-    for (@_) {
-        croak "Roles do not currently support "
-            . ref($_)
-            . " references for $type method modifiers"
-            if ref $_;
-        my $add_method = "add_${type}_method_modifier";
-        $meta->$add_method( $_, $code );
+
+    if ( ref($_[0]) eq 'Regexp' ) {
+        croak "Roles do not currently support regex "
+            . " references for $type method modifiers";
     }
+
+    Moose::Util::add_method_modifier($meta, $type, \@_);
 }
 
 sub before { _add_method_modifier('before', @_) }
@@ -111,29 +108,45 @@ sub init_meta {
     }
 
     my $metaclass = $args{metaclass} || "Moose::Meta::Role";
+    my $meta_name = exists $args{meta_name} ? $args{meta_name} : 'meta';
+
+    Moose->throw_error("The Metaclass $metaclass must be loaded. (Perhaps you forgot to 'use $metaclass'?)")
+        unless is_class_loaded($metaclass);
 
-    # make a subtype for each Moose class
+    Moose->throw_error("The Metaclass $metaclass must be a subclass of Moose::Meta::Role.")
+        unless $metaclass->isa('Moose::Meta::Role');
+
+    # make a subtype for each Moose role
     role_type $role unless find_type_constraint($role);
 
-    # FIXME copy from Moose.pm
     my $meta;
-    if ($role->can('meta')) {
-        $meta = $role->meta();
-
-        unless ( blessed($meta) && $meta->isa('Moose::Meta::Role') ) {
-            require Moose;
-            Moose->throw_error("You already have a &meta function, but it does not return a Moose::Meta::Role");
+    if ( $meta = Class::MOP::get_metaclass_by_name($role) ) {
+        unless ( $meta->isa("Moose::Meta::Role") ) {
+            my $error_message = "$role already has a metaclass, but it does not inherit $metaclass ($meta).";
+            if ( $meta->isa('Moose::Meta::Class') ) {
+                Moose->throw_error($error_message . ' You cannot make the same thing a role and a class. Remove either Moose or Moose::Role.');
+            } else {
+                Moose->throw_error($error_message);
+            }
         }
     }
     else {
         $meta = $metaclass->initialize($role);
+    }
 
-        $meta->add_method(
-            'meta' => sub {
-                # re-initialize so it inherits properly
-                $metaclass->initialize( ref($_[0]) || $_[0] );
-            }
-        );
+    if (defined $meta_name) {
+        # also check for inherited non moose 'meta' method?
+        my $existing = $meta->get_method($meta_name);
+        if ($existing && !$existing->isa('Class::MOP::Method::Meta')) {
+            Carp::cluck "Moose::Role is overwriting an existing method named "
+                      . "$meta_name in role $role with a method "
+                      . "which returns the class's metaclass. If this is "
+                      . "actually what you want, you should remove the "
+                      . "existing method, otherwise, you should rename or "
+                      . "disable this generated method using the "
+                      . "'-meta_name' option to 'use Moose::Role'.";
+        }
+        $meta->_add_meta_method($meta_name);
     }
 
     return $meta;
@@ -141,14 +154,12 @@ sub init_meta {
 
 1;
 
+# ABSTRACT: The Moose Role
+
 __END__
 
 =pod
 
-=head1 NAME
-
-Moose::Role - The Moose Role
-
 =head1 SYNOPSIS
 
   package Eq;
@@ -173,6 +184,23 @@ Moose::Role - The Moose Role
       $self->as_float == $other->as_float;
   }
 
+  # ... and also
+
+  package Comparator;
+  use Moose;
+
+  has compare_to => (
+      is      => 'ro',
+      does    => 'Eq',
+      handles => 'Eq',
+  );
+
+  # ... which allows
+
+  my $currency1 = Currency->new(...);
+  my $currency2 = Currency->new(...);
+  Comparator->new(compare_to => $currency1)->equal($currency2);
+
 =head1 DESCRIPTION
 
 The concept of roles is documented in L<Moose::Manual::Roles>. This document
@@ -210,22 +238,10 @@ Moose::Role offers a way to remove the keywords it exports, through the
 C<unimport> method. You simply have to say C<no Moose::Role> at the bottom of
 your code for this to work.
 
-=head2 B<< Moose::Role->init_meta(for_class => $role, metaclass => $metaclass) >>
-
-The C<init_meta> method sets up the metaclass object for the role
-specified by C<for_class>. It also injects a a C<meta> accessor into
-the role so you can get at this object.
-
-The default metaclass is L<Moose::Meta::Role>. You can specify an
-alternate metaclass with the C<metaclass> parameter.
-
 =head1 METACLASS
 
-When you use Moose::Role, you can specify which metaclass to use:
-
-    use Moose::Role -metaclass => 'My::Meta::Role';
-
-You can also specify traits which will be applied to your role metaclass:
+When you use Moose::Role, you can specify traits which will be applied to your
+role metaclass:
 
     use Moose::Role -traits => 'My::Trait';
 
@@ -245,11 +261,12 @@ L<Moose::Util> 'apply_all_roles' or the role's metaclass:
 
 Doing this creates a new, mutable, anonymous subclass, applies the role to that,
 and reblesses. In a debugger, for example, you will see class names of the
-form C< Class::MOP::Class::__ANON__::SERIAL::6 >, which means that doing a 'ref'
-on your instance may not return what you expect. See L<Moose::Object> for 'DOES'.
+form C< Moose::Meta::Class::__ANON__::SERIAL::6 >, which means that doing a
+'ref' on your instance may not return what you expect. See L<Moose::Object> for
+'DOES'.
 
-Additional params may be added to the new instance by providing 'rebless_params'.
-See L<Moose::Meta::Role::Application::ToInstance>.
+Additional params may be added to the new instance by providing
+'rebless_params'. See L<Moose::Meta::Role::Application::ToInstance>.
 
 =head1 CAVEATS
 
@@ -283,19 +300,4 @@ ordering.
 
 See L<Moose/BUGS> for details on reporting bugs.
 
-=head1 AUTHOR
-
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
-
-Christian Hansen E<lt>chansen@cpan.orgE<gt>
-
-=head1 COPYRIGHT AND LICENSE
-
-Copyright 2006-2010 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.
-
 =cut