foo
[gitmo/Moose.git] / lib / Moose / Role.pm
index 6f74e81..45034a2 100644 (file)
@@ -4,13 +4,15 @@ package Moose::Role;
 use strict;
 use warnings;
 
-use Scalar::Util ();
+use Scalar::Util 'blessed';
 use Carp         'confess';
 use Sub::Name    'subname';
 
 use Sub::Exporter;
 
-our $VERSION = '0.03';
+our $VERSION = '0.06';
+
+use Moose ();
 
 use Moose::Meta::Role;
 use Moose::Util::TypeConstraints;
@@ -27,17 +29,18 @@ use Moose::Util::TypeConstraints;
         subtype $role
             => as 'Role'
             => where { $_->does($role) }
+            => optimize_as { blessed($_[0]) && $_[0]->can('does') && $_[0]->does($role) }  
         unless find_type_constraint($role);        
 
        my $meta;
        if ($role->can('meta')) {
                $meta = $role->meta();
                (blessed($meta) && $meta->isa('Moose::Meta::Role'))
-                       || confess "Whoops, not møøsey enough";
+                || confess "You already have a &meta function, but it does not return a Moose::Meta::Role";
        }
        else {
-               $meta = Moose::Meta::Role->new(role_name => $role);
-               $meta->_role_meta->add_method('meta' => sub { $meta })          
+               $meta = Moose::Meta::Role->initialize($role);
+               $meta->Moose::Meta::Class::add_method('meta' => sub { $meta })          
        }
 
         return $METAS{$role} = $meta;
