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