lib/Moose.pm

   1
   2 package Moose;
   3
   4 use strict;
   5 use warnings;
   6
   7 our $VERSION = '0.13';
   8
   9 use Scalar::Util 'blessed', 'reftype';
  10 use Carp         'confess';
  11 use Sub::Name    'subname';
  12 use B            'svref_2object';
  13
  14 use Sub::Exporter;
  15
  16 use Class::MOP;
  17
  18 use Moose::Meta::Class;
  19 use Moose::Meta::TypeConstraint;
  20 use Moose::Meta::TypeCoercion;
  21 use Moose::Meta::Attribute;
  22 use Moose::Meta::Instance;
  23
  24 use Moose::Object;
  25 use Moose::Util::TypeConstraints;
  26
  27 {
  28     my $CALLER;
  29
  30     sub _init_meta {
  31         my $class = $CALLER;
  32
  33         # make a subtype for each Moose class
  34         subtype $class
  35             => as 'Object'
  36             => where { $_->isa($class) }
  37         unless find_type_constraint($class);
  38
  39         my $meta;
  40         if ($class->can('meta')) {
  41             # NOTE:
  42             # this is the case where the metaclass pragma
  43             # was used before the 'use Moose' statement to
  44             # override a specific class
  45             $meta = $class->meta();
  46             (blessed($meta) && $meta->isa('Moose::Meta::Class'))
  47                 || confess "You already have a &meta function, but it does not return a Moose::Meta::Class";
  48         }
  49         else {
  50             # NOTE:
  51             # this is broken currently, we actually need
  52             # to allow the possiblity of an inherited
  53             # meta, which will not be visible until the
  54             # user 'extends' first. This needs to have
  55             # more intelligence to it
  56             $meta = Moose::Meta::Class->initialize($class);
  57             $meta->add_method('meta' => sub {
  58                 # re-initialize so it inherits properly
  59                 Moose::Meta::Class->initialize(blessed($_[0]) || $_[0]);
  60             })
  61         }
  62
  63         # make sure they inherit from Moose::Object
  64         $meta->superclasses('Moose::Object')
  65            unless $meta->superclasses();
  66     }
  67
  68     my %exports = (
  69         extends => sub {
  70             my $class = $CALLER;
  71             return subname 'Moose::extends' => sub (@) {
  72                 confess "Must derive at least one class" unless @_;
  73                 _load_all_classes(@_);
  74                 # this checks the metaclass to make sure
  75                 # it is correct, sometimes it can get out
  76                 # of sync when the classes are being built
  77                 my $meta = $class->meta->_fix_metaclass_incompatability(@_);
  78                 $meta->superclasses(@_);
  79             };
  80         },
  81         with => sub {
  82             my $class = $CALLER;
  83             return subname 'Moose::with' => sub (@) {
  84                 my (@roles) = @_;
  85                 confess "Must specify at least one role" unless @roles;
  86                 _load_all_classes(@roles);
  87                 $class->meta->_apply_all_roles(@roles);
  88             };
  89         },
  90         has => sub {
  91             my $class = $CALLER;
  92             return subname 'Moose::has' => sub ($;%) {
  93                 my ($name, %options) = @_;
  94                 $class->meta->_process_attribute($name, %options);
  95             };
  96         },
  97         before => sub {
  98             my $class = $CALLER;
  99             return subname 'Moose::before' => sub (@&) {
 100                 my $code = pop @_;
 101                 my $meta = $class->meta;
 102                 $meta->add_before_method_modifier($_, $code) for @_;
 103             };
 104         },
 105         after => sub {
 106             my $class = $CALLER;
 107             return subname 'Moose::after' => sub (@&) {
 108                 my $code = pop @_;
 109                 my $meta = $class->meta;
 110                 $meta->add_after_method_modifier($_, $code) for @_;
 111             };
 112         },
 113         around => sub {
 114             my $class = $CALLER;
 115             return subname 'Moose::around' => sub (@&) {
 116                 my $code = pop @_;
 117                 my $meta = $class->meta;
 118                 $meta->add_around_method_modifier($_, $code) for @_;
 119             };
 120         },
 121         super => sub {
 122             return subname 'Moose::super' => sub {};
 123         },
 124         override => sub {
 125             my $class = $CALLER;
 126             return subname 'Moose::override' => sub ($&) {
 127                 my ($name, $method) = @_;
 128                 $class->meta->add_override_method_modifier($name => $method);
 129             };
 130         },
 131         inner => sub {
 132             return subname 'Moose::inner' => sub {};
 133         },
 134         augment => sub {
 135             my $class = $CALLER;
 136             return subname 'Moose::augment' => sub (@&) {
 137                 my ($name, $method) = @_;
 138                 $class->meta->add_augment_method_modifier($name => $method);
 139             };
 140         },
 141
 142         # NOTE:
 143         # this is experimental for now ...
 144         self => sub {
 145             return subname 'Moose::self' => sub {};
 146         },
 147         method => sub {
 148             my $class = $CALLER;
 149             return subname 'Moose::method' => sub {
 150                 my ($name, $method) = @_;
 151                 $class->meta->add_method($name, sub {
 152                     my $self = shift;
 153                     no strict   'refs';
 154                     no warnings 'redefine';
 155                     local *{$class->meta->name . '::self'} = sub { $self };
 156                     $method->(@_);
 157                 });
 158             };
 159         },
 160
 161         confess => sub {
 162             return \&Carp::confess;
 163         },
 164         blessed => sub {
 165             return \&Scalar::Util::blessed;
 166         },
 167     );
 168
 169     my $exporter = Sub::Exporter::build_exporter({
 170         exports => \%exports,
 171         groups  => {
 172             default => [':all']
 173         }
 174     });
 175
 176     sub import {
 177         $CALLER = caller();
 178
 179         strict->import;
 180         warnings->import;
 181
 182         # we should never export to main
 183         return if $CALLER eq 'main';
 184
 185         _init_meta();
 186
 187         goto $exporter;
 188     }
 189
 190     sub unimport {
 191         no strict 'refs';
 192         my $class = caller();
 193         # loop through the exports ...
 194         foreach my $name (keys %exports) {
 195             next if $name =~ /inner|super|self/;
 196
 197             # if we find one ...
 198             if (defined &{$class . '::' . $name}) {
 199                 my $keyword = \&{$class . '::' . $name};
 200
 201                 # make sure it is from Moose
 202                 my $pkg_name = eval { svref_2object($keyword)->GV->STASH->NAME };
 203                 next if $@;
 204                 next if $pkg_name ne 'Moose';
 205
 206                 # and if it is from Moose then undef the slot
 207                 delete ${$class . '::'}{$name};
 208             }
 209         }
 210     }
 211 }
 212
 213 ## Utility functions
 214
 215 sub _load_all_classes {
 216     foreach my $super (@_) {
 217         # see if this is already
 218         # loaded in the symbol table
 219         next if _is_class_already_loaded($super);
 220         # otherwise require it ...
 221         # NOTE:
 222         # just in case the class we are
 223         # loading has a locally defined
 224         # &require, we make sure that we
 225         # use the on in UNIVERSAL
 226         my $file = $class . '.pm';
 227         $file =~ s{::}{/}g;
 228         eval { CORE::require($file) };
 229         confess(
 230             "Could not load module '$super' because : $@"
 231             ) if $@;
 232     }
 233 }
 234
 235 sub _is_class_already_loaded {
 236         my $name = shift;
 237         no strict 'refs';
 238         return 1 if defined ${"${name}::VERSION"} || defined @{"${name}::ISA"};
 239         foreach (keys %{"${name}::"}) {
 240                 next if substr($_, -2, 2) eq '::';
 241                 return 1 if defined &{"${name}::$_"};
 242         }
 243         return 0;
 244 }
 245
 246 1;
 247
 248 __END__
 249
 250 =pod
 251
 252 =head1 NAME
 253
 254 Moose - A complete modern object system for Perl 5
 255
 256 =head1 SYNOPSIS
 257
 258   package Point;
 259   use strict;
 260   use warnings;
 261   use Moose;
 262
 263   has 'x' => (is => 'rw', isa => 'Int');
 264   has 'y' => (is => 'rw', isa => 'Int');
 265
 266   sub clear {
 267       my $self = shift;
 268       $self->x(0);
 269       $self->y(0);
 270   }
 271
 272   package Point3D;
 273   use strict;
 274   use warnings;
 275   use Moose;
 276
 277   extends 'Point';
 278
 279   has 'z' => (is => 'rw', isa => 'Int');
 280
 281   after 'clear' => sub {
 282       my $self = shift;
 283       $self->z(0);
 284   };
 285
 286 =head1 CAVEAT
 287
 288 Moose is a rapidly maturing module, and is already being used by
 289 a number of people. It's test suite is growing larger by the day,
 290 and the docs should soon follow.
 291
 292 This said, Moose is not yet finished, and should still be considered
 293 to be evolving. Much of the outer API is stable, but the internals
 294 are still subject to change (although not without serious thought
 295 given to it).
 296
 297 For more details, please refer to the L<FUTURE PLANS> section of
 298 this document.
 299
 300 =head1 DESCRIPTION
 301
 302 Moose is an extension of the Perl 5 object system.
 303
 304 =head2 Another object system!?!?
 305
 306 Yes, I know there has been an explosion recently of new ways to
 307 build object's in Perl 5, most of them based on inside-out objects
 308 and other such things. Moose is different because it is not a new
 309 object system for Perl 5, but instead an extension of the existing
 310 object system.
 311
 312 Moose is built on top of L<Class::MOP>, which is a metaclass system
 313 for Perl 5. This means that Moose not only makes building normal
 314 Perl 5 objects better, but it also provides the power of metaclass
 315 programming.
 316
 317 =head2 Can I use this in production? Or is this just an experiment?
 318
 319 Moose is I<based> on the prototypes and experiments I did for the Perl 6
 320 meta-model; however Moose is B<NOT> an experiment/prototype, it is
 321 for B<real>. I will be deploying Moose into production environments later
 322 this year, and I have every intentions of using it as my de facto class
 323 builder from now on.
 324
 325 =head2 Is Moose just Perl 6 in Perl 5?
 326
 327 No. While Moose is very much inspired by Perl 6, it is not itself Perl 6.
 328 Instead, it is an OO system for Perl 5. I built Moose because I was tired or
 329 writing the same old boring Perl 5 OO code, and drooling over Perl 6 OO. So
 330 instead of switching to Ruby, I wrote Moose :)
 331
 332 =head1 BUILDING CLASSES WITH MOOSE
 333
 334 Moose makes every attempt to provide as much convenience as possible during
 335 class construction/definition, but still stay out of your way if you want it
 336 to. Here are a few items to note when building classes with Moose.
 337
 338 Unless specified with C<extends>, any class which uses Moose will
 339 inherit from L<Moose::Object>.
 340
 341 Moose will also manage all attributes (including inherited ones) that
 342 are defined with C<has>. And assuming that you call C<new>, which is
 343 inherited from L<Moose::Object>, then this includes properly initializing
 344 all instance slots, setting defaults where appropriate, and performing any
 345 type constraint checking or coercion.
 346
 347 =head1 EXPORTED FUNCTIONS
 348
 349 Moose will export a number of functions into the class's namespace which
 350 can then be used to set up the class. These functions all work directly
 351 on the current class.
 352
 353 =over 4
 354
 355 =item B<meta>
 356
 357 This is a method which provides access to the current class's metaclass.
 358
 359 =item B<extends (@superclasses)>
 360
 361 This function will set the superclass(es) for the current class.
 362
 363 This approach is recommended instead of C<use base>, because C<use base>
 364 actually C<push>es onto the class's C<@ISA>, whereas C<extends> will
 365 replace it. This is important to ensure that classes which do not have
 366 superclasses still properly inherit from L<Moose::Object>.
 367
 368 =item B<with (@roles)>
 369
 370 This will apply a given set of C<@roles> to the local class. Role support
 371 is currently under heavy development; see L<Moose::Role> for more details.
 372
 373 =item B<has ($name, %options)>
 374
 375 This will install an attribute of a given C<$name> into the current class.
 376 The list of C<%options> are the same as those provided by
 377 L<Class::MOP::Attribute>, in addition to the list below which are provided
 378 by Moose (L<Moose::Meta::Attribute> to be more specific):
 379
 380 =over 4
 381
 382 =item I<is =E<gt> 'rw'|'ro'>
 383
 384 The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read
 385 only). These will create either a read/write accessor or a read-only
 386 accessor respectively, using the same name as the C<$name> of the attribute.
 387
 388 If you need more control over how your accessors are named, you can use the
 389 I<reader>, I<writer> and I<accessor> options inherited from L<Class::MOP::Attribute>.
 390
 391 =item I<isa =E<gt> $type_name>
 392
 393 The I<isa> option uses Moose's type constraint facilities to set up runtime
 394 type checking for this attribute. Moose will perform the checks during class
 395 construction, and within any accessors. The C<$type_name> argument must be a
 396 string. The string can be either a class name or a type defined using
 397 Moose's type definition features.
 398
 399 =item I<coerce =E<gt> (1|0)>
 400
 401 This will attempt to use coercion with the supplied type constraint to change
 402 the value passed into any accessors or constructors. You B<must> have supplied
 403 a type constraint in order for this to work. See L<Moose::Cookbook::Recipe5>
 404 for an example usage.
 405
 406 =item I<does =E<gt> $role_name>
 407
 408 This will accept the name of a role which the value stored in this attribute
 409 is expected to have consumed.
 410
 411 =item I<required =E<gt> (1|0)>
 412
 413 This marks the attribute as being required. This means a value must be supplied
 414 during class construction, and the attribute can never be set to C<undef> with
 415 an accessor.
 416
 417 =item I<weak_ref =E<gt> (1|0)>
 418
 419 This will tell the class to store the value of this attribute as a weakened
 420 reference. If an attribute is a weakened reference, it B<cannot> also be
 421 coerced.
 422
 423 =item I<lazy =E<gt> (1|0)>
 424
 425 This will tell the class to not create this slot until absolutely necessary.
 426 If an attribute is marked as lazy it B<must> have a default supplied.
 427
 428 =item I<auto_deref =E<gt> (1|0)>
 429
 430 This tells the accessor whether to automatically dereference the value returned.
 431 This is only legal if your C<isa> option is either an C<ArrayRef> or C<HashRef>.
 432
 433 =item I<trigger =E<gt> $code>
 434
 435 The trigger option is a CODE reference which will be called after the value of
 436 the attribute is set. The CODE ref will be passed the instance itself, the
 437 updated value and the attribute meta-object (this is for more advanced fiddling
 438 and can typically be ignored in most cases). You B<cannot> have a trigger on
 439 a read-only attribute.
 440
 441 =item I<handles =E<gt> [ @handles ]>
 442
 443 There is experimental support for attribute delegation using the C<handles>
 444 option. More docs to come later.
 445
 446 =back
 447
 448 =item B<before $name|@names =E<gt> sub { ... }>
 449
 450 =item B<after $name|@names =E<gt> sub { ... }>
 451
 452 =item B<around $name|@names =E<gt> sub { ... }>
 453
 454 This three items are syntactic sugar for the before, after, and around method
 455 modifier features that L<Class::MOP> provides. More information on these can
 456 be found in the L<Class::MOP> documentation for now.
 457
 458 =item B<super>
 459
 460 The keyword C<super> is a no-op when called outside of an C<override> method. In
 461 the context of an C<override> method, it will call the next most appropriate
 462 superclass method with the same arguments as the original method.
 463
 464 =item B<override ($name, &sub)>
 465
 466 An C<override> method is a way of explicitly saying "I am overriding this
 467 method from my superclass". You can call C<super> within this method, and
 468 it will work as expected. The same thing I<can> be accomplished with a normal
 469 method call and the C<SUPER::> pseudo-package; it is really your choice.
 470
 471 =item B<inner>
 472
 473 The keyword C<inner>, much like C<super>, is a no-op outside of the context of
 474 an C<augment> method. You can think of C<inner> as being the inverse of
 475 C<super>; the details of how C<inner> and C<augment> work is best described in
 476 the L<Moose::Cookbook>.
 477
 478 =item B<augment ($name, &sub)>
 479
 480 An C<augment> method, is a way of explicitly saying "I am augmenting this
 481 method from my superclass". Once again, the details of how C<inner> and
 482 C<augment> work is best described in the L<Moose::Cookbook>.
 483
 484 =item B<confess>
 485
 486 This is the C<Carp::confess> function, and exported here because I use it
 487 all the time. This feature may change in the future, so you have been warned.
 488
 489 =item B<blessed>
 490
 491 This is the C<Scalar::Uti::blessed> function, it is exported here because I
 492 use it all the time. It is highly recommended that this is used instead of
 493 C<ref> anywhere you need to test for an object's class name.
 494
 495 =back
 496
 497 =head1 UNEXPORTING FUNCTIONS
 498
 499 =head2 B<unimport>
 500
 501 Moose offers a way of removing the keywords it exports though the C<unimport>
 502 method. You simply have to say C<no Moose> at the bottom of your code for this
 503 to work. Here is an example:
 504
 505     package Person;
 506     use Moose;
 507
 508     has 'first_name' => (is => 'rw', isa => 'Str');
 509     has 'last_name'  => (is => 'rw', isa => 'Str');
 510
 511     sub full_name {
 512         my $self = shift;
 513         $self->first_name . ' ' . $self->last_name
 514     }
 515
 516     no Moose; # keywords are removed from the Person package
 517
 518 =head1 MISC.
 519
 520 =head2 What does Moose stand for??
 521
 522 Moose doesn't stand for one thing in particular, however, if you
 523 want, here are a few of my favorites; feel free to contribute
 524 more :)
 525
 526 =over 4
 527
 528 =item Make Other Object Systems Envious
 529
 530 =item Makes Object Orientation So Easy
 531
 532 =item Makes Object Orientation Spiffy- Er  (sorry ingy)
 533
 534 =item Most Other Object Systems Emasculate
 535
 536 =item Moose Often Ovulate Sorta Early
 537
 538 =item Moose Offers Often Super Extensions
 539
 540 =item Meta Object Orientation Syntax Extensions
 541
 542 =back
 543
 544 =head1 CAVEATS
 545
 546 =over 4
 547
 548 =item *
 549
 550 It should be noted that C<super> and C<inner> C<cannot> be used in the same
 551 method. However, they can be combined together with the same class hierarchy;
 552 see F<t/014_override_augment_inner_super.t> for an example.
 553
 554 The reason for this is that C<super> is only valid within a method
 555 with the C<override> modifier, and C<inner> will never be valid within an
 556 C<override> method. In fact, C<augment> will skip over any C<override> methods
 557 when searching for its appropriate C<inner>.
 558
 559 This might seem like a restriction, but I am of the opinion that keeping these
 560 two features separate (but interoperable) actually makes them easy to use, since
 561 their behavior is then easier to predict. Time will tell if I am right or not.
 562
 563 =back
 564
 565 =head1 ACKNOWLEDGEMENTS
 566
 567 =over 4
 568
 569 =item I blame Sam Vilain for introducing me to the insanity that is meta-models.
 570
 571 =item I blame Audrey Tang for then encouraging my meta-model habit in #perl6.
 572
 573 =item Without Yuval "nothingmuch" Kogman this module would not be possible,
 574 and it certainly wouldn't have this name ;P
 575
 576 =item The basis of the TypeContraints module was Rob Kinyon's idea
 577 originally, I just ran with it.
 578
 579 =item Thanks to mst & chansen and the whole #moose poose for all the
 580 ideas/feature-requests/encouragement
 581
 582 =item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes.
 583
 584 =back
 585
 586 =head1 SEE ALSO
 587
 588 =over 4
 589
 590 =item L<Class::MOP> documentation
 591
 592 =item The #moose channel on irc.perl.org
 593
 594 =item The Moose mailing list - moose@perl.org
 595
 596 =item L<http://forum2.org/moose/>
 597
 598 =item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf>
 599
 600 This paper (suggested by lbr on #moose) was what lead to the implementation
 601 of the C<super>/C<overrride> and C<inner>/C<augment> features. If you really
 602 want to understand this feature, I suggest you read this.
 603
 604 =back
 605
 606 =head1 BUGS
 607
 608 All complex software has bugs lurking in it, and this module is no
 609 exception. If you find a bug please either email me, or add the bug
 610 to cpan-RT.
 611
 612 =head1 AUTHOR
 613
 614 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 615
 616 Christian Hansen E<lt>chansen@cpan.orgE<gt>
 617
 618 Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
 619
 620 =head1 COPYRIGHT AND LICENSE
 621
 622 Copyright 2006 by Infinity Interactive, Inc.
 623
 624 L<http://www.iinteractive.com>
 625
 626 This library is free software; you can redistribute it and/or modify
 627 it under the same terms as Perl itself.
 628
 629 =cut