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