bump version to 0.81
[gitmo/Moose.git] / lib / Moose.pm
1
2 package Moose;
3
4 use 5.008;
5
6 our $VERSION   = '0.81';
7 $VERSION = eval $VERSION;
8 our $AUTHORITY = 'cpan:STEVAN';
9
10 use Scalar::Util 'blessed';
11 use Carp         'confess';
12
13 use Moose::Exporter;
14
15 use Class::MOP 0.85;
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::Object;
24
25 use Moose::Meta::Role;
26 use Moose::Meta::Role::Composite;
27 use Moose::Meta::Role::Application;
28 use Moose::Meta::Role::Application::RoleSummation;
29 use Moose::Meta::Role::Application::ToClass;
30 use Moose::Meta::Role::Application::ToRole;
31 use Moose::Meta::Role::Application::ToInstance;
32
33 use Moose::Util::TypeConstraints;
34 use Moose::Util ();
35
36 sub _caller_info {
37     my $level = @_ ? ($_[0] + 1) : 2;
38     my %info;
39     @info{qw(package file line)} = caller($level);
40     return \%info;
41 }
42
43 sub throw_error {
44     # FIXME This
45     shift;
46     goto \&confess
47 }
48
49 sub extends {
50     my $class = shift;
51
52     Moose->throw_error("Must derive at least one class") unless @_;
53
54     # this checks the metaclass to make sure
55     # it is correct, sometimes it can get out
56     # of sync when the classes are being built
57     Moose::Meta::Class->initialize($class)->superclasses(@_);
58 }
59
60 sub with {
61     my $class = shift;
62     Moose::Util::apply_all_roles(Class::MOP::Class->initialize($class), @_);
63 }
64
65 sub has {
66     my $class = shift;
67     my $name  = shift;
68
69     Moose->throw_error('Usage: has \'name\' => ( key => value, ... )')
70         if @_ % 2 == 1;
71
72     my %options = ( definition_context => _caller_info(), @_ );
73     my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ];
74     Class::MOP::Class->initialize($class)->add_attribute( $_, %options ) for @$attrs;
75 }
76
77 sub before {
78     my $class = shift;
79     Moose::Util::add_method_modifier($class, 'before', \@_);
80 }
81
82 sub after {
83     my $class = shift;
84     Moose::Util::add_method_modifier($class, 'after', \@_);
85 }
86
87 sub around {
88     my $class = shift;
89     Moose::Util::add_method_modifier($class, 'around', \@_);
90 }
91
92 our $SUPER_PACKAGE;
93 our $SUPER_BODY;
94 our @SUPER_ARGS;
95
96 sub super {
97     # This check avoids a recursion loop - see
98     # t/100_bugs/020_super_recursion.t
99     return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
100     return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
101 }
102
103 sub override {
104     my $class = shift;
105     my ( $name, $method ) = @_;
106     Class::MOP::Class->initialize($class)->add_override_method_modifier( $name => $method );
107 }
108
109 sub inner {
110     my $pkg = caller();
111     our ( %INNER_BODY, %INNER_ARGS );
112
113     if ( my $body = $INNER_BODY{$pkg} ) {
114         my @args = @{ $INNER_ARGS{$pkg} };
115         local $INNER_ARGS{$pkg};
116         local $INNER_BODY{$pkg};
117         return $body->(@args);
118     } else {
119         return;
120     }
121 }
122
123 sub augment {
124     my $class = shift;
125     my ( $name, $method ) = @_;
126     Class::MOP::Class->initialize($class)->add_augment_method_modifier( $name => $method );
127 }
128
129 Moose::Exporter->setup_import_methods(
130     with_caller => [
131         qw( extends with has before after around override augment)
132     ],
133     as_is => [
134         qw( super inner ),
135         \&Carp::confess,
136         \&Scalar::Util::blessed,
137     ],
138 );
139
140 sub init_meta {
141     # This used to be called as a function. This hack preserves
142     # backwards compatibility.
143     if ( $_[0] ne __PACKAGE__ ) {
144         return __PACKAGE__->init_meta(
145             for_class  => $_[0],
146             base_class => $_[1],
147             metaclass  => $_[2],
148         );
149     }
150
151     shift;
152     my %args = @_;
153
154     my $class = $args{for_class}
155         or Moose->throw_error("Cannot call init_meta without specifying a for_class");
156     my $base_class = $args{base_class} || 'Moose::Object';
157     my $metaclass  = $args{metaclass}  || 'Moose::Meta::Class';
158
159     Moose->throw_error("The Metaclass $metaclass must be a subclass of Moose::Meta::Class.")
160         unless $metaclass->isa('Moose::Meta::Class');
161
162     # make a subtype for each Moose class
163     class_type($class)
164         unless find_type_constraint($class);
165
166     my $meta;
167
168     if ( $meta = Class::MOP::get_metaclass_by_name($class) ) {
169         unless ( $meta->isa("Moose::Meta::Class") ) {
170             Moose->throw_error("$class already has a metaclass, but it does not inherit $metaclass ($meta)");
171         }
172     } else {
173         # no metaclass, no 'meta' method
174
175         # now we check whether our ancestors have metaclass, and if so borrow that
176         my ( undef, @isa ) = @{ $class->mro::get_linear_isa };
177
178         foreach my $ancestor ( @isa ) {
179             my $ancestor_meta = Class::MOP::get_metaclass_by_name($ancestor) || next;
180
181             my $ancestor_meta_class = ($ancestor_meta->is_immutable
182                 ? $ancestor_meta->get_mutable_metaclass_name
183                 : ref($ancestor_meta));
184
185             # if we have an ancestor metaclass that inherits $metaclass, we use
186             # that. This is like _fix_metaclass_incompatibility, but we can do it now.
187
188             # the case of having an ancestry is not very common, but arises in
189             # e.g. Reaction
190             unless ( $metaclass->isa( $ancestor_meta_class ) ) {
191                 if ( $ancestor_meta_class->isa($metaclass) ) {
192                     $metaclass = $ancestor_meta_class;
193                 }
194             }
195         }
196
197         $meta = $metaclass->initialize($class);
198     }
199
200     if ( $class->can('meta') ) {
201         # check 'meta' method
202
203         # it may be inherited
204
205         # NOTE:
206         # this is the case where the metaclass pragma
207         # was used before the 'use Moose' statement to
208         # override a specific class
209         my $method_meta = $class->meta;
210
211         ( blessed($method_meta) && $method_meta->isa('Moose::Meta::Class') )
212             || Moose->throw_error("$class already has a &meta function, but it does not return a Moose::Meta::Class ($method_meta)");
213
214         $meta = $method_meta;
215     }
216
217     unless ( $meta->has_method("meta") ) { # don't overwrite
218         # also check for inherited non moose 'meta' method?
219         # FIXME also skip this if the user requested by passing an option
220         $meta->add_method(
221             'meta' => sub {
222                 # re-initialize so it inherits properly
223                 $metaclass->initialize( ref($_[0]) || $_[0] );
224             }
225         );
226     }
227
228     # make sure they inherit from Moose::Object
229     $meta->superclasses($base_class)
230       unless $meta->superclasses();
231
232     return $meta;
233 }
234
235 # This may be used in some older MooseX extensions.
236 sub _get_caller {
237     goto &Moose::Exporter::_get_caller;
238 }
239
240 ## make 'em all immutable
241
242 $_->make_immutable(
243     inline_constructor => 1,
244     constructor_name   => "_new",
245     # these are Class::MOP accessors, so they need inlining
246     inline_accessors => 1
247     ) for grep { $_->is_mutable }
248     map { $_->meta }
249     qw(
250     Moose::Meta::Attribute
251     Moose::Meta::Class
252     Moose::Meta::Instance
253
254     Moose::Meta::TypeCoercion
255     Moose::Meta::TypeCoercion::Union
256
257     Moose::Meta::Method
258     Moose::Meta::Method::Accessor
259     Moose::Meta::Method::Constructor
260     Moose::Meta::Method::Destructor
261     Moose::Meta::Method::Overridden
262     Moose::Meta::Method::Augmented
263
264     Moose::Meta::Role
265     Moose::Meta::Role::Method
266     Moose::Meta::Role::Method::Required
267     Moose::Meta::Role::Method::Conflicting
268
269     Moose::Meta::Role::Composite
270
271     Moose::Meta::Role::Application
272     Moose::Meta::Role::Application::RoleSummation
273     Moose::Meta::Role::Application::ToClass
274     Moose::Meta::Role::Application::ToRole
275     Moose::Meta::Role::Application::ToInstance
276 );
277
278 1;
279
280 __END__
281
282 =pod
283
284 =head1 NAME
285
286 Moose - A postmodern object system for Perl 5
287
288 =head1 SYNOPSIS
289
290   package Point;
291   use Moose; # automatically turns on strict and warnings
292
293   has 'x' => (is => 'rw', isa => 'Int');
294   has 'y' => (is => 'rw', isa => 'Int');
295
296   sub clear {
297       my $self = shift;
298       $self->x(0);
299       $self->y(0);
300   }
301
302   package Point3D;
303   use Moose;
304
305   extends 'Point';
306
307   has 'z' => (is => 'rw', isa => 'Int');
308
309   after 'clear' => sub {
310       my $self = shift;
311       $self->z(0);
312   };
313
314 =head1 DESCRIPTION
315
316 Moose is an extension of the Perl 5 object system.
317
318 The main goal of Moose is to make Perl 5 Object Oriented programming
319 easier, more consistent and less tedious. With Moose you can to think
320 more about what you want to do and less about the mechanics of OOP.
321
322 Additionally, Moose is built on top of L<Class::MOP>, which is a
323 metaclass system for Perl 5. This means that Moose not only makes
324 building normal Perl 5 objects better, but it provides the power of
325 metaclass programming as well.
326
327 =head2 New to Moose?
328
329 If you're new to Moose, the best place to start is the
330 L<Moose::Manual> docs, followed by the L<Moose::Cookbook>. The intro
331 will show you what Moose is, and how it makes Perl 5 OO better.
332
333 The cookbook recipes on Moose basics will get you up to speed with
334 many of Moose's features quickly. Once you have an idea of what Moose
335 can do, you can use the API documentation to get more detail on
336 features which interest you.
337
338 =head2 Moose Extensions
339
340 The C<MooseX::> namespace is the official place to find Moose extensions.
341 These extensions can be found on the CPAN.  The easiest way to find them
342 is to search for them (L<http://search.cpan.org/search?query=MooseX::>),
343 or to examine L<Task::Moose> which aims to keep an up-to-date, easily
344 installable list of Moose extensions.
345
346 =head1 BUILDING CLASSES WITH MOOSE
347
348 Moose makes every attempt to provide as much convenience as possible during
349 class construction/definition, but still stay out of your way if you want it
350 to. Here are a few items to note when building classes with Moose.
351
352 Unless specified with C<extends>, any class which uses Moose will
353 inherit from L<Moose::Object>.
354
355 Moose will also manage all attributes (including inherited ones) that are
356 defined with C<has>. And (assuming you call C<new>, which is inherited from
357 L<Moose::Object>) this includes properly initializing all instance slots,
358 setting defaults where appropriate, and performing any type constraint checking
359 or coercion.
360
361 =head1 PROVIDED METHODS
362
363 Moose provides a number of methods to all your classes, mostly through the
364 inheritance of L<Moose::Object>. There is however, one exception.
365
366 =over 4
367
368 =item B<meta>
369
370 This is a method which provides access to the current class's metaclass.
371
372 =back
373
374 =head1 EXPORTED FUNCTIONS
375
376 Moose will export a number of functions into the class's namespace which
377 may then be used to set up the class. These functions all work directly
378 on the current class.
379
380 =over 4
381
382 =item B<extends (@superclasses)>
383
384 This function will set the superclass(es) for the current class.
385
386 This approach is recommended instead of C<use base>, because C<use base>
387 actually C<push>es onto the class's C<@ISA>, whereas C<extends> will
388 replace it. This is important to ensure that classes which do not have
389 superclasses still properly inherit from L<Moose::Object>.
390
391 =item B<with (@roles)>
392
393 This will apply a given set of C<@roles> to the local class.
394
395 =item B<has $name|@$names =E<gt> %options>
396
397 This will install an attribute of a given C<$name> into the current class. If
398 the first parameter is an array reference, it will create an attribute for
399 every C<$name> in the list. The C<%options> are the same as those provided by
400 L<Class::MOP::Attribute>, in addition to the list below which are provided by
401 Moose (L<Moose::Meta::Attribute> to be more specific):
402
403 =over 4
404
405 =item I<is =E<gt> 'rw'|'ro'>
406
407 The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read
408 only). These will create either a read/write accessor or a read-only
409 accessor respectively, using the same name as the C<$name> of the attribute.
410
411 If you need more control over how your accessors are named, you can
412 use the L<reader|Class::MOP::Attribute/reader>,
413 L<writer|Class::MOP::Attribute/writer> and
414 L<accessor|Class::MOP::Attribute/accessor> options inherited from
415 L<Class::MOP::Attribute>, however if you use those, you won't need the
416 I<is> option.
417
418 =item I<isa =E<gt> $type_name>
419
420 The I<isa> option uses Moose's type constraint facilities to set up runtime
421 type checking for this attribute. Moose will perform the checks during class
422 construction, and within any accessors. The C<$type_name> argument must be a
423 string. The string may be either a class name or a type defined using
424 Moose's type definition features. (Refer to L<Moose::Util::TypeConstraints>
425 for information on how to define a new type, and how to retrieve type meta-data).
426
427 =item I<coerce =E<gt> (1|0)>
428
429 This will attempt to use coercion with the supplied type constraint to change
430 the value passed into any accessors or constructors. You B<must> have supplied
431 a type constraint in order for this to work. See L<Moose::Cookbook::Basics::Recipe5>
432 for an example.
433
434 =item I<does =E<gt> $role_name>
435
436 This will accept the name of a role which the value stored in this attribute
437 is expected to have consumed.
438
439 =item I<required =E<gt> (1|0)>
440
441 This marks the attribute as being required. This means a value must be
442 supplied during class construction, I<or> the attribute must be lazy
443 and have either a default or a builder. Note that c<required> does not
444 say anything about the attribute's value, which can be C<undef>.
445
446 =item I<weak_ref =E<gt> (1|0)>
447
448 This will tell the class to store the value of this attribute as a weakened
449 reference. If an attribute is a weakened reference, it B<cannot> also be
450 coerced.
451
452 =item I<lazy =E<gt> (1|0)>
453
454 This will tell the class to not create this slot until absolutely necessary.
455 If an attribute is marked as lazy it B<must> have a default supplied.
456
457 =item I<auto_deref =E<gt> (1|0)>
458
459 This tells the accessor whether to automatically dereference the value returned.
460 This is only legal if your C<isa> option is either C<ArrayRef> or C<HashRef>.
461
462 =item I<trigger =E<gt> $code>
463
464 The I<trigger> option is a CODE reference which will be called after
465 the value of the attribute is set. The CODE ref will be passed the
466 instance itself and the updated value. You B<cannot> have a trigger on
467 a read-only attribute.
468
469 B<NOTE:> Triggers will only fire when you B<assign> to the attribute,
470 either in the constructor, or using the writer. Default and built values will
471 B<not> cause the trigger to be fired.
472
473 =item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | CODE>
474
475 The I<handles> option provides Moose classes with automated delegation features.
476 This is a pretty complex and powerful option. It accepts many different option
477 formats, each with its own benefits and drawbacks.
478
479 B<NOTE:> The class being delegated to does not need to be a Moose based class,
480 which is why this feature is especially useful when wrapping non-Moose classes.
481
482 All I<handles> option formats share the following traits:
483
484 You cannot override a locally defined method with a delegated method; an
485 exception will be thrown if you try. That is to say, if you define C<foo> in
486 your class, you cannot override it with a delegated C<foo>. This is almost never
487 something you would want to do, and if it is, you should do it by hand and not
488 use Moose.
489
490 You cannot override any of the methods found in Moose::Object, or the C<BUILD>
491 and C<DEMOLISH> methods. These will not throw an exception, but will silently
492 move on to the next method in the list. My reasoning for this is that you would
493 almost never want to do this, since it usually breaks your class. As with
494 overriding locally defined methods, if you do want to do this, you should do it
495 manually, not with Moose.
496
497 You do not I<need> to have a reader (or accessor) for the attribute in order
498 to delegate to it. Moose will create a means of accessing the value for you,
499 however this will be several times B<less> efficient then if you had given
500 the attribute a reader (or accessor) to use.
501
502 Below is the documentation for each option format:
503
504 =over 4
505
506 =item C<ARRAY>
507
508 This is the most common usage for I<handles>. You basically pass a list of
509 method names to be delegated, and Moose will install a delegation method
510 for each one.
511
512 =item C<HASH>
513
514 This is the second most common usage for I<handles>. Instead of a list of
515 method names, you pass a HASH ref where each key is the method name you
516 want installed locally, and its value is the name of the original method
517 in the class being delegated to.
518
519 This can be very useful for recursive classes like trees. Here is a
520 quick example (soon to be expanded into a Moose::Cookbook recipe):
521
522   package Tree;
523   use Moose;
524
525   has 'node' => (is => 'rw', isa => 'Any');
526
527   has 'children' => (
528       is      => 'ro',
529       isa     => 'ArrayRef',
530       default => sub { [] }
531   );
532
533   has 'parent' => (
534       is          => 'rw',
535       isa         => 'Tree',
536       weak_ref => 1,
537       handles     => {
538           parent_node => 'node',
539           siblings    => 'children',
540       }
541   );
542
543 In this example, the Tree package gets C<parent_node> and C<siblings> methods,
544 which delegate to the C<node> and C<children> methods (respectively) of the Tree
545 instance stored in the C<parent> slot.
546
547 =item C<REGEXP>
548
549 The regexp option works very similar to the ARRAY option, except that it builds
550 the list of methods for you. It starts by collecting all possible methods of the
551 class being delegated to, then filters that list using the regexp supplied here.
552
553 B<NOTE:> An I<isa> option is required when using the regexp option format. This
554 is so that we can determine (at compile time) the method list from the class.
555 Without an I<isa> this is just not possible.
556
557 =item C<ROLE>
558
559 With the role option, you specify the name of a role whose "interface" then
560 becomes the list of methods to handle. The "interface" can be defined as; the
561 methods of the role and any required methods of the role. It should be noted
562 that this does B<not> include any method modifiers or generated attribute
563 methods (which is consistent with role composition).
564
565 =item C<CODE>
566
567 This is the option to use when you really want to do something funky. You should
568 only use it if you really know what you are doing, as it involves manual
569 metaclass twiddling.
570
571 This takes a code reference, which should expect two arguments. The first is the
572 attribute meta-object this I<handles> is attached to. The second is the
573 metaclass of the class being delegated to. It expects you to return a hash (not
574 a HASH ref) of the methods you want mapped.
575
576 =back
577
578 =item I<metaclass =E<gt> $metaclass_name>
579
580 This tells the class to use a custom attribute metaclass for this particular
581 attribute. Custom attribute metaclasses are useful for extending the
582 capabilities of the I<has> keyword: they are the simplest way to extend the MOP,
583 but they are still a fairly advanced topic and too much to cover here, see
584 L<Moose::Cookbook::Meta::Recipe1> for more information.
585
586 The default behavior here is to just load C<$metaclass_name>; however, we also
587 have a way to alias to a shorter name. This will first look to see if
588 B<Moose::Meta::Attribute::Custom::$metaclass_name> exists. If it does, Moose
589 will then check to see if that has the method C<register_implementation>, which
590 should return the actual name of the custom attribute metaclass. If there is no
591 C<register_implementation> method, it will fall back to using
592 B<Moose::Meta::Attribute::Custom::$metaclass_name> as the metaclass name.
593
594 =item I<traits =E<gt> [ @role_names ]>
595
596 This tells Moose to take the list of C<@role_names> and apply them to the
597 attribute meta-object. This is very similar to the I<metaclass> option, but
598 allows you to use more than one extension at a time.
599
600 See L<TRAIT NAME RESOLUTION> for details on how a trait name is
601 resolved to a class name.
602
603 Also see L<Moose::Cookbook::Meta::Recipe3> for a metaclass trait
604 example.
605
606 =item I<builder> => Str
607
608 The value of this key is the name of the method that will be called to
609 obtain the value used to initialize the attribute. See the L<builder
610 option docs in Class::MOP::Attribute|Class::MOP::Attribute/builder>
611  and/or L<Moose::Cookbook::Basics::Recipe9> for more information.
612
613 =item I<default> => SCALAR | CODE
614
615 The value of this key is the default value which will initialize the attribute.
616
617 NOTE: If the value is a simple scalar (string or number), then it can
618 be just passed as is.  However, if you wish to initialize it with a
619 HASH or ARRAY ref, then you need to wrap that inside a CODE reference.
620 See the L<default option docs in
621 Class::MOP::Attribute|Class::MOP::Attribute/default> for more
622 information.
623
624 =item I<clearer> => Str
625
626 Creates a method allowing you to clear the value, see the L<clearer option
627 docs in Class::MOP::Attribute|Class::MOP::Attribute/clearer> for more
628 information.
629
630 =item I<predicate> => Str
631
632 Creates a method to perform a basic test to see if a value has been set in the
633 attribute, see the L<predicate option docs in
634 Class::MOP::Attribute|Class::MOP::Attribute/predicate> for more information.
635
636 =item I<lazy_build> => (0|1)
637
638 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
639 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
640
641 =item I<initializer> => Str
642
643 This may be a method name (referring to a method on the class with
644 this attribute) or a CODE ref.  The initializer is used to set the
645 attribute value on an instance when the attribute is set during
646 instance initialization (but not when the value is being assigned
647 to). See the L<initializer option docs in
648 Class::MOP::Attribute|Class::MOP::Attribute/initializer> for more
649 information.
650
651 =back
652
653 =item B<has +$name =E<gt> %options>
654
655 This is variation on the normal attribute creator C<has> which allows you to
656 clone and extend an attribute from a superclass or from a role. Here is an
657 example of the superclass usage:
658
659   package Foo;
660   use Moose;
661
662   has 'message' => (
663       is      => 'rw',
664       isa     => 'Str',
665       default => 'Hello, I am a Foo'
666   );
667
668   package My::Foo;
669   use Moose;
670
671   extends 'Foo';
672
673   has '+message' => (default => 'Hello I am My::Foo');
674
675 What is happening here is that B<My::Foo> is cloning the C<message> attribute
676 from its parent class B<Foo>, retaining the C<is =E<gt> 'rw'> and C<isa =E<gt>
677 'Str'> characteristics, but changing the value in C<default>.
678
679 Here is another example, but within the context of a role:
680
681   package Foo::Role;
682   use Moose::Role;
683
684   has 'message' => (
685       is      => 'rw',
686       isa     => 'Str',
687       default => 'Hello, I am a Foo'
688   );
689
690   package My::Foo;
691   use Moose;
692
693   with 'Foo::Role';
694
695   has '+message' => (default => 'Hello I am My::Foo');
696
697 In this case, we are basically taking the attribute which the role supplied
698 and altering it within the bounds of this feature.
699
700 Aside from where the attributes come from (one from superclass, the other
701 from a role), this feature works exactly the same. This feature is restricted
702 somewhat, so as to try and force at least I<some> sanity into it. You are only
703 allowed to change the following attributes:
704
705 =over 4
706
707 =item I<default>
708
709 Change the default value of an attribute.
710
711 =item I<coerce>
712
713 Change whether the attribute attempts to coerce a value passed to it.
714
715 =item I<required>
716
717 Change if the attribute is required to have a value.
718
719 =item I<documentation>
720
721 Change the documentation string associated with the attribute.
722
723 =item I<lazy>
724
725 Change if the attribute lazily initializes the slot.
726
727 =item I<isa>
728
729 You I<are> allowed to change the type without restriction.
730
731 It is recommended that you use this freedom with caution. We used to
732 only allow for extension only if the type was a subtype of the parent's
733 type, but we felt that was too restrictive and is better left as a
734 policy decision.
735
736 =item I<handles>
737
738 You are allowed to B<add> a new C<handles> definition, but you are B<not>
739 allowed to I<change> one.
740
741 =item I<builder>
742
743 You are allowed to B<add> a new C<builder> definition, but you are B<not>
744 allowed to I<change> one.
745
746 =item I<metaclass>
747
748 You are allowed to B<add> a new C<metaclass> definition, but you are
749 B<not> allowed to I<change> one.
750
751 =item I<traits>
752
753 You are allowed to B<add> additional traits to the C<traits> definition.
754 These traits will be composed into the attribute, but preexisting traits
755 B<are not> overridden, or removed.
756
757 =back
758
759 =item B<before $name|@names =E<gt> sub { ... }>
760
761 =item B<after $name|@names =E<gt> sub { ... }>
762
763 =item B<around $name|@names =E<gt> sub { ... }>
764
765 This three items are syntactic sugar for the before, after, and around method
766 modifier features that L<Class::MOP> provides. More information on these may be
767 found in the L<Class::MOP::Class documentation|Class::MOP::Class/"Method
768 Modifiers"> for now.
769
770 =item B<super>
771
772 The keyword C<super> is a no-op when called outside of an C<override> method. In
773 the context of an C<override> method, it will call the next most appropriate
774 superclass method with the same arguments as the original method.
775
776 =item B<override ($name, &sub)>
777
778 An C<override> method is a way of explicitly saying "I am overriding this
779 method from my superclass". You can call C<super> within this method, and
780 it will work as expected. The same thing I<can> be accomplished with a normal
781 method call and the C<SUPER::> pseudo-package; it is really your choice.
782
783 =item B<inner>
784
785 The keyword C<inner>, much like C<super>, is a no-op outside of the context of
786 an C<augment> method. You can think of C<inner> as being the inverse of
787 C<super>; the details of how C<inner> and C<augment> work is best described in
788 the L<Moose::Cookbook::Basics::Recipe6>.
789
790 =item B<augment ($name, &sub)>
791
792 An C<augment> method, is a way of explicitly saying "I am augmenting this
793 method from my superclass". Once again, the details of how C<inner> and
794 C<augment> work is best described in the L<Moose::Cookbook::Basics::Recipe6>.
795
796 =item B<confess>
797
798 This is the C<Carp::confess> function, and exported here because I use it
799 all the time.
800
801 =item B<blessed>
802
803 This is the C<Scalar::Util::blessed> function, it is exported here because I
804 use it all the time. It is highly recommended that this is used instead of
805 C<ref> anywhere you need to test for an object's class name.
806
807 =back
808
809 =head1 METACLASS
810
811 When you use Moose, you can specify which metaclass to use:
812
813     use Moose -metaclass => 'My::Meta::Class';
814
815 You can also specify traits which will be applied to your metaclass:
816
817     use Moose -traits => 'My::Trait';
818
819 This is very similar to the attribute traits feature. When you do
820 this, your class's C<meta> object will have the specified traits
821 applied to it. See L<TRAIT NAME RESOLUTION> for more details.
822
823 =head2 Trait Name Resolution
824
825 By default, when given a trait name, Moose simply tries to load a
826 class of the same name. If such a class does not exist, it then looks
827 for for a class matching
828 B<Moose::Meta::$type::Custom::Trait::$trait_name>. The C<$type>
829 variable here will be one of B<Attribute> or B<Class>, depending on
830 what the trait is being applied to.
831
832 If a class with this long name exists, Moose checks to see if it has
833 the method C<register_implementation>. This method is expected to
834 return the I<real> class name of the trait. If there is no
835 C<register_implementation> method, it will fall back to using
836 B<Moose::Meta::$type::Custom::Trait::$trait> as the trait name.
837
838 If all this is confusing, take a look at
839 L<Moose::Cookbook::Meta::Recipe3>, which demonstrates how to create an
840 attribute trait.
841
842 =head1 UNIMPORTING FUNCTIONS
843
844 =head2 B<unimport>
845
846 Moose offers a way to remove the keywords it exports, through the C<unimport>
847 method. You simply have to say C<no Moose> at the bottom of your code for this
848 to work. Here is an example:
849
850     package Person;
851     use Moose;
852
853     has 'first_name' => (is => 'rw', isa => 'Str');
854     has 'last_name'  => (is => 'rw', isa => 'Str');
855
856     sub full_name {
857         my $self = shift;
858         $self->first_name . ' ' . $self->last_name
859     }
860
861     no Moose; # keywords are removed from the Person package
862
863 =head1 EXTENDING AND EMBEDDING MOOSE
864
865 To learn more about extending Moose, we recommend checking out the
866 "Extending" recipes in the L<Moose::Cookbook>, starting with
867 L<Moose::Cookbook::Extending::Recipe1>, which provides an overview of
868 all the different ways you might extend Moose.
869
870 =head2 B<< Moose->init_meta(for_class => $class, base_class => $baseclass, metaclass => $metaclass) >>
871
872 The C<init_meta> method sets up the metaclass object for the class
873 specified by C<for_class>. This method injects a a C<meta> accessor
874 into the class so you can get at this object. It also sets the class's
875 superclass to C<base_class>, with L<Moose::Object> as the default.
876
877 C<init_meta> returns the metaclass object for C<$class>.
878
879 You can specify an alternate metaclass with the C<metaclass> option.
880
881 For more detail on this topic, see L<Moose::Cookbook::Extending::Recipe2>.
882
883 This method used to be documented as a function which accepted
884 positional parameters. This calling style will still work for
885 backwards compatibility, but is deprecated.
886
887 =head2 B<import>
888
889 Moose's C<import> method supports the L<Sub::Exporter> form of C<{into =E<gt> $pkg}>
890 and C<{into_level =E<gt> 1}>.
891
892 B<NOTE>: Doing this is more or less deprecated. Use L<Moose::Exporter>
893 instead, which lets you stack multiple C<Moose.pm>-alike modules
894 sanely. It handles getting the exported functions into the right place
895 for you.
896
897 =head2 B<throw_error>
898
899 An alias for C<confess>, used by internally by Moose.
900
901 =head1 METACLASS COMPATIBILITY AND MOOSE
902
903 Metaclass compatibility is a thorny subject. You should start by
904 reading the "About Metaclass compatibility" section in the
905 C<Class::MOP> docs.
906
907 Moose will attempt to resolve a few cases of metaclass incompatibility
908 when you set the superclasses for a class, unlike C<Class::MOP>, which
909 simply dies if the metaclasses are incompatible.
910
911 In actuality, Moose fixes incompatibility for I<all> of a class's
912 metaclasses, not just the class metaclass. That includes the instance
913 metaclass, attribute metaclass, as well as its constructor class and
914 destructor class. However, for simplicity this discussion will just
915 refer to "metaclass", meaning the class metaclass, most of the time.
916
917 Moose has two algorithms for fixing metaclass incompatibility.
918
919 The first algorithm is very simple. If all the metaclass for the
920 parent is a I<subclass> of the child's metaclass, then we simply
921 replace the child's metaclass with the parent's.
922
923 The second algorithm is more complicated. It tries to determine if the
924 metaclasses only "differ by roles". This means that the parent and
925 child's metaclass share a common ancestor in their respective
926 hierarchies, and that the subclasses under the common ancestor are
927 only different because of role applications. This case is actually
928 fairly common when you mix and match various C<MooseX::*> modules,
929 many of which apply roles to the metaclass.
930
931 If the parent and child do differ by roles, Moose replaces the
932 metaclass in the child with a newly created metaclass. This metaclass
933 is a subclass of the parent's metaclass, does all of the roles that
934 the child's metaclass did before being replaced. Effectively, this
935 means the new metaclass does all of the roles done by both the
936 parent's and child's original metaclasses.
937
938 Ultimately, this is all transparent to you except in the case of an
939 unresolvable conflict.
940
941 =head2 The MooseX:: namespace
942
943 Generally if you're writing an extension I<for> Moose itself you'll want
944 to put your extension in the C<MooseX::> namespace. This namespace is
945 specifically for extensions that make Moose better or different in some
946 fundamental way. It is traditionally B<not> for a package that just happens
947 to use Moose. This namespace follows from the examples of the C<LWPx::>
948 and C<DBIx::> namespaces that perform the same function for C<LWP> and C<DBI>
949 respectively.
950
951 =head1 CAVEATS
952
953 =over 4
954
955 =item *
956
957 It should be noted that C<super> and C<inner> B<cannot> be used in the same
958 method. However, they may be combined within the same class hierarchy; see
959 F<t/014_override_augment_inner_super.t> for an example.
960
961 The reason for this is that C<super> is only valid within a method
962 with the C<override> modifier, and C<inner> will never be valid within an
963 C<override> method. In fact, C<augment> will skip over any C<override> methods
964 when searching for its appropriate C<inner>.
965
966 This might seem like a restriction, but I am of the opinion that keeping these
967 two features separate (yet interoperable) actually makes them easy to use, since
968 their behavior is then easier to predict. Time will tell whether I am right or
969 not (UPDATE: so far so good).
970
971 =back
972
973 =head1 GETTING HELP
974
975 We offer both a mailing list and a very active IRC channel.
976
977 The mailing list is L<moose@perl.org>. You must be subscribed to send
978 a message. To subscribe, send an empty message to
979 L<moose-subscribe@perl.org>
980
981 You can also visit us at L<#moose on
982 irc.perl.org|irc://irc.perl.org/#moose>. This channel is quite active,
983 and questions at all levels (on Moose-related topics ;) are welcome.
984
985 =head1 ACKNOWLEDGEMENTS
986
987 =over 4
988
989 =item I blame Sam Vilain for introducing me to the insanity that is meta-models.
990
991 =item I blame Audrey Tang for then encouraging my meta-model habit in #perl6.
992
993 =item Without Yuval "nothingmuch" Kogman this module would not be possible,
994 and it certainly wouldn't have this name ;P
995
996 =item The basis of the TypeContraints module was Rob Kinyon's idea
997 originally, I just ran with it.
998
999 =item Thanks to mst & chansen and the whole #moose posse for all the
1000 early ideas/feature-requests/encouragement/bug-finding.
1001
1002 =item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes.
1003
1004 =back
1005
1006 =head1 SEE ALSO
1007
1008 =over 4
1009
1010 =item L<http://www.iinteractive.com/moose>
1011
1012 This is the official web home of Moose, it contains links to our public SVN repository
1013 as well as links to a number of talks and articles on Moose and Moose related
1014 technologies.
1015
1016 =item The Moose is flying, a tutorial by Randal Schwartz
1017
1018 Part 1 - L<http://www.stonehenge.com/merlyn/LinuxMag/col94.html>
1019
1020 Part 2 - L<http://www.stonehenge.com/merlyn/LinuxMag/col95.html>
1021
1022 =item Several Moose extension modules in the C<MooseX::> namespace.
1023
1024 See L<http://search.cpan.org/search?query=MooseX::> for extensions.
1025
1026 =item Moose stats on ohloh.net - L<http://www.ohloh.net/projects/moose>
1027
1028 =back
1029
1030 =head2 Books
1031
1032 =over 4
1033
1034 =item The Art of the MetaObject Protocol
1035
1036 I mention this in the L<Class::MOP> docs too, this book was critical in
1037 the development of both modules and is highly recommended.
1038
1039 =back
1040
1041 =head2 Papers
1042
1043 =over 4
1044
1045 =item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf>
1046
1047 This paper (suggested by lbr on #moose) was what lead to the implementation
1048 of the C<super>/C<override> and C<inner>/C<augment> features. If you really
1049 want to understand them, I suggest you read this.
1050
1051 =back
1052
1053 =head1 BUGS
1054
1055 All complex software has bugs lurking in it, and this module is no
1056 exception.
1057
1058 Please report any bugs to C<bug-moose@rt.cpan.org>, or through the web
1059 interface at L<http://rt.cpan.org>.
1060
1061 =head1 FEATURE REQUESTS
1062
1063 We are very strict about what features we add to the Moose core, especially
1064 the user-visible features. Instead we have made sure that the underlying
1065 meta-system of Moose is as extensible as possible so that you can add your
1066 own features easily.
1067
1068 That said, occasionally there is a feature needed in the meta-system
1069 to support your planned extension, in which case you should either
1070 email the mailing list (moose@perl.org) or join us on IRC at
1071 L<irc://irc.perl.org/#moose> to discuss. The
1072 L<Moose::Manual::Contributing> has more detail about how and when you
1073 can contribute.
1074
1075 =head1 AUTHOR
1076
1077 Moose is an open project, there are at this point dozens of people who have
1078 contributed, and can contribute. If you have added anything to the Moose
1079 project you have a commit bit on this file and can add your name to the list.
1080
1081 =head2 CABAL
1082
1083 However there are only a few people with the rights to release a new version
1084 of Moose. The Moose Cabal are the people to go to with questions regarding
1085 the wider purview of Moose, and help out maintaining not just the code
1086 but the community as well.
1087
1088 Stevan (stevan) Little E<lt>stevan@iinteractive.comE<gt>
1089
1090 Yuval (nothingmuch) Kogman
1091
1092 Shawn (sartak) Moore
1093
1094 Dave (autarch) Rolsky E<lt>autarch@urth.orgE<gt>
1095
1096 =head2 OTHER CONTRIBUTORS
1097
1098 Aankhen
1099
1100 Adam (Alias) Kennedy
1101
1102 Anders (Debolaz) Nor Berle
1103
1104 Nathan (kolibrie) Gray
1105
1106 Christian (chansen) Hansen
1107
1108 Hans Dieter (confound) Pearcey
1109
1110 Eric (ewilhelm) Wilhelm
1111
1112 Guillermo (groditi) Roditi
1113
1114 Jess (castaway) Robinson
1115
1116 Matt (mst) Trout
1117
1118 Robert (phaylon) Sedlacek
1119
1120 Robert (rlb3) Boone
1121
1122 Scott (konobi) McWhirter
1123
1124 Shlomi (rindolf) Fish
1125
1126 Chris (perigrin) Prather
1127
1128 Wallace (wreis) Reis
1129
1130 Jonathan (jrockway) Rockway
1131
1132 Piotr (dexter) Roszatycki
1133
1134 Sam (mugwump) Vilain
1135
1136 Cory (gphat) Watson
1137
1138 ... and many other #moose folks
1139
1140 =head1 COPYRIGHT AND LICENSE
1141
1142 Copyright 2006-2009 by Infinity Interactive, Inc.
1143
1144 L<http://www.iinteractive.com>
1145
1146 This library is free software; you can redistribute it and/or modify
1147 it under the same terms as Perl itself.
1148
1149 =cut