9 our $VERSION = '0.33_01';
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);
43 $meta->add_attribute($_ => @_) for ref($name) ? @{$name} : $name;
47 my $meta = Mouse::Meta::Class->initialize(scalar caller);
52 $meta->add_before_method_modifier($_ => $code);
57 my $meta = Mouse::Meta::Class->initialize(scalar caller);
62 $meta->add_after_method_modifier($_ => $code);
67 my $meta = Mouse::Meta::Class->initialize(scalar caller);
72 $meta->add_around_method_modifier($_ => $code);
77 Mouse::Util::apply_all_roles(scalar(caller), @_);
85 # This check avoids a recursion loop - see
86 # t/100_bugs/020_super_recursion.t
87 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
88 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
92 my $meta = Mouse::Meta::Class->initialize(caller);
93 my $pkg = $meta->name;
98 my $body = $pkg->can($name)
99 or confess "You cannot override '$name' because it has no super method";
101 $meta->add_method($name => sub {
102 local $SUPER_PACKAGE = $pkg;
103 local @SUPER_ARGS = @_;
104 local $SUPER_BODY = $body;
110 sub inner { not_supported }
111 sub augment{ not_supported }
117 my $class = $args{for_class}
118 or confess("Cannot call init_meta without specifying a for_class");
119 my $base_class = $args{base_class} || 'Mouse::Object';
120 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
122 confess("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
123 unless $metaclass->isa('Mouse::Meta::Class');
125 # make a subtype for each Mouse class
126 Mouse::Util::TypeConstraints::class_type($class)
127 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
129 my $meta = $metaclass->initialize($class);
131 $meta->add_method(meta => sub{
132 return $metaclass->initialize(ref($_[0]) || $_[0]);
135 $meta->superclasses($base_class)
136 unless $meta->superclasses;
148 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
154 my $level = delete $opts->{into_level};
155 $level = 0 unless defined $level;
156 my $caller = caller($level);
158 # we should never export to main
159 if ($caller eq 'main') {
160 warn qq{$class does not export its sugar to the 'main' package.\n};
165 for_class => $caller,
169 __PACKAGE__->export_to_level( $level+1, $class, @_);
171 # shortcut for the common case of no type character
173 for my $keyword (@EXPORT) {
174 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
187 for my $keyword (@EXPORT) {
189 if(exists $is_removable{$keyword}
190 && ($code = $caller->can($keyword))
191 && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
193 delete $stash->{$keyword};
204 Mouse - Moose minus the antlers
209 use Mouse; # automatically turns on strict and warnings
211 has 'x' => (is => 'rw', isa => 'Int');
212 has 'y' => (is => 'rw', isa => 'Int');
225 has 'z' => (is => 'rw', isa => 'Int');
227 after 'clear' => sub {
234 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
236 Unfortunately, Moose has a compile-time penalty. Though significant progress
237 has been made over the years, the compile time penalty is a non-starter for
238 some very specific applications. If you are writing a command-line application
239 or CGI script where startup time is essential, you may not be able to use
240 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
243 Mouse aims to alleviate this by providing a subset of Moose's functionality,
246 We're also going as light on dependencies as possible.
247 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
248 if you want support for L</before>, L</after>, and L</around>.
252 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
253 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
254 over 96%. Even the error messages are taken from Moose. The Mouse code just
255 runs the test suite 4x faster.
257 The idea is that, if you need the extra power, you should be able to run
258 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
259 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
260 in which case it will act as Moose. Since Mouse is a little sloppier than
261 Moose, if you run into weird errors, it would be worth running:
263 ANY_MOOSE=Moose perl your-script.pl
265 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
270 Please don't copy MooseX code to MouseX. If you need extensions, you really
271 should upgrade to Moose. We don't need two parallel sets of extensions!
273 If you really must write a Mouse extension, please contact the Moose mailing
274 list or #moose on IRC beforehand.
278 The original author of this module has mostly stepped down from maintaining
279 Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
280 If you would like to help maintain this module, please get in touch with us.
284 =head2 meta -> Mouse::Meta::Class
286 Returns this class' metaclass instance.
288 =head2 extends superclasses
290 Sets this class' superclasses.
292 =head2 before (method|methods) => Code
294 Installs a "before" method modifier. See L<Moose/before> or
295 L<Class::Method::Modifiers/before>.
297 Use of this feature requires L<Class::Method::Modifiers>!
299 =head2 after (method|methods) => Code
301 Installs an "after" method modifier. See L<Moose/after> or
302 L<Class::Method::Modifiers/after>.
304 Use of this feature requires L<Class::Method::Modifiers>!
306 =head2 around (method|methods) => Code
308 Installs an "around" method modifier. See L<Moose/around> or
309 L<Class::Method::Modifiers/around>.
311 Use of this feature requires L<Class::Method::Modifiers>!
313 =head2 has (name|names) => parameters
315 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
322 If specified, inlines a read-only/read-write accessor with the same name as
325 =item isa => TypeConstraint
327 Provides type checking in the constructor and accessor. The following types are
328 supported. Any unknown type is taken to be a class check (e.g. isa =>
329 'DateTime' would accept only L<DateTime> objects).
331 Any Item Bool Undef Defined Value Num Int Str ClassName
332 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
335 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
338 =item required => 0|1
340 Whether this attribute is required to have a value. If the attribute is lazy or
341 has a builder, then providing a value for the attribute in the constructor is
344 =item init_arg => Str | Undef
346 Allows you to use a different key name in the constructor. If undef, the
347 attribue can't be passed to the constructor.
349 =item default => Value | CodeRef
351 Sets the default value of the attribute. If the default is a coderef, it will
352 be invoked to get the default value. Due to quirks of Perl, any bare reference
353 is forbidden, you must wrap the reference in a coderef. Otherwise, all
354 instances will share the same reference.
358 If specified, the default is calculated on demand instead of in the
361 =item predicate => Str
363 Lets you specify a method name for installing a predicate method, which checks
364 that the attribute has a value. It will not invoke a lazy default or builder
369 Lets you specify a method name for installing a clearer method, which clears
370 the attribute's value from the instance. On the next read, lazy or builder will
373 =item handles => HashRef|ArrayRef
375 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
376 given method names to method calls on the attribute. HashRef maps local method
377 names to remote method names called on the attribute. Other forms of
378 L</handles>, such as regular expression and coderef, are not yet supported.
380 =item weak_ref => 0|1
382 Lets you automatically weaken any reference stored in the attribute.
384 Use of this feature requires L<Scalar::Util>!
386 =item trigger => CodeRef
388 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.
390 Mouse 0.05 supported more complex triggers, but this behavior is now removed.
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 auto_deref => 0|1
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 lazy_build => 0|1
407 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
408 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
412 =head2 confess error -> BOOM
414 L<Carp/confess> for your convenience.
416 =head2 blessed value -> ClassName | undef
418 L<Scalar::Util/blessed> for your convenience.
424 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
425 You may use L</extends> to replace the superclass list.
429 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
430 keywords (such as L</extends>) it will break loudly instead breaking subtly.
434 =head2 load_class Class::Name
436 This will load a given C<Class::Name> (or die if it's not loadable).
437 This function can be used in place of tricks like
438 C<eval "use $module"> or using C<require>.
440 =head2 is_class_loaded Class::Name -> Bool
442 Returns whether this class is actually loaded or not. It uses a heuristic which
443 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
444 locally-defined method.
446 =head1 SOURCE CODE ACCESS
448 We have a public git repo:
450 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
454 Shawn M Moore, C<< <sartak at gmail.com> >>
456 Yuval Kogman, C<< <nothingmuch at woobling.org> >>
464 Goro Fuji (gfx) C<< <gfuji at cpan.org> >>
466 with plenty of code borrowed from L<Class::MOP> and L<Moose>
470 There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
471 this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
472 to resolve these tests are more than welcome.
474 Please report any bugs through RT: email
475 C<bug-mouse at rt.cpan.org>, or browse
476 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
478 =head1 COPYRIGHT AND LICENSE
480 Copyright 2008-2009 Infinity Interactive, Inc.
482 http://www.iinteractive.com/
484 This program is free software; you can redistribute it and/or modify it
485 under the same terms as Perl itself.