X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose.pm;h=a4e670b6c5deb3ac7bfde2159b458bc4fdb9a561;hb=c84f324f828ad00e6ccf2ace23d56d6bedecdfa3;hp=80204a9bc6b9e79b62ee058fe056a98de9e0edbc;hpb=e95c7c42186441314d04af44f7e65562772d9d83;p=gitmo%2FMoose.git diff --git a/lib/Moose.pm b/lib/Moose.pm index 80204a9..a4e670b 100644 --- a/lib/Moose.pm +++ b/lib/Moose.pm @@ -4,17 +4,17 @@ package Moose; use strict; use warnings; -our $VERSION = '0.13'; +our $VERSION = '0.24'; +our $AUTHORITY = 'cpan:STEVAN'; use Scalar::Util 'blessed', 'reftype'; use Carp 'confess'; use Sub::Name 'subname'; use B 'svref_2object'; -use UNIVERSAL::require; use Sub::Exporter; -use Class::MOP; +use Class::MOP 0.39; use Moose::Meta::Class; use Moose::Meta::TypeConstraint; @@ -35,6 +35,7 @@ use Moose::Util::TypeConstraints; subtype $class => as 'Object' => where { $_->isa($class) } + => optimize_as { blessed($_[0]) && $_[0]->isa($class) } unless find_type_constraint($class); my $meta; @@ -71,7 +72,7 @@ use Moose::Util::TypeConstraints; my $class = $CALLER; return subname 'Moose::extends' => sub (@) { confess "Must derive at least one class" unless @_; - _load_all_classes(@_); + Class::MOP::load_class($_) for @_; # this checks the metaclass to make sure # it is correct, sometimes it can get out # of sync when the classes are being built @@ -84,15 +85,16 @@ use Moose::Util::TypeConstraints; return subname 'Moose::with' => sub (@) { my (@roles) = @_; confess "Must specify at least one role" unless @roles; - _load_all_classes(@roles); + Class::MOP::load_class($_) for @roles; $class->meta->_apply_all_roles(@roles); }; }, has => sub { my $class = $CALLER; return subname 'Moose::has' => sub ($;%) { - my ($name, %options) = @_; - $class->meta->_process_attribute($name, %options); + my ($name, %options) = @_; + my $attrs = (ref($name) eq 'ARRAY') ? $name : [($name)]; + $class->meta->_process_attribute($_, %options) for @$attrs; }; }, before => sub { @@ -120,6 +122,11 @@ use Moose::Util::TypeConstraints; }; }, super => sub { + { + our %SUPER_SLOT; + no strict 'refs'; + $SUPER_SLOT{$CALLER} = \*{"${CALLER}::super"}; + } return subname 'Moose::super' => sub {}; }, override => sub { @@ -130,6 +137,11 @@ use Moose::Util::TypeConstraints; }; }, inner => sub { + { + our %INNER_SLOT; + no strict 'refs'; + $INNER_SLOT{$CALLER} = \*{"${CALLER}::inner"}; + } return subname 'Moose::inner' => sub {}; }, augment => sub { @@ -141,23 +153,29 @@ use Moose::Util::TypeConstraints; }, # NOTE: - # this is experimental for now ... - self => sub { - return subname 'Moose::self' => sub {}; - }, - method => sub { - my $class = $CALLER; - return subname 'Moose::method' => sub { - my ($name, $method) = @_; - $class->meta->add_method($name, sub { - my $self = shift; - no strict 'refs'; - no warnings 'redefine'; - local *{$class->meta->name . '::self'} = sub { $self }; - $method->(@_); - }); - }; - }, + # this is experimental, but I am not + # happy with it. If you want to try + # it, you will have to uncomment it + # yourself. + # There is a really good chance that + # this will be deprecated, dont get + # too attached + # self => sub { + # return subname 'Moose::self' => sub {}; + # }, + # method => sub { + # my $class = $CALLER; + # return subname 'Moose::method' => sub { + # my ($name, $method) = @_; + # $class->meta->add_method($name, sub { + # my $self = shift; + # no strict 'refs'; + # no warnings 'redefine'; + # local *{$class->meta->name . '::self'} = sub { $self }; + # $method->(@_); + # }); + # }; + # }, confess => sub { return \&Carp::confess; @@ -193,7 +211,6 @@ use Moose::Util::TypeConstraints; my $class = caller(); # loop through the exports ... foreach my $name (keys %exports) { - next if $name =~ /inner|super|self/; # if we find one ... if (defined &{$class . '::' . $name}) { @@ -209,36 +226,29 @@ use Moose::Util::TypeConstraints; } } } + + } -## Utility functions - -sub _load_all_classes { - foreach my $super (@_) { - # see if this is already - # loaded in the symbol table - next if _is_class_already_loaded($super); - # otherwise require it ... - # NOTE: - # just in case the class we are - # loading has a locally defined - # &require, we make sure that we - # use the on in UNIVERSAL - ($super->UNIVERSAL::require) - || confess "Could not load module '$super' because : " . $UNIVERSAL::require::ERROR; - } -} +## make 'em all immutable -sub _is_class_already_loaded { - my $name = shift; - no strict 'refs'; - return 1 if defined ${"${name}::VERSION"} || defined @{"${name}::ISA"}; - foreach (keys %{"${name}::"}) { - next if substr($_, -2, 2) eq '::'; - return 1 if defined &{"${name}::$_"}; - } - return 0; -} +$_->meta->make_immutable( + inline_constructor => 0, + inline_accessors => 0, +) for ( + 'Moose::Meta::Attribute', + 'Moose::Meta::Class', + 'Moose::Meta::Instance', + + 'Moose::Meta::TypeConstraint', + 'Moose::Meta::TypeConstraint::Union', + 'Moose::Meta::TypeCoercion', + + 'Moose::Meta::Method', + 'Moose::Meta::Method::Accessor', + 'Moose::Meta::Method::Constructor', + 'Moose::Meta::Method::Overriden', +); 1; @@ -253,9 +263,7 @@ Moose - A complete modern object system for Perl 5 =head1 SYNOPSIS package Point; - use strict; - use warnings; - use Moose; + use Moose; # automatically turns on strict and warnings has 'x' => (is => 'rw', isa => 'Int'); has 'y' => (is => 'rw', isa => 'Int'); @@ -267,8 +275,6 @@ Moose - A complete modern object system for Perl 5 } package Point3D; - use strict; - use warnings; use Moose; extends 'Point'; @@ -278,21 +284,7 @@ Moose - A complete modern object system for Perl 5 after 'clear' => sub { my $self = shift; $self->z(0); - }; - -=head1 CAVEAT - -Moose is a rapidly maturing module, and is already being used by -a number of people. It's test suite is growing larger by the day, -and the docs should soon follow. - -This said, Moose is not yet finished, and should still be considered -to be evolving. Much of the outer API is stable, but the internals -are still subject to change (although not without serious thought -given to it). - -For more details, please refer to the L section of -this document. + }; =head1 DESCRIPTION @@ -311,18 +303,28 @@ for Perl 5. This means that Moose not only makes building normal Perl 5 objects better, but it also provides the power of metaclass programming. -=head2 Can I use this in production? Or is this just an experiment? +=head2 Is this for real? Or is this just an experiment? Moose is I on the prototypes and experiments I did for the Perl 6 -meta-model; however Moose is B an experiment/prototype, it is -for B. I will be deploying Moose into production environments later -this year, and I have every intentions of using it as my de facto class -builder from now on. +meta-model. However, Moose is B an experiment/prototype; it is for B. + +=head2 Is this ready for use in production? + +Yes, I believe that it is. + +I have two medium-to-large-ish web applications which use Moose heavily +and have been in production (without issue) for several months now. At +$work, we are re-writing our core offering in it. And several people on +#moose have been using it (in production) for several months now as well. + +Of course, in the end, you need to make this call yourself. If you have +any questions or concerns, please feel free to email me, or even the list +or just stop by #moose and ask away. =head2 Is Moose just Perl 6 in Perl 5? No. While Moose is very much inspired by Perl 6, it is not itself Perl 6. -Instead, it is an OO system for Perl 5. I built Moose because I was tired or +Instead, it is an OO system for Perl 5. I built Moose because I was tired of writing the same old boring Perl 5 OO code, and drooling over Perl 6 OO. So instead of switching to Ruby, I wrote Moose :) @@ -335,16 +337,16 @@ to. Here are a few items to note when building classes with Moose. Unless specified with C, any class which uses Moose will inherit from L. -Moose will also manage all attributes (including inherited ones) that -are defined with C. And assuming that you call C, which is -inherited from L, then this includes properly initializing -all instance slots, setting defaults where appropriate, and performing any -type constraint checking or coercion. +Moose will also manage all attributes (including inherited ones) that are +defined with C. And (assuming you call C, which is inherited from +L) this includes properly initializing all instance slots, +setting defaults where appropriate, and performing any type constraint checking +or coercion. =head1 EXPORTED FUNCTIONS Moose will export a number of functions into the class's namespace which -can then be used to set up the class. These functions all work directly +may then be used to set up the class. These functions all work directly on the current class. =over 4 @@ -367,10 +369,10 @@ superclasses still properly inherit from L. This will apply a given set of C<@roles> to the local class. Role support is currently under heavy development; see L for more details. -=item B +=item B %options> This will install an attribute of a given C<$name> into the current class. -The list of C<%options> are the same as those provided by +The C<%options> are the same as those provided by L, in addition to the list below which are provided by Moose (L to be more specific): @@ -382,15 +384,16 @@ The I option accepts either I (for read/write) or I (for read only). These will create either a read/write accessor or a read-only accessor respectively, using the same name as the C<$name> of the attribute. -If you need more control over how your accessors are named, you can use the -I, I and I options inherited from L. +If you need more control over how your accessors are named, you can use the +I, I and I options inherited from +L. =item I $type_name> The I option uses Moose's type constraint facilities to set up runtime type checking for this attribute. Moose will perform the checks during class construction, and within any accessors. The C<$type_name> argument must be a -string. The string can be either a class name or a type defined using +string. The string may be either a class name or a type defined using Moose's type definition features. =item I (1|0)> @@ -398,7 +401,7 @@ Moose's type definition features. This will attempt to use coercion with the supplied type constraint to change the value passed into any accessors or constructors. You B have supplied a type constraint in order for this to work. See L -for an example usage. +for an example. =item I $role_name> @@ -408,7 +411,7 @@ is expected to have consumed. =item I (1|0)> This marks the attribute as being required. This means a value must be supplied -during class construction, and the attribute can never be set to C with +during class construction, and the attribute may never be set to C with an accessor. =item I (1|0)> @@ -425,20 +428,188 @@ If an attribute is marked as lazy it B have a default supplied. =item I (1|0)> This tells the accessor whether to automatically dereference the value returned. -This is only legal if your C option is either an C or C. +This is only legal if your C option is either C or C. + +=item I $metaclass_name> + +This tells the class to use a custom attribute metaclass for this particular +attribute. Custom attribute metaclasses are useful for extending the +capabilities of the I keyword: they are the simplest way to extend the MOP, +but they are still a fairly advanced topic and too much to cover here. I will +try and write a recipe on them soon. + +The default behavior here is to just load C<$metaclass_name>; however, we also +have a way to alias to a shorter name. This will first look to see if +B exists. If it does, Moose +will then check to see if that has the method C, which +should return the actual name of the custom attribute metaclass. If there is no +C method, it will fall back to using +B as the metaclass name. =item I $code> -The trigger option is a CODE reference which will be called after the value of -the attribute is set. The CODE ref will be passed the instance itself, the +The I option is a CODE reference which will be called after the value of +the attribute is set. The CODE ref will be passed the instance itself, the updated value and the attribute meta-object (this is for more advanced fiddling -and can typically be ignored in most cases). You B have a trigger on -a read-only attribute. +and can typically be ignored). You B have a trigger on a read-only +attribute. + +=item I ARRAY | HASH | REGEXP | ROLE | CODE> + +The I option provides Moose classes with automated delegation features. +This is a pretty complex and powerful option. It accepts many different option +formats, each with its own benefits and drawbacks. + +B This feature is no longer experimental, but it may still have subtle +bugs lurking in the deeper corners. If you think you have found a bug, you +probably have, so please report it to me right away. + +B The class being delegated to does not need to be a Moose based class, +which is why this feature is especially useful when wrapping non-Moose classes. + +All I option formats share the following traits: -=item I [ @handles ]> +You cannot override a locally defined method with a delegated method; an +exception will be thrown if you try. That is to say, if you define C in +your class, you cannot override it with a delegated C. This is almost never +something you would want to do, and if it is, you should do it by hand and not +use Moose. -There is experimental support for attribute delegation using the C -option. More docs to come later. +You cannot override any of the methods found in Moose::Object, or the C +and C methods. These will not throw an exception, but will silently +move on to the next method in the list. My reasoning for this is that you would +almost never want to do this, since it usually breaks your class. As with +overriding locally defined methods, if you do want to do this, you should do it +manually, not with Moose. + +Below is the documentation for each option format: + +=over 4 + +=item C + +This is the most common usage for I. You basically pass a list of +method names to be delegated, and Moose will install a delegation method +for each one. + +=item C + +This is the second most common usage for I. Instead of a list of +method names, you pass a HASH ref where each key is the method name you +want installed locally, and its value is the name of the original method +in the class being delegated to. + +This can be very useful for recursive classes like trees. Here is a +quick example (soon to be expanded into a Moose::Cookbook::Recipe): + + package Tree; + use Moose; + + has 'node' => (is => 'rw', isa => 'Any'); + + has 'children' => ( + is => 'ro', + isa => 'ArrayRef', + default => sub { [] } + ); + + has 'parent' => ( + is => 'rw', + isa => 'Tree', + is_weak_ref => 1, + handles => { + parent_node => 'node', + siblings => 'children', + } + ); + +In this example, the Tree package gets C and C methods, +which delegate to the C and C methods (respectively) of the Tree +instance stored in the C slot. + +=item C + +The regexp option works very similar to the ARRAY option, except that it builds +the list of methods for you. It starts by collecting all possible methods of the +class being delegated to, then filters that list using the regexp supplied here. + +B An I option is required when using the regexp option format. This +is so that we can determine (at compile time) the method list from the class. +Without an I this is just not possible. + +=item C + +With the role option, you specify the name of a role whose "interface" then +becomes the list of methods to handle. The "interface" can be defined as; the +methods of the role and any required methods of the role. It should be noted +that this does B include any method modifiers or generated attribute +methods (which is consistent with role composition). + +=item C + +This is the option to use when you really want to do something funky. You should +only use it if you really know what you are doing, as it involves manual +metaclass twiddling. + +This takes a code reference, which should expect two arguments. The first is the +attribute meta-object this I is attached to. The second is the +metaclass of the class being delegated to. It expects you to return a hash (not +a HASH ref) of the methods you want mapped. + +=back + +=back + +=item B %options> + +This is variation on the normal attibute creator C which allows you to +clone and extend an attribute from a superclass. Here is a quick example: + + package Foo; + use Moose; + + has 'message' => ( + is => 'rw', + isa => 'Str', + default => 'Hello, I am a Foo' + ); + + package My::Foo; + use Moose; + + extends 'Foo'; + + has '+message' => (default => 'Hello I am My::Foo'); + +What is happening here is that B is cloning the C attribute +from its parent class B, retaining the C 'rw'> and C +'Str'> characteristics, but changing the value in C. + +This feature is restricted somewhat, so as to try and enfore at least I +sanity into it. You are only allowed to change the following attributes: + +=over 4 + +=item I + +Change the default value of an attribute. + +=item I + +Change whether the attribute attempts to coerce a value passed to it. + +=item I + +Change if the attribute is required to have a value. + +=item I + +Change the documentation string associated with the attribute. + +=item I + +You I allowed to change the type, B the new type is a +subtype of the old type. =back @@ -448,9 +619,10 @@ option. More docs to come later. =item B sub { ... }> -This three items are syntactic sugar for the before, after, and around method -modifier features that L provides. More information on these can -be found in the L documentation for now. +This three items are syntactic sugar for the before, after, and around method +modifier features that L provides. More information on these may be +found in the L for now. =item B @@ -485,17 +657,17 @@ all the time. This feature may change in the future, so you have been warned. =item B -This is the C function, it is exported here because I +This is the C function, it is exported here because I use it all the time. It is highly recommended that this is used instead of C anywhere you need to test for an object's class name. =back -=head1 UNEXPORTING FUNCTIONS +=head1 UNIMPORTING FUNCTIONS =head2 B -Moose offers a way of removing the keywords it exports though the C +Moose offers a way to remove the keywords it exports, through the C method. You simply have to say C at the bottom of your code for this to work. Here is an example: @@ -512,50 +684,25 @@ to work. Here is an example: no Moose; # keywords are removed from the Person package -=head1 MISC. - -=head2 What does Moose stand for?? - -Moose doesn't stand for one thing in particular, however, if you -want, here are a few of my favorites; feel free to contribute -more :) - -=over 4 - -=item Make Other Object Systems Envious - -=item Makes Object Orientation So Easy - -=item Makes Object Orientation Spiffy- Er (sorry ingy) - -=item Most Other Object Systems Emasculate - -=item Moose Often Ovulate Sorta Early - -=item Moose Offers Often Super Extensions - -=item Meta Object Orientation Syntax Extensions - -=back - =head1 CAVEATS =over 4 =item * -It should be noted that C and C C be used in the same -method. However, they can be combined together with the same class hierarchy; -see F for an example. +It should be noted that C and C B be used in the same +method. However, they may be combined within the same class hierarchy; see +F for an example. The reason for this is that C is only valid within a method with the C modifier, and C will never be valid within an C method. In fact, C will skip over any C methods when searching for its appropriate C. -This might seem like a restriction, but I am of the opinion that keeping these -two features separate (but interoperable) actually makes them easy to use, since -their behavior is then easier to predict. Time will tell if I am right or not. +This might seem like a restriction, but I am of the opinion that keeping these +two features separate (yet interoperable) actually makes them easy to use, since +their behavior is then easier to predict. Time will tell whether I am right or +not (UPDATE: so far so good). =back @@ -574,7 +721,7 @@ and it certainly wouldn't have this name ;P originally, I just ran with it. =item Thanks to mst & chansen and the whole #moose poose for all the -ideas/feature-requests/encouragement +early ideas/feature-requests/encouragement/bug-finding. =item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes. @@ -584,19 +731,31 @@ ideas/feature-requests/encouragement =over 4 +=item L + +This is the official web home of Moose, it contains links to our public SVN repo +as well as links to a number of talks and articles on Moose and Moose related +technologies. + =item L documentation =item The #moose channel on irc.perl.org =item The Moose mailing list - moose@perl.org -=item L +=item Moose stats on ohloh.net - L + +=back + +=head2 Papers + +=over 4 =item L This paper (suggested by lbr on #moose) was what lead to the implementation -of the C/C and C/C features. If you really -want to understand this feature, I suggest you read this. +of the C/C and C/C features. If you really +want to understand them, I suggest you read this. =back @@ -610,13 +769,39 @@ to cpan-RT. Stevan Little Estevan@iinteractive.comE -Christian Hansen Echansen@cpan.orgE +B + +Aankhen + +Adam (Alias) Kennedy + +Anders (Debolaz) Nor Berle + +Christian (chansen) Hansen + +Eric (ewilhelm) Wilhelm + +Guillermo (groditi) Roditi + +Jess (castaway) Robinson + +Matt (mst) Trout + +Robert (phaylon) Sedlacek + +Robert (rlb3) Boone + +Scott (konobi) McWhirter + +Yuval (nothingmuch) Kogman + +Chris (perigrin) Prather -Yuval Kogman Enothingmuch@woobling.orgE +... and many other #moose folks =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006, 2007 by Infinity Interactive, Inc. L