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