9 sub moose_version(){ 0.90 } # which Mouse is a subset of
12 use Scalar::Util 'blessed';
13 use Mouse::Util qw(load_class is_class_loaded);
15 use Mouse::Meta::Attribute;
16 use Mouse::Meta::Module;
17 use Mouse::Meta::Class;
18 use Mouse::Meta::Role;
20 use Mouse::Util::TypeConstraints;
22 our @EXPORT = qw(extends has before after around override super blessed confess with);
24 our %is_removable = map{ $_ => undef } @EXPORT;
25 delete $is_removable{blessed};
26 delete $is_removable{confess};
28 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
31 my $meta = Mouse::Meta::Class->initialize(scalar caller);
32 $meta->add_attribute(@_);
36 my $meta = Mouse::Meta::Class->initialize(scalar caller);
41 $meta->add_before_method_modifier($_ => $code);
46 my $meta = Mouse::Meta::Class->initialize(scalar caller);
51 $meta->add_after_method_modifier($_ => $code);
56 my $meta = Mouse::Meta::Class->initialize(scalar caller);
61 $meta->add_around_method_modifier($_ => $code);
66 Mouse::Util::apply_all_roles(scalar(caller), @_);
74 # This check avoids a recursion loop - see
75 # t/100_bugs/020_super_recursion.t
76 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
77 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
81 my $meta = Mouse::Meta::Class->initialize(caller);
82 my $pkg = $meta->name;
87 my $body = $pkg->can($name)
88 or confess "You cannot override '$name' because it has no super method";
90 $meta->add_method($name => sub {
91 local $SUPER_PACKAGE = $pkg;
92 local @SUPER_ARGS = @_;
93 local $SUPER_BODY = $body;
100 # This used to be called as a function. This hack preserves
101 # backwards compatibility.
102 if ( $_[0] ne __PACKAGE__ ) {
103 return __PACKAGE__->init_meta(
113 my $class = $args{for_class}
115 "Cannot call init_meta without specifying a for_class");
116 my $base_class = $args{base_class} || 'Mouse::Object';
117 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
119 Carp::croak("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
120 unless $metaclass->isa('Mouse::Meta::Class');
122 # make a subtype for each Mouse class
124 unless find_type_constraint($class);
126 my $meta = $metaclass->initialize($class);
127 $meta->superclasses($base_class)
128 unless $meta->superclasses;
130 $meta->add_method(meta => sub{
131 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
145 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
151 my $level = delete $opts->{into_level};
152 $level = 0 unless defined $level;
153 my $caller = caller($level);
155 # we should never export to main
156 if ($caller eq 'main') {
157 warn qq{$class does not export its sugar to the 'main' package.\n};
162 for_class => $caller,
166 __PACKAGE__->export_to_level( $level+1, $class, @_);
168 # shortcut for the common case of no type character
170 for my $keyword (@EXPORT) {
171 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
184 for my $keyword (@EXPORT) {
186 if(exists $is_removable{$keyword}
187 && ($code = $caller->can($keyword))
188 && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
190 delete $stash->{$keyword};
201 Mouse - Moose minus the antlers
206 use Mouse; # automatically turns on strict and warnings
208 has 'x' => (is => 'rw', isa => 'Int');
209 has 'y' => (is => 'rw', isa => 'Int');
222 has 'z' => (is => 'rw', isa => 'Int');
224 after 'clear' => sub {
231 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
233 Unfortunately, Moose has a compile-time penalty. Though significant progress
234 has been made over the years, the compile time penalty is a non-starter for
235 some very specific applications. If you are writing a command-line application
236 or CGI script where startup time is essential, you may not be able to use
237 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
240 Mouse aims to alleviate this by providing a subset of Moose's functionality,
243 We're also going as light on dependencies as possible.
244 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
245 if you want support for L</before>, L</after>, and L</around>.
249 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
250 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
251 over 96%. Even the error messages are taken from Moose. The Mouse code just
252 runs the test suite 4x faster.
254 The idea is that, if you need the extra power, you should be able to run
255 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
256 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
257 in which case it will act as Moose. Since Mouse is a little sloppier than
258 Moose, if you run into weird errors, it would be worth running:
260 ANY_MOOSE=Moose perl your-script.pl
262 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
267 Please don't copy MooseX code to MouseX. If you need extensions, you really
268 should upgrade to Moose. We don't need two parallel sets of extensions!
270 If you really must write a Mouse extension, please contact the Moose mailing
271 list or #moose on IRC beforehand.
275 The original author of this module has mostly stepped down from maintaining
276 Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
277 If you would like to help maintain this module, please get in touch with us.
281 =head2 meta -> Mouse::Meta::Class
283 Returns this class' metaclass instance.
285 =head2 extends superclasses
287 Sets this class' superclasses.
289 =head2 before (method|methods) => Code
291 Installs a "before" method modifier. See L<Moose/before> or
292 L<Class::Method::Modifiers/before>.
294 Use of this feature requires L<Class::Method::Modifiers>!
296 =head2 after (method|methods) => Code
298 Installs an "after" method modifier. See L<Moose/after> or
299 L<Class::Method::Modifiers/after>.
301 Use of this feature requires L<Class::Method::Modifiers>!
303 =head2 around (method|methods) => Code
305 Installs an "around" method modifier. See L<Moose/around> or
306 L<Class::Method::Modifiers/around>.
308 Use of this feature requires L<Class::Method::Modifiers>!
310 =head2 has (name|names) => parameters
312 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
319 If specified, inlines a read-only/read-write accessor with the same name as
322 =item isa => TypeConstraint
324 Provides type checking in the constructor and accessor. The following types are
325 supported. Any unknown type is taken to be a class check (e.g. isa =>
326 'DateTime' would accept only L<DateTime> objects).
328 Any Item Bool Undef Defined Value Num Int Str ClassName
329 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
332 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
335 =item required => 0|1
337 Whether this attribute is required to have a value. If the attribute is lazy or
338 has a builder, then providing a value for the attribute in the constructor is
341 =item init_arg => Str | Undef
343 Allows you to use a different key name in the constructor. If undef, the
344 attribue can't be passed to the constructor.
346 =item default => Value | CodeRef
348 Sets the default value of the attribute. If the default is a coderef, it will
349 be invoked to get the default value. Due to quirks of Perl, any bare reference
350 is forbidden, you must wrap the reference in a coderef. Otherwise, all
351 instances will share the same reference.
355 If specified, the default is calculated on demand instead of in the
358 =item predicate => Str
360 Lets you specify a method name for installing a predicate method, which checks
361 that the attribute has a value. It will not invoke a lazy default or builder
366 Lets you specify a method name for installing a clearer method, which clears
367 the attribute's value from the instance. On the next read, lazy or builder will
370 =item handles => HashRef|ArrayRef
372 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
373 given method names to method calls on the attribute. HashRef maps local method
374 names to remote method names called on the attribute. Other forms of
375 L</handles>, such as regular expression and coderef, are not yet supported.
377 =item weak_ref => 0|1
379 Lets you automatically weaken any reference stored in the attribute.
381 Use of this feature requires L<Scalar::Util>!
383 =item trigger => CodeRef
385 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.
387 Mouse 0.05 supported more complex triggers, but this behavior is now removed.
391 Defines a method name to be called to provide the default value of the
392 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
393 C<< default => sub { $_[0]->build_foo } >>.
395 =item auto_deref => 0|1
397 Allows you to automatically dereference ArrayRef and HashRef attributes in list
398 context. In scalar context, the reference is returned (NOT the list length or
399 bucket status). You must specify an appropriate type constraint to use
402 =item lazy_build => 0|1
404 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
405 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
409 =head2 confess error -> BOOM
411 L<Carp/confess> for your convenience.
413 =head2 blessed value -> ClassName | undef
415 L<Scalar::Util/blessed> for your convenience.
421 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
422 You may use L</extends> to replace the superclass list.
426 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
427 keywords (such as L</extends>) it will break loudly instead breaking subtly.
431 =head2 load_class Class::Name
433 This will load a given C<Class::Name> (or die if it's not loadable).
434 This function can be used in place of tricks like
435 C<eval "use $module"> or using C<require>.
437 =head2 is_class_loaded Class::Name -> Bool
439 Returns whether this class is actually loaded or not. It uses a heuristic which
440 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
441 locally-defined method.
443 =head1 SOURCE CODE ACCESS
445 We have a public git repo:
447 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
451 Shawn M Moore, C<< <sartak at gmail.com> >>
453 Yuval Kogman, C<< <nothingmuch at woobling.org> >>
461 Goro Fuji (gfx) C<< <gfuji at cpan.org> >>
463 with plenty of code borrowed from L<Class::MOP> and L<Moose>
467 There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
468 this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
469 to resolve these tests are more than welcome.
471 Please report any bugs through RT: email
472 C<bug-mouse at rt.cpan.org>, or browse
473 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
475 =head1 COPYRIGHT AND LICENSE
477 Copyright 2008-2009 Infinity Interactive, Inc.
479 http://www.iinteractive.com/
481 This program is free software; you can redistribute it and/or modify it
482 under the same terms as Perl itself.