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