@@ -53,8 +56,9 @@ use Moose::Util::TypeConstraints;
            },
            with => sub {
                my $meta = _find_meta();
-               return subname 'Moose::Role::with' => sub { 
+               return subname 'Moose::Role::with' => sub (@) { 
                 my (@roles) = @_;
+                confess "Must specify at least one role" unless @roles;
                 Moose::_load_all_classes(@roles);
                 ($_->can('meta') && $_->meta->isa('Moose::Meta::Role'))
                     || confess "You can only consume roles, $_ is not a Moose role"
@@ -71,40 +75,42 @@ use Moose::Util::TypeConstraints;
            },  
         requires => sub {
             my $meta = _find_meta();
-            return subname 'Moose::Role::requires' => sub { 
+            return subname 'Moose::Role::requires' => sub (@) { 
+                confess "Must specify at least one method" unless @_;
                 $meta->add_required_methods(@_);
                };
            },  
         excludes => sub {
             my $meta = _find_meta();
-            return subname 'Moose::Role::excludes' => sub { 
+            return subname 'Moose::Role::excludes' => sub (@) { 
+                confess "Must specify at least one role" unless @_;
                 $meta->add_excluded_roles(@_);
                };
            },      
         has => sub {
             my $meta = _find_meta();
-            return subname 'Moose::Role::has' => sub { 
+            return subname 'Moose::Role::has' => sub ($;%) { 
                        my ($name, %options) = @_;
                        $meta->add_attribute($name, %options) 
                };
            },
         before => sub {
             my $meta = _find_meta();
-            return subname 'Moose::Role::before' => sub { 
-                       my $code = pop @_;
-                       $meta->add_before_method_modifier($_, $code) for @_;
+            return subname 'Moose::Role::before' => sub (@&) { 
+                my $code = pop @_;
+                $meta->add_before_method_modifier($_, $code) for @_;
                };
            },
         after => sub {
             my $meta = _find_meta();
-            return subname 'Moose::Role::after' => sub { 
+            return subname 'Moose::Role::after' => sub (@&) { 
                        my $code = pop @_;
                        $meta->add_after_method_modifier($_, $code) for @_;
                };
            },
         around => sub {
             my $meta = _find_meta();
-            return subname 'Moose::Role::around' => sub { 
+            return subname 'Moose::Role::around' => sub (@&) { 
                        my $code = pop @_;
                        $meta->add_around_method_modifier($_, $code) for @_;
                };
@@ -115,21 +121,21 @@ use Moose::Util::TypeConstraints;
         },
         override => sub {
             my $meta = _find_meta();
-            return subname 'Moose::Role::override' => sub {
+            return subname 'Moose::Role::override' => sub ($&) {
                 my ($name, $code) = @_;
-                       $meta->add_override_method_modifier($name, $code);
+                $meta->add_override_method_modifier($name, $code);
                };
            },          
         inner => sub {
             my $meta = _find_meta();
             return subname 'Moose::Role::inner' => sub {
-                confess "Moose::Role does not currently support 'inner'";          
+                confess "Moose::Role cannot support 'inner'";
                };
            },
         augment => sub {
             my $meta = _find_meta();
             return subname 'Moose::Role::augment' => sub {
-                confess "Moose::Role does not currently support 'augment'";
+                confess "Moose::Role cannot support 'augment'";
                };
            },
         confess => sub {
@@ -149,6 +155,9 @@ use Moose::Util::TypeConstraints;
     
     sub import {
         $CALLER = caller();
+        
+        strict->import;
+        warnings->import;        
 
         # we should never export to main
         return if $CALLER eq 'main';
@@ -198,29 +207,41 @@ Moose::Role - The Moose Role
 
 =head1 DESCRIPTION
 
-This is currently a very early release of Perl 6 style Roles for 
-Moose, it is still incomplete, but getting much closer. If you are 
-interested in helping move this feature along, please come to 
-#moose on irc.perl.org and we can talk. 
+Role support in Moose is coming along quite well. It's best documentation 
+is still the the test suite, but it is fairly safe to assume Perl 6 style 
+behavior, and then either refer to the test suite, or ask questions on 
+#moose if something doesn't quite do what you expect. More complete 
+documentation is planned and will be included with the next official 
+(non-developer) release.
 
-=head1 CAVEATS
+=head1 EXPORTED FUNCTIONS
+
+Currently Moose::Role supports all of the functions that L<Moose> exports, 
+but differs slightly in how some items are handled (see L<CAVEATS> below 
+for details). 
 
-Currently, the role support has a few of caveats. They are as follows:
+Moose::Role also offers two role specific keyword exports:
 
 =over 4
 
-=item *
+=item B<requires (@method_names)>
 
-At this time classes I<cannot> correctly consume more than one role. The 
-role composition process, and it's conflict detection has not been added
-yet. While this should be considered a major feature, it can easily be 
-worked around, and in many cases, is not needed at all.
-A class can actually consume multiple roles, they are just applied one 
-after another in the order you ask for them. This is incorrect behavior, 
-the roles should be merged first, and conflicts determined, etc. However, 
-if your roles do not have any conflicts, then things will work just 
-fine. This actually tends to be quite sufficient for basic roles.
+Roles can require that certain methods are implemented by any class which 
+C<does> the role. 
+
+=item B<excludes (@role_names)>
+
+Roles can C<exclude> other roles, in effect saying "I can never be combined
+with these C<@role_names>". This is a feature which should not be used 
+lightly. 
+
+=back
+
+=head1 CAVEATS
+
+The role support now has only a few caveats. They are as follows:
+
+=over 4
 
 =item *
 
@@ -229,6 +250,29 @@ The same is true of the C<augment> and C<inner> keywords (not sure those
 really make sense for roles). All other Moose keywords will be I<deferred> 
 so that they can be applied to the consuming class. 
 
+=item * 
+
+Role composition does it's best to B<not> be order sensitive when it comes
+to conflict resolution and requirements detection. However, it is order 
+sensitive when it comes to method modifiers. All before/around/after modifiers
+are included whenever a role is composed into a class, and then are applied 
+in the order the roles are used. This too means that there is no conflict for 
+before/around/after modifiers as well. 
+
+In most cases, this will be a non issue, however it is something to keep in 
+mind when using method modifiers in a role. You should never assume any 
+ordering.
+
+=item *
+
+The C<requires> keyword currently only works with actual methods. A method 
+modifier (before/around/after and override) will not count as a fufillment 
+of the requirement, and neither will an autogenerated accessor for an attribute.
+
+It is likely that the attribute accessors will eventually be allowed to fufill 
+those requirements, either that or we will introduce a C<requires_attr> keyword
+of some kind instead. This descision has not yet been finalized.
+
 =back
 
 =head1 BUGS
@@ -252,4 +296,4 @@ 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
\ No newline at end of file
+=cut