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