Commit | Line | Data |
fcd84ca9 |
1 | |
2 | package Moose; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
2d562421 |
7 | our $VERSION = '0.05'; |
fcd84ca9 |
8 | |
cc65ead0 |
9 | use Scalar::Util 'blessed', 'reftype'; |
fcd84ca9 |
10 | use Carp 'confess'; |
bc1e29b5 |
11 | use Sub::Name 'subname'; |
fcd84ca9 |
12 | |
7f18097c |
13 | use UNIVERSAL::require; |
2d562421 |
14 | use Sub::Exporter; |
7f18097c |
15 | |
ef1d5f4b |
16 | use Class::MOP; |
17 | |
c0e30cf5 |
18 | use Moose::Meta::Class; |
7415b2cb |
19 | use Moose::Meta::TypeConstraint; |
7c13858b |
20 | use Moose::Meta::TypeCoercion; |
78cd1d3b |
21 | use Moose::Meta::Attribute; |
ddd0ec20 |
22 | use Moose::Meta::Instance; |
c0e30cf5 |
23 | |
fcd84ca9 |
24 | use Moose::Object; |
7415b2cb |
25 | use Moose::Util::TypeConstraints; |
a15dff8d |
26 | |
a3c7e2fe |
27 | { |
be33e4f3 |
28 | my $CALLER; |
a3c7e2fe |
29 | |
be33e4f3 |
30 | sub _init_meta { |
a3c7e2fe |
31 | my $class = $CALLER; |
32 | |
a3c7e2fe |
33 | # make a subtype for each Moose class |
34 | subtype $class |
35 | => as 'Object' |
36 | => where { $_->isa($class) } |
37 | unless find_type_constraint($class); |
38 | |
39 | my $meta; |
40 | if ($class->can('meta')) { |
fcec2383 |
41 | # NOTE: |
42 | # this is the case where the metaclass pragma |
43 | # was used before the 'use Moose' statement to |
44 | # override a specific class |
a3c7e2fe |
45 | $meta = $class->meta(); |
46 | (blessed($meta) && $meta->isa('Moose::Meta::Class')) |
47 | || confess "Whoops, not møøsey enough"; |
48 | } |
49 | else { |
fcec2383 |
50 | # NOTE: |
51 | # this is broken currently, we actually need |
52 | # to allow the possiblity of an inherited |
53 | # meta, which will not be visible until the |
54 | # user 'extends' first. This needs to have |
55 | # more intelligence to it |
590868a3 |
56 | $meta = Moose::Meta::Class->initialize($class); |
a3c7e2fe |
57 | $meta->add_method('meta' => sub { |
58 | # re-initialize so it inherits properly |
fcb7afc2 |
59 | Moose::Meta::Class->initialize(blessed($_[0]) || $_[0]); |
a3c7e2fe |
60 | }) |
61 | } |
62 | |
63 | # make sure they inherit from Moose::Object |
64 | $meta->superclasses('Moose::Object') |
65 | unless $meta->superclasses(); |
a3c7e2fe |
66 | } |
67 | |
68 | my %exports = ( |
69 | extends => sub { |
be33e4f3 |
70 | my $class = $CALLER; |
3d544ed5 |
71 | return subname 'Moose::extends' => sub { |
a3c7e2fe |
72 | _load_all_classes(@_); |
be33e4f3 |
73 | my $meta = $class->meta; |
74 | foreach my $super (@_) { |
75 | # don't bother if it does not have a meta. |
76 | next unless $super->can('meta'); |
77 | # if it's meta is a vanilla Moose, |
78 | # then we can safely ignore it. |
79 | next if blessed($super->meta) eq 'Moose::Meta::Class'; |
80 | # but if we have anything else, |
81 | # we need to check it out ... |
82 | unless (# see if of our metaclass is incompatible |
687e52bb |
83 | ($meta->isa(blessed($super->meta)) && |
84 | # and see if our instance metaclass is incompatible |
85 | $meta->instance_metaclass->isa($super->meta->instance_metaclass)) && |
be33e4f3 |
86 | # ... and if we are just a vanilla Moose |
87 | $meta->isa('Moose::Meta::Class')) { |
88 | # re-initialize the meta ... |
89 | my $super_meta = $super->meta; |
687e52bb |
90 | # NOTE: |
91 | # We might want to consider actually |
92 | # transfering any attributes from the |
93 | # original meta into this one, but in |
94 | # general you should not have any there |
95 | # at this point anyway, so it's very |
96 | # much an obscure edge case anyway |
be33e4f3 |
97 | $meta = $super_meta->reinitialize($class => ( |
98 | ':attribute_metaclass' => $super_meta->attribute_metaclass, |
99 | ':method_metaclass' => $super_meta->method_metaclass, |
100 | ':instance_metaclass' => $super_meta->instance_metaclass, |
101 | )); |
102 | } |
103 | } |
104 | $meta->superclasses(@_); |
a3c7e2fe |
105 | }; |
106 | }, |
107 | with => sub { |
be33e4f3 |
108 | my $class = $CALLER; |
3d544ed5 |
109 | return subname 'Moose::with' => sub { |
a3c7e2fe |
110 | my ($role) = @_; |
111 | _load_all_classes($role); |
687e52bb |
112 | ($role->can('meta') && $role->meta->isa('Moose::Meta::Role')) |
113 | || confess "You can only consume roles, $role is not a Moose role"; |
be33e4f3 |
114 | $role->meta->apply($class->meta); |
a3c7e2fe |
115 | }; |
116 | }, |
117 | has => sub { |
be33e4f3 |
118 | my $class = $CALLER; |
3d544ed5 |
119 | return subname 'Moose::has' => sub { |
452bac1b |
120 | my ($name, %options) = @_; |
be33e4f3 |
121 | my $meta = $class->meta; |
2d2b92e5 |
122 | if ($name =~ /^\+(.*)/) { |
1d768fb1 |
123 | my $inherited_attr = $meta->find_attribute_by_name($1); |
124 | (defined $inherited_attr) |
125 | || confess "Could not find an attribute by the name of '$1' to inherit from"; |
ce0e8d63 |
126 | my $new_attr = $inherited_attr->clone_and_inherit_options(%options); |
1d768fb1 |
127 | $meta->add_attribute($new_attr); |
b0ea39ef |
128 | } |
129 | else { |
2d2b92e5 |
130 | if ($options{metaclass}) { |
131 | _load_all_classes($options{metaclass}); |
132 | $meta->add_attribute($options{metaclass}->new($name, %options)); |
133 | } |
134 | else { |
135 | $meta->add_attribute($name, %options); |
136 | } |
b0ea39ef |
137 | } |
a3c7e2fe |
138 | }; |
139 | }, |
140 | before => sub { |
be33e4f3 |
141 | my $class = $CALLER; |
3d544ed5 |
142 | return subname 'Moose::before' => sub { |
a3c7e2fe |
143 | my $code = pop @_; |
be33e4f3 |
144 | my $meta = $class->meta; |
a3c7e2fe |
145 | $meta->add_before_method_modifier($_, $code) for @_; |
146 | }; |
147 | }, |
148 | after => sub { |
be33e4f3 |
149 | my $class = $CALLER; |
3d544ed5 |
150 | return subname 'Moose::after' => sub { |
a3c7e2fe |
151 | my $code = pop @_; |
be33e4f3 |
152 | my $meta = $class->meta; |
a3c7e2fe |
153 | $meta->add_after_method_modifier($_, $code) for @_; |
154 | }; |
155 | }, |
156 | around => sub { |
be33e4f3 |
157 | my $class = $CALLER; |
3d544ed5 |
158 | return subname 'Moose::around' => sub { |
a3c7e2fe |
159 | my $code = pop @_; |
be33e4f3 |
160 | my $meta = $class->meta; |
a3c7e2fe |
161 | $meta->add_around_method_modifier($_, $code) for @_; |
162 | }; |
163 | }, |
164 | super => sub { |
3d544ed5 |
165 | return subname 'Moose::super' => sub {}; |
a3c7e2fe |
166 | }, |
167 | override => sub { |
be33e4f3 |
168 | my $class = $CALLER; |
3d544ed5 |
169 | return subname 'Moose::override' => sub { |
a3c7e2fe |
170 | my ($name, $method) = @_; |
be33e4f3 |
171 | $class->meta->add_override_method_modifier($name => $method); |
a3c7e2fe |
172 | }; |
173 | }, |
174 | inner => sub { |
3d544ed5 |
175 | return subname 'Moose::inner' => sub {}; |
a3c7e2fe |
176 | }, |
177 | augment => sub { |
be33e4f3 |
178 | my $class = $CALLER; |
3d544ed5 |
179 | return subname 'Moose::augment' => sub { |
a3c7e2fe |
180 | my ($name, $method) = @_; |
be33e4f3 |
181 | $class->meta->add_augment_method_modifier($name => $method); |
a3c7e2fe |
182 | }; |
183 | }, |
184 | confess => sub { |
185 | return \&Carp::confess; |
186 | }, |
187 | blessed => sub { |
188 | return \&Scalar::Util::blessed; |
54b1cdf0 |
189 | }, |
190 | all_methods => sub { |
452bac1b |
191 | subname 'Moose::all_methods' => sub () { qr/.*/ } |
a3c7e2fe |
192 | } |
193 | ); |
3d544ed5 |
194 | |
a3c7e2fe |
195 | my $exporter = Sub::Exporter::build_exporter({ |
196 | exports => \%exports, |
197 | groups => { |
198 | default => [':all'] |
199 | } |
200 | }); |
201 | |
fcb7afc2 |
202 | sub import { |
a3c7e2fe |
203 | $CALLER = caller(); |
204 | |
205 | # we should never export to main |
206 | return if $CALLER eq 'main'; |
be33e4f3 |
207 | |
208 | _init_meta(); |
9eacbf7c |
209 | |
a3c7e2fe |
210 | goto $exporter; |
fcb7afc2 |
211 | } |
fcd84ca9 |
212 | } |
213 | |
e9bb8a31 |
214 | ## Utility functions |
215 | |
78cd1d3b |
216 | sub _load_all_classes { |
e9bb8a31 |
217 | foreach my $super (@_) { |
218 | # see if this is already |
219 | # loaded in the symbol table |
220 | next if _is_class_already_loaded($super); |
221 | # otherwise require it ... |
222 | ($super->require) |
223 | || confess "Could not load superclass '$super' because : " . $UNIVERSAL::require::ERROR; |
224 | } |
225 | } |
226 | |
d7f17ebb |
227 | sub _is_class_already_loaded { |
228 | my $name = shift; |
229 | no strict 'refs'; |
230 | return 1 if defined ${"${name}::VERSION"} || defined @{"${name}::ISA"}; |
231 | foreach (keys %{"${name}::"}) { |
232 | next if substr($_, -2, 2) eq '::'; |
233 | return 1 if defined &{"${name}::$_"}; |
234 | } |
235 | return 0; |
236 | } |
237 | |
fcd84ca9 |
238 | 1; |
239 | |
240 | __END__ |
241 | |
242 | =pod |
243 | |
244 | =head1 NAME |
245 | |
e522431d |
246 | Moose - Moose, it's the new Camel |
fcd84ca9 |
247 | |
248 | =head1 SYNOPSIS |
e522431d |
249 | |
250 | package Point; |
251 | use Moose; |
252 | |
182134e8 |
253 | has 'x' => (isa => 'Int', is => 'rw'); |
254 | has 'y' => (isa => 'Int', is => 'rw'); |
e522431d |
255 | |
256 | sub clear { |
257 | my $self = shift; |
258 | $self->x(0); |
259 | $self->y(0); |
260 | } |
261 | |
262 | package Point3D; |
263 | use Moose; |
264 | |
265 | extends 'Point'; |
09fdc1dc |
266 | |
182134e8 |
267 | has 'z' => (isa => 'Int'); |
e522431d |
268 | |
269 | after 'clear' => sub { |
270 | my $self = shift; |
271 | $self->{z} = 0; |
272 | }; |
273 | |
274 | =head1 CAVEAT |
275 | |
79592a54 |
276 | This is an early release of this module, it still needs |
e522431d |
277 | some fine tuning and B<lots> more documentation. I am adopting |
278 | the I<release early and release often> approach with this module, |
279 | so keep an eye on your favorite CPAN mirror! |
280 | |
fcd84ca9 |
281 | =head1 DESCRIPTION |
282 | |
e522431d |
283 | Moose is an extension of the Perl 5 object system. |
284 | |
285 | =head2 Another object system!?!? |
fcd84ca9 |
286 | |
e522431d |
287 | Yes, I know there has been an explosion recently of new ways to |
288 | build object's in Perl 5, most of them based on inside-out objects, |
289 | and other such things. Moose is different because it is not a new |
290 | object system for Perl 5, but instead an extension of the existing |
291 | object system. |
3c7278fb |
292 | |
e522431d |
293 | Moose is built on top of L<Class::MOP>, which is a metaclass system |
294 | for Perl 5. This means that Moose not only makes building normal |
505c6fac |
295 | Perl 5 objects better, but it also provides the power of metaclass |
296 | programming. |
e522431d |
297 | |
298 | =head2 What does Moose stand for?? |
299 | |
300 | Moose doesn't stand for one thing in particular, however, if you |
301 | want, here are a few of my favorites, feel free to contribute |
302 | more :) |
303 | |
304 | =over 4 |
305 | |
5569c072 |
306 | =item Make Other Object Systems Envious |
e522431d |
307 | |
308 | =item Makes Object Orientation So Easy |
309 | |
5569c072 |
310 | =item Makes Object Orientation Spiffy- Er (sorry ingy) |
505c6fac |
311 | |
5569c072 |
312 | =item Most Other Object Systems Emasculate |
505c6fac |
313 | |
314 | =item My Overcraft Overfilled (with) Some Eels |
315 | |
316 | =item Moose Often Ovulate Sorta Early |
317 | |
505c6fac |
318 | =item Many Overloaded Object Systems Exists |
319 | |
320 | =item Moose Offers Often Super Extensions |
321 | |
446e850f |
322 | =item Meta Object Orientation Syntax Extensions |
323 | |
e522431d |
324 | =back |
3c7278fb |
325 | |
6ba6d68c |
326 | =head1 BUILDING CLASSES WITH MOOSE |
327 | |
328 | Moose makes every attempt to provide as much convience during class |
329 | construction/definition, but still stay out of your way if you want |
330 | it to. Here are some of the features Moose provides: |
331 | |
332 | Unless specified with C<extends>, any class which uses Moose will |
333 | inherit from L<Moose::Object>. |
334 | |
335 | Moose will also manage all attributes (including inherited ones) that |
336 | are defined with C<has>. And assuming that you call C<new> which is |
337 | inherited from L<Moose::Object>, then this includes properly initializing |
338 | all instance slots, setting defaults where approprtiate and performing any |
339 | type constraint checking or coercion. |
340 | |
79592a54 |
341 | For more details, see the ever expanding L<Moose::Cookbook>. |
342 | |
6ba6d68c |
343 | =head1 EXPORTED FUNCTIONS |
344 | |
345 | Moose will export a number of functions into the class's namespace, which |
346 | can then be used to set up the class. These functions all work directly |
347 | on the current class. |
348 | |
349 | =over 4 |
350 | |
351 | =item B<meta> |
352 | |
353 | This is a method which provides access to the current class's metaclass. |
354 | |
355 | =item B<extends (@superclasses)> |
356 | |
357 | This function will set the superclass(es) for the current class. |
358 | |
359 | This approach is recommended instead of C<use base>, because C<use base> |
360 | actually C<push>es onto the class's C<@ISA>, whereas C<extends> will |
361 | replace it. This is important to ensure that classes which do not have |
362 | superclasses properly inherit from L<Moose::Object>. |
363 | |
e9ec68d6 |
364 | =item B<with ($role)> |
365 | |
76d37e5a |
366 | This will apply a given C<$role> to the local class. Role support is |
367 | currently very experimental, see L<Moose::Role> for more details. |
e9ec68d6 |
368 | |
6ba6d68c |
369 | =item B<has ($name, %options)> |
370 | |
371 | This will install an attribute of a given C<$name> into the current class. |
372 | The list of C<%options> are the same as those provided by both |
373 | L<Class::MOP::Attribute> and L<Moose::Meta::Attribute>, in addition to a |
374 | few convience ones provided by Moose which are listed below: |
375 | |
376 | =over 4 |
377 | |
076c81ed |
378 | =item I<is =E<gt> 'rw'|'ro'> |
6ba6d68c |
379 | |
380 | The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read |
381 | only). These will create either a read/write accessor or a read-only |
382 | accessor respectively, using the same name as the C<$name> of the attribute. |
383 | |
384 | If you need more control over how your accessors are named, you can use the |
385 | I<reader>, I<writer> and I<accessor> options inherited from L<Moose::Meta::Attribute>. |
386 | |
076c81ed |
387 | =item I<isa =E<gt> $type_name> |
6ba6d68c |
388 | |
389 | The I<isa> option uses Moose's type constraint facilities to set up runtime |
390 | type checking for this attribute. Moose will perform the checks during class |
391 | construction, and within any accessors. The C<$type_name> argument must be a |
392 | string. The string can be either a class name, or a type defined using |
393 | Moose's type defintion features. |
394 | |
daea75c9 |
395 | =item I<coerce =E<gt> (1|0)> |
396 | |
397 | This will attempt to use coercion with the supplied type constraint to change |
398 | the value passed into any accessors of constructors. You B<must> have supplied |
399 | a type constraint in order for this to work. See L<Moose::Cookbook::Recipe5> |
400 | for an example usage. |
401 | |
402 | =item I<does =E<gt> $role_name> |
403 | |
404 | This will accept the name of a role which the value stored in this attribute |
405 | is expected to have consumed. |
406 | |
407 | =item I<required =E<gt> (1|0)> |
408 | |
409 | This marks the attribute as being required. This means a value must be supplied |
410 | during class construction, and the attribute can never be set to C<undef> with |
411 | an accessor. |
412 | |
413 | =item I<weak_ref =E<gt> (1|0)> |
414 | |
415 | This will tell the class to strore the value of this attribute as a weakened |
416 | reference. If an attribute is a weakened reference, it can B<not> also be coerced. |
417 | |
418 | =item I<lazy =E<gt> (1|0)> |
419 | |
420 | This will tell the class to not create this slot until absolutely nessecary. |
421 | If an attribute is marked as lazy it B<must> have a default supplied. |
422 | |
423 | =item I<trigger =E<gt> $code> |
424 | |
425 | The trigger option is a CODE reference which will be called after the value of |
426 | the attribute is set. The CODE ref will be passed the instance itself, the |
427 | updated value and the attribute meta-object (this is for more advanced fiddling |
cce8198b |
428 | and can typically be ignored in most cases). You can B<not> have a trigger on |
429 | a read-only attribute. |
daea75c9 |
430 | |
6ba6d68c |
431 | =back |
432 | |
076c81ed |
433 | =item B<before $name|@names =E<gt> sub { ... }> |
6ba6d68c |
434 | |
076c81ed |
435 | =item B<after $name|@names =E<gt> sub { ... }> |
6ba6d68c |
436 | |
076c81ed |
437 | =item B<around $name|@names =E<gt> sub { ... }> |
6ba6d68c |
438 | |
439 | This three items are syntactic sugar for the before, after and around method |
440 | modifier features that L<Class::MOP> provides. More information on these can |
441 | be found in the L<Class::MOP> documentation for now. |
442 | |
159da176 |
443 | =item B<super> |
444 | |
445 | The keyword C<super> is a noop when called outside of an C<override> method. In |
446 | the context of an C<override> method, it will call the next most appropriate |
447 | superclass method with the same arguments as the original method. |
448 | |
449 | =item B<override ($name, &sub)> |
450 | |
451 | An C<override> method, is a way of explictly saying "I am overriding this |
452 | method from my superclass". You can call C<super> within this method, and |
453 | it will work as expected. The same thing I<can> be accomplished with a normal |
454 | method call and the C<SUPER::> pseudo-package, it is really your choice. |
455 | |
456 | =item B<inner> |
457 | |
458 | The keyword C<inner>, much like C<super>, is a no-op outside of the context of |
459 | an C<augment> method. You can think of C<inner> as being the inverse of |
460 | C<super>, the details of how C<inner> and C<augment> work is best described in |
461 | the L<Moose::Cookbook>. |
462 | |
463 | =item B<augment ($name, &sub)> |
464 | |
465 | An C<augment> method, is a way of explictly saying "I am augmenting this |
466 | method from my superclass". Once again, the details of how C<inner> and |
467 | C<augment> work is best described in the L<Moose::Cookbook>. |
468 | |
6ba6d68c |
469 | =item B<confess> |
470 | |
471 | This is the C<Carp::confess> function, and exported here beause I use it |
472 | all the time. This feature may change in the future, so you have been warned. |
473 | |
474 | =item B<blessed> |
475 | |
476 | This is the C<Scalar::Uti::blessed> function, it is exported here beause I |
477 | use it all the time. It is highly recommended that this is used instead of |
478 | C<ref> anywhere you need to test for an object's class name. |
479 | |
480 | =back |
481 | |
05d9eaf6 |
482 | =head1 CAVEATS |
483 | |
484 | =over 4 |
485 | |
486 | =item * |
487 | |
488 | It should be noted that C<super> and C<inner> can B<not> be used in the same |
489 | method. However, they can be combined together with the same class hierarchy, |
490 | see F<t/014_override_augment_inner_super.t> for an example. |
491 | |
492 | The reason that this is so is because C<super> is only valid within a method |
493 | with the C<override> modifier, and C<inner> will never be valid within an |
494 | C<override> method. In fact, C<augment> will skip over any C<override> methods |
495 | when searching for it's appropriate C<inner>. |
496 | |
497 | This might seem like a restriction, but I am of the opinion that keeping these |
498 | two features seperate (but interoperable) actually makes them easy to use since |
499 | their behavior is then easier to predict. Time will tell if I am right or not. |
500 | |
501 | =back |
502 | |
5569c072 |
503 | =head1 ACKNOWLEDGEMENTS |
504 | |
505 | =over 4 |
506 | |
54c189df |
507 | =item I blame Sam Vilain for introducing me to the insanity that is meta-models. |
5569c072 |
508 | |
54c189df |
509 | =item I blame Audrey Tang for then encouraging my meta-model habit in #perl6. |
5569c072 |
510 | |
076c81ed |
511 | =item Without Yuval "nothingmuch" Kogman this module would not be possible, |
54c189df |
512 | and it certainly wouldn't have this name ;P |
5569c072 |
513 | |
514 | =item The basis of the TypeContraints module was Rob Kinyon's idea |
515 | originally, I just ran with it. |
516 | |
076c81ed |
517 | =item Thanks to mst & chansen and the whole #moose poose for all the |
d46a48f3 |
518 | ideas/feature-requests/encouragement |
519 | |
5569c072 |
520 | =back |
521 | |
e90c03d0 |
522 | =head1 SEE ALSO |
523 | |
524 | =over 4 |
525 | |
6ba6d68c |
526 | =item L<Class::MOP> documentation |
527 | |
528 | =item The #moose channel on irc.perl.org |
529 | |
e90c03d0 |
530 | =item L<http://forum2.org/moose/> |
531 | |
159da176 |
532 | =item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf> |
533 | |
534 | This paper (suggested by lbr on #moose) was what lead to the implementation |
535 | of the C<super>/C<overrride> and C<inner>/C<augment> features. If you really |
536 | want to understand this feature, I suggest you read this. |
537 | |
e90c03d0 |
538 | =back |
539 | |
fcd84ca9 |
540 | =head1 BUGS |
541 | |
542 | All complex software has bugs lurking in it, and this module is no |
543 | exception. If you find a bug please either email me, or add the bug |
544 | to cpan-RT. |
545 | |
fcd84ca9 |
546 | =head1 AUTHOR |
547 | |
548 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
549 | |
550 | =head1 COPYRIGHT AND LICENSE |
551 | |
552 | Copyright 2006 by Infinity Interactive, Inc. |
553 | |
554 | L<http://www.iinteractive.com> |
555 | |
556 | This library is free software; you can redistribute it and/or modify |
557 | it under the same terms as Perl itself. |
558 | |
ddd0ec20 |
559 | =cut |