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);
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 ();
23 our @EXPORT = qw(extends has before after around override super blessed confess with);
25 our %is_removable = map{ $_ => undef } @EXPORT;
26 delete $is_removable{blessed};
27 delete $is_removable{confess};
29 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
32 my $meta = Mouse::Meta::Class->initialize(scalar caller);
33 $meta->add_attribute(@_);
37 my $meta = Mouse::Meta::Class->initialize(scalar caller);
42 $meta->add_before_method_modifier($_ => $code);
47 my $meta = Mouse::Meta::Class->initialize(scalar caller);
52 $meta->add_after_method_modifier($_ => $code);
57 my $meta = Mouse::Meta::Class->initialize(scalar caller);
62 $meta->add_around_method_modifier($_ => $code);
67 Mouse::Util::apply_all_roles(scalar(caller), @_);
75 # This check avoids a recursion loop - see
76 # t/100_bugs/020_super_recursion.t
77 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
78 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
82 my $meta = Mouse::Meta::Class->initialize(caller);
83 my $pkg = $meta->name;
88 my $body = $pkg->can($name)
89 or confess "You cannot override '$name' because it has no super method";
91 $meta->add_method($name => sub {
92 local $SUPER_PACKAGE = $pkg;
93 local @SUPER_ARGS = @_;
94 local $SUPER_BODY = $body;
104 my $class = $args{for_class}
105 or confess("Cannot call init_meta without specifying a for_class");
106 my $base_class = $args{base_class} || 'Mouse::Object';
107 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
109 confess("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
110 unless $metaclass->isa('Mouse::Meta::Class');
112 # make a subtype for each Mouse class
113 Mouse::Util::TypeConstraints::class_type($class)
114 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
116 my $meta = $metaclass->initialize($class);
118 $meta->add_method(meta => sub{
119 return $metaclass->initialize(ref($_[0]) || $_[0]);
122 $meta->superclasses($base_class)
123 unless $meta->superclasses;
135 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
141 my $level = delete $opts->{into_level};
142 $level = 0 unless defined $level;
143 my $caller = caller($level);
145 # we should never export to main
146 if ($caller eq 'main') {
147 warn qq{$class does not export its sugar to the 'main' package.\n};
152 for_class => $caller,
156 __PACKAGE__->export_to_level( $level+1, $class, @_);
158 # shortcut for the common case of no type character
160 for my $keyword (@EXPORT) {
161 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
174 for my $keyword (@EXPORT) {
176 if(exists $is_removable{$keyword}
177 && ($code = $caller->can($keyword))
178 && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
180 delete $stash->{$keyword};
191 Mouse - Moose minus the antlers
196 use Mouse; # automatically turns on strict and warnings
198 has 'x' => (is => 'rw', isa => 'Int');
199 has 'y' => (is => 'rw', isa => 'Int');
212 has 'z' => (is => 'rw', isa => 'Int');
214 after 'clear' => sub {
221 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
223 Unfortunately, Moose has a compile-time penalty. Though significant progress
224 has been made over the years, the compile time penalty is a non-starter for
225 some very specific applications. If you are writing a command-line application
226 or CGI script where startup time is essential, you may not be able to use
227 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
230 Mouse aims to alleviate this by providing a subset of Moose's functionality,
233 We're also going as light on dependencies as possible.
234 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
235 if you want support for L</before>, L</after>, and L</around>.
239 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
240 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
241 over 96%. Even the error messages are taken from Moose. The Mouse code just
242 runs the test suite 4x faster.
244 The idea is that, if you need the extra power, you should be able to run
245 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
246 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
247 in which case it will act as Moose. Since Mouse is a little sloppier than
248 Moose, if you run into weird errors, it would be worth running:
250 ANY_MOOSE=Moose perl your-script.pl
252 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
257 Please don't copy MooseX code to MouseX. If you need extensions, you really
258 should upgrade to Moose. We don't need two parallel sets of extensions!
260 If you really must write a Mouse extension, please contact the Moose mailing
261 list or #moose on IRC beforehand.
265 The original author of this module has mostly stepped down from maintaining
266 Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
267 If you would like to help maintain this module, please get in touch with us.
271 =head2 meta -> Mouse::Meta::Class
273 Returns this class' metaclass instance.
275 =head2 extends superclasses
277 Sets this class' superclasses.
279 =head2 before (method|methods) => Code
281 Installs a "before" method modifier. See L<Moose/before> or
282 L<Class::Method::Modifiers/before>.
284 Use of this feature requires L<Class::Method::Modifiers>!
286 =head2 after (method|methods) => Code
288 Installs an "after" method modifier. See L<Moose/after> or
289 L<Class::Method::Modifiers/after>.
291 Use of this feature requires L<Class::Method::Modifiers>!
293 =head2 around (method|methods) => Code
295 Installs an "around" method modifier. See L<Moose/around> or
296 L<Class::Method::Modifiers/around>.
298 Use of this feature requires L<Class::Method::Modifiers>!
300 =head2 has (name|names) => parameters
302 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
309 If specified, inlines a read-only/read-write accessor with the same name as
312 =item isa => TypeConstraint
314 Provides type checking in the constructor and accessor. The following types are
315 supported. Any unknown type is taken to be a class check (e.g. isa =>
316 'DateTime' would accept only L<DateTime> objects).
318 Any Item Bool Undef Defined Value Num Int Str ClassName
319 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
322 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
325 =item required => 0|1
327 Whether this attribute is required to have a value. If the attribute is lazy or
328 has a builder, then providing a value for the attribute in the constructor is
331 =item init_arg => Str | Undef
333 Allows you to use a different key name in the constructor. If undef, the
334 attribue can't be passed to the constructor.
336 =item default => Value | CodeRef
338 Sets the default value of the attribute. If the default is a coderef, it will
339 be invoked to get the default value. Due to quirks of Perl, any bare reference
340 is forbidden, you must wrap the reference in a coderef. Otherwise, all
341 instances will share the same reference.
345 If specified, the default is calculated on demand instead of in the
348 =item predicate => Str
350 Lets you specify a method name for installing a predicate method, which checks
351 that the attribute has a value. It will not invoke a lazy default or builder
356 Lets you specify a method name for installing a clearer method, which clears
357 the attribute's value from the instance. On the next read, lazy or builder will
360 =item handles => HashRef|ArrayRef
362 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
363 given method names to method calls on the attribute. HashRef maps local method
364 names to remote method names called on the attribute. Other forms of
365 L</handles>, such as regular expression and coderef, are not yet supported.
367 =item weak_ref => 0|1
369 Lets you automatically weaken any reference stored in the attribute.
371 Use of this feature requires L<Scalar::Util>!
373 =item trigger => CodeRef
375 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.
377 Mouse 0.05 supported more complex triggers, but this behavior is now removed.
381 Defines a method name to be called to provide the default value of the
382 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
383 C<< default => sub { $_[0]->build_foo } >>.
385 =item auto_deref => 0|1
387 Allows you to automatically dereference ArrayRef and HashRef attributes in list
388 context. In scalar context, the reference is returned (NOT the list length or
389 bucket status). You must specify an appropriate type constraint to use
392 =item lazy_build => 0|1
394 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
395 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
399 =head2 confess error -> BOOM
401 L<Carp/confess> for your convenience.
403 =head2 blessed value -> ClassName | undef
405 L<Scalar::Util/blessed> for your convenience.
411 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
412 You may use L</extends> to replace the superclass list.
416 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
417 keywords (such as L</extends>) it will break loudly instead breaking subtly.
421 =head2 load_class Class::Name
423 This will load a given C<Class::Name> (or die if it's not loadable).
424 This function can be used in place of tricks like
425 C<eval "use $module"> or using C<require>.
427 =head2 is_class_loaded Class::Name -> Bool
429 Returns whether this class is actually loaded or not. It uses a heuristic which
430 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
431 locally-defined method.
433 =head1 SOURCE CODE ACCESS
435 We have a public git repo:
437 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
441 Shawn M Moore, C<< <sartak at gmail.com> >>
443 Yuval Kogman, C<< <nothingmuch at woobling.org> >>
451 Goro Fuji (gfx) C<< <gfuji at cpan.org> >>
453 with plenty of code borrowed from L<Class::MOP> and L<Moose>
457 There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
458 this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
459 to resolve these tests are more than welcome.
461 Please report any bugs through RT: email
462 C<bug-mouse at rt.cpan.org>, or browse
463 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
465 =head1 COPYRIGHT AND LICENSE
467 Copyright 2008-2009 Infinity Interactive, Inc.
469 http://www.iinteractive.com/
471 This program is free software; you can redistribute it and/or modify it
472 under the same terms as Perl itself.