7 our $VERSION = '0.37_02';
12 use Scalar::Util 'blessed';
14 use Mouse::Util qw(load_class is_class_loaded get_code_package 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 ();
23 our @ISA = qw(Exporter);
35 our %is_removable = map{ $_ => undef } @EXPORT;
36 delete $is_removable{blessed};
37 delete $is_removable{confess};
39 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
42 my $meta = Mouse::Meta::Class->initialize(scalar caller);
45 $meta->add_attribute($_ => @_) for ref($name) ? @{$name} : $name;
49 my $meta = Mouse::Meta::Class->initialize(scalar caller);
54 $meta->add_before_method_modifier($_ => $code);
59 my $meta = Mouse::Meta::Class->initialize(scalar caller);
64 $meta->add_after_method_modifier($_ => $code);
69 my $meta = Mouse::Meta::Class->initialize(scalar caller);
74 $meta->add_around_method_modifier($_ => $code);
79 Mouse::Util::apply_all_roles(scalar(caller), @_);
87 # This check avoids a recursion loop - see
88 # t/100_bugs/020_super_recursion.t
89 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
90 return if !defined $SUPER_BODY;
91 $SUPER_BODY->(@SUPER_ARGS);
95 # my($name, $method) = @_;
96 Mouse::Meta::Class->initialize(scalar caller)->add_override_method_modifier(@_);
99 sub inner { not_supported }
100 sub augment{ not_supported }
106 my $class = $args{for_class}
107 or confess("Cannot call init_meta without specifying a for_class");
108 my $base_class = $args{base_class} || 'Mouse::Object';
109 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
111 confess("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
112 unless $metaclass->isa('Mouse::Meta::Class');
114 # make a subtype for each Mouse class
115 Mouse::Util::TypeConstraints::class_type($class)
116 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
118 my $meta = $metaclass->initialize($class);
120 $meta->add_method(meta => sub{
121 return $metaclass->initialize(ref($_[0]) || $_[0]);
124 $meta->superclasses($base_class)
125 unless $meta->superclasses;
137 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
143 my $level = delete $opts->{into_level};
144 $level = 0 unless defined $level;
145 my $caller = caller($level);
147 # we should never export to main
148 if ($caller eq 'main') {
149 warn qq{$class does not export its sugar to the 'main' package.\n};
154 for_class => $caller,
158 __PACKAGE__->export_to_level( $level+1, $class, @_);
160 # shortcut for the common case of no type character
162 for my $keyword (@EXPORT) {
163 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
176 for my $keyword (@EXPORT) {
178 if(exists $is_removable{$keyword}
179 && ($code = $caller->can($keyword))
180 && get_code_package($code) eq __PACKAGE__){
182 delete $stash->{$keyword};
193 Mouse - Moose minus the antlers
198 use Mouse; # automatically turns on strict and warnings
200 has 'x' => (is => 'rw', isa => 'Int');
201 has 'y' => (is => 'rw', isa => 'Int');
214 has 'z' => (is => 'rw', isa => 'Int');
216 after 'clear' => sub {
223 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
225 Unfortunately, Moose has a compile-time penalty. Though significant progress
226 has been made over the years, the compile time penalty is a non-starter for
227 some very specific applications. If you are writing a command-line application
228 or CGI script where startup time is essential, you may not be able to use
229 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
232 Mouse aims to alleviate this by providing a subset of Moose's functionality,
235 We're also going as light on dependencies as possible.
236 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
237 if you want support for L</before>, L</after>, and L</around>.
239 =head2 MOOSE COMPATIBILITY
241 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
242 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
243 over 96%. Even the error messages are taken from Moose. The Mouse code just
244 runs the test suite 4x faster.
246 The idea is that, if you need the extra power, you should be able to run
247 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
248 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
249 in which case it will act as Moose. Since Mouse is a little sloppier than
250 Moose, if you run into weird errors, it would be worth running:
252 ANY_MOOSE=Moose perl your-script.pl
254 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
259 Please don't copy MooseX code to MouseX. If you need extensions, you really
260 should upgrade to Moose. We don't need two parallel sets of extensions!
262 If you really must write a Mouse extension, please contact the Moose mailing
263 list or #moose on IRC beforehand.
267 =head2 C<< $object->meta -> Mouse::Meta::Class >>
269 Returns this class' metaclass instance.
271 =head2 C<< extends superclasses >>
273 Sets this class' superclasses.
275 =head2 C<< before (method|methods) => CodeRef >>
277 Installs a "before" method modifier. See L<Moose/before> or
278 L<Class::Method::Modifiers/before>.
280 Use of this feature requires L<Class::Method::Modifiers>!
282 =head2 C<< after (method|methods) => CodeRef >>
284 Installs an "after" method modifier. See L<Moose/after> or
285 L<Class::Method::Modifiers/after>.
287 Use of this feature requires L<Class::Method::Modifiers>!
289 =head2 C<< around (method|methods) => CodeRef >>
291 Installs an "around" method modifier. See L<Moose/around> or
292 L<Class::Method::Modifiers/around>.
294 Use of this feature requires L<Class::Method::Modifiers>!
296 =head2 C<< has (name|names) => parameters >>
298 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
303 =item C<< is => ro|rw|bare >>
305 If specified, inlines a read-only/read-write accessor with the same name as
308 =item C<< isa => TypeConstraint >>
310 Provides type checking in the constructor and accessor. The following types are
311 supported. Any unknown type is taken to be a class check
312 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
314 Any Item Bool Undef Defined Value Num Int Str ClassName
315 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
318 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
321 =item C<< required => Bool >>
323 Whether this attribute is required to have a value. If the attribute is lazy or
324 has a builder, then providing a value for the attribute in the constructor is
327 =item C<< init_arg => Str | Undef >>
329 Allows you to use a different key name in the constructor. If undef, the
330 attribute can't be passed to the constructor.
332 =item C<< default => Value | CodeRef >>
334 Sets the default value of the attribute. If the default is a coderef, it will
335 be invoked to get the default value. Due to quirks of Perl, any bare reference
336 is forbidden, you must wrap the reference in a coderef. Otherwise, all
337 instances will share the same reference.
339 =item C<< lazy => Bool >>
341 If specified, the default is calculated on demand instead of in the
344 =item C<< predicate => Str >>
346 Lets you specify a method name for installing a predicate method, which checks
347 that the attribute has a value. It will not invoke a lazy default or builder
350 =item C<< clearer => Str >>
352 Lets you specify a method name for installing a clearer method, which clears
353 the attribute's value from the instance. On the next read, lazy or builder will
356 =item C<< handles => HashRef|ArrayRef >>
358 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
359 given method names to method calls on the attribute. HashRef maps local method
360 names to remote method names called on the attribute. Other forms of
361 L</handles>, such as regular expression and coderef, are not yet supported.
363 =item C<< weak_ref => Bool >>
365 Lets you automatically weaken any reference stored in the attribute.
367 Use of this feature requires L<Scalar::Util>!
369 =item C<< trigger => CodeRef >>
371 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.
373 =item C<< builder => Str >>
375 Defines a method name to be called to provide the default value of the
376 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
377 C<< default => sub { $_[0]->build_foo } >>.
379 =item C<< auto_deref => Bool >>
381 Allows you to automatically dereference ArrayRef and HashRef attributes in list
382 context. In scalar context, the reference is returned (NOT the list length or
383 bucket status). You must specify an appropriate type constraint to use
386 =item C<< lazy_build => Bool >>
388 Automatically define the following options:
393 builder => "_build_$attr",
394 clearer => "clear_$attr",
395 predicate => "has_$attr",
400 =head2 C<< confess(message) -> BOOM >>
402 L<Carp/confess> for your convenience.
404 =head2 C<< blessed(value) -> ClassName | undef >>
406 L<Scalar::Util/blessed> for your convenience.
412 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
413 You may use L</extends> to replace the superclass list.
417 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
418 keywords (such as L</extends>) it will break loudly instead breaking subtly.
420 =head1 SOURCE CODE ACCESS
422 We have a public git repository:
424 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
438 Shawn M Moore, E<lt>sartak at gmail.comE<gt>
440 Yuval Kogman, E<lt>nothingmuch at woobling.orgE<gt>
448 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
450 with plenty of code borrowed from L<Class::MOP> and L<Moose>
454 All complex software has bugs lurking in it, and this module is no exception.
455 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
456 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
458 =head1 COPYRIGHT AND LICENSE
460 Copyright 2008-2009 Infinity Interactive, Inc.
462 http://www.iinteractive.com/
464 This program is free software; you can redistribute it and/or modify it
465 under the same terms as Perl itself.