9 sub moose_version(){ 0.90 } # which Mouse is a subset of
12 use Scalar::Util 'blessed';
14 use Mouse::Util qw(load_class is_class_loaded 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 ();
33 our %is_removable = map{ $_ => undef } @EXPORT;
34 delete $is_removable{blessed};
35 delete $is_removable{confess};
37 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
40 my $meta = Mouse::Meta::Class->initialize(scalar caller);
41 $meta->add_attribute(@_);
45 my $meta = Mouse::Meta::Class->initialize(scalar caller);
50 $meta->add_before_method_modifier($_ => $code);
55 my $meta = Mouse::Meta::Class->initialize(scalar caller);
60 $meta->add_after_method_modifier($_ => $code);
65 my $meta = Mouse::Meta::Class->initialize(scalar caller);
70 $meta->add_around_method_modifier($_ => $code);
75 Mouse::Util::apply_all_roles(scalar(caller), @_);
83 # This check avoids a recursion loop - see
84 # t/100_bugs/020_super_recursion.t
85 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
86 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
90 my $meta = Mouse::Meta::Class->initialize(caller);
91 my $pkg = $meta->name;
96 my $body = $pkg->can($name)
97 or confess "You cannot override '$name' because it has no super method";
99 $meta->add_method($name => sub {
100 local $SUPER_PACKAGE = $pkg;
101 local @SUPER_ARGS = @_;
102 local $SUPER_BODY = $body;
108 sub inner { not_supported }
109 sub augment{ not_supported }
115 my $class = $args{for_class}
116 or confess("Cannot call init_meta without specifying a for_class");
117 my $base_class = $args{base_class} || 'Mouse::Object';
118 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
120 confess("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
121 unless $metaclass->isa('Mouse::Meta::Class');
123 # make a subtype for each Mouse class
124 Mouse::Util::TypeConstraints::class_type($class)
125 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
127 my $meta = $metaclass->initialize($class);
129 $meta->add_method(meta => sub{
130 return $metaclass->initialize(ref($_[0]) || $_[0]);
133 $meta->superclasses($base_class)
134 unless $meta->superclasses;
146 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
152 my $level = delete $opts->{into_level};
153 $level = 0 unless defined $level;
154 my $caller = caller($level);
156 # we should never export to main
157 if ($caller eq 'main') {
158 warn qq{$class does not export its sugar to the 'main' package.\n};
163 for_class => $caller,
167 __PACKAGE__->export_to_level( $level+1, $class, @_);
169 # shortcut for the common case of no type character
171 for my $keyword (@EXPORT) {
172 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
185 for my $keyword (@EXPORT) {
187 if(exists $is_removable{$keyword}
188 && ($code = $caller->can($keyword))
189 && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
191 delete $stash->{$keyword};
202 Mouse - Moose minus the antlers
207 use Mouse; # automatically turns on strict and warnings
209 has 'x' => (is => 'rw', isa => 'Int');
210 has 'y' => (is => 'rw', isa => 'Int');
223 has 'z' => (is => 'rw', isa => 'Int');
225 after 'clear' => sub {
232 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
234 Unfortunately, Moose has a compile-time penalty. Though significant progress
235 has been made over the years, the compile time penalty is a non-starter for
236 some very specific applications. If you are writing a command-line application
237 or CGI script where startup time is essential, you may not be able to use
238 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
241 Mouse aims to alleviate this by providing a subset of Moose's functionality,
244 We're also going as light on dependencies as possible.
245 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
246 if you want support for L</before>, L</after>, and L</around>.
250 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
251 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
252 over 96%. Even the error messages are taken from Moose. The Mouse code just
253 runs the test suite 4x faster.
255 The idea is that, if you need the extra power, you should be able to run
256 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
257 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
258 in which case it will act as Moose. Since Mouse is a little sloppier than
259 Moose, if you run into weird errors, it would be worth running:
261 ANY_MOOSE=Moose perl your-script.pl
263 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
268 Please don't copy MooseX code to MouseX. If you need extensions, you really
269 should upgrade to Moose. We don't need two parallel sets of extensions!
271 If you really must write a Mouse extension, please contact the Moose mailing
272 list or #moose on IRC beforehand.
276 The original author of this module has mostly stepped down from maintaining
277 Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
278 If you would like to help maintain this module, please get in touch with us.
282 =head2 meta -> Mouse::Meta::Class
284 Returns this class' metaclass instance.
286 =head2 extends superclasses
288 Sets this class' superclasses.
290 =head2 before (method|methods) => Code
292 Installs a "before" method modifier. See L<Moose/before> or
293 L<Class::Method::Modifiers/before>.
295 Use of this feature requires L<Class::Method::Modifiers>!
297 =head2 after (method|methods) => Code
299 Installs an "after" method modifier. See L<Moose/after> or
300 L<Class::Method::Modifiers/after>.
302 Use of this feature requires L<Class::Method::Modifiers>!
304 =head2 around (method|methods) => Code
306 Installs an "around" method modifier. See L<Moose/around> or
307 L<Class::Method::Modifiers/around>.
309 Use of this feature requires L<Class::Method::Modifiers>!
311 =head2 has (name|names) => parameters
313 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
320 If specified, inlines a read-only/read-write accessor with the same name as
323 =item isa => TypeConstraint
325 Provides type checking in the constructor and accessor. The following types are
326 supported. Any unknown type is taken to be a class check (e.g. isa =>
327 'DateTime' would accept only L<DateTime> objects).
329 Any Item Bool Undef Defined Value Num Int Str ClassName
330 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
333 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
336 =item required => 0|1
338 Whether this attribute is required to have a value. If the attribute is lazy or
339 has a builder, then providing a value for the attribute in the constructor is
342 =item init_arg => Str | Undef
344 Allows you to use a different key name in the constructor. If undef, the
345 attribue can't be passed to the constructor.
347 =item default => Value | CodeRef
349 Sets the default value of the attribute. If the default is a coderef, it will
350 be invoked to get the default value. Due to quirks of Perl, any bare reference
351 is forbidden, you must wrap the reference in a coderef. Otherwise, all
352 instances will share the same reference.
356 If specified, the default is calculated on demand instead of in the
359 =item predicate => Str
361 Lets you specify a method name for installing a predicate method, which checks
362 that the attribute has a value. It will not invoke a lazy default or builder
367 Lets you specify a method name for installing a clearer method, which clears
368 the attribute's value from the instance. On the next read, lazy or builder will
371 =item handles => HashRef|ArrayRef
373 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
374 given method names to method calls on the attribute. HashRef maps local method
375 names to remote method names called on the attribute. Other forms of
376 L</handles>, such as regular expression and coderef, are not yet supported.
378 =item weak_ref => 0|1
380 Lets you automatically weaken any reference stored in the attribute.
382 Use of this feature requires L<Scalar::Util>!
384 =item trigger => CodeRef
386 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.
388 Mouse 0.05 supported more complex triggers, but this behavior is now removed.
392 Defines a method name to be called to provide the default value of the
393 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
394 C<< default => sub { $_[0]->build_foo } >>.
396 =item auto_deref => 0|1
398 Allows you to automatically dereference ArrayRef and HashRef attributes in list
399 context. In scalar context, the reference is returned (NOT the list length or
400 bucket status). You must specify an appropriate type constraint to use
403 =item lazy_build => 0|1
405 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
406 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
410 =head2 confess error -> BOOM
412 L<Carp/confess> for your convenience.
414 =head2 blessed value -> ClassName | undef
416 L<Scalar::Util/blessed> for your convenience.
422 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
423 You may use L</extends> to replace the superclass list.
427 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
428 keywords (such as L</extends>) it will break loudly instead breaking subtly.
432 =head2 load_class Class::Name
434 This will load a given C<Class::Name> (or die if it's not loadable).
435 This function can be used in place of tricks like
436 C<eval "use $module"> or using C<require>.
438 =head2 is_class_loaded Class::Name -> Bool
440 Returns whether this class is actually loaded or not. It uses a heuristic which
441 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
442 locally-defined method.
444 =head1 SOURCE CODE ACCESS
446 We have a public git repo:
448 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
452 Shawn M Moore, C<< <sartak at gmail.com> >>
454 Yuval Kogman, C<< <nothingmuch at woobling.org> >>
462 Goro Fuji (gfx) C<< <gfuji at cpan.org> >>
464 with plenty of code borrowed from L<Class::MOP> and L<Moose>
468 There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
469 this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
470 to resolve these tests are more than welcome.
472 Please report any bugs through RT: email
473 C<bug-mouse at rt.cpan.org>, or browse
474 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
476 =head1 COPYRIGHT AND LICENSE
478 Copyright 2008-2009 Infinity Interactive, Inc.
480 http://www.iinteractive.com/
482 This program is free software; you can redistribute it and/or modify it
483 under the same terms as Perl itself.