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