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