Missed a few use_ok calls that started warning now that Moose::Role
[gitmo/Moose.git] / lib / Moose.pm
CommitLineData
fcd84ca9 1
2package Moose;
3
4use strict;
5use warnings;
6
a94188ac 7our $VERSION = '0.56';
d44714be 8our $AUTHORITY = 'cpan:STEVAN';
fcd84ca9 9
21f1e231 10use Scalar::Util 'blessed';
c0b37457 11use Carp 'confess', 'croak', 'cluck';
fcd84ca9 12
5bd4db9b 13use Moose::Exporter;
7f18097c 14
46217c9c 15use Class::MOP 0.64;
ef1d5f4b 16
c0e30cf5 17use Moose::Meta::Class;
7415b2cb 18use Moose::Meta::TypeConstraint;
7c13858b 19use Moose::Meta::TypeCoercion;
78cd1d3b 20use Moose::Meta::Attribute;
ddd0ec20 21use Moose::Meta::Instance;
c0e30cf5 22
d67145ed 23use Moose::Meta::Role;
24
fcd84ca9 25use Moose::Object;
7415b2cb 26use Moose::Util::TypeConstraints;
d7d8a8c7 27use Moose::Util ();
a15dff8d 28
5bd4db9b 29sub extends {
30 my $class = shift;
3d544ed5 31
5bd4db9b 32 croak "Must derive at least one class" unless @_;
9bcfbab1 33
5bd4db9b 34 my @supers = @_;
35 foreach my $super (@supers) {
36 Class::MOP::load_class($super);
37 croak "You cannot inherit from a Moose Role ($super)"
38 if $super->can('meta') &&
39 blessed $super->meta &&
40 $super->meta->isa('Moose::Meta::Role')
c92c1205 41 }
5bee491d 42
26fbace8 43
86dd5d11 44
5bd4db9b 45 # this checks the metaclass to make sure
46 # it is correct, sometimes it can get out
47 # of sync when the classes are being built
48 my $meta = $class->meta->_fix_metaclass_incompatability(@supers);
49 $meta->superclasses(@supers);
50}
a3c7e2fe 51
5bd4db9b 52sub with {
53 my $class = shift;
54 Moose::Util::apply_all_roles($class->meta, @_);
55}
9bcfbab1 56
5bd4db9b 57sub has {
58 my $class = shift;
59 my $name = shift;
60 croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1;
61 my %options = @_;
62 my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ];
63 $class->meta->add_attribute( $_, %options ) for @$attrs;
64}
9bcfbab1 65
5bd4db9b 66sub before {
67 my $class = shift;
68 Moose::Util::add_method_modifier($class, 'before', \@_);
69}
70
71sub after {
72 my $class = shift;
73 Moose::Util::add_method_modifier($class, 'after', \@_);
74}
75
76sub around {
77 my $class = shift;
78 Moose::Util::add_method_modifier($class, 'around', \@_);
79}
80
81sub super {
82 return unless our $SUPER_BODY; $SUPER_BODY->(our @SUPER_ARGS);
83}
9bcfbab1 84
5bd4db9b 85sub override {
86 my $class = shift;
87 my ( $name, $method ) = @_;
88 $class->meta->add_override_method_modifier( $name => $method );
89}
9bcfbab1 90
5bd4db9b 91sub inner {
92 my $pkg = caller();
93 our ( %INNER_BODY, %INNER_ARGS );
94
95 if ( my $body = $INNER_BODY{$pkg} ) {
96 my @args = @{ $INNER_ARGS{$pkg} };
97 local $INNER_ARGS{$pkg};
98 local $INNER_BODY{$pkg};
99 return $body->(@args);
100 } else {
101 return;
ce265cc3 102 }
5bd4db9b 103}
9bcfbab1 104
5bd4db9b 105sub augment {
106 my $class = shift;
107 my ( $name, $method ) = @_;
108 $class->meta->add_augment_method_modifier( $name => $method );
ce265cc3 109}
9bcfbab1 110
5bd4db9b 111sub make_immutable {
112 my $class = shift;
113 cluck "The make_immutable keyword has been deprecated, " .
114 "please go back to __PACKAGE__->meta->make_immutable\n";
115 $class->meta->make_immutable(@_);
116}
9bcfbab1 117
a5c426fc 118my $exporter = Moose::Exporter->build_import_methods(
5bd4db9b 119 with_caller => [
120 qw( extends with has before after around override augment make_immutable )
121 ],
122 as_is => [
123 qw( super inner ),
124 \&Carp::confess,
125 \&Scalar::Util::blessed,
126 ],
a5c426fc 127 also => sub { init_meta( shift, 'Moose::Object' ); },
5bd4db9b 128);
129
5bd4db9b 130# NOTE:
131# This is for special use by
132# some modules and stuff, I
133# dont know if it is sane enough
134# to document actually.
135# - SL
136sub __CURRY_EXPORTS_FOR_CLASS__ {
137 my $caller = shift;
138 ($caller ne 'Moose')
139 || croak "_import_into must be called a function, not a method";
140 ($caller->can('meta') && $caller->meta->isa('Class::MOP::Class'))
141 || croak "Cannot call _import_into on a package ($caller) without a metaclass";
142# return map { $_ => $exports{$_}->() } (@_ ? @_ : keys %exports);
143}
ce265cc3 144
cc841c0e 145sub init_meta {
146 my ( $class, $base_class, $metaclass ) = @_;
147 $base_class = 'Moose::Object' unless defined $base_class;
148 $metaclass = 'Moose::Meta::Class' unless defined $metaclass;
149
150 confess
151 "The Metaclass $metaclass must be a subclass of Moose::Meta::Class."
152 unless $metaclass->isa('Moose::Meta::Class');
153
154 # make a subtype for each Moose class
155 class_type($class)
156 unless find_type_constraint($class);
157
158 my $meta;
159 if ( $class->can('meta') ) {
160 # NOTE:
161 # this is the case where the metaclass pragma
162 # was used before the 'use Moose' statement to
163 # override a specific class
164 $meta = $class->meta();
165 ( blessed($meta) && $meta->isa('Moose::Meta::Class') )
166 || confess "You already have a &meta function, but it does not return a Moose::Meta::Class";
167 }
168 else {
169 # NOTE:
170 # this is broken currently, we actually need
171 # to allow the possiblity of an inherited
172 # meta, which will not be visible until the
173 # user 'extends' first. This needs to have
174 # more intelligence to it
175 $meta = $metaclass->initialize($class);
176 $meta->add_method(
177 'meta' => sub {
178 # re-initialize so it inherits properly
179 $metaclass->initialize( blessed( $_[0] ) || $_[0] );
180 }
181 );
182 }
183
184 # make sure they inherit from Moose::Object
185 $meta->superclasses($base_class)
186 unless $meta->superclasses();
187
188 return $meta;
189}
190
8ecb1fa0 191## make 'em all immutable
192
193$_->meta->make_immutable(
194 inline_constructor => 0,
77a18c28 195 inline_accessors => 1, # these are Class::MOP accessors, so they need inlining
9bcfbab1 196 )
197 for (
8ecb1fa0 198 'Moose::Meta::Attribute',
199 'Moose::Meta::Class',
200 'Moose::Meta::Instance',
201
202 'Moose::Meta::TypeConstraint',
203 'Moose::Meta::TypeConstraint::Union',
0fbd4b0a 204 'Moose::Meta::TypeConstraint::Parameterized',
8ecb1fa0 205 'Moose::Meta::TypeCoercion',
206
207 'Moose::Meta::Method',
208 'Moose::Meta::Method::Accessor',
209 'Moose::Meta::Method::Constructor',
9bcfbab1 210 'Moose::Meta::Method::Destructor',
8ecb1fa0 211 'Moose::Meta::Method::Overriden',
d67145ed 212
213 'Moose::Meta::Role',
9bcfbab1 214 'Moose::Meta::Role::Method',
215 'Moose::Meta::Role::Method::Required',
216 );
8ecb1fa0 217
fcd84ca9 2181;
219
220__END__
221
222=pod
223
224=head1 NAME
225
8bdc7f13 226Moose - A postmodern object system for Perl 5
fcd84ca9 227
228=head1 SYNOPSIS
e522431d 229
230 package Point;
1cd45431 231 use Moose; # automatically turns on strict and warnings
26fbace8 232
43d599e5 233 has 'x' => (is => 'rw', isa => 'Int');
234 has 'y' => (is => 'rw', isa => 'Int');
26fbace8 235
e522431d 236 sub clear {
237 my $self = shift;
238 $self->x(0);
26fbace8 239 $self->y(0);
e522431d 240 }
26fbace8 241
e522431d 242 package Point3D;
243 use Moose;
26fbace8 244
e522431d 245 extends 'Point';
26fbace8 246
43d599e5 247 has 'z' => (is => 'rw', isa => 'Int');
26fbace8 248
e522431d 249 after 'clear' => sub {
250 my $self = shift;
43d599e5 251 $self->z(0);
26fbace8 252 };
2c0cbef7 253
fcd84ca9 254=head1 DESCRIPTION
255
26fbace8 256Moose is an extension of the Perl 5 object system.
e522431d 257
9b9da6f1 258The main goal of Moose is to make Perl 5 Object Oriented programming
259easier, more consistent and less tedious. With Moose you can to think
260more about what you want to do and less about the mechanics of OOP.
fcd84ca9 261
9b9da6f1 262Additionally, Moose is built on top of L<Class::MOP>, which is a
263metaclass system for Perl 5. This means that Moose not only makes
264building normal Perl 5 objects better, but it provides the power of
265metaclass programming as well.
8bdc7f13 266
28669f89 267=head2 Moose Extensions
268
12aed9a0 269The C<MooseX::> namespace is the official place to find Moose extensions.
270These extensions can be found on the CPAN. The easiest way to find them
271is to search for them (L<http://search.cpan.org/search?query=MooseX::>),
272or to examine L<Task::Moose> which aims to keep an up-to-date, easily
273installable list of Moose extensions.
28669f89 274
6ba6d68c 275=head1 BUILDING CLASSES WITH MOOSE
276
68efb014 277Moose makes every attempt to provide as much convenience as possible during
278class construction/definition, but still stay out of your way if you want it
279to. Here are a few items to note when building classes with Moose.
6ba6d68c 280
26fbace8 281Unless specified with C<extends>, any class which uses Moose will
6ba6d68c 282inherit from L<Moose::Object>.
283
1cd45431 284Moose will also manage all attributes (including inherited ones) that are
285defined with C<has>. And (assuming you call C<new>, which is inherited from
286L<Moose::Object>) this includes properly initializing all instance slots,
287setting defaults where appropriate, and performing any type constraint checking
288or coercion.
6ba6d68c 289
004222dc 290=head1 PROVIDED METHODS
6ba6d68c 291
004222dc 292Moose provides a number of methods to all your classes, mostly through the
293inheritance of L<Moose::Object>. There is however, one exception.
6ba6d68c 294
295=over 4
296
297=item B<meta>
298
299This is a method which provides access to the current class's metaclass.
300
004222dc 301=back
302
303=head1 EXPORTED FUNCTIONS
304
305Moose will export a number of functions into the class's namespace which
306may then be used to set up the class. These functions all work directly
307on the current class.
308
309=over 4
310
6ba6d68c 311=item B<extends (@superclasses)>
312
313This function will set the superclass(es) for the current class.
314
26fbace8 315This approach is recommended instead of C<use base>, because C<use base>
316actually C<push>es onto the class's C<@ISA>, whereas C<extends> will
317replace it. This is important to ensure that classes which do not have
68efb014 318superclasses still properly inherit from L<Moose::Object>.
6ba6d68c 319
43d599e5 320=item B<with (@roles)>
e9ec68d6 321
004222dc 322This will apply a given set of C<@roles> to the local class.
e9ec68d6 323
cd7eeaf5 324=item B<has $name =E<gt> %options>
6ba6d68c 325
26fbace8 326This will install an attribute of a given C<$name> into the current class.
327The C<%options> are the same as those provided by
328L<Class::MOP::Attribute>, in addition to the list below which are provided
43d599e5 329by Moose (L<Moose::Meta::Attribute> to be more specific):
6ba6d68c 330
331=over 4
332
076c81ed 333=item I<is =E<gt> 'rw'|'ro'>
6ba6d68c 334
26fbace8 335The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read
336only). These will create either a read/write accessor or a read-only
6ba6d68c 337accessor respectively, using the same name as the C<$name> of the attribute.
338
1cd45431 339If you need more control over how your accessors are named, you can use the
340I<reader>, I<writer> and I<accessor> options inherited from
004222dc 341L<Class::MOP::Attribute>, however if you use those, you won't need the I<is>
342option.
6ba6d68c 343
076c81ed 344=item I<isa =E<gt> $type_name>
6ba6d68c 345
26fbace8 346The I<isa> option uses Moose's type constraint facilities to set up runtime
347type checking for this attribute. Moose will perform the checks during class
348construction, and within any accessors. The C<$type_name> argument must be a
349string. The string may be either a class name or a type defined using
9cca2e9e 350Moose's type definition features. (Refer to L<Moose::Util::TypeConstraints>
c2a69ef1 351for information on how to define a new type, and how to retrieve type meta-data).
6ba6d68c 352
daea75c9 353=item I<coerce =E<gt> (1|0)>
354
26fbace8 355This will attempt to use coercion with the supplied type constraint to change
356the value passed into any accessors or constructors. You B<must> have supplied
5cfe3805 357a type constraint in order for this to work. See L<Moose::Cookbook::Basics::Recipe5>
1cd45431 358for an example.
daea75c9 359
360=item I<does =E<gt> $role_name>
361
26fbace8 362This will accept the name of a role which the value stored in this attribute
daea75c9 363is expected to have consumed.
364
365=item I<required =E<gt> (1|0)>
366
26fbace8 367This marks the attribute as being required. This means a I<defined> value must be
368supplied during class construction, and the attribute may never be set to
369C<undef> with an accessor.
daea75c9 370
371=item I<weak_ref =E<gt> (1|0)>
372
68efb014 373This will tell the class to store the value of this attribute as a weakened
374reference. If an attribute is a weakened reference, it B<cannot> also be
375coerced.
daea75c9 376
377=item I<lazy =E<gt> (1|0)>
378
26fbace8 379This will tell the class to not create this slot until absolutely necessary.
daea75c9 380If an attribute is marked as lazy it B<must> have a default supplied.
381
9e93dd19 382=item I<auto_deref =E<gt> (1|0)>
383
26fbace8 384This tells the accessor whether to automatically dereference the value returned.
1cd45431 385This is only legal if your C<isa> option is either C<ArrayRef> or C<HashRef>.
9e93dd19 386
65e14c86 387=item I<trigger =E<gt> $code>
388
389The I<trigger> option is a CODE reference which will be called after the value of
390the attribute is set. The CODE ref will be passed the instance itself, the
391updated value and the attribute meta-object (this is for more advanced fiddling
392and can typically be ignored). You B<cannot> have a trigger on a read-only
393attribute.
daea75c9 394
c84f324f 395=item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | CODE>
2c0cbef7 396
26fbace8 397The I<handles> option provides Moose classes with automated delegation features.
398This is a pretty complex and powerful option. It accepts many different option
399formats, each with its own benefits and drawbacks.
38e3283b 400
1cd45431 401B<NOTE:> The class being delegated to does not need to be a Moose based class,
402which is why this feature is especially useful when wrapping non-Moose classes.
38e3283b 403
1cd45431 404All I<handles> option formats share the following traits:
38e3283b 405
1cd45431 406You cannot override a locally defined method with a delegated method; an
407exception will be thrown if you try. That is to say, if you define C<foo> in
408your class, you cannot override it with a delegated C<foo>. This is almost never
409something you would want to do, and if it is, you should do it by hand and not
410use Moose.
38e3283b 411
1cd45431 412You cannot override any of the methods found in Moose::Object, or the C<BUILD>
413and C<DEMOLISH> methods. These will not throw an exception, but will silently
414move on to the next method in the list. My reasoning for this is that you would
415almost never want to do this, since it usually breaks your class. As with
416overriding locally defined methods, if you do want to do this, you should do it
417manually, not with Moose.
38e3283b 418
f3c4e20e 419You do not I<need> to have a reader (or accessor) for the attribute in order
420to delegate to it. Moose will create a means of accessing the value for you,
421however this will be several times B<less> efficient then if you had given
422the attribute a reader (or accessor) to use.
423
38e3283b 424Below is the documentation for each option format:
425
426=over 4
427
428=item C<ARRAY>
429
26fbace8 430This is the most common usage for I<handles>. You basically pass a list of
431method names to be delegated, and Moose will install a delegation method
1cd45431 432for each one.
38e3283b 433
434=item C<HASH>
435
26fbace8 436This is the second most common usage for I<handles>. Instead of a list of
437method names, you pass a HASH ref where each key is the method name you
438want installed locally, and its value is the name of the original method
439in the class being delegated to.
fd595040 440
26fbace8 441This can be very useful for recursive classes like trees. Here is a
5cfe3805 442quick example (soon to be expanded into a Moose::Cookbook recipe):
38e3283b 443
1cd45431 444 package Tree;
38e3283b 445 use Moose;
26fbace8 446
38e3283b 447 has 'node' => (is => 'rw', isa => 'Any');
26fbace8 448
38e3283b 449 has 'children' => (
450 is => 'ro',
451 isa => 'ArrayRef',
452 default => sub { [] }
453 );
26fbace8 454
38e3283b 455 has 'parent' => (
456 is => 'rw',
457 isa => 'Tree',
a4e516f6 458 weak_ref => 1,
38e3283b 459 handles => {
460 parent_node => 'node',
26fbace8 461 siblings => 'children',
38e3283b 462 }
463 );
464
1cd45431 465In this example, the Tree package gets C<parent_node> and C<siblings> methods,
466which delegate to the C<node> and C<children> methods (respectively) of the Tree
26fbace8 467instance stored in the C<parent> slot.
38e3283b 468
469=item C<REGEXP>
470
26fbace8 471The regexp option works very similar to the ARRAY option, except that it builds
472the list of methods for you. It starts by collecting all possible methods of the
473class being delegated to, then filters that list using the regexp supplied here.
38e3283b 474
26fbace8 475B<NOTE:> An I<isa> option is required when using the regexp option format. This
476is so that we can determine (at compile time) the method list from the class.
38e3283b 477Without an I<isa> this is just not possible.
478
c84f324f 479=item C<ROLE>
480
26fbace8 481With the role option, you specify the name of a role whose "interface" then
482becomes the list of methods to handle. The "interface" can be defined as; the
483methods of the role and any required methods of the role. It should be noted
484that this does B<not> include any method modifiers or generated attribute
c84f324f 485methods (which is consistent with role composition).
486
38e3283b 487=item C<CODE>
488
1cd45431 489This is the option to use when you really want to do something funky. You should
490only use it if you really know what you are doing, as it involves manual
491metaclass twiddling.
38e3283b 492
1cd45431 493This takes a code reference, which should expect two arguments. The first is the
494attribute meta-object this I<handles> is attached to. The second is the
495metaclass of the class being delegated to. It expects you to return a hash (not
26fbace8 496a HASH ref) of the methods you want mapped.
38e3283b 497
498=back
2c0cbef7 499
004222dc 500=item I<metaclass =E<gt> $metaclass_name>
501
502This tells the class to use a custom attribute metaclass for this particular
503attribute. Custom attribute metaclasses are useful for extending the
504capabilities of the I<has> keyword: they are the simplest way to extend the MOP,
505but they are still a fairly advanced topic and too much to cover here, see
5cfe3805 506L<Moose::Cookbook::Meta::Recipe1> for more information.
004222dc 507
508The default behavior here is to just load C<$metaclass_name>; however, we also
509have a way to alias to a shorter name. This will first look to see if
510B<Moose::Meta::Attribute::Custom::$metaclass_name> exists. If it does, Moose
511will then check to see if that has the method C<register_implementation>, which
512should return the actual name of the custom attribute metaclass. If there is no
513C<register_implementation> method, it will fall back to using
514B<Moose::Meta::Attribute::Custom::$metaclass_name> as the metaclass name.
515
516=item I<traits =E<gt> [ @role_names ]>
517
518This tells Moose to take the list of C<@role_names> and apply them to the
519attribute meta-object. This is very similar to the I<metaclass> option, but
520allows you to use more than one extension at a time. This too is an advanced
521topic, we don't yet have a cookbook for it though.
522
523As with I<metaclass>, the default behavior is to just load C<$role_name>; however,
524we also have a way to alias to a shorter name. This will first look to see if
525B<Moose::Meta::Attribute::Custom::Trait::$role_name> exists. If it does, Moose
526will then check to see if that has the method C<register_implementation>, which
527should return the actual name of the custom attribute trait. If there is no
528C<register_implementation> method, it will fall back to using
529B<Moose::Meta::Attribute::Custom::Trait::$metaclass_name> as the trait name.
530
6ba6d68c 531=back
532
cd7eeaf5 533=item B<has +$name =E<gt> %options>
534
26fbace8 535This is variation on the normal attibute creator C<has> which allows you to
8d62bf6d 536clone and extend an attribute from a superclass or from a role. Here is an
537example of the superclass usage:
cd7eeaf5 538
539 package Foo;
540 use Moose;
26fbace8 541
cd7eeaf5 542 has 'message' => (
26fbace8 543 is => 'rw',
cd7eeaf5 544 isa => 'Str',
545 default => 'Hello, I am a Foo'
546 );
26fbace8 547
cd7eeaf5 548 package My::Foo;
549 use Moose;
26fbace8 550
cd7eeaf5 551 extends 'Foo';
26fbace8 552
cd7eeaf5 553 has '+message' => (default => 'Hello I am My::Foo');
554
1cd45431 555What is happening here is that B<My::Foo> is cloning the C<message> attribute
556from its parent class B<Foo>, retaining the C<is =E<gt> 'rw'> and C<isa =E<gt>
557'Str'> characteristics, but changing the value in C<default>.
cd7eeaf5 558
8d62bf6d 559Here is another example, but within the context of a role:
560
561 package Foo::Role;
562 use Moose::Role;
986d175a 563
8d62bf6d 564 has 'message' => (
565 is => 'rw',
566 isa => 'Str',
567 default => 'Hello, I am a Foo'
568 );
986d175a 569
8d62bf6d 570 package My::Foo;
571 use Moose;
986d175a 572
8d62bf6d 573 with 'Foo::Role';
986d175a 574
8d62bf6d 575 has '+message' => (default => 'Hello I am My::Foo');
576
577In this case, we are basically taking the attribute which the role supplied
4032c9bb 578and altering it within the bounds of this feature.
8d62bf6d 579
4032c9bb 580Aside from where the attributes come from (one from superclass, the other
581from a role), this feature works exactly the same. This feature is restricted
582somewhat, so as to try and force at least I<some> sanity into it. You are only
583allowed to change the following attributes:
cd7eeaf5 584
585=over 4
586
26fbace8 587=item I<default>
cd7eeaf5 588
589Change the default value of an attribute.
590
26fbace8 591=item I<coerce>
cd7eeaf5 592
593Change whether the attribute attempts to coerce a value passed to it.
594
26fbace8 595=item I<required>
cd7eeaf5 596
597Change if the attribute is required to have a value.
598
599=item I<documentation>
600
601Change the documentation string associated with the attribute.
602
83cc9094 603=item I<lazy>
604
605Change if the attribute lazily initializes the slot.
606
cd7eeaf5 607=item I<isa>
608
aed87761 609You I<are> allowed to change the type without restriction.
610
611It is recommended that you use this freedom with caution. We used to
612only allow for extension only if the type was a subtype of the parent's
613type, but we felt that was too restrictive and is better left as a
614policy descision.
cd7eeaf5 615
83cc9094 616=item I<handles>
617
26fbace8 618You are allowed to B<add> a new C<handles> definition, but you are B<not>
619allowed to I<change> one.
83cc9094 620
8d62bf6d 621=item I<builder>
622
623You are allowed to B<add> a new C<builder> definition, but you are B<not>
624allowed to I<change> one.
625
13284479 626=item I<metaclass>
627
628You are allowed to B<add> a new C<metaclass> definition, but you are
629B<not> allowed to I<change> one.
630
631=item I<traits>
632
633You are allowed to B<add> additional traits to the C<traits> definition.
634These traits will be composed into the attribute, but pre-existing traits
635B<are not> overridden, or removed.
636
cd7eeaf5 637=back
638
076c81ed 639=item B<before $name|@names =E<gt> sub { ... }>
6ba6d68c 640
076c81ed 641=item B<after $name|@names =E<gt> sub { ... }>
6ba6d68c 642
076c81ed 643=item B<around $name|@names =E<gt> sub { ... }>
6ba6d68c 644
d8af92ae 645This three items are syntactic sugar for the before, after, and around method
646modifier features that L<Class::MOP> provides. More information on these may be
647found in the L<Class::MOP::Class documentation|Class::MOP::Class/"Method
648Modifiers"> for now.
6ba6d68c 649
159da176 650=item B<super>
651
26fbace8 652The keyword C<super> is a no-op when called outside of an C<override> method. In
653the context of an C<override> method, it will call the next most appropriate
159da176 654superclass method with the same arguments as the original method.
655
656=item B<override ($name, &sub)>
657
26fbace8 658An C<override> method is a way of explicitly saying "I am overriding this
659method from my superclass". You can call C<super> within this method, and
660it will work as expected. The same thing I<can> be accomplished with a normal
661method call and the C<SUPER::> pseudo-package; it is really your choice.
159da176 662
663=item B<inner>
664
26fbace8 665The keyword C<inner>, much like C<super>, is a no-op outside of the context of
666an C<augment> method. You can think of C<inner> as being the inverse of
68efb014 667C<super>; the details of how C<inner> and C<augment> work is best described in
5cfe3805 668the L<Moose::Cookbook::Basics::Recipe6>.
159da176 669
670=item B<augment ($name, &sub)>
671
26fbace8 672An C<augment> method, is a way of explicitly saying "I am augmenting this
673method from my superclass". Once again, the details of how C<inner> and
5cfe3805 674C<augment> work is best described in the L<Moose::Cookbook::Basics::Recipe6>.
159da176 675
6ba6d68c 676=item B<confess>
677
68efb014 678This is the C<Carp::confess> function, and exported here because I use it
004222dc 679all the time.
6ba6d68c 680
681=item B<blessed>
682
1cd45431 683This is the C<Scalar::Util::blessed> function, it is exported here because I
26fbace8 684use it all the time. It is highly recommended that this is used instead of
6ba6d68c 685C<ref> anywhere you need to test for an object's class name.
686
687=back
688
1cd45431 689=head1 UNIMPORTING FUNCTIONS
31f8ec72 690
691=head2 B<unimport>
692
1cd45431 693Moose offers a way to remove the keywords it exports, through the C<unimport>
31f8ec72 694method. You simply have to say C<no Moose> at the bottom of your code for this
695to work. Here is an example:
696
697 package Person;
698 use Moose;
699
700 has 'first_name' => (is => 'rw', isa => 'Str');
701 has 'last_name' => (is => 'rw', isa => 'Str');
26fbace8 702
703 sub full_name {
31f8ec72 704 my $self = shift;
26fbace8 705 $self->first_name . ' ' . $self->last_name
31f8ec72 706 }
26fbace8 707
708 no Moose; # keywords are removed from the Person package
31f8ec72 709
9bcfbab1 710=head1 EXTENDING AND EMBEDDING MOOSE
711
26fbace8 712Moose also offers some options for extending or embedding it into your own
9bcfbab1 713framework. The basic premise is to have something that sets up your class'
26fbace8 714metaclass and export the moose declarators (C<has>, C<with>, C<extends>,...).
9bcfbab1 715Here is an example:
716
717 package MyFramework;
718 use Moose;
26fbace8 719
9bcfbab1 720 sub import {
721 my $CALLER = caller();
722
723 strict->import;
724 warnings->import;
725
726 # we should never export to main
727 return if $CALLER eq 'main';
728 Moose::init_meta( $CALLER, 'MyFramework::Base' );
729 Moose->import({into => $CALLER});
730
731 # Do my custom framework stuff
26fbace8 732
9bcfbab1 733 return 1;
734 }
26fbace8 735
9bcfbab1 736=head2 B<import>
737
77a18c28 738Moose's C<import> method supports the L<Sub::Exporter> form of C<{into =E<gt> $pkg}>
9bcfbab1 739and C<{into_level =E<gt> 1}>
740
741=head2 B<init_meta ($class, $baseclass, $metaclass)>
742
26fbace8 743Moose does some boot strapping: it creates a metaclass object for your class,
744and then injects a C<meta> accessor into your class to retrieve it. Then it
745sets your baseclass to Moose::Object or the value you pass in unless you already
746have one. This is all done via C<init_meta> which takes the name of your class
2bbba362 747and optionally a baseclass and a metaclass as arguments.
26fbace8 748
80837fe1 749For more detail on this topic, see L<Moose::Cookbook::Extending::Recipe2>.
750
05d9eaf6 751=head1 CAVEATS
752
753=over 4
754
755=item *
756
1cd45431 757It should be noted that C<super> and C<inner> B<cannot> be used in the same
758method. However, they may be combined within the same class hierarchy; see
759F<t/014_override_augment_inner_super.t> for an example.
05d9eaf6 760
26fbace8 761The reason for this is that C<super> is only valid within a method
762with the C<override> modifier, and C<inner> will never be valid within an
763C<override> method. In fact, C<augment> will skip over any C<override> methods
68efb014 764when searching for its appropriate C<inner>.
05d9eaf6 765
1cd45431 766This might seem like a restriction, but I am of the opinion that keeping these
767two features separate (yet interoperable) actually makes them easy to use, since
768their behavior is then easier to predict. Time will tell whether I am right or
c84f324f 769not (UPDATE: so far so good).
05d9eaf6 770
004222dc 771=item *
772
773It is important to note that we currently have no simple way of combining
774multiple extended versions of Moose (see L<EXTENDING AND EMBEDDING MOOSE> above),
775and that in many cases they will conflict with one another. We are working on
776developing a way around this issue, but in the meantime, you have been warned.
777
05d9eaf6 778=back
779
9b9da6f1 780=head1 JUSTIFICATION
781
782In case you are still asking yourself "Why do I need this?", then this
783section is for you. This used to be part of the main DESCRIPTION, but
784I think Moose no longer actually needs justification, so it is included
785(read: buried) here for those who are still not convinced.
786
787=over 4
788
789=item Another object system!?!?
790
791Yes, I know there has been an explosion recently of new ways to
792build objects in Perl 5, most of them based on inside-out objects
793and other such things. Moose is different because it is not a new
794object system for Perl 5, but instead an extension of the existing
795object system.
796
797Moose is built on top of L<Class::MOP>, which is a metaclass system
798for Perl 5. This means that Moose not only makes building normal
799Perl 5 objects better, but it also provides the power of metaclass
800programming.
801
802=item Is this for real? Or is this just an experiment?
803
804Moose is I<based> on the prototypes and experiments I did for the Perl 6
805meta-model. However, Moose is B<NOT> an experiment/prototype; it is for B<real>.
806
807=item Is this ready for use in production?
808
809Yes, I believe that it is.
810
811Moose has been used successfully in production environemnts by several people
812and companies (including the one I work for). There are Moose applications
813which have been in production with little or no issue now for well over two years.
814I consider it highly stable and we are commited to keeping it stable.
815
816Of course, in the end, you need to make this call yourself. If you have
817any questions or concerns, please feel free to email me, or even the list
818or just stop by #moose and ask away.
819
820=item Is Moose just Perl 6 in Perl 5?
821
822No. While Moose is very much inspired by Perl 6, it is not itself Perl 6.
823Instead, it is an OO system for Perl 5. I built Moose because I was tired of
824writing the same old boring Perl 5 OO code, and drooling over Perl 6 OO. So
825instead of switching to Ruby, I wrote Moose :)
826
827=item Wait, I<post> modern, I thought it was just I<modern>?
828
829So I was reading Larry Wall's talk from the 1999 Linux World entitled
830"Perl, the first postmodern computer language" in which he talks about how
831he picked the features for Perl because he thought they were cool and he
832threw out the ones that he thought sucked. This got me thinking about how
833we have done the same thing in Moose. For Moose, we have "borrowed" features
834from Perl 6, CLOS (LISP), Smalltalk, Java, BETA, OCaml, Ruby and more, and
835the bits we didn't like (cause they sucked) we tossed aside. So for this
836reason (and a few others) I have re-dubbed Moose a I<postmodern> object system.
837
838Nuff Said.
839
840=back
841
5569c072 842=head1 ACKNOWLEDGEMENTS
843
844=over 4
845
54c189df 846=item I blame Sam Vilain for introducing me to the insanity that is meta-models.
5569c072 847
54c189df 848=item I blame Audrey Tang for then encouraging my meta-model habit in #perl6.
5569c072 849
26fbace8 850=item Without Yuval "nothingmuch" Kogman this module would not be possible,
54c189df 851and it certainly wouldn't have this name ;P
5569c072 852
26fbace8 853=item The basis of the TypeContraints module was Rob Kinyon's idea
5569c072 854originally, I just ran with it.
855
638585e1 856=item Thanks to mst & chansen and the whole #moose posse for all the
c84f324f 857early ideas/feature-requests/encouragement/bug-finding.
d46a48f3 858
68efb014 859=item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes.
860
5569c072 861=back
862
e90c03d0 863=head1 SEE ALSO
864
865=over 4
866
c84f324f 867=item L<http://www.iinteractive.com/moose>
868
869This is the official web home of Moose, it contains links to our public SVN repo
26fbace8 870as well as links to a number of talks and articles on Moose and Moose related
871technologies.
c84f324f 872
196064ab 873=item L<Moose::Cookbook> - How to cook a Moose
874
875=item The Moose is flying, a tutorial by Randal Schwartz
876
877Part 1 - L<http://www.stonehenge.com/merlyn/LinuxMag/col94.html>
878
879Part 2 - L<http://www.stonehenge.com/merlyn/LinuxMag/col95.html>
880
6ba6d68c 881=item L<Class::MOP> documentation
882
883=item The #moose channel on irc.perl.org
884
e67a0fca 885=item The Moose mailing list - moose@perl.org
886
9e0361e1 887=item Moose stats on ohloh.net - L<http://www.ohloh.net/projects/moose>
c84f324f 888
12aed9a0 889=item Several Moose extension modules in the C<MooseX::> namespace.
890
891See L<http://search.cpan.org/search?query=MooseX::> for extensions.
28669f89 892
c84f324f 893=back
894
004222dc 895=head2 Books
896
897=over 4
898
899=item The Art of the MetaObject Protocol
900
901I mention this in the L<Class::MOP> docs too, this book was critical in
902the development of both modules and is highly recommended.
903
904=back
905
26fbace8 906=head2 Papers
c84f324f 907
908=over 4
e90c03d0 909
159da176 910=item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf>
911
26fbace8 912This paper (suggested by lbr on #moose) was what lead to the implementation
913of the C<super>/C<override> and C<inner>/C<augment> features. If you really
1cd45431 914want to understand them, I suggest you read this.
159da176 915
e90c03d0 916=back
917
fcd84ca9 918=head1 BUGS
919
26fbace8 920All complex software has bugs lurking in it, and this module is no
fcd84ca9 921exception. If you find a bug please either email me, or add the bug
922to cpan-RT.
923
47b19570 924=head1 FEATURE REQUESTS
925
926We are very strict about what features we add to the Moose core, especially
927the user-visible features. Instead we have made sure that the underlying
928meta-system of Moose is as extensible as possible so that you can add your
929own features easily. That said, occasionally there is a feature needed in the
930meta-system to support your planned extension, in which case you should
931either email the mailing list or join us on irc at #moose to discuss.
932
fcd84ca9 933=head1 AUTHOR
934
935Stevan Little E<lt>stevan@iinteractive.comE<gt>
936
9af1d28b 937B<with contributions from:>
db1ab48d 938
9af1d28b 939Aankhen
940
941Adam (Alias) Kennedy
942
943Anders (Debolaz) Nor Berle
944
5868294f 945Nathan (kolibre) Gray
946
9af1d28b 947Christian (chansen) Hansen
948
e7f8d0c2 949Hans Dieter (confound) Pearcey
950
9af1d28b 951Eric (ewilhelm) Wilhelm
952
953Guillermo (groditi) Roditi
954
955Jess (castaway) Robinson
956
957Matt (mst) Trout
958
959Robert (phaylon) Sedlacek
960
961Robert (rlb3) Boone
962
963Scott (konobi) McWhirter
964
f44ae52f 965Shlomi (rindolf) Fish
966
9af1d28b 967Yuval (nothingmuch) Kogman
968
cbe25729 969Chris (perigrin) Prather
970
68b6146c 971Wallace (wreis) Reis
972
e46f5cc2 973Jonathan (jrockway) Rockway
974
3ccdc84a 975Piotr (dexter) Roszatycki
976
26fbace8 977Sam (mugwump) Vilain
f1917f58 978
ac211120 979Shawn (sartak) Moore
980
9af1d28b 981... and many other #moose folks
98aae381 982
fcd84ca9 983=head1 COPYRIGHT AND LICENSE
984
778db3ac 985Copyright 2006-2008 by Infinity Interactive, Inc.
fcd84ca9 986
987L<http://www.iinteractive.com>
988
989This library is free software; you can redistribute it and/or modify
26fbace8 990it under the same terms as Perl itself.
fcd84ca9 991
ddd0ec20 992=cut