12 use Scalar::Util 'blessed';
14 use Mouse::Util qw(load_class is_class_loaded get_code_package not_supported);
16 use Mouse::Meta::Module;
17 use Mouse::Meta::Class;
18 use Mouse::Meta::Role;
19 use Mouse::Meta::Attribute;
21 use Mouse::Util::TypeConstraints ();
23 our @ISA = qw(Exporter);
35 our %is_removable = map{ $_ => undef } @EXPORT;
36 delete $is_removable{blessed};
37 delete $is_removable{confess};
39 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
42 my $meta = Mouse::Meta::Class->initialize(scalar caller);
45 $meta->add_attribute($_ => @_) for ref($name) ? @{$name} : $name;
49 my $meta = Mouse::Meta::Class->initialize(scalar caller);
54 $meta->add_before_method_modifier($_ => $code);
59 my $meta = Mouse::Meta::Class->initialize(scalar caller);
64 $meta->add_after_method_modifier($_ => $code);
69 my $meta = Mouse::Meta::Class->initialize(scalar caller);
74 $meta->add_around_method_modifier($_ => $code);
79 Mouse::Util::apply_all_roles(scalar(caller), @_);
87 # This check avoids a recursion loop - see
88 # t/100_bugs/020_super_recursion.t
89 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
90 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
94 my $meta = Mouse::Meta::Class->initialize(caller);
95 my $pkg = $meta->name;
100 my $body = $pkg->can($name)
101 or confess "You cannot override '$name' because it has no super method";
103 $meta->add_method($name => sub {
104 local $SUPER_PACKAGE = $pkg;
105 local @SUPER_ARGS = @_;
106 local $SUPER_BODY = $body;
112 sub inner { not_supported }
113 sub augment{ not_supported }
119 my $class = $args{for_class}
120 or confess("Cannot call init_meta without specifying a for_class");
121 my $base_class = $args{base_class} || 'Mouse::Object';
122 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
124 confess("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
125 unless $metaclass->isa('Mouse::Meta::Class');
127 # make a subtype for each Mouse class
128 Mouse::Util::TypeConstraints::class_type($class)
129 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
131 my $meta = $metaclass->initialize($class);
133 $meta->add_method(meta => sub{
134 return $metaclass->initialize(ref($_[0]) || $_[0]);
137 $meta->superclasses($base_class)
138 unless $meta->superclasses;
150 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
156 my $level = delete $opts->{into_level};
157 $level = 0 unless defined $level;
158 my $caller = caller($level);
160 # we should never export to main
161 if ($caller eq 'main') {
162 warn qq{$class does not export its sugar to the 'main' package.\n};
167 for_class => $caller,
171 __PACKAGE__->export_to_level( $level+1, $class, @_);
173 # shortcut for the common case of no type character
175 for my $keyword (@EXPORT) {
176 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
189 for my $keyword (@EXPORT) {
191 if(exists $is_removable{$keyword}
192 && ($code = $caller->can($keyword))
193 && get_code_package($code) eq __PACKAGE__){
195 delete $stash->{$keyword};
206 Mouse - Moose minus the antlers
211 use Mouse; # automatically turns on strict and warnings
213 has 'x' => (is => 'rw', isa => 'Int');
214 has 'y' => (is => 'rw', isa => 'Int');
227 has 'z' => (is => 'rw', isa => 'Int');
229 after 'clear' => sub {
236 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
238 Unfortunately, Moose has a compile-time penalty. Though significant progress
239 has been made over the years, the compile time penalty is a non-starter for
240 some very specific applications. If you are writing a command-line application
241 or CGI script where startup time is essential, you may not be able to use
242 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
245 Mouse aims to alleviate this by providing a subset of Moose's functionality,
248 We're also going as light on dependencies as possible.
249 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
250 if you want support for L</before>, L</after>, and L</around>.
252 =head2 MOOSE COMPATIBILITY
254 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
255 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
256 over 96%. Even the error messages are taken from Moose. The Mouse code just
257 runs the test suite 4x faster.
259 The idea is that, if you need the extra power, you should be able to run
260 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
261 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
262 in which case it will act as Moose. Since Mouse is a little sloppier than
263 Moose, if you run into weird errors, it would be worth running:
265 ANY_MOOSE=Moose perl your-script.pl
267 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
272 Please don't copy MooseX code to MouseX. If you need extensions, you really
273 should upgrade to Moose. We don't need two parallel sets of extensions!
275 If you really must write a Mouse extension, please contact the Moose mailing
276 list or #moose on IRC beforehand.
280 The original author of this module has mostly stepped down from maintaining
281 Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
282 If you would like to help maintain this module, please get in touch with us.
286 =head2 C<< $object->meta -> Mouse::Meta::Class >>
288 Returns this class' metaclass instance.
290 =head2 C<< extends superclasses >>
292 Sets this class' superclasses.
294 =head2 C<< before (method|methods) => CodeRef >>
296 Installs a "before" method modifier. See L<Moose/before> or
297 L<Class::Method::Modifiers/before>.
299 Use of this feature requires L<Class::Method::Modifiers>!
301 =head2 C<< after (method|methods) => CodeRef >>
303 Installs an "after" method modifier. See L<Moose/after> or
304 L<Class::Method::Modifiers/after>.
306 Use of this feature requires L<Class::Method::Modifiers>!
308 =head2 C<< around (method|methods) => CodeRef >>
310 Installs an "around" method modifier. See L<Moose/around> or
311 L<Class::Method::Modifiers/around>.
313 Use of this feature requires L<Class::Method::Modifiers>!
315 =head2 C<< has (name|names) => parameters >>
317 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
322 =item C<< is => ro|rw|bare >>
324 If specified, inlines a read-only/read-write accessor with the same name as
327 =item C<< isa => TypeConstraint >>
329 Provides type checking in the constructor and accessor. The following types are
330 supported. Any unknown type is taken to be a class check
331 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
333 Any Item Bool Undef Defined Value Num Int Str ClassName
334 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
337 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
340 =item C<< required => Bool >>
342 Whether this attribute is required to have a value. If the attribute is lazy or
343 has a builder, then providing a value for the attribute in the constructor is
346 =item C<< init_arg => Str | Undef >>
348 Allows you to use a different key name in the constructor. If undef, the
349 attribute can't be passed to the constructor.
351 =item C<< default => Value | CodeRef >>
353 Sets the default value of the attribute. If the default is a coderef, it will
354 be invoked to get the default value. Due to quirks of Perl, any bare reference
355 is forbidden, you must wrap the reference in a coderef. Otherwise, all
356 instances will share the same reference.
358 =item C<< lazy => Bool >>
360 If specified, the default is calculated on demand instead of in the
363 =item C<< predicate => Str >>
365 Lets you specify a method name for installing a predicate method, which checks
366 that the attribute has a value. It will not invoke a lazy default or builder
369 =item C<< clearer => Str >>
371 Lets you specify a method name for installing a clearer method, which clears
372 the attribute's value from the instance. On the next read, lazy or builder will
375 =item C<< handles => HashRef|ArrayRef >>
377 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
378 given method names to method calls on the attribute. HashRef maps local method
379 names to remote method names called on the attribute. Other forms of
380 L</handles>, such as regular expression and coderef, are not yet supported.
382 =item C<< weak_ref => Bool >>
384 Lets you automatically weaken any reference stored in the attribute.
386 Use of this feature requires L<Scalar::Util>!
388 =item C<< trigger => CodeRef >>
390 Any time the attribute's value is set (either through the accessor or the constructor), the trigger is called on it. The trigger receives as arguments the instance, the new value, and the attribute instance.
392 =item C<< builder => Str >>
394 Defines a method name to be called to provide the default value of the
395 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
396 C<< default => sub { $_[0]->build_foo } >>.
398 =item C<< auto_deref => Bool >>
400 Allows you to automatically dereference ArrayRef and HashRef attributes in list
401 context. In scalar context, the reference is returned (NOT the list length or
402 bucket status). You must specify an appropriate type constraint to use
405 =item C<< lazy_build => Bool >>
407 Automatically define the following options:
412 builder => "_build_$attr",
413 clearer => "clear_$attr",
414 predicate => "has_$attr",
419 =head2 C<< confess(message) -> BOOM >>
421 L<Carp/confess> for your convenience.
423 =head2 C<< blessed(value) -> ClassName | undef >>
425 L<Scalar::Util/blessed> for your convenience.
431 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
432 You may use L</extends> to replace the superclass list.
436 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
437 keywords (such as L</extends>) it will break loudly instead breaking subtly.
439 =head1 SOURCE CODE ACCESS
441 We have a public git repository:
443 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
457 Shawn M Moore, E<lt>sartak at gmail.comE<gt>
459 Yuval Kogman, E<lt>nothingmuch at woobling.orgE<gt>
467 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
469 with plenty of code borrowed from L<Class::MOP> and L<Moose>
473 All complex software has bugs lurking in it, and this module is no exception.
474 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
475 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
477 =head1 COPYRIGHT AND LICENSE
479 Copyright 2008-2009 Infinity Interactive, Inc.
481 http://www.iinteractive.com/
483 This program is free software; you can redistribute it and/or modify it
484 under the same terms as Perl itself.