4 use Mouse::Exporter; # enables strict and warnings
6 our $VERSION = '0.37_06';
9 use Scalar::Util qw(blessed);
11 use Mouse::Util qw(load_class is_class_loaded get_code_package not_supported);
13 use Mouse::Meta::Module;
14 use Mouse::Meta::Class;
15 use Mouse::Meta::Role;
16 use Mouse::Meta::Attribute;
18 use Mouse::Util::TypeConstraints ();
20 Mouse::Exporter->setup_import_methods(
28 \&Scalar::Util::blessed,
33 # XXX: for backward compatibility
43 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
46 my $meta = Mouse::Meta::Class->initialize(scalar caller);
49 $meta->throw_error(q{Usage: has 'name' => ( key => value, ... )})
\r
50 if @_ % 2; # odd number of arguments
52 $meta->add_attribute($_ => @_) for ref($name) ? @{$name} : $name;
56 my $meta = Mouse::Meta::Class->initialize(scalar caller);
61 $meta->add_before_method_modifier($_ => $code);
66 my $meta = Mouse::Meta::Class->initialize(scalar caller);
71 $meta->add_after_method_modifier($_ => $code);
76 my $meta = Mouse::Meta::Class->initialize(scalar caller);
81 $meta->add_around_method_modifier($_ => $code);
86 Mouse::Util::apply_all_roles(scalar(caller), @_);
94 # This check avoids a recursion loop - see
95 # t/100_bugs/020_super_recursion.t
96 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
97 return if !defined $SUPER_BODY;
98 $SUPER_BODY->(@SUPER_ARGS);
102 # my($name, $method) = @_;
103 Mouse::Meta::Class->initialize(scalar caller)->add_override_method_modifier(@_);
111 if ( my $body = $INNER_BODY{$pkg} ) {
112 my $args = $INNER_ARGS{$pkg};
113 local $INNER_ARGS{$pkg};
114 local $INNER_BODY{$pkg};
115 return $body->(@{$args});
123 #my($name, $method) = @_;
124 Mouse::Meta::Class->initialize(scalar caller)->add_augment_method_modifier(@_);
131 my $class = $args{for_class}
132 or confess("Cannot call init_meta without specifying a for_class");
134 my $base_class = $args{base_class} || 'Mouse::Object';
135 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
137 my $meta = $metaclass->initialize($class);
139 $meta->add_method(meta => sub{
140 return $metaclass->initialize(ref($_[0]) || $_[0]);
143 $meta->superclasses($base_class)
144 unless $meta->superclasses;
146 # make a class type for each Mouse class
147 Mouse::Util::TypeConstraints::class_type($class)
148 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
159 Mouse - Moose minus the antlers
163 This document describes Mouse version 0.37_06
168 use Mouse; # automatically turns on strict and warnings
170 has 'x' => (is => 'rw', isa => 'Int');
171 has 'y' => (is => 'rw', isa => 'Int');
184 has 'z' => (is => 'rw', isa => 'Int');
186 after 'clear' => sub {
193 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
195 Unfortunately, Moose has a compile-time penalty. Though significant progress
196 has been made over the years, the compile time penalty is a non-starter for
197 some very specific applications. If you are writing a command-line application
198 or CGI script where startup time is essential, you may not be able to use
199 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
202 Mouse aims to alleviate this by providing a subset of Moose's functionality,
205 We're also going as light on dependencies as possible.
206 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
207 if you want support for L</before>, L</after>, and L</around>.
209 =head2 MOOSE COMPATIBILITY
211 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
212 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
213 over 96%. Even the error messages are taken from Moose. The Mouse code just
214 runs the test suite 4x faster.
216 The idea is that, if you need the extra power, you should be able to run
217 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
218 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
219 in which case it will act as Moose. Since Mouse is a little sloppier than
220 Moose, if you run into weird errors, it would be worth running:
222 ANY_MOOSE=Moose perl your-script.pl
224 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
229 Please don't copy MooseX code to MouseX. If you need extensions, you really
230 should upgrade to Moose. We don't need two parallel sets of extensions!
232 If you really must write a Mouse extension, please contact the Moose mailing
233 list or #moose on IRC beforehand.
237 =head2 C<< $object->meta -> Mouse::Meta::Class >>
239 Returns this class' metaclass instance.
241 =head2 C<< extends superclasses >>
243 Sets this class' superclasses.
245 =head2 C<< before (method|methods) => CodeRef >>
247 Installs a "before" method modifier. See L<Moose/before> or
248 L<Class::Method::Modifiers/before>.
250 Use of this feature requires L<Class::Method::Modifiers>!
252 =head2 C<< after (method|methods) => CodeRef >>
254 Installs an "after" method modifier. See L<Moose/after> or
255 L<Class::Method::Modifiers/after>.
257 Use of this feature requires L<Class::Method::Modifiers>!
259 =head2 C<< around (method|methods) => CodeRef >>
261 Installs an "around" method modifier. See L<Moose/around> or
262 L<Class::Method::Modifiers/around>.
264 Use of this feature requires L<Class::Method::Modifiers>!
266 =head2 C<< has (name|names) => parameters >>
268 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
273 =item C<< is => ro|rw|bare >>
275 If specified, inlines a read-only/read-write accessor with the same name as
278 =item C<< isa => TypeConstraint >>
280 Provides type checking in the constructor and accessor. The following types are
281 supported. Any unknown type is taken to be a class check
282 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
284 Any Item Bool Undef Defined Value Num Int Str ClassName
285 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
288 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
291 =item C<< required => Bool >>
293 Whether this attribute is required to have a value. If the attribute is lazy or
294 has a builder, then providing a value for the attribute in the constructor is
297 =item C<< init_arg => Str | Undef >>
299 Allows you to use a different key name in the constructor. If undef, the
300 attribute can't be passed to the constructor.
302 =item C<< default => Value | CodeRef >>
304 Sets the default value of the attribute. If the default is a coderef, it will
305 be invoked to get the default value. Due to quirks of Perl, any bare reference
306 is forbidden, you must wrap the reference in a coderef. Otherwise, all
307 instances will share the same reference.
309 =item C<< lazy => Bool >>
311 If specified, the default is calculated on demand instead of in the
314 =item C<< predicate => Str >>
316 Lets you specify a method name for installing a predicate method, which checks
317 that the attribute has a value. It will not invoke a lazy default or builder
320 =item C<< clearer => Str >>
322 Lets you specify a method name for installing a clearer method, which clears
323 the attribute's value from the instance. On the next read, lazy or builder will
326 =item C<< handles => HashRef|ArrayRef >>
328 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
329 given method names to method calls on the attribute. HashRef maps local method
330 names to remote method names called on the attribute. Other forms of
331 L</handles>, such as regular expression and coderef, are not yet supported.
333 =item C<< weak_ref => Bool >>
335 Lets you automatically weaken any reference stored in the attribute.
337 Use of this feature requires L<Scalar::Util>!
339 =item C<< trigger => CodeRef >>
341 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.
343 =item C<< builder => Str >>
345 Defines a method name to be called to provide the default value of the
346 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
347 C<< default => sub { $_[0]->build_foo } >>.
349 =item C<< auto_deref => Bool >>
351 Allows you to automatically dereference ArrayRef and HashRef attributes in list
352 context. In scalar context, the reference is returned (NOT the list length or
353 bucket status). You must specify an appropriate type constraint to use
356 =item C<< lazy_build => Bool >>
358 Automatically define the following options:
363 builder => "_build_$attr",
364 clearer => "clear_$attr",
365 predicate => "has_$attr",
370 =head2 C<< confess(message) -> BOOM >>
372 L<Carp/confess> for your convenience.
374 =head2 C<< blessed(value) -> ClassName | undef >>
376 L<Scalar::Util/blessed> for your convenience.
382 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
383 You may use L</extends> to replace the superclass list.
387 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
388 keywords (such as L</extends>) it will break loudly instead breaking subtly.
390 =head1 SOURCE CODE ACCESS
392 We have a public git repository:
394 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
408 Shawn M Moore, E<lt>sartak at gmail.comE<gt>
410 Yuval Kogman, E<lt>nothingmuch at woobling.orgE<gt>
418 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
420 with plenty of code borrowed from L<Class::MOP> and L<Moose>
424 All complex software has bugs lurking in it, and this module is no exception.
425 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
426 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
428 =head1 COPYRIGHT AND LICENSE
430 Copyright 2008-2009 Infinity Interactive, Inc.
432 http://www.iinteractive.com/
434 This program is free software; you can redistribute it and/or modify it
435 under the same terms as Perl itself.