8 $VERSION = eval $VERSION;
9 our $AUTHORITY = 'cpan:STEVAN';
11 use Scalar::Util 'blessed';
18 use Moose::Meta::Class;
19 use Moose::Meta::TypeConstraint;
20 use Moose::Meta::TypeCoercion;
21 use Moose::Meta::Attribute;
22 use Moose::Meta::Instance;
26 use Moose::Meta::Role;
27 use Moose::Meta::Role::Composite;
28 use Moose::Meta::Role::Application;
29 use Moose::Meta::Role::Application::RoleSummation;
30 use Moose::Meta::Role::Application::ToClass;
31 use Moose::Meta::Role::Application::ToRole;
32 use Moose::Meta::Role::Application::ToInstance;
34 use Moose::Util::TypeConstraints;
37 use Moose::Meta::Attribute::Native;
48 Moose->throw_error("Must derive at least one class") unless @_;
50 # this checks the metaclass to make sure
51 # it is correct, sometimes it can get out
52 # of sync when the classes are being built
53 $meta->superclasses(@_);
57 Moose::Util::apply_all_roles(shift, @_);
64 Moose->throw_error('Usage: has \'name\' => ( key => value, ... )')
67 my %options = ( definition_context => Moose::Util::_caller_info(), @_ );
68 my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ];
69 $meta->add_attribute( $_, %options ) for @$attrs;
73 Moose::Util::add_method_modifier(shift, 'before', \@_);
77 Moose::Util::add_method_modifier(shift, 'after', \@_);
81 Moose::Util::add_method_modifier(shift, 'around', \@_);
89 # This check avoids a recursion loop - see
90 # t/100_bugs/020_super_recursion.t
91 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
92 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
97 my ( $name, $method ) = @_;
98 $meta->add_override_method_modifier( $name => $method );
103 our ( %INNER_BODY, %INNER_ARGS );
105 if ( my $body = $INNER_BODY{$pkg} ) {
106 my @args = @{ $INNER_ARGS{$pkg} };
107 local $INNER_ARGS{$pkg};
108 local $INNER_BODY{$pkg};
109 return $body->(@args);
117 my ( $name, $method ) = @_;
118 $meta->add_augment_method_modifier( $name => $method );
121 Moose::Exporter->setup_import_methods(
123 qw( extends with has before after around override augment )
128 \&Scalar::Util::blessed,
133 # This used to be called as a function. This hack preserves
134 # backwards compatibility.
135 if ( $_[0] ne __PACKAGE__ ) {
136 return __PACKAGE__->init_meta(
146 my $class = $args{for_class}
147 or Moose->throw_error("Cannot call init_meta without specifying a for_class");
148 my $base_class = $args{base_class} || 'Moose::Object';
149 my $metaclass = $args{metaclass} || 'Moose::Meta::Class';
151 Moose->throw_error("The Metaclass $metaclass must be a subclass of Moose::Meta::Class.")
152 unless $metaclass->isa('Moose::Meta::Class');
154 # make a subtype for each Moose class
156 unless find_type_constraint($class);
160 if ( $meta = Class::MOP::get_metaclass_by_name($class) ) {
161 unless ( $meta->isa("Moose::Meta::Class") ) {
162 my $error_message = "$class already has a metaclass, but it does not inherit $metaclass ($meta).";
163 if ( $meta->isa('Moose::Meta::Role') ) {
164 Moose->throw_error($error_message . ' You cannot make the same thing a role and a class. Remove either Moose or Moose::Role.');
166 Moose->throw_error($error_message);
170 # no metaclass, no 'meta' method
172 # now we check whether our ancestors have metaclass, and if so borrow that
173 my ( undef, @isa ) = @{ $class->mro::get_linear_isa };
175 foreach my $ancestor ( @isa ) {
176 my $ancestor_meta = Class::MOP::get_metaclass_by_name($ancestor) || next;
178 my $ancestor_meta_class = ($ancestor_meta->is_immutable
179 ? $ancestor_meta->_get_mutable_metaclass_name
180 : ref($ancestor_meta));
182 # if we have an ancestor metaclass that inherits $metaclass, we use
183 # that. This is like _fix_metaclass_incompatibility, but we can do it now.
185 # the case of having an ancestry is not very common, but arises in
187 unless ( $metaclass->isa( $ancestor_meta_class ) ) {
188 if ( $ancestor_meta_class->isa($metaclass) ) {
189 $metaclass = $ancestor_meta_class;
194 $meta = $metaclass->initialize($class);
197 if ( $class->can('meta') ) {
198 # check 'meta' method
200 # it may be inherited
203 # this is the case where the metaclass pragma
204 # was used before the 'use Moose' statement to
205 # override a specific class
206 my $method_meta = $class->meta;
208 ( blessed($method_meta) && $method_meta->isa('Moose::Meta::Class') )
209 || Moose->throw_error("$class already has a &meta function, but it does not return a Moose::Meta::Class ($method_meta)");
211 $meta = $method_meta;
214 unless ( $meta->has_method("meta") ) { # don't overwrite
215 # also check for inherited non moose 'meta' method?
216 # FIXME also skip this if the user requested by passing an option
219 # re-initialize so it inherits properly
220 $metaclass->initialize( ref($_[0]) || $_[0] );
225 # make sure they inherit from Moose::Object
226 $meta->superclasses($base_class)
227 unless $meta->superclasses();
232 # This may be used in some older MooseX extensions.
234 goto &Moose::Exporter::_get_caller;
237 ## make 'em all immutable
240 inline_constructor => 1,
241 constructor_name => "_new",
242 # these are Class::MOP accessors, so they need inlining
243 inline_accessors => 1
244 ) for grep { $_->is_mutable }
247 Moose::Meta::Attribute
249 Moose::Meta::Instance
251 Moose::Meta::TypeCoercion
252 Moose::Meta::TypeCoercion::Union
255 Moose::Meta::Method::Accessor
256 Moose::Meta::Method::Constructor
257 Moose::Meta::Method::Destructor
258 Moose::Meta::Method::Overridden
259 Moose::Meta::Method::Augmented
262 Moose::Meta::Role::Method
263 Moose::Meta::Role::Method::Required
264 Moose::Meta::Role::Method::Conflicting
266 Moose::Meta::Role::Composite
268 Moose::Meta::Role::Application
269 Moose::Meta::Role::Application::RoleSummation
270 Moose::Meta::Role::Application::ToClass
271 Moose::Meta::Role::Application::ToRole
272 Moose::Meta::Role::Application::ToInstance
283 Moose - A postmodern object system for Perl 5
288 use Moose; # automatically turns on strict and warnings
290 has 'x' => (is => 'rw', isa => 'Int');
291 has 'y' => (is => 'rw', isa => 'Int');
304 has 'z' => (is => 'rw', isa => 'Int');
306 after 'clear' => sub {
313 Moose is an extension of the Perl 5 object system.
315 The main goal of Moose is to make Perl 5 Object Oriented programming
316 easier, more consistent and less tedious. With Moose you can to think
317 more about what you want to do and less about the mechanics of OOP.
319 Additionally, Moose is built on top of L<Class::MOP>, which is a
320 metaclass system for Perl 5. This means that Moose not only makes
321 building normal Perl 5 objects better, but it provides the power of
322 metaclass programming as well.
326 If you're new to Moose, the best place to start is the
327 L<Moose::Manual> docs, followed by the L<Moose::Cookbook>. The intro
328 will show you what Moose is, and how it makes Perl 5 OO better.
330 The cookbook recipes on Moose basics will get you up to speed with
331 many of Moose's features quickly. Once you have an idea of what Moose
332 can do, you can use the API documentation to get more detail on
333 features which interest you.
335 =head2 Moose Extensions
337 The C<MooseX::> namespace is the official place to find Moose extensions.
338 These extensions can be found on the CPAN. The easiest way to find them
339 is to search for them (L<http://search.cpan.org/search?query=MooseX::>),
340 or to examine L<Task::Moose> which aims to keep an up-to-date, easily
341 installable list of Moose extensions.
345 Much of the Moose documentation has been translated into other languages.
351 Japanese docs can be found at L<http://perldoc.perlassociation.org/pod/Moose-Doc-JA/index.html>. The source POD files can be found in GitHub: L<http://github.com/jpa/Moose-Doc-JA>
355 =head1 BUILDING CLASSES WITH MOOSE
357 Moose makes every attempt to provide as much convenience as possible during
358 class construction/definition, but still stay out of your way if you want it
359 to. Here are a few items to note when building classes with Moose.
361 Unless specified with C<extends>, any class which uses Moose will
362 inherit from L<Moose::Object>.
364 Moose will also manage all attributes (including inherited ones) that are
365 defined with C<has>. And (assuming you call C<new>, which is inherited from
366 L<Moose::Object>) this includes properly initializing all instance slots,
367 setting defaults where appropriate, and performing any type constraint checking
370 =head1 PROVIDED METHODS
372 Moose provides a number of methods to all your classes, mostly through the
373 inheritance of L<Moose::Object>. There is however, one exception.
379 This is a method which provides access to the current class's metaclass.
383 =head1 EXPORTED FUNCTIONS
385 Moose will export a number of functions into the class's namespace which
386 may then be used to set up the class. These functions all work directly
387 on the current class.
391 =item B<extends (@superclasses)>
393 This function will set the superclass(es) for the current class.
395 This approach is recommended instead of C<use base>, because C<use base>
396 actually C<push>es onto the class's C<@ISA>, whereas C<extends> will
397 replace it. This is important to ensure that classes which do not have
398 superclasses still properly inherit from L<Moose::Object>.
400 =item B<with (@roles)>
402 This will apply a given set of C<@roles> to the local class.
404 =item B<has $name|@$names =E<gt> %options>
406 This will install an attribute of a given C<$name> into the current class. If
407 the first parameter is an array reference, it will create an attribute for
408 every C<$name> in the list. The C<%options> are the same as those provided by
409 L<Class::MOP::Attribute>, in addition to the list below which are provided by
410 Moose (L<Moose::Meta::Attribute> to be more specific):
414 =item I<is =E<gt> 'rw'|'ro'>
416 The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read
417 only). These will create either a read/write accessor or a read-only
418 accessor respectively, using the same name as the C<$name> of the attribute.
420 If you need more control over how your accessors are named, you can
421 use the L<reader|Class::MOP::Attribute/reader>,
422 L<writer|Class::MOP::Attribute/writer> and
423 L<accessor|Class::MOP::Attribute/accessor> options inherited from
424 L<Class::MOP::Attribute>, however if you use those, you won't need the
427 =item I<isa =E<gt> $type_name>
429 The I<isa> option uses Moose's type constraint facilities to set up runtime
430 type checking for this attribute. Moose will perform the checks during class
431 construction, and within any accessors. The C<$type_name> argument must be a
432 string. The string may be either a class name or a type defined using
433 Moose's type definition features. (Refer to L<Moose::Util::TypeConstraints>
434 for information on how to define a new type, and how to retrieve type meta-data).
436 =item I<coerce =E<gt> (1|0)>
438 This will attempt to use coercion with the supplied type constraint to change
439 the value passed into any accessors or constructors. You B<must> have supplied
440 a type constraint in order for this to work. See L<Moose::Cookbook::Basics::Recipe5>
443 =item I<does =E<gt> $role_name>
445 This will accept the name of a role which the value stored in this attribute
446 is expected to have consumed.
448 =item I<required =E<gt> (1|0)>
450 This marks the attribute as being required. This means a value must be
451 supplied during class construction, I<or> the attribute must be lazy
452 and have either a default or a builder. Note that c<required> does not
453 say anything about the attribute's value, which can be C<undef>.
455 =item I<weak_ref =E<gt> (1|0)>
457 This will tell the class to store the value of this attribute as a weakened
458 reference. If an attribute is a weakened reference, it B<cannot> also be
461 =item I<lazy =E<gt> (1|0)>
463 This will tell the class to not create this slot until absolutely necessary.
464 If an attribute is marked as lazy it B<must> have a default supplied.
466 =item I<auto_deref =E<gt> (1|0)>
468 This tells the accessor whether to automatically dereference the value returned.
469 This is only legal if your C<isa> option is either C<ArrayRef> or C<HashRef>.
471 =item I<trigger =E<gt> $code>
473 The I<trigger> option is a CODE reference which will be called after
474 the value of the attribute is set. The CODE ref will be passed the
475 instance itself and the updated value. If the attribute already had a
476 value, this will be passed as the third value to the trigger.
478 You B<can> have a trigger on a read-only attribute.
480 B<NOTE:> Triggers will only fire when you B<assign> to the attribute,
481 either in the constructor, or using the writer. Default and built values will
482 B<not> cause the trigger to be fired.
484 =item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | DUCKTYPE | CODE>
486 The I<handles> option provides Moose classes with automated delegation features.
487 This is a pretty complex and powerful option. It accepts many different option
488 formats, each with its own benefits and drawbacks.
490 B<NOTE:> The class being delegated to does not need to be a Moose based class,
491 which is why this feature is especially useful when wrapping non-Moose classes.
493 All I<handles> option formats share the following traits:
495 You cannot override a locally defined method with a delegated method; an
496 exception will be thrown if you try. That is to say, if you define C<foo> in
497 your class, you cannot override it with a delegated C<foo>. This is almost never
498 something you would want to do, and if it is, you should do it by hand and not
501 You cannot override any of the methods found in Moose::Object, or the C<BUILD>
502 and C<DEMOLISH> methods. These will not throw an exception, but will silently
503 move on to the next method in the list. My reasoning for this is that you would
504 almost never want to do this, since it usually breaks your class. As with
505 overriding locally defined methods, if you do want to do this, you should do it
506 manually, not with Moose.
508 You do not I<need> to have a reader (or accessor) for the attribute in order
509 to delegate to it. Moose will create a means of accessing the value for you,
510 however this will be several times B<less> efficient then if you had given
511 the attribute a reader (or accessor) to use.
513 Below is the documentation for each option format:
519 This is the most common usage for I<handles>. You basically pass a list of
520 method names to be delegated, and Moose will install a delegation method
525 This is the second most common usage for I<handles>. Instead of a list of
526 method names, you pass a HASH ref where each key is the method name you
527 want installed locally, and its value is the name of the original method
528 in the class being delegated to.
530 This can be very useful for recursive classes like trees. Here is a
531 quick example (soon to be expanded into a Moose::Cookbook recipe):
536 has 'node' => (is => 'rw', isa => 'Any');
541 default => sub { [] }
549 parent_node => 'node',
550 siblings => 'children',
554 In this example, the Tree package gets C<parent_node> and C<siblings> methods,
555 which delegate to the C<node> and C<children> methods (respectively) of the Tree
556 instance stored in the C<parent> slot.
558 You may also use an array reference to curry arguments to the original method.
562 handles => { set_foo => [ set => 'foo' ] },
565 # $self->set_foo(...) calls $self->thing->set('foo', ...)
567 The first element of the array reference is the original method name, and the
568 rest is a list of curried arguments.
572 The regexp option works very similar to the ARRAY option, except that it builds
573 the list of methods for you. It starts by collecting all possible methods of the
574 class being delegated to, then filters that list using the regexp supplied here.
576 B<NOTE:> An I<isa> option is required when using the regexp option format. This
577 is so that we can determine (at compile time) the method list from the class.
578 Without an I<isa> this is just not possible.
582 With the role option, you specify the name of a role whose "interface" then
583 becomes the list of methods to handle. The "interface" can be defined as; the
584 methods of the role and any required methods of the role. It should be noted
585 that this does B<not> include any method modifiers or generated attribute
586 methods (which is consistent with role composition).
590 With the duck type option, you pass a duck type object whose "interface" then
591 becomes the list of methods to handle. The "interface" can be defined as; the
592 list of methods passed to C<duck_type> to create a duck type object. For more
593 information on C<duck_type> please check
594 L<Moose::Util::TypeConstraints>.
598 This is the option to use when you really want to do something funky. You should
599 only use it if you really know what you are doing, as it involves manual
602 This takes a code reference, which should expect two arguments. The first is the
603 attribute meta-object this I<handles> is attached to. The second is the
604 metaclass of the class being delegated to. It expects you to return a hash (not
605 a HASH ref) of the methods you want mapped.
609 =item I<metaclass =E<gt> $metaclass_name>
611 This tells the class to use a custom attribute metaclass for this particular
612 attribute. Custom attribute metaclasses are useful for extending the
613 capabilities of the I<has> keyword: they are the simplest way to extend the MOP,
614 but they are still a fairly advanced topic and too much to cover here, see
615 L<Moose::Cookbook::Meta::Recipe1> for more information.
617 See L<Metaclass and Trait Name Resolution> for details on how a metaclass name
618 is resolved to a class name.
620 =item I<traits =E<gt> [ @role_names ]>
622 This tells Moose to take the list of C<@role_names> and apply them to the
623 attribute meta-object. This is very similar to the I<metaclass> option, but
624 allows you to use more than one extension at a time.
626 See L<Metaclass and Trait Name Resolution> for details on how a trait name is
627 resolved to a role name.
629 Also see L<Moose::Cookbook::Meta::Recipe3> for a metaclass trait
632 =item I<builder> => Str
634 The value of this key is the name of the method that will be called to
635 obtain the value used to initialize the attribute. See the L<builder
636 option docs in Class::MOP::Attribute|Class::MOP::Attribute/builder>
637 and/or L<Moose::Cookbook::Basics::Recipe8> for more information.
639 =item I<default> => SCALAR | CODE
641 The value of this key is the default value which will initialize the attribute.
643 NOTE: If the value is a simple scalar (string or number), then it can
644 be just passed as is. However, if you wish to initialize it with a
645 HASH or ARRAY ref, then you need to wrap that inside a CODE reference.
646 See the L<default option docs in
647 Class::MOP::Attribute|Class::MOP::Attribute/default> for more
650 =item I<clearer> => Str
652 Creates a method allowing you to clear the value, see the L<clearer option
653 docs in Class::MOP::Attribute|Class::MOP::Attribute/clearer> for more
656 =item I<predicate> => Str
658 Creates a method to perform a basic test to see if a value has been set in the
659 attribute, see the L<predicate option docs in
660 Class::MOP::Attribute|Class::MOP::Attribute/predicate> for more information.
662 =item I<lazy_build> => (0|1)
664 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
665 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
667 =item I<initializer> => Str
669 This may be a method name (referring to a method on the class with
670 this attribute) or a CODE ref. The initializer is used to set the
671 attribute value on an instance when the attribute is set during
672 instance initialization (but not when the value is being assigned
673 to). See the L<initializer option docs in
674 Class::MOP::Attribute|Class::MOP::Attribute/initializer> for more
677 =item I<documentation> => $string
679 An arbitrary string that can be retrieved later by calling C<<
680 $attr->documentation >>.
686 =item B<has +$name =E<gt> %options>
688 This is variation on the normal attribute creator C<has> which allows you to
689 clone and extend an attribute from a superclass or from a role. Here is an
690 example of the superclass usage:
698 default => 'Hello, I am a Foo'
706 has '+message' => (default => 'Hello I am My::Foo');
708 What is happening here is that B<My::Foo> is cloning the C<message> attribute
709 from its parent class B<Foo>, retaining the C<is =E<gt> 'rw'> and C<isa =E<gt>
710 'Str'> characteristics, but changing the value in C<default>.
712 Here is another example, but within the context of a role:
720 default => 'Hello, I am a Foo'
728 has '+message' => (default => 'Hello I am My::Foo');
730 In this case, we are basically taking the attribute which the role supplied
731 and altering it within the bounds of this feature.
733 Note that you can only extend an attribute from either a superclass or a role,
734 you cannot extend an attribute in a role that composes over an attribute from
737 Aside from where the attributes come from (one from superclass, the other
738 from a role), this feature works exactly the same. This feature is restricted
739 somewhat, so as to try and force at least I<some> sanity into it. You are only
740 allowed to change the following attributes:
746 Change the default value of an attribute.
750 Change whether the attribute attempts to coerce a value passed to it.
754 Change if the attribute is required to have a value.
756 =item I<documentation>
758 Change the documentation string associated with the attribute.
762 Change if the attribute lazily initializes the slot.
766 You I<are> allowed to change the type without restriction.
768 It is recommended that you use this freedom with caution. We used to
769 only allow for extension only if the type was a subtype of the parent's
770 type, but we felt that was too restrictive and is better left as a
775 You are allowed to B<add> a new C<handles> definition, but you are B<not>
776 allowed to I<change> one.
780 You are allowed to B<add> a new C<builder> definition, but you are B<not>
781 allowed to I<change> one.
785 You are allowed to B<add> a new C<metaclass> definition, but you are
786 B<not> allowed to I<change> one.
790 You are allowed to B<add> additional traits to the C<traits> definition.
791 These traits will be composed into the attribute, but preexisting traits
792 B<are not> overridden, or removed.
796 =item B<before $name|@names =E<gt> sub { ... }>
798 =item B<after $name|@names =E<gt> sub { ... }>
800 =item B<around $name|@names =E<gt> sub { ... }>
802 These three items are syntactic sugar for the before, after, and around method
803 modifier features that L<Class::MOP> provides. More information on these may be
804 found in L<Moose::Manual::MethodModifiers> and the
805 L<Class::MOP::Class documentation|Class::MOP::Class/"Method Modifiers">.
809 The keyword C<super> is a no-op when called outside of an C<override> method. In
810 the context of an C<override> method, it will call the next most appropriate
811 superclass method with the same arguments as the original method.
813 =item B<override ($name, &sub)>
815 An C<override> method is a way of explicitly saying "I am overriding this
816 method from my superclass". You can call C<super> within this method, and
817 it will work as expected. The same thing I<can> be accomplished with a normal
818 method call and the C<SUPER::> pseudo-package; it is really your choice.
822 The keyword C<inner>, much like C<super>, is a no-op outside of the context of
823 an C<augment> method. You can think of C<inner> as being the inverse of
824 C<super>; the details of how C<inner> and C<augment> work is best described in
825 the L<Moose::Cookbook::Basics::Recipe6>.
827 =item B<augment ($name, &sub)>
829 An C<augment> method, is a way of explicitly saying "I am augmenting this
830 method from my superclass". Once again, the details of how C<inner> and
831 C<augment> work is best described in the L<Moose::Cookbook::Basics::Recipe6>.
835 This is the C<Carp::confess> function, and exported here because I use it
840 This is the C<Scalar::Util::blessed> function, it is exported here because I
841 use it all the time. It is highly recommended that this is used instead of
842 C<ref> anywhere you need to test for an object's class name.
848 When you use Moose, you can specify which metaclass to use:
850 use Moose -metaclass => 'My::Meta::Class';
852 You can also specify traits which will be applied to your metaclass:
854 use Moose -traits => 'My::Trait';
856 This is very similar to the attribute traits feature. When you do
857 this, your class's C<meta> object will have the specified traits
858 applied to it. See L<Metaclass and Trait Name Resolution> for more
861 =head2 Metaclass and Trait Name Resolution
863 By default, when given a trait name, Moose simply tries to load a
864 class of the same name. If such a class does not exist, it then looks
865 for for a class matching
866 B<Moose::Meta::$type::Custom::Trait::$trait_name>. The C<$type>
867 variable here will be one of B<Attribute> or B<Class>, depending on
868 what the trait is being applied to.
870 If a class with this long name exists, Moose checks to see if it has
871 the method C<register_implementation>. This method is expected to
872 return the I<real> class name of the trait. If there is no
873 C<register_implementation> method, it will fall back to using
874 B<Moose::Meta::$type::Custom::Trait::$trait> as the trait name.
876 The lookup method for metaclasses is the same, except that it looks
877 for a class matching B<Moose::Meta::$type::Custom::$metaclass_name>.
879 If all this is confusing, take a look at
880 L<Moose::Cookbook::Meta::Recipe3>, which demonstrates how to create an
883 =head1 UNIMPORTING FUNCTIONS
887 Moose offers a way to remove the keywords it exports, through the C<unimport>
888 method. You simply have to say C<no Moose> at the bottom of your code for this
889 to work. Here is an example:
894 has 'first_name' => (is => 'rw', isa => 'Str');
895 has 'last_name' => (is => 'rw', isa => 'Str');
899 $self->first_name . ' ' . $self->last_name
902 no Moose; # keywords are removed from the Person package
904 =head1 EXTENDING AND EMBEDDING MOOSE
906 To learn more about extending Moose, we recommend checking out the
907 "Extending" recipes in the L<Moose::Cookbook>, starting with
908 L<Moose::Cookbook::Extending::Recipe1>, which provides an overview of
909 all the different ways you might extend Moose.
911 =head2 B<< Moose->init_meta(for_class => $class, base_class => $baseclass, metaclass => $metaclass) >>
913 The C<init_meta> method sets up the metaclass object for the class
914 specified by C<for_class>. This method injects a a C<meta> accessor
915 into the class so you can get at this object. It also sets the class's
916 superclass to C<base_class>, with L<Moose::Object> as the default.
918 C<init_meta> returns the metaclass object for C<$class>.
920 You can specify an alternate metaclass with the C<metaclass> option.
922 For more detail on this topic, see L<Moose::Cookbook::Extending::Recipe2>.
924 This method used to be documented as a function which accepted
925 positional parameters. This calling style will still work for
926 backwards compatibility, but is deprecated.
930 Moose's C<import> method supports the L<Sub::Exporter> form of C<{into =E<gt> $pkg}>
931 and C<{into_level =E<gt> 1}>.
933 B<NOTE>: Doing this is more or less deprecated. Use L<Moose::Exporter>
934 instead, which lets you stack multiple C<Moose.pm>-alike modules
935 sanely. It handles getting the exported functions into the right place
938 =head2 B<throw_error>
940 An alias for C<confess>, used by internally by Moose.
942 =head1 METACLASS COMPATIBILITY AND MOOSE
944 Metaclass compatibility is a thorny subject. You should start by
945 reading the "About Metaclass compatibility" section in the
948 Moose will attempt to resolve a few cases of metaclass incompatibility
949 when you set the superclasses for a class, unlike C<Class::MOP>, which
950 simply dies if the metaclasses are incompatible.
952 In actuality, Moose fixes incompatibility for I<all> of a class's
953 metaclasses, not just the class metaclass. That includes the instance
954 metaclass, attribute metaclass, as well as its constructor class and
955 destructor class. However, for simplicity this discussion will just
956 refer to "metaclass", meaning the class metaclass, most of the time.
958 Moose has two algorithms for fixing metaclass incompatibility.
960 The first algorithm is very simple. If all the metaclass for the
961 parent is a I<subclass> of the child's metaclass, then we simply
962 replace the child's metaclass with the parent's.
964 The second algorithm is more complicated. It tries to determine if the
965 metaclasses only "differ by roles". This means that the parent and
966 child's metaclass share a common ancestor in their respective
967 hierarchies, and that the subclasses under the common ancestor are
968 only different because of role applications. This case is actually
969 fairly common when you mix and match various C<MooseX::*> modules,
970 many of which apply roles to the metaclass.
972 If the parent and child do differ by roles, Moose replaces the
973 metaclass in the child with a newly created metaclass. This metaclass
974 is a subclass of the parent's metaclass, does all of the roles that
975 the child's metaclass did before being replaced. Effectively, this
976 means the new metaclass does all of the roles done by both the
977 parent's and child's original metaclasses.
979 Ultimately, this is all transparent to you except in the case of an
980 unresolvable conflict.
982 =head2 The MooseX:: namespace
984 Generally if you're writing an extension I<for> Moose itself you'll want
985 to put your extension in the C<MooseX::> namespace. This namespace is
986 specifically for extensions that make Moose better or different in some
987 fundamental way. It is traditionally B<not> for a package that just happens
988 to use Moose. This namespace follows from the examples of the C<LWPx::>
989 and C<DBIx::> namespaces that perform the same function for C<LWP> and C<DBI>
998 It should be noted that C<super> and C<inner> B<cannot> be used in the same
999 method. However, they may be combined within the same class hierarchy; see
1000 F<t/014_override_augment_inner_super.t> for an example.
1002 The reason for this is that C<super> is only valid within a method
1003 with the C<override> modifier, and C<inner> will never be valid within an
1004 C<override> method. In fact, C<augment> will skip over any C<override> methods
1005 when searching for its appropriate C<inner>.
1007 This might seem like a restriction, but I am of the opinion that keeping these
1008 two features separate (yet interoperable) actually makes them easy to use, since
1009 their behavior is then easier to predict. Time will tell whether I am right or
1010 not (UPDATE: so far so good).
1016 We offer both a mailing list and a very active IRC channel.
1018 The mailing list is L<moose@perl.org>. You must be subscribed to send
1019 a message. To subscribe, send an empty message to
1020 L<moose-subscribe@perl.org>
1022 You can also visit us at L<#moose on
1023 irc.perl.org|irc://irc.perl.org/#moose>. This channel is quite active,
1024 and questions at all levels (on Moose-related topics ;) are welcome.
1026 =head1 ACKNOWLEDGEMENTS
1030 =item I blame Sam Vilain for introducing me to the insanity that is meta-models.
1032 =item I blame Audrey Tang for then encouraging my meta-model habit in #perl6.
1034 =item Without Yuval "nothingmuch" Kogman this module would not be possible,
1035 and it certainly wouldn't have this name ;P
1037 =item The basis of the TypeContraints module was Rob Kinyon's idea
1038 originally, I just ran with it.
1040 =item Thanks to mst & chansen and the whole #moose posse for all the
1041 early ideas/feature-requests/encouragement/bug-finding.
1043 =item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes.
1051 =item L<http://www.iinteractive.com/moose>
1053 This is the official web home of Moose, it contains links to our public SVN repository
1054 as well as links to a number of talks and articles on Moose and Moose related
1057 =item The Moose is flying, a tutorial by Randal Schwartz
1059 Part 1 - L<http://www.stonehenge.com/merlyn/LinuxMag/col94.html>
1061 Part 2 - L<http://www.stonehenge.com/merlyn/LinuxMag/col95.html>
1063 =item Several Moose extension modules in the C<MooseX::> namespace.
1065 See L<http://search.cpan.org/search?query=MooseX::> for extensions.
1067 =item Moose stats on ohloh.net - L<http://www.ohloh.net/projects/moose>
1075 =item The Art of the MetaObject Protocol
1077 I mention this in the L<Class::MOP> docs too, this book was critical in
1078 the development of both modules and is highly recommended.
1086 =item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf>
1088 This paper (suggested by lbr on #moose) was what lead to the implementation
1089 of the C<super>/C<override> and C<inner>/C<augment> features. If you really
1090 want to understand them, I suggest you read this.
1096 All complex software has bugs lurking in it, and this module is no
1099 Please report any bugs to C<bug-moose@rt.cpan.org>, or through the web
1100 interface at L<http://rt.cpan.org>.
1102 =head1 FEATURE REQUESTS
1104 We are very strict about what features we add to the Moose core, especially
1105 the user-visible features. Instead we have made sure that the underlying
1106 meta-system of Moose is as extensible as possible so that you can add your
1107 own features easily.
1109 That said, occasionally there is a feature needed in the meta-system
1110 to support your planned extension, in which case you should either
1111 email the mailing list (moose@perl.org) or join us on IRC at
1112 L<irc://irc.perl.org/#moose> to discuss. The
1113 L<Moose::Manual::Contributing> has more detail about how and when you
1118 Moose is an open project, there are at this point dozens of people who have
1119 contributed, and can contribute. If you have added anything to the Moose
1120 project you have a commit bit on this file and can add your name to the list.
1124 However there are only a few people with the rights to release a new version
1125 of Moose. The Moose Cabal are the people to go to with questions regarding
1126 the wider purview of Moose, and help out maintaining not just the code
1127 but the community as well.
1129 Stevan (stevan) Little E<lt>stevan@iinteractive.comE<gt>
1131 Yuval (nothingmuch) Kogman
1133 Shawn (sartak) Moore E<lt>sartak@bestpractical.comE<gt>
1135 Dave (autarch) Rolsky E<lt>autarch@urth.orgE<gt>
1137 Jesse (doy) Luehrs E<lt>doy at tozt dot netE<gt>
1139 Hans Dieter (confound) Pearcey E<lt>hdp@pobox.comE<gt>
1141 Chris (perigrin) Prather
1143 Florian Ragwitz E<lt>rafl@debian.orgE<gt>
1145 =head2 OTHER CONTRIBUTORS
1149 Adam (Alias) Kennedy
1151 Anders (Debolaz) Nor Berle
1153 Nathan (kolibrie) Gray
1155 Christian (chansen) Hansen
1157 Eric (ewilhelm) Wilhelm
1159 Guillermo (groditi) Roditi
1161 Jess (castaway) Robinson
1165 Robert (phaylon) Sedlacek
1169 Scott (konobi) McWhirter
1171 Shlomi (rindolf) Fish
1173 Wallace (wreis) Reis
1175 Jonathan (jrockway) Rockway
1177 Piotr (dexter) Roszatycki
1179 Sam (mugwump) Vilain
1183 Dylan Hardison (doc fixes)
1185 ... and many other #moose folks
1187 =head1 COPYRIGHT AND LICENSE
1189 Copyright 2006-2009 by Infinity Interactive, Inc.
1191 L<http://www.iinteractive.com>
1193 This library is free software; you can redistribute it and/or modify
1194 it under the same terms as Perl itself.