remove the name => undef restriction on find_or_create_{isa,does}_type_constraint
[gitmo/Moose.git] / lib / Moose.pm
1
2 package Moose;
3
4 use strict;
5 use warnings;
6
7 our $VERSION   = '0.41';
8 our $AUTHORITY = 'cpan:STEVAN';
9
10 use Scalar::Util 'blessed', 'reftype';
11 use Carp         'confess', 'croak';
12 use Sub::Name    'subname';
13
14 use Sub::Exporter;
15
16 use Class::MOP;
17
18 use Moose::Meta::Class;
19 use Moose::Meta::TypeConstraint;
20 use Moose::Meta::TypeCoercion;
21 use Moose::Meta::Attribute;
22 use Moose::Meta::Instance;
23
24 use Moose::Meta::Role;
25
26 use Moose::Object;
27 use Moose::Util::TypeConstraints;
28 use Moose::Util ();
29
30 {
31     my $CALLER;
32
33     sub init_meta {
34         my ( $class, $base_class, $metaclass ) = @_;
35         $base_class = 'Moose::Object'      unless defined $base_class;
36         $metaclass  = 'Moose::Meta::Class' unless defined $metaclass;
37
38         confess
39             "The Metaclass $metaclass must be a subclass of Moose::Meta::Class."
40             unless $metaclass->isa('Moose::Meta::Class');
41
42         # make a subtype for each Moose class
43         class_type($class)
44             unless find_type_constraint($class);
45
46         my $meta;
47         if ( $class->can('meta') ) {
48             # NOTE:
49             # this is the case where the metaclass pragma
50             # was used before the 'use Moose' statement to
51             # override a specific class
52             $meta = $class->meta();
53             ( blessed($meta) && $meta->isa('Moose::Meta::Class') )
54               || confess "You already have a &meta function, but it does not return a Moose::Meta::Class";
55         }
56         else {
57             # NOTE:
58             # this is broken currently, we actually need
59             # to allow the possiblity of an inherited
60             # meta, which will not be visible until the
61             # user 'extends' first. This needs to have
62             # more intelligence to it
63             $meta = $metaclass->initialize($class);
64             $meta->add_method(
65                 'meta' => sub {
66                     # re-initialize so it inherits properly
67                     $metaclass->initialize( blessed( $_[0] ) || $_[0] );
68                 }
69             );
70         }
71
72         # make sure they inherit from Moose::Object
73         $meta->superclasses($base_class)
74           unless $meta->superclasses();
75          
76         return $meta;
77     }
78
79     my %exports = (
80         extends => sub {
81             my $class = $CALLER;
82             return subname 'Moose::extends' => sub (@) {
83                 confess "Must derive at least one class" unless @_;
84         
85                 my @supers = @_;
86                 foreach my $super (@supers) {
87                     Class::MOP::load_class($super);
88                 }
89
90                 # this checks the metaclass to make sure
91                 # it is correct, sometimes it can get out
92                 # of sync when the classes are being built
93                 my $meta = $class->meta->_fix_metaclass_incompatability(@supers);
94                 $meta->superclasses(@supers);
95             };
96         },
97         with => sub {
98             my $class = $CALLER;
99             return subname 'Moose::with' => sub (@) {
100                 Moose::Util::apply_all_roles($class->meta, @_)
101             };
102         },
103         has => sub {
104             my $class = $CALLER;
105             return subname 'Moose::has' => sub ($;%) {
106                 my $name    = shift;
107                 croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1;
108                 my %options = @_;
109                 my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ];
110                 $class->meta->add_attribute( $_, %options ) for @$attrs;
111             };
112         },
113         before => sub {
114             my $class = $CALLER;
115             return subname 'Moose::before' => sub (@&) {
116                 my $code = pop @_;
117                 my $meta = $class->meta;
118                 $meta->add_before_method_modifier( $_, $code ) for @_;
119             };
120         },
121         after => sub {
122             my $class = $CALLER;
123             return subname 'Moose::after' => sub (@&) {
124                 my $code = pop @_;
125                 my $meta = $class->meta;
126                 $meta->add_after_method_modifier( $_, $code ) for @_;
127             };
128         },
129         around => sub {
130             my $class = $CALLER;
131             return subname 'Moose::around' => sub (@&) {
132                 my $code = pop @_;
133                 my $meta = $class->meta;
134                 $meta->add_around_method_modifier( $_, $code ) for @_;
135             };
136         },
137         super => sub {
138             {
139                 our %SUPER_SLOT;
140                 no strict 'refs';
141                 $SUPER_SLOT{$CALLER} = \*{"${CALLER}::super"};
142             }
143             return subname 'Moose::super' => sub { };
144         },
145         override => sub {
146             my $class = $CALLER;
147             return subname 'Moose::override' => sub ($&) {
148                 my ( $name, $method ) = @_;
149                 $class->meta->add_override_method_modifier( $name => $method );
150             };
151         },
152         inner => sub {
153             {
154                 our %INNER_SLOT;
155                 no strict 'refs';
156                 $INNER_SLOT{$CALLER} = \*{"${CALLER}::inner"};
157             }
158             return subname 'Moose::inner' => sub { };
159         },
160         augment => sub {
161             my $class = $CALLER;
162             return subname 'Moose::augment' => sub (@&) {
163                 my ( $name, $method ) = @_;
164                 $class->meta->add_augment_method_modifier( $name => $method );
165             };
166         },
167         make_immutable => sub {
168             my $class = $CALLER;
169             return subname 'Moose::make_immutable' => sub {
170                 warn "The make_immutable keyword has been deprecated, " . 
171                      "please go back to __PACKAGE__->meta->make_immutable\n";
172                 $class->meta->make_immutable(@_);
173             };            
174         },        
175         confess => sub {
176             return \&Carp::confess;
177         },
178         blessed => sub {
179             return \&Scalar::Util::blessed;
180         },
181     );
182
183     my $exporter = Sub::Exporter::build_exporter(
184         {
185             exports => \%exports,
186             groups  => { default => [':all'] }
187         }
188     );
189
190     # 1 extra level because it's called by import so there's a layer of indirection
191     sub _get_caller{
192         my $offset = 1;
193         return
194             ref $_[1] && defined $_[1]->{into}
195             ? $_[1]->{into}
196             : ref $_[1] && defined $_[1]->{into_level}
197             ? caller($offset + $_[1]->{into_level})
198             : caller($offset);
199     }
200
201     sub import {
202         $CALLER = _get_caller(@_);
203
204         # this works because both pragmas set $^H (see perldoc perlvar)
205         # which affects the current compilation - i.e. the file who use'd
206         # us - which is why we don't need to do anything special to make
207         # it affect that file rather than this one (which is already compiled)
208
209         strict->import;
210         warnings->import;
211
212         # we should never export to main
213         return if $CALLER eq 'main';
214
215         init_meta( $CALLER, 'Moose::Object' );
216
217         goto $exporter;
218     }
219
220     sub unimport {
221         no strict 'refs';
222         my $class = _get_caller(@_);
223
224         # loop through the exports ...
225         foreach my $name ( keys %exports ) {
226
227             # if we find one ...
228             if ( defined &{ $class . '::' . $name } ) {
229                 my $keyword = \&{ $class . '::' . $name };
230
231                 # make sure it is from Moose
232                 my ($pkg_name) = Class::MOP::get_code_info($keyword);
233                 next if $@;
234                 next if $pkg_name ne 'Moose';
235
236                 # and if it is from Moose then undef the slot
237                 delete ${ $class . '::' }{$name};
238             }
239         }
240     }
241
242 }
243
244 ## make 'em all immutable
245
246 $_->meta->make_immutable(
247     inline_constructor => 0,
248     inline_accessors   => 1,  # these are Class::MOP accessors, so they need inlining
249   )
250   for (
251     'Moose::Meta::Attribute',
252     'Moose::Meta::Class',
253     'Moose::Meta::Instance',
254
255     'Moose::Meta::TypeConstraint',
256     'Moose::Meta::TypeConstraint::Union',
257     'Moose::Meta::TypeConstraint::Parameterized',
258     'Moose::Meta::TypeCoercion',
259
260     'Moose::Meta::Method',
261     'Moose::Meta::Method::Accessor',
262     'Moose::Meta::Method::Constructor',
263     'Moose::Meta::Method::Destructor',
264     'Moose::Meta::Method::Overriden',
265
266     'Moose::Meta::Role',
267     'Moose::Meta::Role::Method',
268     'Moose::Meta::Role::Method::Required',
269   );
270
271 1;
272
273 __END__
274
275 =pod
276
277 =head1 NAME
278
279 Moose - A postmodern object system for Perl 5
280
281 =head1 SYNOPSIS
282
283   package Point;
284   use Moose; # automatically turns on strict and warnings
285
286   has 'x' => (is => 'rw', isa => 'Int');
287   has 'y' => (is => 'rw', isa => 'Int');
288
289   sub clear {
290       my $self = shift;
291       $self->x(0);
292       $self->y(0);
293   }
294
295   package Point3D;
296   use Moose;
297
298   extends 'Point';
299
300   has 'z' => (is => 'rw', isa => 'Int');
301
302   after 'clear' => sub {
303       my $self = shift;
304       $self->z(0);
305   };
306
307 =head1 DESCRIPTION
308
309 Moose is an extension of the Perl 5 object system.
310
311 =head2 Another object system!?!?
312
313 Yes, I know there has been an explosion recently of new ways to
314 build object's in Perl 5, most of them based on inside-out objects
315 and other such things. Moose is different because it is not a new
316 object system for Perl 5, but instead an extension of the existing
317 object system.
318
319 Moose is built on top of L<Class::MOP>, which is a metaclass system
320 for Perl 5. This means that Moose not only makes building normal
321 Perl 5 objects better, but it also provides the power of metaclass
322 programming.
323
324 =head2 Is this for real? Or is this just an experiment?
325
326 Moose is I<based> on the prototypes and experiments I did for the Perl 6
327 meta-model. However, Moose is B<NOT> an experiment/prototype; it is for B<real>.
328
329 =head2 Is this ready for use in production?
330
331 Yes, I believe that it is.
332
333 Moose has been used successfully in production environemnts by several people
334 and companies (including the one I work for). There are Moose applications
335 which have been in production with little or no issue now for well over a year.
336 I consider it highly stable and we are commited to keeping it stable.
337
338 Of course, in the end, you need to make this call yourself. If you have
339 any questions or concerns, please feel free to email me, or even the list
340 or just stop by #moose and ask away.
341
342 =head2 Is Moose just Perl 6 in Perl 5?
343
344 No. While Moose is very much inspired by Perl 6, it is not itself Perl 6.
345 Instead, it is an OO system for Perl 5. I built Moose because I was tired of
346 writing the same old boring Perl 5 OO code, and drooling over Perl 6 OO. So
347 instead of switching to Ruby, I wrote Moose :)
348
349 =head2 Wait, I<post> modern, I thought it was just I<modern>?
350
351 So I was reading Larry Wall's talk from the 1999 Linux World entitled 
352 "Perl, the first postmodern computer language" in which he talks about how 
353 he picked the features for Perl because he thought they were cool and he 
354 threw out the ones that he thought sucked. This got me thinking about how 
355 we have done the same thing in Moose. For Moose, we have "borrowed" features 
356 from Perl 6, CLOS (LISP), Smalltalk, Java, BETA, OCaml, Ruby and more, and 
357 the bits we didn't like (cause they sucked) we tossed aside. So for this 
358 reason (and a few others) I have re-dubbed Moose a I<postmodern> object system.
359
360 Nuff Said. 
361
362 =head2 Moose Extensions
363
364 The L<MooseX::> namespace is the official place to find Moose extensions.
365 There are a number of these modules out on CPAN right now the best way to
366 find them is to search for MooseX:: on search.cpan.org.
367
368 =head1 BUILDING CLASSES WITH MOOSE
369
370 Moose makes every attempt to provide as much convenience as possible during
371 class construction/definition, but still stay out of your way if you want it
372 to. Here are a few items to note when building classes with Moose.
373
374 Unless specified with C<extends>, any class which uses Moose will
375 inherit from L<Moose::Object>.
376
377 Moose will also manage all attributes (including inherited ones) that are
378 defined with C<has>. And (assuming you call C<new>, which is inherited from
379 L<Moose::Object>) this includes properly initializing all instance slots,
380 setting defaults where appropriate, and performing any type constraint checking
381 or coercion.
382
383 =head1 PROVIDED METHODS
384
385 Moose provides a number of methods to all your classes, mostly through the 
386 inheritance of L<Moose::Object>. There is however, one exception.
387
388 =over 4
389
390 =item B<meta>
391
392 This is a method which provides access to the current class's metaclass.
393
394 =back
395
396 =head1 EXPORTED FUNCTIONS
397
398 Moose will export a number of functions into the class's namespace which
399 may then be used to set up the class. These functions all work directly
400 on the current class.
401
402 =over 4
403
404 =item B<extends (@superclasses)>
405
406 This function will set the superclass(es) for the current class.
407
408 This approach is recommended instead of C<use base>, because C<use base>
409 actually C<push>es onto the class's C<@ISA>, whereas C<extends> will
410 replace it. This is important to ensure that classes which do not have
411 superclasses still properly inherit from L<Moose::Object>.
412
413 =item B<with (@roles)>
414
415 This will apply a given set of C<@roles> to the local class. 
416
417 =item B<has $name =E<gt> %options>
418
419 This will install an attribute of a given C<$name> into the current class.
420 The C<%options> are the same as those provided by
421 L<Class::MOP::Attribute>, in addition to the list below which are provided
422 by Moose (L<Moose::Meta::Attribute> to be more specific):
423
424 =over 4
425
426 =item I<is =E<gt> 'rw'|'ro'>
427
428 The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read
429 only). These will create either a read/write accessor or a read-only
430 accessor respectively, using the same name as the C<$name> of the attribute.
431
432 If you need more control over how your accessors are named, you can use the
433 I<reader>, I<writer> and I<accessor> options inherited from
434 L<Class::MOP::Attribute>, however if you use those, you won't need the I<is> 
435 option.
436
437 =item I<isa =E<gt> $type_name>
438
439 The I<isa> option uses Moose's type constraint facilities to set up runtime
440 type checking for this attribute. Moose will perform the checks during class
441 construction, and within any accessors. The C<$type_name> argument must be a
442 string. The string may be either a class name or a type defined using
443 Moose's type definition features. (Refer to L<Moose::Util::TypeConstraints>
444 for information on how to define a new type, and how to retrieve type meta-data).
445
446 =item I<coerce =E<gt> (1|0)>
447
448 This will attempt to use coercion with the supplied type constraint to change
449 the value passed into any accessors or constructors. You B<must> have supplied
450 a type constraint in order for this to work. See L<Moose::Cookbook::Recipe5>
451 for an example.
452
453 =item I<does =E<gt> $role_name>
454
455 This will accept the name of a role which the value stored in this attribute
456 is expected to have consumed.
457
458 =item I<required =E<gt> (1|0)>
459
460 This marks the attribute as being required. This means a I<defined> value must be
461 supplied during class construction, and the attribute may never be set to
462 C<undef> with an accessor.
463
464 =item I<weak_ref =E<gt> (1|0)>
465
466 This will tell the class to store the value of this attribute as a weakened
467 reference. If an attribute is a weakened reference, it B<cannot> also be
468 coerced.
469
470 =item I<lazy =E<gt> (1|0)>
471
472 This will tell the class to not create this slot until absolutely necessary.
473 If an attribute is marked as lazy it B<must> have a default supplied.
474
475 =item I<auto_deref =E<gt> (1|0)>
476
477 This tells the accessor whether to automatically dereference the value returned.
478 This is only legal if your C<isa> option is either C<ArrayRef> or C<HashRef>.
479
480 =item I<trigger =E<gt> $code>
481
482 The I<trigger> option is a CODE reference which will be called after the value of
483 the attribute is set. The CODE ref will be passed the instance itself, the
484 updated value and the attribute meta-object (this is for more advanced fiddling
485 and can typically be ignored). You B<cannot> have a trigger on a read-only
486 attribute.
487
488 =item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | CODE>
489
490 The I<handles> option provides Moose classes with automated delegation features.
491 This is a pretty complex and powerful option. It accepts many different option
492 formats, each with its own benefits and drawbacks.
493
494 B<NOTE:> The class being delegated to does not need to be a Moose based class,
495 which is why this feature is especially useful when wrapping non-Moose classes.
496
497 All I<handles> option formats share the following traits:
498
499 You cannot override a locally defined method with a delegated method; an
500 exception will be thrown if you try. That is to say, if you define C<foo> in
501 your class, you cannot override it with a delegated C<foo>. This is almost never
502 something you would want to do, and if it is, you should do it by hand and not
503 use Moose.
504
505 You cannot override any of the methods found in Moose::Object, or the C<BUILD>
506 and C<DEMOLISH> methods. These will not throw an exception, but will silently
507 move on to the next method in the list. My reasoning for this is that you would
508 almost never want to do this, since it usually breaks your class. As with
509 overriding locally defined methods, if you do want to do this, you should do it
510 manually, not with Moose.
511
512 You do not I<need> to have a reader (or accessor) for the attribute in order 
513 to delegate to it. Moose will create a means of accessing the value for you, 
514 however this will be several times B<less> efficient then if you had given 
515 the attribute a reader (or accessor) to use.
516
517 Below is the documentation for each option format:
518
519 =over 4
520
521 =item C<ARRAY>
522
523 This is the most common usage for I<handles>. You basically pass a list of
524 method names to be delegated, and Moose will install a delegation method
525 for each one.
526
527 =item C<HASH>
528
529 This is the second most common usage for I<handles>. Instead of a list of
530 method names, you pass a HASH ref where each key is the method name you
531 want installed locally, and its value is the name of the original method
532 in the class being delegated to.
533
534 This can be very useful for recursive classes like trees. Here is a
535 quick example (soon to be expanded into a Moose::Cookbook::Recipe):
536
537   package Tree;
538   use Moose;
539
540   has 'node' => (is => 'rw', isa => 'Any');
541
542   has 'children' => (
543       is      => 'ro',
544       isa     => 'ArrayRef',
545       default => sub { [] }
546   );
547
548   has 'parent' => (
549       is          => 'rw',
550       isa         => 'Tree',
551       weak_ref => 1,
552       handles     => {
553           parent_node => 'node',
554           siblings    => 'children',
555       }
556   );
557
558 In this example, the Tree package gets C<parent_node> and C<siblings> methods,
559 which delegate to the C<node> and C<children> methods (respectively) of the Tree
560 instance stored in the C<parent> slot.
561
562 =item C<REGEXP>
563
564 The regexp option works very similar to the ARRAY option, except that it builds
565 the list of methods for you. It starts by collecting all possible methods of the
566 class being delegated to, then filters that list using the regexp supplied here.
567
568 B<NOTE:> An I<isa> option is required when using the regexp option format. This
569 is so that we can determine (at compile time) the method list from the class.
570 Without an I<isa> this is just not possible.
571
572 =item C<ROLE>
573
574 With the role option, you specify the name of a role whose "interface" then
575 becomes the list of methods to handle. The "interface" can be defined as; the
576 methods of the role and any required methods of the role. It should be noted
577 that this does B<not> include any method modifiers or generated attribute
578 methods (which is consistent with role composition).
579
580 =item C<CODE>
581
582 This is the option to use when you really want to do something funky. You should
583 only use it if you really know what you are doing, as it involves manual
584 metaclass twiddling.
585
586 This takes a code reference, which should expect two arguments. The first is the
587 attribute meta-object this I<handles> is attached to. The second is the
588 metaclass of the class being delegated to. It expects you to return a hash (not
589 a HASH ref) of the methods you want mapped.
590
591 =back
592
593 =item I<metaclass =E<gt> $metaclass_name>
594
595 This tells the class to use a custom attribute metaclass for this particular
596 attribute. Custom attribute metaclasses are useful for extending the
597 capabilities of the I<has> keyword: they are the simplest way to extend the MOP,
598 but they are still a fairly advanced topic and too much to cover here, see 
599 L<Moose::Cookbook::Recipe11> for more information.
600
601 The default behavior here is to just load C<$metaclass_name>; however, we also
602 have a way to alias to a shorter name. This will first look to see if
603 B<Moose::Meta::Attribute::Custom::$metaclass_name> exists. If it does, Moose
604 will then check to see if that has the method C<register_implementation>, which
605 should return the actual name of the custom attribute metaclass. If there is no
606 C<register_implementation> method, it will fall back to using
607 B<Moose::Meta::Attribute::Custom::$metaclass_name> as the metaclass name.
608
609 =item I<traits =E<gt> [ @role_names ]>
610
611 This tells Moose to take the list of C<@role_names> and apply them to the 
612 attribute meta-object. This is very similar to the I<metaclass> option, but 
613 allows you to use more than one extension at a time. This too is an advanced 
614 topic, we don't yet have a cookbook for it though. 
615
616 As with I<metaclass>, the default behavior is to just load C<$role_name>; however, 
617 we also have a way to alias to a shorter name. This will first look to see if
618 B<Moose::Meta::Attribute::Custom::Trait::$role_name> exists. If it does, Moose
619 will then check to see if that has the method C<register_implementation>, which
620 should return the actual name of the custom attribute trait. If there is no
621 C<register_implementation> method, it will fall back to using
622 B<Moose::Meta::Attribute::Custom::Trait::$metaclass_name> as the trait name.
623
624 =back
625
626 =item B<has +$name =E<gt> %options>
627
628 This is variation on the normal attibute creator C<has> which allows you to
629 clone and extend an attribute from a superclass or from a role. Here is an 
630 example of the superclass usage:
631
632   package Foo;
633   use Moose;
634
635   has 'message' => (
636       is      => 'rw',
637       isa     => 'Str',
638       default => 'Hello, I am a Foo'
639   );
640
641   package My::Foo;
642   use Moose;
643
644   extends 'Foo';
645
646   has '+message' => (default => 'Hello I am My::Foo');
647
648 What is happening here is that B<My::Foo> is cloning the C<message> attribute
649 from its parent class B<Foo>, retaining the C<is =E<gt> 'rw'> and C<isa =E<gt>
650 'Str'> characteristics, but changing the value in C<default>.
651
652 Here is another example, but within the context of a role:
653
654   package Foo::Role;
655   use Moose::Role;
656   
657   has 'message' => (
658       is      => 'rw',
659       isa     => 'Str',
660       default => 'Hello, I am a Foo'
661   );
662   
663   package My::Foo;
664   use Moose;
665   
666   with 'Foo::Role';
667   
668   has '+message' => (default => 'Hello I am My::Foo');
669
670 In this case, we are basically taking the attribute which the role supplied 
671 and altering it within the bounds of this feature. 
672
673 Aside from where the attributes come from (one from superclass, the other 
674 from a role), this feature works exactly the same. This feature is restricted 
675 somewhat, so as to try and force at least I<some> sanity into it. You are only 
676 allowed to change the following attributes:
677
678 =over 4
679
680 =item I<default>
681
682 Change the default value of an attribute.
683
684 =item I<coerce>
685
686 Change whether the attribute attempts to coerce a value passed to it.
687
688 =item I<required>
689
690 Change if the attribute is required to have a value.
691
692 =item I<documentation>
693
694 Change the documentation string associated with the attribute.
695
696 =item I<lazy>
697
698 Change if the attribute lazily initializes the slot.
699
700 =item I<isa>
701
702 You I<are> allowed to change the type without restriction. 
703
704 It is recommended that you use this freedom with caution. We used to 
705 only allow for extension only if the type was a subtype of the parent's 
706 type, but we felt that was too restrictive and is better left as a 
707 policy descision. 
708
709 =item I<handles>
710
711 You are allowed to B<add> a new C<handles> definition, but you are B<not>
712 allowed to I<change> one.
713
714 =item I<builder>
715
716 You are allowed to B<add> a new C<builder> definition, but you are B<not>
717 allowed to I<change> one.
718
719 =back
720
721 =item B<before $name|@names =E<gt> sub { ... }>
722
723 =item B<after $name|@names =E<gt> sub { ... }>
724
725 =item B<around $name|@names =E<gt> sub { ... }>
726
727 This three items are syntactic sugar for the before, after, and around method
728 modifier features that L<Class::MOP> provides. More information on these may be
729 found in the L<Class::MOP::Class documentation|Class::MOP::Class/"Method
730 Modifiers"> for now.
731
732 =item B<super>
733
734 The keyword C<super> is a no-op when called outside of an C<override> method. In
735 the context of an C<override> method, it will call the next most appropriate
736 superclass method with the same arguments as the original method.
737
738 =item B<override ($name, &sub)>
739
740 An C<override> method is a way of explicitly saying "I am overriding this
741 method from my superclass". You can call C<super> within this method, and
742 it will work as expected. The same thing I<can> be accomplished with a normal
743 method call and the C<SUPER::> pseudo-package; it is really your choice.
744
745 =item B<inner>
746
747 The keyword C<inner>, much like C<super>, is a no-op outside of the context of
748 an C<augment> method. You can think of C<inner> as being the inverse of
749 C<super>; the details of how C<inner> and C<augment> work is best described in
750 the L<Moose::Cookbook::Recipe7>.
751
752 =item B<augment ($name, &sub)>
753
754 An C<augment> method, is a way of explicitly saying "I am augmenting this
755 method from my superclass". Once again, the details of how C<inner> and
756 C<augment> work is best described in the L<Moose::Cookbook::Recipe7>.
757
758 =item B<confess>
759
760 This is the C<Carp::confess> function, and exported here because I use it
761 all the time. 
762
763 =item B<blessed>
764
765 This is the C<Scalar::Util::blessed> function, it is exported here because I
766 use it all the time. It is highly recommended that this is used instead of
767 C<ref> anywhere you need to test for an object's class name.
768
769 =back
770
771 =head1 UNIMPORTING FUNCTIONS
772
773 =head2 B<unimport>
774
775 Moose offers a way to remove the keywords it exports, through the C<unimport>
776 method. You simply have to say C<no Moose> at the bottom of your code for this
777 to work. Here is an example:
778
779     package Person;
780     use Moose;
781
782     has 'first_name' => (is => 'rw', isa => 'Str');
783     has 'last_name'  => (is => 'rw', isa => 'Str');
784
785     sub full_name {
786         my $self = shift;
787         $self->first_name . ' ' . $self->last_name
788     }
789
790     no Moose; # keywords are removed from the Person package
791
792 =head1 EXTENDING AND EMBEDDING MOOSE
793
794 Moose also offers some options for extending or embedding it into your own
795 framework. The basic premise is to have something that sets up your class'
796 metaclass and export the moose declarators (C<has>, C<with>, C<extends>,...).
797 Here is an example:
798
799     package MyFramework;
800     use Moose;
801
802     sub import {
803         my $CALLER = caller();
804
805         strict->import;
806         warnings->import;
807
808         # we should never export to main
809         return if $CALLER eq 'main';
810         Moose::init_meta( $CALLER, 'MyFramework::Base' );
811         Moose->import({into => $CALLER});
812
813         # Do my custom framework stuff
814
815         return 1;
816     }
817
818 =head2 B<import>
819
820 Moose's C<import> method supports the L<Sub::Exporter> form of C<{into =E<gt> $pkg}>
821 and C<{into_level =E<gt> 1}>
822
823 =head2 B<init_meta ($class, $baseclass, $metaclass)>
824
825 Moose does some boot strapping: it creates a metaclass object for your class,
826 and then injects a C<meta> accessor into your class to retrieve it. Then it
827 sets your baseclass to Moose::Object or the value you pass in unless you already
828 have one. This is all done via C<init_meta> which takes the name of your class
829 and optionally a baseclass and a metaclass as arguments.
830
831 =head1 CAVEATS
832
833 =over 4
834
835 =item *
836
837 It should be noted that C<super> and C<inner> B<cannot> be used in the same
838 method. However, they may be combined within the same class hierarchy; see
839 F<t/014_override_augment_inner_super.t> for an example.
840
841 The reason for this is that C<super> is only valid within a method
842 with the C<override> modifier, and C<inner> will never be valid within an
843 C<override> method. In fact, C<augment> will skip over any C<override> methods
844 when searching for its appropriate C<inner>.
845
846 This might seem like a restriction, but I am of the opinion that keeping these
847 two features separate (yet interoperable) actually makes them easy to use, since
848 their behavior is then easier to predict. Time will tell whether I am right or
849 not (UPDATE: so far so good).
850
851 =item *
852
853 It is important to note that we currently have no simple way of combining 
854 multiple extended versions of Moose (see L<EXTENDING AND EMBEDDING MOOSE> above), 
855 and that in many cases they will conflict with one another. We are working on 
856 developing a way around this issue, but in the meantime, you have been warned.
857
858 =back
859
860 =head1 ACKNOWLEDGEMENTS
861
862 =over 4
863
864 =item I blame Sam Vilain for introducing me to the insanity that is meta-models.
865
866 =item I blame Audrey Tang for then encouraging my meta-model habit in #perl6.
867
868 =item Without Yuval "nothingmuch" Kogman this module would not be possible,
869 and it certainly wouldn't have this name ;P
870
871 =item The basis of the TypeContraints module was Rob Kinyon's idea
872 originally, I just ran with it.
873
874 =item Thanks to mst & chansen and the whole #moose posse for all the
875 early ideas/feature-requests/encouragement/bug-finding.
876
877 =item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes.
878
879 =back
880
881 =head1 SEE ALSO
882
883 =over 4
884
885 =item L<http://www.iinteractive.com/moose>
886
887 This is the official web home of Moose, it contains links to our public SVN repo
888 as well as links to a number of talks and articles on Moose and Moose related
889 technologies.
890
891 =item L<Class::MOP> documentation
892
893 =item The #moose channel on irc.perl.org
894
895 =item The Moose mailing list - moose@perl.org
896
897 =item Moose stats on ohloh.net - L<http://www.ohloh.net/projects/5788>
898
899 =item Several Moose extension modules in the L<MooseX::> namespace.
900
901 =back
902
903 =head2 Books
904
905 =over 4
906
907 =item The Art of the MetaObject Protocol
908
909 I mention this in the L<Class::MOP> docs too, this book was critical in 
910 the development of both modules and is highly recommended.
911
912 =back
913
914 =head2 Papers
915
916 =over 4
917
918 =item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf>
919
920 This paper (suggested by lbr on #moose) was what lead to the implementation
921 of the C<super>/C<override> and C<inner>/C<augment> features. If you really
922 want to understand them, I suggest you read this.
923
924 =back
925
926 =head1 BUGS
927
928 All complex software has bugs lurking in it, and this module is no
929 exception. If you find a bug please either email me, or add the bug
930 to cpan-RT.
931
932 =head1 AUTHOR
933
934 Stevan Little E<lt>stevan@iinteractive.comE<gt>
935
936 B<with contributions from:>
937
938 Aankhen
939
940 Adam (Alias) Kennedy
941
942 Anders (Debolaz) Nor Berle
943
944 Nathan (kolibre) Gray
945
946 Christian (chansen) Hansen
947
948 Hans Dieter (confound) Pearcey
949
950 Eric (ewilhelm) Wilhelm
951
952 Guillermo (groditi) Roditi
953
954 Jess (castaway) Robinson
955
956 Matt (mst) Trout
957
958 Robert (phaylon) Sedlacek
959
960 Robert (rlb3) Boone
961
962 Scott (konobi) McWhirter
963
964 Shlomi (rindolf) Fish
965
966 Yuval (nothingmuch) Kogman
967
968 Chris (perigrin) Prather
969
970 Jonathan (jrockway) Rockway
971
972 Piotr (dexter) Roszatycki
973
974 Sam (mugwump) Vilain
975
976 Shawn (sartak) Moore
977
978 ... and many other #moose folks
979
980 =head1 COPYRIGHT AND LICENSE
981
982 Copyright 2006-2008 by Infinity Interactive, Inc.
983
984 L<http://www.iinteractive.com>
985
986 This library is free software; you can redistribute it and/or modify
987 it under the same terms as Perl itself.
988
989 =cut