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