lib/Mouse.pm

   1 package Mouse;
   2 use 5.006_002;
   3
   4 use Mouse::Exporter; # enables strict and warnings
   5
   6 our $VERSION = '0.92';
   7
   8 use Carp         ();
   9 use Scalar::Util ();
  10
  11 use Mouse::Util ();
  12
  13 use Mouse::Meta::Module;
  14 use Mouse::Meta::Class;
  15 use Mouse::Meta::Role;
  16 use Mouse::Meta::Attribute;
  17 use Mouse::Object;
  18 use Mouse::Util::TypeConstraints ();
  19
  20 Mouse::Exporter->setup_import_methods(
  21     as_is => [qw(
  22         extends with
  23         has
  24         before after around
  25         override super
  26         augment  inner
  27     ),
  28         \&Scalar::Util::blessed,
  29         \&Carp::confess,
  30    ],
  31 );
  32
  33
  34 sub extends {
  35     Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_);
  36     return;
  37 }
  38
  39 sub with {
  40     Mouse::Util::apply_all_roles(scalar(caller), @_);
  41     return;
  42 }
  43
  44 sub has {
  45     my $meta = Mouse::Meta::Class->initialize(scalar caller);
  46     my $name = shift;
  47
  48     $meta->throw_error(q{Usage: has 'name' => ( key => value, ... )})
  49         if @_ % 2; # odd number of arguments
  50
  51     for my $n(ref($name) ? @{$name} : $name){
  52         $meta->add_attribute($n => @_);
  53     }
  54     return;
  55 }
  56
  57 sub before {
  58     my $meta = Mouse::Meta::Class->initialize(scalar caller);
  59     my $code = pop;
  60     for my $name($meta->_collect_methods(@_)) {
  61         $meta->add_before_method_modifier($name => $code);
  62     }
  63     return;
  64 }
  65
  66 sub after {
  67     my $meta = Mouse::Meta::Class->initialize(scalar caller);
  68     my $code = pop;
  69     for my $name($meta->_collect_methods(@_)) {
  70         $meta->add_after_method_modifier($name => $code);
  71     }
  72     return;
  73 }
  74
  75 sub around {
  76     my $meta = Mouse::Meta::Class->initialize(scalar caller);
  77     my $code = pop;
  78     for my $name($meta->_collect_methods(@_)) {
  79         $meta->add_around_method_modifier($name => $code);
  80     }
  81     return;
  82 }
  83
  84 our $SUPER_PACKAGE;
  85 our $SUPER_BODY;
  86 our @SUPER_ARGS;
  87
  88 sub super {
  89     # This check avoids a recursion loop - see
  90     # t/100_bugs/020_super_recursion.t
  91     return if  defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
  92     return if !defined $SUPER_BODY;
  93     $SUPER_BODY->(@SUPER_ARGS);
  94 }
  95
  96 sub override {
  97     # my($name, $method) = @_;
  98     Mouse::Meta::Class->initialize(scalar caller)->add_override_method_modifier(@_);
  99 }
 100
 101 our %INNER_BODY;
 102 our %INNER_ARGS;
 103
 104 sub inner {
 105     my $pkg = caller();
 106     if ( my $body = $INNER_BODY{$pkg} ) {
 107         my $args = $INNER_ARGS{$pkg};
 108         local $INNER_ARGS{$pkg};
 109         local $INNER_BODY{$pkg};
 110         return $body->(@{$args});
 111     }
 112     else {
 113         return;
 114     }
 115 }
 116
 117 sub augment {
 118     #my($name, $method) = @_;
 119     Mouse::Meta::Class->initialize(scalar caller)->add_augment_method_modifier(@_);
 120     return;
 121 }
 122
 123 sub init_meta {
 124     shift;
 125     my %args = @_;
 126
 127     my $class = $args{for_class}
 128         or confess("Cannot call init_meta without specifying a for_class");
 129
 130     my $base_class = $args{base_class} || 'Mouse::Object';
 131     my $metaclass  = $args{metaclass}  || 'Mouse::Meta::Class';
 132
 133     my $meta = $metaclass->initialize($class);
 134
 135     $meta->add_method(meta => sub{
 136         return $metaclass->initialize(ref($_[0]) || $_[0]);
 137     });
 138
 139     $meta->superclasses($base_class)
 140         unless $meta->superclasses;
 141
 142     # make a class type for each Mouse class
 143     Mouse::Util::TypeConstraints::class_type($class)
 144         unless Mouse::Util::TypeConstraints::find_type_constraint($class);
 145
 146     return $meta;
 147 }
 148
 149 1;
 150 __END__
 151
 152 =head1 NAME
 153
 154 Mouse - Moose minus the antlers
 155
 156 =head1 VERSION
 157
 158 This document describes Mouse version 0.92
 159
 160 =head1 SYNOPSIS
 161
 162     package Point;
 163     use Mouse; # automatically turns on strict and warnings
 164
 165     has 'x' => (is => 'rw', isa => 'Int');
 166     has 'y' => (is => 'rw', isa => 'Int');
 167
 168     sub clear {
 169         my $self = shift;
 170         $self->x(0);
 171         $self->y(0);
 172     }
 173
 174
 175     __PACKAGE__->meta->make_immutable();
 176
 177     package Point3D;
 178     use Mouse;
 179
 180     extends 'Point';
 181
 182     has 'z' => (is => 'rw', isa => 'Int');
 183
 184     after 'clear' => sub {
 185         my $self = shift;
 186         $self->z(0);
 187     };
 188
 189     __PACKAGE__->meta->make_immutable();
 190
 191 =head1 DESCRIPTION
 192
 193 L<Moose|Moose> is a postmodern object system for Perl5. Moose is wonderful.
 194
 195 Unfortunately, Moose has a compile-time penalty. Though significant progress
 196 has been made over the years, the compile time penalty is a non-starter for
 197 some very specific applications. If you are writing a command-line application
 198 or CGI script where startup time is essential, you may not be able to use
 199 Moose (we recommend that you instead use persistent Perl executing environments
 200 like C<FastCGI> for the latter, if possible).
 201
 202 Mouse is a Moose compatible object system, which aims to alleviate this penalty
 203 by providing a subset of Moose's functionality.
 204
 205 We're also going as light on dependencies as possible. Mouse currently has
 206 B<no dependencies> except for building/testing modules. Mouse also works
 207 without XS, although it has an XS backend to make it much faster.
 208
 209 =head2 Moose Compatibility
 210
 211 Compatibility with Moose has been the utmost concern. The sugary interface is
 212 highly compatible with Moose. Even the error messages are taken from Moose.
 213 The Mouse code just runs its test suite 4x faster.
 214
 215 The idea is that, if you need the extra power, you should be able to run
 216 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
 217 we have written L<Any::Moose|Any::Moose> which will act as Mouse unless Moose is loaded,
 218 in which case it will act as Moose. Since Mouse is a little sloppier than
 219 Moose, if you run into weird errors, it would be worth running:
 220
 221     ANY_MOOSE=Moose perl your-script.pl
 222
 223 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
 224 also better.
 225
 226 See also L<Mouse::Spec> for compatibility and incompatibility with Moose.
 227
 228 =head2 Mouse Extentions
 229
 230 Please don't copy MooseX code to MouseX. If you need extensions, you really
 231 should upgrade to Moose. We don't need two parallel sets of extensions!
 232
 233 If you really must write a Mouse extension, please contact the Moose mailing
 234 list or #moose on IRC beforehand.
 235
 236 =head1 KEYWORDS
 237
 238 =head2 C<< $object->meta -> Mouse::Meta::Class >>
 239
 240 Returns this class' metaclass instance.
 241
 242 =head2 C<< extends superclasses >>
 243
 244 Sets this class' superclasses.
 245
 246 =head2 C<< before (method|methods|regexp) => CodeRef >>
 247
 248 Installs a "before" method modifier. See L<Moose/before>.
 249
 250 =head2 C<< after (method|methods|regexp) => CodeRef >>
 251
 252 Installs an "after" method modifier. See L<Moose/after>.
 253
 254 =head2 C<< around (method|methods|regexp) => CodeRef >>
 255
 256 Installs an "around" method modifier. See L<Moose/around>.
 257
 258 =head2 C<< has (name|names) => parameters >>
 259
 260 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
 261 this class. Options:
 262
 263 =over 4
 264
 265 =item C<< is => ro|rw|bare >>
 266
 267 The I<is> option accepts either I<rw> (for read/write), I<ro> (for read
 268 only) or I<bare> (for nothing). These will create either a read/write accessor
 269 or a read-only accessor respectively, using the same name as the C<$name> of
 270 the attribute.
 271
 272 If you need more control over how your accessors are named, you can
 273 use the C<reader>, C<writer> and C<accessor> options, however if you
 274 use those, you won't need the I<is> option.
 275
 276 =item C<< isa => TypeName | ClassName >>
 277
 278 Provides type checking in the constructor and accessor. The following types are
 279 supported. Any unknown type is taken to be a class check
 280 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
 281
 282     Any Item Bool Undef Defined Value Num Int Str ClassName
 283     Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
 284     FileHandle Object
 285
 286 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
 287
 288 =item C<< does => RoleName >>
 289
 290 This will accept the name of a role which the value stored in this attribute
 291 is expected to have consumed.
 292
 293 =item C<< coerce => Bool >>
 294
 295 This will attempt to use coercion with the supplied type constraint to change
 296 the value passed into any accessors or constructors. You B<must> have supplied
 297 a type constraint in order for this to work. See L<Moose::Cookbook::Basics::Recipe5>
 298 for an example.
 299
 300 =item C<< required => Bool >>
 301
 302 Whether this attribute is required to have a value. If the attribute is lazy or
 303 has a builder, then providing a value for the attribute in the constructor is
 304 optional.
 305
 306 =item C<< init_arg => Str | Undef >>
 307
 308 Allows you to use a different key name in the constructor.  If undef, the
 309 attribute can't be passed to the constructor.
 310
 311 =item C<< default => Value | CodeRef >>
 312
 313 Sets the default value of the attribute. If the default is a coderef, it will
 314 be invoked to get the default value. Due to quirks of Perl, any bare reference
 315 is forbidden, you must wrap the reference in a coderef. Otherwise, all
 316 instances will share the same reference.
 317
 318 =item C<< lazy => Bool >>
 319
 320 If specified, the default is calculated on demand instead of in the
 321 constructor.
 322
 323 =item C<< predicate => Str >>
 324
 325 Lets you specify a method name for installing a predicate method, which checks
 326 that the attribute has a value. It will not invoke a lazy default or builder
 327 method.
 328
 329 =item C<< clearer => Str >>
 330
 331 Lets you specify a method name for installing a clearer method, which clears
 332 the attribute's value from the instance. On the next read, lazy or builder will
 333 be invoked.
 334
 335 =item C<< handles => HashRef|ArrayRef|Regexp >>
 336
 337 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
 338 given method names to method calls on the attribute. HashRef maps local method
 339 names to remote method names called on the attribute. Other forms of
 340 L</handles>, such as RoleName and CodeRef, are not yet supported.
 341
 342 =item C<< weak_ref => Bool >>
 343
 344 Lets you automatically weaken any reference stored in the attribute.
 345
 346 Use of this feature requires L<Scalar::Util>!
 347
 348 =item C<< trigger => CodeRef >>
 349
 350 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.
 351
 352 =item C<< builder => Str >>
 353
 354 Defines a method name to be called to provide the default value of the
 355 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
 356 C<< default => sub { $_[0]->build_foo } >>.
 357
 358 =item C<< auto_deref => Bool >>
 359
 360 Allows you to automatically dereference ArrayRef and HashRef attributes in list
 361 context. In scalar context, the reference is returned (NOT the list length or
 362 bucket status). You must specify an appropriate type constraint to use
 363 auto_deref.
 364
 365 =item C<< lazy_build => Bool >>
 366
 367 Automatically define the following options:
 368
 369     has $attr => (
 370         # ...
 371         lazy      => 1
 372         builder   => "_build_$attr",
 373         clearer   => "clear_$attr",
 374         predicate => "has_$attr",
 375     );
 376
 377 =back
 378
 379 =head2 C<< confess(message) -> BOOM >>
 380
 381 L<Carp/confess> for your convenience.
 382
 383 =head2 C<< blessed(value) -> ClassName | undef >>
 384
 385 L<Scalar::Util/blessed> for your convenience.
 386
 387 =head1 MISC
 388
 389 =head2 import
 390
 391 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
 392 You may use L</extends> to replace the superclass list.
 393
 394 =head2 unimport
 395
 396 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
 397 keywords (such as L</extends>) it will break loudly instead breaking subtly.
 398
 399 =head1 SOURCE CODE ACCESS
 400
 401 We have a public git repository:
 402
 403  git clone git://git.moose.perl.org/Mouse.git
 404
 405 =head1 DEPENDENCIES
 406
 407 Perl 5.6.2 or later.
 408
 409 =head1 SEE ALSO
 410
 411 L<Mouse::Role>
 412
 413 L<Mouse::Spec>
 414
 415 L<Moose>
 416
 417 L<Moose::Manual>
 418
 419 L<Moose::Cookbook>
 420
 421 L<Class::MOP>
 422
 423 =head1 AUTHORS
 424
 425 Shawn M Moore E<lt>sartak at gmail.comE<gt>
 426
 427 Yuval Kogman E<lt>nothingmuch at woobling.orgE<gt>
 428
 429 tokuhirom
 430
 431 Yappo
 432
 433 wu-lee
 434
 435 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
 436
 437 with plenty of code borrowed from L<Class::MOP> and L<Moose>
 438
 439 =head1 BUGS
 440
 441 All complex software has bugs lurking in it, and this module is no exception.
 442 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
 443 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
 444
 445 =head1 COPYRIGHT AND LICENSE
 446
 447 Copyright (c) 2008-2010 Infinity Interactive, Inc.
 448
 449 http://www.iinteractive.com/
 450
 451 This program is free software; you can redistribute it and/or modify it
 452 under the same terms as Perl itself.
 453
 454 =cut
 455