10 use Scalar::Util 'blessed';
12 use Mouse::Util qw(load_class is_class_loaded not_supported);
14 use Mouse::Meta::Module;
15 use Mouse::Meta::Class;
16 use Mouse::Meta::Role;
17 use Mouse::Meta::Attribute;
19 use Mouse::Util::TypeConstraints ();
31 our %is_removable = map{ $_ => undef } @EXPORT;
32 delete $is_removable{blessed};
33 delete $is_removable{confess};
35 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
38 my $meta = Mouse::Meta::Class->initialize(scalar caller);
39 $meta->add_attribute(@_);
43 my $meta = Mouse::Meta::Class->initialize(scalar caller);
48 $meta->add_before_method_modifier($_ => $code);
53 my $meta = Mouse::Meta::Class->initialize(scalar caller);
58 $meta->add_after_method_modifier($_ => $code);
63 my $meta = Mouse::Meta::Class->initialize(scalar caller);
68 $meta->add_around_method_modifier($_ => $code);
73 Mouse::Util::apply_all_roles(scalar(caller), @_);
81 # This check avoids a recursion loop - see
82 # t/100_bugs/020_super_recursion.t
83 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
84 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
88 my $meta = Mouse::Meta::Class->initialize(caller);
89 my $pkg = $meta->name;
94 my $body = $pkg->can($name)
95 or confess "You cannot override '$name' because it has no super method";
97 $meta->add_method($name => sub {
98 local $SUPER_PACKAGE = $pkg;
99 local @SUPER_ARGS = @_;
100 local $SUPER_BODY = $body;
106 sub inner { not_supported }
107 sub augment{ not_supported }
113 my $class = $args{for_class}
114 or confess("Cannot call init_meta without specifying a for_class");
115 my $base_class = $args{base_class} || 'Mouse::Object';
116 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
118 confess("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
119 unless $metaclass->isa('Mouse::Meta::Class');
121 # make a subtype for each Mouse class
122 Mouse::Util::TypeConstraints::class_type($class)
123 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
125 my $meta = $metaclass->initialize($class);
127 $meta->add_method(meta => sub{
128 return $metaclass->initialize(ref($_[0]) || $_[0]);
131 $meta->superclasses($base_class)
132 unless $meta->superclasses;
144 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
150 my $level = delete $opts->{into_level};
151 $level = 0 unless defined $level;
152 my $caller = caller($level);
154 # we should never export to main
155 if ($caller eq 'main') {
156 warn qq{$class does not export its sugar to the 'main' package.\n};
161 for_class => $caller,
165 __PACKAGE__->export_to_level( $level+1, $class, @_);
167 # shortcut for the common case of no type character
169 for my $keyword (@EXPORT) {
170 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
183 for my $keyword (@EXPORT) {
185 if(exists $is_removable{$keyword}
186 && ($code = $caller->can($keyword))
187 && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
189 delete $stash->{$keyword};
200 Mouse - Moose minus the antlers
205 use Mouse; # automatically turns on strict and warnings
207 has 'x' => (is => 'rw', isa => 'Int');
208 has 'y' => (is => 'rw', isa => 'Int');
221 has 'z' => (is => 'rw', isa => 'Int');
223 after 'clear' => sub {
230 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
232 Unfortunately, Moose has a compile-time penalty. Though significant progress
233 has been made over the years, the compile time penalty is a non-starter for
234 some very specific applications. If you are writing a command-line application
235 or CGI script where startup time is essential, you may not be able to use
236 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
239 Mouse aims to alleviate this by providing a subset of Moose's functionality,
242 We're also going as light on dependencies as possible.
243 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
244 if you want support for L</before>, L</after>, and L</around>.
248 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
249 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
250 over 96%. Even the error messages are taken from Moose. The Mouse code just
251 runs the test suite 4x faster.
253 The idea is that, if you need the extra power, you should be able to run
254 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
255 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
256 in which case it will act as Moose. Since Mouse is a little sloppier than
257 Moose, if you run into weird errors, it would be worth running:
259 ANY_MOOSE=Moose perl your-script.pl
261 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
266 Please don't copy MooseX code to MouseX. If you need extensions, you really
267 should upgrade to Moose. We don't need two parallel sets of extensions!
269 If you really must write a Mouse extension, please contact the Moose mailing
270 list or #moose on IRC beforehand.
274 The original author of this module has mostly stepped down from maintaining
275 Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
276 If you would like to help maintain this module, please get in touch with us.
280 =head2 meta -> Mouse::Meta::Class
282 Returns this class' metaclass instance.
284 =head2 extends superclasses
286 Sets this class' superclasses.
288 =head2 before (method|methods) => Code
290 Installs a "before" method modifier. See L<Moose/before> or
291 L<Class::Method::Modifiers/before>.
293 Use of this feature requires L<Class::Method::Modifiers>!
295 =head2 after (method|methods) => Code
297 Installs an "after" method modifier. See L<Moose/after> or
298 L<Class::Method::Modifiers/after>.
300 Use of this feature requires L<Class::Method::Modifiers>!
302 =head2 around (method|methods) => Code
304 Installs an "around" method modifier. See L<Moose/around> or
305 L<Class::Method::Modifiers/around>.
307 Use of this feature requires L<Class::Method::Modifiers>!
309 =head2 has (name|names) => parameters
311 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
318 If specified, inlines a read-only/read-write accessor with the same name as
321 =item isa => TypeConstraint
323 Provides type checking in the constructor and accessor. The following types are
324 supported. Any unknown type is taken to be a class check (e.g. isa =>
325 'DateTime' would accept only L<DateTime> objects).
327 Any Item Bool Undef Defined Value Num Int Str ClassName
328 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
331 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
334 =item required => 0|1
336 Whether this attribute is required to have a value. If the attribute is lazy or
337 has a builder, then providing a value for the attribute in the constructor is
340 =item init_arg => Str | Undef
342 Allows you to use a different key name in the constructor. If undef, the
343 attribue can't be passed to the constructor.
345 =item default => Value | CodeRef
347 Sets the default value of the attribute. If the default is a coderef, it will
348 be invoked to get the default value. Due to quirks of Perl, any bare reference
349 is forbidden, you must wrap the reference in a coderef. Otherwise, all
350 instances will share the same reference.
354 If specified, the default is calculated on demand instead of in the
357 =item predicate => Str
359 Lets you specify a method name for installing a predicate method, which checks
360 that the attribute has a value. It will not invoke a lazy default or builder
365 Lets you specify a method name for installing a clearer method, which clears
366 the attribute's value from the instance. On the next read, lazy or builder will
369 =item handles => HashRef|ArrayRef
371 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
372 given method names to method calls on the attribute. HashRef maps local method
373 names to remote method names called on the attribute. Other forms of
374 L</handles>, such as regular expression and coderef, are not yet supported.
376 =item weak_ref => 0|1
378 Lets you automatically weaken any reference stored in the attribute.
380 Use of this feature requires L<Scalar::Util>!
382 =item trigger => CodeRef
384 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.
386 Mouse 0.05 supported more complex triggers, but this behavior is now removed.
390 Defines a method name to be called to provide the default value of the
391 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
392 C<< default => sub { $_[0]->build_foo } >>.
394 =item auto_deref => 0|1
396 Allows you to automatically dereference ArrayRef and HashRef attributes in list
397 context. In scalar context, the reference is returned (NOT the list length or
398 bucket status). You must specify an appropriate type constraint to use
401 =item lazy_build => 0|1
403 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
404 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
408 =head2 confess error -> BOOM
410 L<Carp/confess> for your convenience.
412 =head2 blessed value -> ClassName | undef
414 L<Scalar::Util/blessed> for your convenience.
420 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
421 You may use L</extends> to replace the superclass list.
425 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
426 keywords (such as L</extends>) it will break loudly instead breaking subtly.
430 =head2 load_class Class::Name
432 This will load a given C<Class::Name> (or die if it's not loadable).
433 This function can be used in place of tricks like
434 C<eval "use $module"> or using C<require>.
436 =head2 is_class_loaded Class::Name -> Bool
438 Returns whether this class is actually loaded or not. It uses a heuristic which
439 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
440 locally-defined method.
442 =head1 SOURCE CODE ACCESS
444 We have a public git repo:
446 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
450 Shawn M Moore, C<< <sartak at gmail.com> >>
452 Yuval Kogman, C<< <nothingmuch at woobling.org> >>
460 Goro Fuji (gfx) C<< <gfuji at cpan.org> >>
462 with plenty of code borrowed from L<Class::MOP> and L<Moose>
466 There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
467 this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
468 to resolve these tests are more than welcome.
470 Please report any bugs through RT: email
471 C<bug-mouse at rt.cpan.org>, or browse
472 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
474 =head1 COPYRIGHT AND LICENSE
476 Copyright 2008-2009 Infinity Interactive, Inc.
478 http://www.iinteractive.com/
480 This program is free software; you can redistribute it and/or modify it
481 under the same terms as Perl itself.