updatin
[gitmo/Moose.git] / lib / Moose.pm
index 1127479..fcae992 100644 (file)
@@ -1,12 +1,10 @@
 
-use lib '/Users/stevan/Projects/CPAN/Class-MOP/Class-MOP/lib';
-
 package Moose;
 
 use strict;
 use warnings;
 
-our $VERSION = '0.02';
+our $VERSION = '0.03_01';
 
 use Scalar::Util 'blessed', 'reftype';
 use Carp         'confess';
@@ -17,10 +15,12 @@ use UNIVERSAL::require;
 use Class::MOP;
 
 use Moose::Meta::Class;
+use Moose::Meta::TypeConstraint;
+use Moose::Meta::TypeCoercion;
 use Moose::Meta::Attribute;
 
 use Moose::Object;
-use Moose::Util::TypeConstraints ':no_export';
+use Moose::Util::TypeConstraints;
 
 sub import {
        shift;
@@ -29,19 +29,18 @@ sub import {
        # we should never export to main
        return if $pkg eq 'main';
        
-       Moose::Util::TypeConstraints->import($pkg);
+       #Moose::Util::TypeConstraints->import($pkg);
        
        # make a subtype for each Moose class
-    Moose::Util::TypeConstraints::subtype($pkg 
-        => Moose::Util::TypeConstraints::as Object 
-        => Moose::Util::TypeConstraints::where { $_->isa($pkg) }
-       );      
+    subtype $pkg 
+        => as 'Object' 
+        => where { $_->isa($pkg) };    
 
        my $meta;
        if ($pkg->can('meta')) {
                $meta = $pkg->meta();
                (blessed($meta) && $meta->isa('Class::MOP::Class'))
-                       || confess "Whoops, not møøsey enough";
+                       || confess "Whoops, not møøsey enough";
        }
        else {
                $meta = Moose::Meta::Class->initialize($pkg => (
@@ -61,29 +60,20 @@ sub import {
        
        # handle superclasses
        $meta->alias_method('extends' => subname 'Moose::extends' => sub { 
-           $_->require for @_;
+        _load_all_classes(@_);
            $meta->superclasses(@_) 
        });     
        
+       # handle roles
+       $meta->alias_method('with' => subname 'Moose::with' => sub { 
+           my ($role) = @_;
+        _load_all_classes($role);
+        $role->meta->apply($meta);
+       });     
+       
        # handle attributes
        $meta->alias_method('has' => subname 'Moose::has' => sub { 
                my ($name, %options) = @_;
-               if (exists $options{is}) {
-                       if ($options{is} eq 'ro') {
-                               $options{reader} = $name;
-                       }
-                       elsif ($options{is} eq 'rw') {
-                               $options{accessor} = $name;                             
-                       }                       
-               }
-               if (exists $options{isa}) {
-                   if (reftype($options{isa}) && reftype($options{isa}) eq 'CODE') {
-                               $options{type_constraint} = $options{isa};
-                       }
-                       else {
-                $options{type_constraint} = Moose::Util::TypeConstraints::find_type_constraint($options{isa});
-                       }
-               }
                $meta->add_attribute($name, %options) 
        });
 
@@ -100,6 +90,18 @@ sub import {
                my $code = pop @_;
                $meta->add_around_method_modifier($_, $code) for @_;    
        });     
+       
+       $meta->alias_method('super' => subname 'Moose::super' => sub {});
+       $meta->alias_method('override' => subname 'Moose::override' => sub {
+           my ($name, $method) = @_;
+           $meta->add_override_method_modifier($name => $method);
+       });             
+       
+       $meta->alias_method('inner' => subname 'Moose::inner' => sub {});
+       $meta->alias_method('augment' => subname 'Moose::augment' => sub {
+           my ($name, $method) = @_;
+           $meta->add_augment_method_modifier($name => $method);
+       });     
 
        # make sure they inherit from Moose::Object
        $meta->superclasses('Moose::Object')
@@ -111,6 +113,30 @@ sub import {
        $meta->alias_method('blessed' => \&Scalar::Util::blessed);                              
 }
 
+## Utility functions
+
+sub _load_all_classes {
+    foreach my $super (@_) {
+        # see if this is already 
+        # loaded in the symbol table
+        next if _is_class_already_loaded($super);
+        # otherwise require it ...
+        ($super->require)
+            || confess "Could not load superclass '$super' because : " . $UNIVERSAL::require::ERROR;
+    }    
+}
+
+sub _is_class_already_loaded {
+       my $name = shift;
+       no strict 'refs';
+       return 1 if defined ${"${name}::VERSION"} || defined @{"${name}::ISA"};
+       foreach (keys %{"${name}::"}) {
+               next if substr($_, -2, 2) eq '::';
+               return 1 if defined &{"${name}::$_"};
+       }
+    return 0;
+}
+
 1;
 
 __END__
@@ -149,7 +175,7 @@ Moose - Moose, it's the new Camel
   
 =head1 CAVEAT
 
-This is a B<very> early release of this module, it still needs 
+This is an early release of this module, it still needs 
 some fine tuning and B<lots> more documentation. I am adopting 
 the I<release early and release often> approach with this module, 
 so keep an eye on your favorite CPAN mirror!
@@ -197,20 +223,182 @@ more :)
 
 =back
 
+=head1 BUILDING CLASSES WITH MOOSE
+
+Moose makes every attempt to provide as much convience during class 
+construction/definition, but still stay out of your way if you want 
+it to. Here are some of the features Moose provides:
+
+Unless specified with C<extends>, any class which uses Moose will 
+inherit from L<Moose::Object>.
+
+Moose will also manage all attributes (including inherited ones) that 
+are defined with C<has>. And assuming that you call C<new> which is 
+inherited from L<Moose::Object>, then this includes properly initializing 
+all instance slots, setting defaults where approprtiate and performing any 
+type constraint checking or coercion. 
+
+For more details, see the ever expanding L<Moose::Cookbook>.
+
+=head1 EXPORTED FUNCTIONS
+
+Moose will export a number of functions into the class's namespace, which 
+can then be used to set up the class. These functions all work directly 
+on the current class.
+
+=over 4
+
+=item B<meta>
+
+This is a method which provides access to the current class's metaclass.
+
+=item B<extends (@superclasses)>
+
+This function will set the superclass(es) for the current class.
+
+This approach is recommended instead of C<use base>, because C<use base> 
+actually C<push>es onto the class's C<@ISA>, whereas C<extends> will 
+replace it. This is important to ensure that classes which do not have 
+superclasses properly inherit from L<Moose::Object>.
+
+=item B<with ($role)>
+
+This will apply a given C<$role> to the local class. Role support is 
+currently very experimental, see L<Moose::Role> for more details.
+
+=item B<has ($name, %options)>
+
+This will install an attribute of a given C<$name> into the current class. 
+The list of C<%options> are the same as those provided by both 
+L<Class::MOP::Attribute> and L<Moose::Meta::Attribute>, in addition to a 
+few convience ones provided by Moose which are listed below:
+
+=over 4
+
+=item I<is =E<gt> 'rw'|'ro'>
+
+The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read 
+only). These will create either a read/write accessor or a read-only 
+accessor respectively, using the same name as the C<$name> of the attribute.
+
+If you need more control over how your accessors are named, you can use the 
+I<reader>, I<writer> and I<accessor> options inherited from L<Moose::Meta::Attribute>.
+
+=item I<isa =E<gt> $type_name>
+
+The I<isa> option uses Moose's type constraint facilities to set up runtime 
+type checking for this attribute. Moose will perform the checks during class 
+construction, and within any accessors. The C<$type_name> argument must be a 
+string. The string can be either a class name, or a type defined using 
+Moose's type defintion features.
+
+=back
+
+=item B<before $name|@names =E<gt> sub { ... }>
+
+=item B<after $name|@names =E<gt> sub { ... }>
+
+=item B<around $name|@names =E<gt> sub { ... }>
+
+This three items are syntactic sugar for the before, after and around method 
+modifier features that L<Class::MOP> provides. More information on these can 
+be found in the L<Class::MOP> documentation for now. 
+
+=item B<super>
+
+The keyword C<super> is a noop when called outside of an C<override> method. In 
+the context of an C<override> method, it will call the next most appropriate 
+superclass method with the same arguments as the original method.
+
+=item B<override ($name, &sub)>
+
+An C<override> method, is a way of explictly saying "I am overriding this 
+method from my superclass". You can call C<super> within this method, and 
+it will work as expected. The same thing I<can> be accomplished with a normal 
+method call and the C<SUPER::> pseudo-package, it is really your choice. 
+
+=item B<inner>
+
+The keyword C<inner>, much like C<super>, is a no-op outside of the context of 
+an C<augment> method. You can think of C<inner> as being the inverse of 
+C<super>, the details of how C<inner> and C<augment> work is best described in 
+the L<Moose::Cookbook>.
+
+=item B<augment ($name, &sub)>
+
+An C<augment> method, is a way of explictly saying "I am augmenting this 
+method from my superclass". Once again, the details of how C<inner> and 
+C<augment> work is best described in the L<Moose::Cookbook>.
+
+=item B<confess>
+
+This is the C<Carp::confess> function, and exported here beause I use it 
+all the time. This feature may change in the future, so you have been warned. 
+
+=item B<blessed>
+
+This is the C<Scalar::Uti::blessed> function, it is exported here beause I 
+use it all the time. It is highly recommended that this is used instead of 
+C<ref> anywhere you need to test for an object's class name.
+
+=back
+
+=head1 CAVEATS
+
+=over 4
+
+=item *
+
+It should be noted that C<super> and C<inner> can B<not> be used in the same 
+method. However, they can be combined together with the same class hierarchy, 
+see F<t/014_override_augment_inner_super.t> for an example. 
+
+The reason that this is so is because C<super> is only valid within a method 
+with the C<override> modifier, and C<inner> will never be valid within an 
+C<override> method. In fact, C<augment> will skip over any C<override> methods 
+when searching for it's appropriate C<inner>. 
+
+This might seem like a restriction, but I am of the opinion that keeping these 
+two features seperate (but interoperable) actually makes them easy to use since 
+their behavior is then easier to predict. Time will tell if I am right or not.
+
+=back
+
 =head1 ACKNOWLEDGEMENTS
 
 =over 4
 
-=item I blame Sam Vilain for giving me my first hit of meta-model crack.
+=item I blame Sam Vilain for introducing me to the insanity that is meta-models.
 
-=item I blame Audrey Tang for encouraging that meta-crack habit in #perl6.
+=item I blame Audrey Tang for then encouraging my meta-model habit in #perl6.
 
-=item Without the love and encouragement of Yuval "nothingmuch" Kogman, 
-this module would not be possible (and it wouldn't have a name).
+=item Without Yuval "nothingmuch" Kogman this module would not be possible, 
+and it certainly wouldn't have this name ;P
 
 =item The basis of the TypeContraints module was Rob Kinyon's idea 
 originally, I just ran with it.
 
+=item Thanks to mst & chansen and the whole #moose poose for all the 
+ideas/feature-requests/encouragement
+
+=back
+
+=head1 SEE ALSO
+
+=over 4
+
+=item L<Class::MOP> documentation
+
+=item The #moose channel on irc.perl.org
+
+=item L<http://forum2.org/moose/>
+
+=item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf>
+
+This paper (suggested by lbr on #moose) was what lead to the implementation 
+of the C<super>/C<overrride> and C<inner>/C<augment> features. If you really 
+want to understand this feature, I suggest you read this.
+
 =back
 
 =head1 BUGS