8 our $AUTHORITY = 'cpan:STEVAN';
10 use Scalar::Util 'blessed', 'reftype';
12 use Sub::Name 'subname';
13 use B 'svref_2object';
19 use Moose::Meta::Class;
20 use Moose::Meta::TypeConstraint;
21 use Moose::Meta::TypeCoercion;
22 use Moose::Meta::Attribute;
23 use Moose::Meta::Instance;
26 use Moose::Util::TypeConstraints;
34 # make a subtype for each Moose class
37 => where { $_->isa($class) }
38 => optimize_as { blessed($_[0]) && $_[0]->isa($class) }
39 unless find_type_constraint($class);
42 if ($class->can('meta')) {
44 # this is the case where the metaclass pragma
45 # was used before the 'use Moose' statement to
46 # override a specific class
47 $meta = $class->meta();
48 (blessed($meta) && $meta->isa('Moose::Meta::Class'))
49 || confess "You already have a &meta function, but it does not return a Moose::Meta::Class";
53 # this is broken currently, we actually need
54 # to allow the possiblity of an inherited
55 # meta, which will not be visible until the
56 # user 'extends' first. This needs to have
57 # more intelligence to it
58 $meta = Moose::Meta::Class->initialize($class);
59 $meta->add_method('meta' => sub {
60 # re-initialize so it inherits properly
61 Moose::Meta::Class->initialize(blessed($_[0]) || $_[0]);
65 # make sure they inherit from Moose::Object
66 $meta->superclasses('Moose::Object')
67 unless $meta->superclasses();
73 return subname 'Moose::extends' => sub (@) {
74 confess "Must derive at least one class" unless @_;
75 Class::MOP::load_class($_) for @_;
76 # this checks the metaclass to make sure
77 # it is correct, sometimes it can get out
78 # of sync when the classes are being built
79 my $meta = $class->meta->_fix_metaclass_incompatability(@_);
80 $meta->superclasses(@_);
85 return subname 'Moose::with' => sub (@) {
87 confess "Must specify at least one role" unless @roles;
88 Class::MOP::load_class($_) for @roles;
89 $class->meta->_apply_all_roles(@roles);
94 return subname 'Moose::has' => sub ($;%) {
95 my ($name, %options) = @_;
96 my $attrs = (ref($name) eq 'ARRAY') ? $name : [($name)];
97 $class->meta->_process_attribute($_, %options) for @$attrs;
102 return subname 'Moose::before' => sub (@&) {
104 my $meta = $class->meta;
105 $meta->add_before_method_modifier($_, $code) for @_;
110 return subname 'Moose::after' => sub (@&) {
112 my $meta = $class->meta;
113 $meta->add_after_method_modifier($_, $code) for @_;
118 return subname 'Moose::around' => sub (@&) {
120 my $meta = $class->meta;
121 $meta->add_around_method_modifier($_, $code) for @_;
128 $SUPER_SLOT{$CALLER} = \*{"${CALLER}::super"};
130 return subname 'Moose::super' => sub {};
134 return subname 'Moose::override' => sub ($&) {
135 my ($name, $method) = @_;
136 $class->meta->add_override_method_modifier($name => $method);
143 $INNER_SLOT{$CALLER} = \*{"${CALLER}::inner"};
145 return subname 'Moose::inner' => sub {};
149 return subname 'Moose::augment' => sub (@&) {
150 my ($name, $method) = @_;
151 $class->meta->add_augment_method_modifier($name => $method);
156 # this is experimental, but I am not
157 # happy with it. If you want to try
158 # it, you will have to uncomment it
160 # There is a really good chance that
161 # this will be deprecated, dont get
164 # return subname 'Moose::self' => sub {};
167 # my $class = $CALLER;
168 # return subname 'Moose::method' => sub {
169 # my ($name, $method) = @_;
170 # $class->meta->add_method($name, sub {
173 # no warnings 'redefine';
174 # local *{$class->meta->name . '::self'} = sub { $self };
181 return \&Carp::confess;
184 return \&Scalar::Util::blessed;
188 my $exporter = Sub::Exporter::build_exporter({
189 exports => \%exports,
201 # we should never export to main
202 return if $CALLER eq 'main';
211 my $class = caller();
212 # loop through the exports ...
213 foreach my $name (keys %exports) {
216 if (defined &{$class . '::' . $name}) {
217 my $keyword = \&{$class . '::' . $name};
219 # make sure it is from Moose
220 my $pkg_name = eval { svref_2object($keyword)->GV->STASH->NAME };
222 next if $pkg_name ne 'Moose';
224 # and if it is from Moose then undef the slot
225 delete ${$class . '::'}{$name};
233 ## make 'em all immutable
235 $_->meta->make_immutable(
236 inline_constructor => 0,
237 inline_accessors => 0,
239 'Moose::Meta::Attribute',
240 'Moose::Meta::Class',
241 'Moose::Meta::Instance',
243 'Moose::Meta::TypeConstraint',
244 'Moose::Meta::TypeConstraint::Union',
245 'Moose::Meta::TypeCoercion',
247 'Moose::Meta::Method',
248 'Moose::Meta::Method::Accessor',
249 'Moose::Meta::Method::Constructor',
250 'Moose::Meta::Method::Overriden',
261 Moose - A complete modern object system for Perl 5
266 use Moose; # automatically turns on strict and warnings
268 has 'x' => (is => 'rw', isa => 'Int');
269 has 'y' => (is => 'rw', isa => 'Int');
282 has 'z' => (is => 'rw', isa => 'Int');
284 after 'clear' => sub {
291 Moose is an extension of the Perl 5 object system.
293 =head2 Another object system!?!?
295 Yes, I know there has been an explosion recently of new ways to
296 build object's in Perl 5, most of them based on inside-out objects
297 and other such things. Moose is different because it is not a new
298 object system for Perl 5, but instead an extension of the existing
301 Moose is built on top of L<Class::MOP>, which is a metaclass system
302 for Perl 5. This means that Moose not only makes building normal
303 Perl 5 objects better, but it also provides the power of metaclass
306 =head2 Is this for real? Or is this just an experiment?
308 Moose is I<based> on the prototypes and experiments I did for the Perl 6
309 meta-model. However, Moose is B<NOT> an experiment/prototype; it is for B<real>.
311 =head2 Is this ready for use in production?
313 Yes, I believe that it is.
315 I have two medium-to-large-ish web applications which use Moose heavily
316 and have been in production (without issue) for several months now. At
317 $work, we are re-writing our core offering in it. And several people on
318 #moose have been using it (in production) for several months now as well.
320 Of course, in the end, you need to make this call yourself. If you have
321 any questions or concerns, please feel free to email me, or even the list
322 or just stop by #moose and ask away.
324 =head2 Is Moose just Perl 6 in Perl 5?
326 No. While Moose is very much inspired by Perl 6, it is not itself Perl 6.
327 Instead, it is an OO system for Perl 5. I built Moose because I was tired of
328 writing the same old boring Perl 5 OO code, and drooling over Perl 6 OO. So
329 instead of switching to Ruby, I wrote Moose :)
331 =head1 BUILDING CLASSES WITH MOOSE
333 Moose makes every attempt to provide as much convenience as possible during
334 class construction/definition, but still stay out of your way if you want it
335 to. Here are a few items to note when building classes with Moose.
337 Unless specified with C<extends>, any class which uses Moose will
338 inherit from L<Moose::Object>.
340 Moose will also manage all attributes (including inherited ones) that are
341 defined with C<has>. And (assuming you call C<new>, which is inherited from
342 L<Moose::Object>) this includes properly initializing all instance slots,
343 setting defaults where appropriate, and performing any type constraint checking
346 =head1 EXPORTED FUNCTIONS
348 Moose will export a number of functions into the class's namespace which
349 may then be used to set up the class. These functions all work directly
350 on the current class.
356 This is a method which provides access to the current class's metaclass.
358 =item B<extends (@superclasses)>
360 This function will set the superclass(es) for the current class.
362 This approach is recommended instead of C<use base>, because C<use base>
363 actually C<push>es onto the class's C<@ISA>, whereas C<extends> will
364 replace it. This is important to ensure that classes which do not have
365 superclasses still properly inherit from L<Moose::Object>.
367 =item B<with (@roles)>
369 This will apply a given set of C<@roles> to the local class. Role support
370 is currently under heavy development; see L<Moose::Role> for more details.
372 =item B<has $name =E<gt> %options>
374 This will install an attribute of a given C<$name> into the current class.
375 The C<%options> are the same as those provided by
376 L<Class::MOP::Attribute>, in addition to the list below which are provided
377 by Moose (L<Moose::Meta::Attribute> to be more specific):
381 =item I<is =E<gt> 'rw'|'ro'>
383 The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read
384 only). These will create either a read/write accessor or a read-only
385 accessor respectively, using the same name as the C<$name> of the attribute.
387 If you need more control over how your accessors are named, you can use the
388 I<reader>, I<writer> and I<accessor> options inherited from
389 L<Class::MOP::Attribute>.
391 =item I<isa =E<gt> $type_name>
393 The I<isa> option uses Moose's type constraint facilities to set up runtime
394 type checking for this attribute. Moose will perform the checks during class
395 construction, and within any accessors. The C<$type_name> argument must be a
396 string. The string may be either a class name or a type defined using
397 Moose's type definition features. (Refer to L<Moose::Util::TypeConstraints>
398 for information on how to define a new type).
400 =item I<coerce =E<gt> (1|0)>
402 This will attempt to use coercion with the supplied type constraint to change
403 the value passed into any accessors or constructors. You B<must> have supplied
404 a type constraint in order for this to work. See L<Moose::Cookbook::Recipe5>
407 =item I<does =E<gt> $role_name>
409 This will accept the name of a role which the value stored in this attribute
410 is expected to have consumed.
412 =item I<required =E<gt> (1|0)>
414 This marks the attribute as being required. This means a value must be supplied
415 during class construction, and the attribute may never be set to C<undef> with
418 =item I<weak_ref =E<gt> (1|0)>
420 This will tell the class to store the value of this attribute as a weakened
421 reference. If an attribute is a weakened reference, it B<cannot> also be
424 =item I<lazy =E<gt> (1|0)>
426 This will tell the class to not create this slot until absolutely necessary.
427 If an attribute is marked as lazy it B<must> have a default supplied.
429 =item I<auto_deref =E<gt> (1|0)>
431 This tells the accessor whether to automatically dereference the value returned.
432 This is only legal if your C<isa> option is either C<ArrayRef> or C<HashRef>.
434 =item I<metaclass =E<gt> $metaclass_name>
436 This tells the class to use a custom attribute metaclass for this particular
437 attribute. Custom attribute metaclasses are useful for extending the
438 capabilities of the I<has> keyword: they are the simplest way to extend the MOP,
439 but they are still a fairly advanced topic and too much to cover here. I will
440 try and write a recipe on them soon.
442 The default behavior here is to just load C<$metaclass_name>; however, we also
443 have a way to alias to a shorter name. This will first look to see if
444 B<Moose::Meta::Attribute::Custom::$metaclass_name> exists. If it does, Moose
445 will then check to see if that has the method C<register_implemenetation>, which
446 should return the actual name of the custom attribute metaclass. If there is no
447 C<register_implemenetation> method, it will fall back to using
448 B<Moose::Meta::Attribute::Custom::$metaclass_name> as the metaclass name.
450 =item I<trigger =E<gt> $code>
452 The I<trigger> option is a CODE reference which will be called after the value of
453 the attribute is set. The CODE ref will be passed the instance itself, the
454 updated value and the attribute meta-object (this is for more advanced fiddling
455 and can typically be ignored). You B<cannot> have a trigger on a read-only
458 =item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | CODE>
460 The I<handles> option provides Moose classes with automated delegation features.
461 This is a pretty complex and powerful option. It accepts many different option
462 formats, each with its own benefits and drawbacks.
464 B<NOTE:> This feature is no longer experimental, but it may still have subtle
465 bugs lurking in the deeper corners. If you think you have found a bug, you
466 probably have, so please report it to me right away.
468 B<NOTE:> The class being delegated to does not need to be a Moose based class,
469 which is why this feature is especially useful when wrapping non-Moose classes.
471 All I<handles> option formats share the following traits:
473 You cannot override a locally defined method with a delegated method; an
474 exception will be thrown if you try. That is to say, if you define C<foo> in
475 your class, you cannot override it with a delegated C<foo>. This is almost never
476 something you would want to do, and if it is, you should do it by hand and not
479 You cannot override any of the methods found in Moose::Object, or the C<BUILD>
480 and C<DEMOLISH> methods. These will not throw an exception, but will silently
481 move on to the next method in the list. My reasoning for this is that you would
482 almost never want to do this, since it usually breaks your class. As with
483 overriding locally defined methods, if you do want to do this, you should do it
484 manually, not with Moose.
486 Below is the documentation for each option format:
492 This is the most common usage for I<handles>. You basically pass a list of
493 method names to be delegated, and Moose will install a delegation method
498 This is the second most common usage for I<handles>. Instead of a list of
499 method names, you pass a HASH ref where each key is the method name you
500 want installed locally, and its value is the name of the original method
501 in the class being delegated to.
503 This can be very useful for recursive classes like trees. Here is a
504 quick example (soon to be expanded into a Moose::Cookbook::Recipe):
509 has 'node' => (is => 'rw', isa => 'Any');
514 default => sub { [] }
522 parent_node => 'node',
523 siblings => 'children',
527 In this example, the Tree package gets C<parent_node> and C<siblings> methods,
528 which delegate to the C<node> and C<children> methods (respectively) of the Tree
529 instance stored in the C<parent> slot.
533 The regexp option works very similar to the ARRAY option, except that it builds
534 the list of methods for you. It starts by collecting all possible methods of the
535 class being delegated to, then filters that list using the regexp supplied here.
537 B<NOTE:> An I<isa> option is required when using the regexp option format. This
538 is so that we can determine (at compile time) the method list from the class.
539 Without an I<isa> this is just not possible.
543 With the role option, you specify the name of a role whose "interface" then
544 becomes the list of methods to handle. The "interface" can be defined as; the
545 methods of the role and any required methods of the role. It should be noted
546 that this does B<not> include any method modifiers or generated attribute
547 methods (which is consistent with role composition).
551 This is the option to use when you really want to do something funky. You should
552 only use it if you really know what you are doing, as it involves manual
555 This takes a code reference, which should expect two arguments. The first is the
556 attribute meta-object this I<handles> is attached to. The second is the
557 metaclass of the class being delegated to. It expects you to return a hash (not
558 a HASH ref) of the methods you want mapped.
564 =item B<has +$name =E<gt> %options>
566 This is variation on the normal attibute creator C<has> which allows you to
567 clone and extend an attribute from a superclass. Here is a quick example:
575 default => 'Hello, I am a Foo'
583 has '+message' => (default => 'Hello I am My::Foo');
585 What is happening here is that B<My::Foo> is cloning the C<message> attribute
586 from its parent class B<Foo>, retaining the C<is =E<gt> 'rw'> and C<isa =E<gt>
587 'Str'> characteristics, but changing the value in C<default>.
589 This feature is restricted somewhat, so as to try and force at least I<some>
590 sanity into it. You are only allowed to change the following attributes:
596 Change the default value of an attribute.
600 Change whether the attribute attempts to coerce a value passed to it.
604 Change if the attribute is required to have a value.
606 =item I<documentation>
608 Change the documentation string associated with the attribute.
612 Change if the attribute lazily initializes the slot.
616 You I<are> allowed to change the type, B<if and only if> the new type is a
617 subtype of the old type.
621 You are allowed to B<add> a new C<handles> definition, but you are B<not>
622 allowed to I<change> one.
626 =item B<before $name|@names =E<gt> sub { ... }>
628 =item B<after $name|@names =E<gt> sub { ... }>
630 =item B<around $name|@names =E<gt> sub { ... }>
632 This three items are syntactic sugar for the before, after, and around method
633 modifier features that L<Class::MOP> provides. More information on these may be
634 found in the L<Class::MOP::Class documentation|Class::MOP::Class/"Method
639 The keyword C<super> is a no-op when called outside of an C<override> method. In
640 the context of an C<override> method, it will call the next most appropriate
641 superclass method with the same arguments as the original method.
643 =item B<override ($name, &sub)>
645 An C<override> method is a way of explicitly saying "I am overriding this
646 method from my superclass". You can call C<super> within this method, and
647 it will work as expected. The same thing I<can> be accomplished with a normal
648 method call and the C<SUPER::> pseudo-package; it is really your choice.
652 The keyword C<inner>, much like C<super>, is a no-op outside of the context of
653 an C<augment> method. You can think of C<inner> as being the inverse of
654 C<super>; the details of how C<inner> and C<augment> work is best described in
655 the L<Moose::Cookbook>.
657 =item B<augment ($name, &sub)>
659 An C<augment> method, is a way of explicitly saying "I am augmenting this
660 method from my superclass". Once again, the details of how C<inner> and
661 C<augment> work is best described in the L<Moose::Cookbook>.
665 This is the C<Carp::confess> function, and exported here because I use it
666 all the time. This feature may change in the future, so you have been warned.
670 This is the C<Scalar::Util::blessed> function, it is exported here because I
671 use it all the time. It is highly recommended that this is used instead of
672 C<ref> anywhere you need to test for an object's class name.
676 =head1 UNIMPORTING FUNCTIONS
680 Moose offers a way to remove the keywords it exports, through the C<unimport>
681 method. You simply have to say C<no Moose> at the bottom of your code for this
682 to work. Here is an example:
687 has 'first_name' => (is => 'rw', isa => 'Str');
688 has 'last_name' => (is => 'rw', isa => 'Str');
692 $self->first_name . ' ' . $self->last_name
695 no Moose; # keywords are removed from the Person package
703 It should be noted that C<super> and C<inner> B<cannot> be used in the same
704 method. However, they may be combined within the same class hierarchy; see
705 F<t/014_override_augment_inner_super.t> for an example.
707 The reason for this is that C<super> is only valid within a method
708 with the C<override> modifier, and C<inner> will never be valid within an
709 C<override> method. In fact, C<augment> will skip over any C<override> methods
710 when searching for its appropriate C<inner>.
712 This might seem like a restriction, but I am of the opinion that keeping these
713 two features separate (yet interoperable) actually makes them easy to use, since
714 their behavior is then easier to predict. Time will tell whether I am right or
715 not (UPDATE: so far so good).
719 =head1 ACKNOWLEDGEMENTS
723 =item I blame Sam Vilain for introducing me to the insanity that is meta-models.
725 =item I blame Audrey Tang for then encouraging my meta-model habit in #perl6.
727 =item Without Yuval "nothingmuch" Kogman this module would not be possible,
728 and it certainly wouldn't have this name ;P
730 =item The basis of the TypeContraints module was Rob Kinyon's idea
731 originally, I just ran with it.
733 =item Thanks to mst & chansen and the whole #moose poose for all the
734 early ideas/feature-requests/encouragement/bug-finding.
736 =item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes.
744 =item L<http://www.iinteractive.com/moose>
746 This is the official web home of Moose, it contains links to our public SVN repo
747 as well as links to a number of talks and articles on Moose and Moose related
750 =item L<Class::MOP> documentation
752 =item The #moose channel on irc.perl.org
754 =item The Moose mailing list - moose@perl.org
756 =item Moose stats on ohloh.net - L<http://www.ohloh.net/projects/5788>
764 =item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf>
766 This paper (suggested by lbr on #moose) was what lead to the implementation
767 of the C<super>/C<override> and C<inner>/C<augment> features. If you really
768 want to understand them, I suggest you read this.
774 All complex software has bugs lurking in it, and this module is no
775 exception. If you find a bug please either email me, or add the bug
780 Stevan Little E<lt>stevan@iinteractive.comE<gt>
782 B<with contributions from:>
788 Anders (Debolaz) Nor Berle
790 Christian (chansen) Hansen
792 Eric (ewilhelm) Wilhelm
794 Guillermo (groditi) Roditi
796 Jess (castaway) Robinson
800 Robert (phaylon) Sedlacek
804 Scott (konobi) McWhirter
806 Shlomi (rindolf) Fish
808 Yuval (nothingmuch) Kogman
810 Chris (perigrin) Prather
812 ... and many other #moose folks
814 =head1 COPYRIGHT AND LICENSE
816 Copyright 2006, 2007 by Infinity Interactive, Inc.
818 L<http://www.iinteractive.com>
820 This library is free software; you can redistribute it and/or modify
821 it under the same terms as Perl itself.