X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose.pm;h=3578db6dd3947625ea423ad27b43303a36180f68;hb=37edf27e10aa98df38b08274d78791dea08cda4c;hp=69dbc639ec81d8f5364ead6c3eea605ac0d975a1;hpb=e606ae5f848070d889472329819c95f5ba763ca3;p=gitmo%2FMoose.git diff --git a/lib/Moose.pm b/lib/Moose.pm index 69dbc63..3578db6 100644 --- a/lib/Moose.pm +++ b/lib/Moose.pm @@ -6,16 +6,16 @@ use warnings; use 5.008; -our $VERSION = '0.57'; +our $VERSION = '0.73'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use Scalar::Util 'blessed'; -use Carp 'confess', 'croak', 'cluck'; +use Carp 'confess'; use Moose::Exporter; -use Class::MOP 0.65; +use Class::MOP 0.78_02; use Moose::Meta::Class; use Moose::Meta::TypeConstraint; @@ -36,18 +36,29 @@ use Moose::Meta::Role::Application::ToInstance; use Moose::Util::TypeConstraints; use Moose::Util (); +sub _caller_info { + my $level = @_ ? ($_[0] + 1) : 2; + my %info; + @info{qw(package file line)} = caller($level); + return \%info; +} + +sub throw_error { + # FIXME This + shift; + goto \&confess +} + sub extends { my $class = shift; - croak "Must derive at least one class" unless @_; + Moose->throw_error("Must derive at least one class") unless @_; my @supers = @_; foreach my $super (@supers) { - Class::MOP::load_class($super); - croak "You cannot inherit from a Moose Role ($super)" - if $super->can('meta') && - blessed $super->meta && - $super->meta->isa('Moose::Meta::Role') + my $meta = Class::MOP::load_class($super); + Moose->throw_error("You cannot inherit from a Moose Role ($super)") + if $meta && $meta->isa('Moose::Meta::Role') } @@ -55,7 +66,7 @@ sub extends { # this checks the metaclass to make sure # it is correct, sometimes it can get out # of sync when the classes are being built - my $meta = Moose::Meta::Class->initialize($class)->_fix_metaclass_incompatability(@supers); + my $meta = Moose::Meta::Class->initialize($class); $meta->superclasses(@supers); } @@ -67,8 +78,11 @@ sub with { sub has { my $class = shift; my $name = shift; - croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1; - my %options = @_; + + Moose->throw_error('Usage: has \'name\' => ( key => value, ... )') + if @_ == 1; + + my %options = ( definition_context => _caller_info(), @_ ); my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ]; Class::MOP::Class->initialize($class)->add_attribute( $_, %options ) for @$attrs; } @@ -88,8 +102,15 @@ sub around { Moose::Util::add_method_modifier($class, 'around', \@_); } +our $SUPER_PACKAGE; +our $SUPER_BODY; +our @SUPER_ARGS; + sub super { - return unless our $SUPER_BODY; $SUPER_BODY->(our @SUPER_ARGS); + # This check avoids a recursion loop - see + # t/100_bugs/020_super_recursion.t + return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller(); + return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS); } sub override { @@ -118,16 +139,9 @@ sub augment { Class::MOP::Class->initialize($class)->add_augment_method_modifier( $name => $method ); } -sub make_immutable { - my $class = shift; - cluck "The make_immutable keyword has been deprecated, " . - "please go back to __PACKAGE__->meta->make_immutable\n"; - Class::MOP::Class->initialize($class)->make_immutable(@_); -} - Moose::Exporter->setup_import_methods( with_caller => [ - qw( extends with has before after around override augment make_immutable ) + qw( extends with has before after around override augment) ], as_is => [ qw( super inner ), @@ -151,12 +165,11 @@ sub init_meta { my %args = @_; my $class = $args{for_class} - or confess "Cannot call init_meta without specifying a for_class"; + or Moose->throw_error("Cannot call init_meta without specifying a for_class"); my $base_class = $args{base_class} || 'Moose::Object'; my $metaclass = $args{metaclass} || 'Moose::Meta::Class'; - confess - "The Metaclass $metaclass must be a subclass of Moose::Meta::Class." + Moose->throw_error("The Metaclass $metaclass must be a subclass of Moose::Meta::Class.") unless $metaclass->isa('Moose::Meta::Class'); # make a subtype for each Moose class @@ -167,7 +180,7 @@ sub init_meta { if ( $meta = Class::MOP::get_metaclass_by_name($class) ) { unless ( $meta->isa("Moose::Meta::Class") ) { - confess "$class already has a metaclass, but it does not inherit $metaclass ($meta)"; + Moose->throw_error("$class already has a metaclass, but it does not inherit $metaclass ($meta)"); } } else { # no metaclass, no 'meta' method @@ -183,7 +196,7 @@ sub init_meta { : ref($ancestor_meta)); # if we have an ancestor metaclass that inherits $metaclass, we use - # that. This is like _fix_metaclass_incompatability, but we can do it now. + # that. This is like _fix_metaclass_incompatibility, but we can do it now. # the case of having an ancestry is not very common, but arises in # e.g. Reaction @@ -209,7 +222,7 @@ sub init_meta { my $method_meta = $class->meta; ( blessed($method_meta) && $method_meta->isa('Moose::Meta::Class') ) - || confess "$class already has a &meta function, but it does not return a Moose::Meta::Class ($meta)"; + || Moose->throw_error("$class already has a &meta function, but it does not return a Moose::Meta::Class ($meta)"); $meta = $method_meta; } @@ -239,24 +252,18 @@ sub _get_caller { ## make 'em all immutable -$_->meta->make_immutable( +$_->make_immutable( inline_constructor => 1, constructor_name => "_new", - inline_accessors => 1, # these are Class::MOP accessors, so they need inlining - ) - for (qw( + # these are Class::MOP accessors, so they need inlining + inline_accessors => 1 + ) for grep { $_->is_mutable } + map { $_->meta } + qw( Moose::Meta::Attribute Moose::Meta::Class Moose::Meta::Instance - Moose::Meta::TypeConstraint - Moose::Meta::TypeConstraint::Union - Moose::Meta::TypeConstraint::Parameterized - Moose::Meta::TypeConstraint::Parameterizable - Moose::Meta::TypeConstraint::Enum - Moose::Meta::TypeConstraint::Class - Moose::Meta::TypeConstraint::Role - Moose::Meta::TypeConstraint::Registry Moose::Meta::TypeCoercion Moose::Meta::TypeCoercion::Union @@ -264,7 +271,7 @@ $_->meta->make_immutable( Moose::Meta::Method::Accessor Moose::Meta::Method::Constructor Moose::Meta::Method::Destructor - Moose::Meta::Method::Overriden + Moose::Meta::Method::Overridden Moose::Meta::Method::Augmented Moose::Meta::Role @@ -278,7 +285,7 @@ $_->meta->make_immutable( Moose::Meta::Role::Application::ToClass Moose::Meta::Role::Application::ToRole Moose::Meta::Role::Application::ToInstance -)); +); 1; @@ -331,9 +338,9 @@ metaclass programming as well. =head2 New to Moose? -If you're new to Moose, the best place to start is the L -docs, followed by the L. The intro will show you what -Moose is, and how it makes Perl 5 OO better. +If you're new to Moose, the best place to start is the +L docs, followed by the L. The intro +will show you what Moose is, and how it makes Perl 5 OO better. The cookbook recipes on Moose basics will get you up to speed with many of Moose's features quickly. Once you have an idea of what Moose @@ -397,12 +404,13 @@ superclasses still properly inherit from L. This will apply a given set of C<@roles> to the local class. -=item B %options> +=item B %options> -This will install an attribute of a given C<$name> into the current class. -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): +This will install an attribute of a given C<$name> into the current class. If +the first parameter is an array reference, it will create an attribute for +every C<$name> in the list. 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): =over 4 @@ -412,10 +420,12 @@ 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, however if you use those, you won't need the I -option. +If you need more control over how your accessors are named, you can +use the L, +L and +L options inherited from +L, however if you use those, you won't need the +I option. =item I $type_name> @@ -462,11 +472,14 @@ This is only legal if your C option is either C or C. =item I $code> -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). You B have a trigger on a read-only -attribute. +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 and the updated value. You B have a trigger on +a read-only attribute. + +B Triggers will only fire when you B to the attribute, +either in the constructor, or using the writer. Default and built values will +B cause the trigger to be fired. =item I ARRAY | HASH | REGEXP | ROLE | CODE> @@ -601,11 +614,56 @@ resolved to a class name. Also see L for a metaclass trait example. +=item I => Str + +The value of this key is the name of the method that will be called to +obtain the value used to initialize the attribute. See the L + and/or L for more information. + +=item I => SCALAR | CODE + +The value of this key is the default value which will initialize the attribute. + +NOTE: If the value is a simple scalar (string or number), then it can +be just passed as is. However, if you wish to initialize it with a +HASH or ARRAY ref, then you need to wrap that inside a CODE reference. +See the L for more +information. + +=item I => Str + +Creates a method allowing you to clear the value, see the L for more +information. + +=item I => Str + +Creates a method to perform a basic test to see if a value has been set in the +attribute, see the L for more information. + +=item I => (0|1) + +Automatically define lazy => 1 as well as builder => "_build_$attr", clearer => +"clear_$attr', predicate => 'has_$attr' unless they are already defined. + +=item I => Str + +This may be a method name (referring to a method on the class with +this attribute) or a CODE ref. The initializer is used to set the +attribute value on an instance when the attribute is set during +instance initialization (but not when the value is being assigned +to). See the L for more +information. + =back =item B %options> -This is variation on the normal attibute creator C which allows you to +This is variation on the normal attribute creator C which allows you to clone and extend an attribute from a superclass or from a role. Here is an example of the superclass usage: @@ -684,7 +742,7 @@ You I allowed to change the type without restriction. It is recommended that you use this freedom with caution. We used to only allow for extension only if the type was a subtype of the parent's type, but we felt that was too restrictive and is better left as a -policy descision. +policy decision. =item I @@ -704,7 +762,7 @@ B allowed to I one. =item I You are allowed to B additional traits to the C definition. -These traits will be composed into the attribute, but pre-existing traits +These traits will be composed into the attribute, but preexisting traits B overridden, or removed. =back @@ -770,7 +828,7 @@ This is very similar to the attribute traits feature. When you do this, your class's C object will have the specified traits applied to it. See L for more details. -=head1 TRAIT NAME RESOLUTION +=head2 Trait Name Resolution By default, when given a trait name, Moose simply tries to load a class of the same name. If such a class does not exist, it then looks @@ -812,11 +870,10 @@ to work. Here is an example: =head1 EXTENDING AND EMBEDDING MOOSE -Moose also offers some options for extending or embedding it into your -own framework. To learn more about extending Moose, we recommend -checking out the "Extending" recipes in the L, -starting with L, which provides -an overview of all the different ways you might extend Moose. +To learn more about extending Moose, we recommend checking out the +"Extending" recipes in the L, starting with +L, which provides an overview of +all the different ways you might extend Moose. =head2 B<< Moose->init_meta(for_class => $class, base_class => $baseclass, metaclass => $metaclass) >> @@ -825,7 +882,7 @@ specified by C. This method injects a a C accessor into the class so you can get at this object. It also sets the class's superclass to C, with L as the default. -You can specify an alternate metaclass with the C parameter. +You can specify an alternate metaclass with the C option. For more detail on this topic, see L. @@ -843,6 +900,60 @@ instead, which lets you stack multiple C-alike modules sanely. It handles getting the exported functions into the right place for you. +=head2 B + +An alias for C, used by internally by Moose. + +=head1 METACLASS COMPATIBILITY AND MOOSE + +Metaclass compatibility is a thorny subject. You should start by +reading the "About Metaclass compatibility" section in the +C docs. + +Moose will attempt to resolve a few cases of metaclass incompatibility +when you set the superclasses for a class, unlike C, which +simply dies if the metaclasses are incompatible. + +In actuality, Moose fixes incompatibility for I of a class's +metaclasses, not just the class metaclass. That includes the instance +metaclass, attribute metaclass, as well as its constructor class and +destructor class. However, for simplicity this discussion will just +refer to "metaclass", meaning the class metaclass, most of the time. + +Moose has two algorithms for fixing metaclass incompatibility. + +The first algorithm is very simple. If all the metaclass for the +parent is a I of the child's metaclass, then we simply +replace the child's metaclass with the parent's. + +The second algorithm is more complicated. It tries to determine if the +metaclasses only "differ by roles". This means that the parent and +child's metaclass share a common ancestor in their respective +hierarchies, and that the subclasses under the common ancestor are +only different because of role applications. This case is actually +fairly common when you mix and match various C modules, +many of which apply roles to the metaclass. + +If the parent and child do differ by roles, Moose replaces the +metaclass in the child with a newly created metaclass. This metaclass +is a subclass of the parent's metaclass, does all of the roles that +the child's metaclass did before being replaced. Effectively, this +means the new metaclass does all of the roles done by both the +parent's and child's original metaclasses. + +Ultimately, this is all transparent to you except in the case of an +unresolvable conflict. + +=head2 The MooseX:: namespace + +Generally if you're writing an extension I Moose itself you'll want +to put your extension in the C namespace. This namespace is +specifically for extensions that make Moose better or different in some +fundamental way. It is traditionally B for a package that just happens +to use Moose. This namespace follows from the examples of the C +and C namespaces that perform the same function for C and C +respectively. + =head1 CAVEATS =over 4 @@ -865,6 +976,18 @@ not (UPDATE: so far so good). =back +=head1 GETTING HELP + +We offer both a mailing list and a very active IRC channel. + +The mailing list is L. You must be subscribed to send +a message. To subscribe, send an empty message to +L + +You can also visit us at L<#moose on +irc.perl.org|irc://irc.perl.org/#moose>. This channel is quite active, +and questions at all levels (on Moose-related topics ;) are welcome. + =head1 ACKNOWLEDGEMENTS =over 4 @@ -892,30 +1015,22 @@ early ideas/feature-requests/encouragement/bug-finding. =item L -This is the official web home of Moose, it contains links to our public SVN repo +This is the official web home of Moose, it contains links to our public SVN repository as well as links to a number of talks and articles on Moose and Moose related technologies. -=item L - How to cook a Moose - =item The Moose is flying, a tutorial by Randal Schwartz Part 1 - L Part 2 - L -=item L documentation - -=item The #moose channel on irc.perl.org - -=item The Moose mailing list - moose@perl.org - -=item Moose stats on ohloh.net - L - =item Several Moose extension modules in the C namespace. See L for extensions. +=item Moose stats on ohloh.net - L + =back =head2 Books @@ -954,13 +1069,32 @@ the user-visible features. Instead we have made sure that the underlying meta-system of Moose is as extensible as possible so that you can add your own features easily. That said, occasionally there is a feature needed in the meta-system to support your planned extension, in which case you should -either email the mailing list or join us on irc at #moose to discuss. +either email the mailing list or join us on irc at #moose to discuss. The +L has more detail about how and when you can +contribute. =head1 AUTHOR -Stevan Little Estevan@iinteractive.comE +Moose is an open project, there are at this point dozens of people who have +contributed, and can contribute. If you have added anything to the Moose +project you have a commit bit on this file and can add your name to the list. + +=head2 CABAL -B +However there are only a few people with the rights to release a new version +of Moose. The Moose Cabal are the people to go to with questions regarding +the wider purview of Moose, and help out maintaining not just the code +but the community as well. + +Stevan (stevan) Little Estevan@iinteractive.comE + +Yuval (nothingmuch) Kogman + +Shawn (sartak) Moore + +Dave (autarch) Rolsky Eautarch@urth.orgE + +=head2 OTHER CONTRIBUTORS Aankhen @@ -968,7 +1102,7 @@ Adam (Alias) Kennedy Anders (Debolaz) Nor Berle -Nathan (kolibre) Gray +Nathan (kolibrie) Gray Christian (chansen) Hansen @@ -990,27 +1124,23 @@ Scott (konobi) McWhirter Shlomi (rindolf) Fish -Yuval (nothingmuch) Kogman - Chris (perigrin) Prather Wallace (wreis) Reis Jonathan (jrockway) Rockway -Dave (autarch) Rolsky - Piotr (dexter) Roszatycki Sam (mugwump) Vilain -Shawn (sartak) Moore +Cory (gphat) Watson ... and many other #moose folks =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L