X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose.pm;h=ec394902fec23b9ef4fa4d5a7c9b0ff758083bd1;hb=afe8a05ef2a26c2a13482af276f7d048f88e1e04;hp=ce94027e89fd49fb13d412b052d984ffcda0fcdd;hpb=113d3174264db82cb788bc846f617584072cba39;p=gitmo%2FMoose.git diff --git a/lib/Moose.pm b/lib/Moose.pm index ce94027..ec39490 100644 --- a/lib/Moose.pm +++ b/lib/Moose.pm @@ -4,16 +4,13 @@ use warnings; use 5.008; -our $VERSION = '0.91'; -$VERSION = eval $VERSION; -our $AUTHORITY = 'cpan:STEVAN'; - use Scalar::Util 'blessed'; use Carp 'confess'; +use Moose::Deprecated; use Moose::Exporter; -use Class::MOP 0.93; +use Class::MOP; use Moose::Meta::Class; use Moose::Meta::TypeConstraint; @@ -133,6 +130,12 @@ sub init_meta { # This used to be called as a function. This hack preserves # backwards compatibility. if ( $_[0] ne __PACKAGE__ ) { + Moose::Deprecated::deprecated( + feature => 'Moose::init_meta', + message => 'Calling Moose::init_meta as a function is deprecated.' + . ' Doing so will throw an error in Moose 2.0200.' + ); + return __PACKAGE__->init_meta( for_class => $_[0], base_class => $_[1], @@ -147,6 +150,7 @@ sub init_meta { 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'; + my $meta_name = exists $args{meta_name} ? $args{meta_name} : 'meta'; Moose->throw_error("The Metaclass $metaclass must be a subclass of Moose::Meta::Class.") unless $metaclass->isa('Moose::Meta::Class'); @@ -159,20 +163,23 @@ sub init_meta { if ( $meta = Class::MOP::get_metaclass_by_name($class) ) { unless ( $meta->isa("Moose::Meta::Class") ) { - Moose->throw_error("$class already has a metaclass, but it does not inherit $metaclass ($meta)"); + my $error_message = "$class already has a metaclass, but it does not inherit $metaclass ($meta)."; + if ( $meta->isa('Moose::Meta::Role') ) { + Moose->throw_error($error_message . ' You cannot make the same thing a role and a class. Remove either Moose or Moose::Role.'); + } else { + Moose->throw_error($error_message); + } } } else { - # no metaclass, no 'meta' method + # no metaclass # now we check whether our ancestors have metaclass, and if so borrow that - my ( undef, @isa ) = @{ $class->mro::get_linear_isa }; + my ( undef, @isa ) = @{ mro::get_linear_isa($class) }; foreach my $ancestor ( @isa ) { my $ancestor_meta = Class::MOP::get_metaclass_by_name($ancestor) || next; - my $ancestor_meta_class = ($ancestor_meta->is_immutable - ? $ancestor_meta->_get_mutable_metaclass_name - : ref($ancestor_meta)); + my $ancestor_meta_class = $ancestor_meta->_real_ref_name; # if we have an ancestor metaclass that inherits $metaclass, we use # that. This is like _fix_metaclass_incompatibility, but we can do it now. @@ -189,32 +196,19 @@ sub init_meta { $meta = $metaclass->initialize($class); } - if ( $class->can('meta') ) { - # check 'meta' method - - # it may be inherited - - # NOTE: - # this is the case where the metaclass pragma - # was used before the 'use Moose' statement to - # override a specific class - my $method_meta = $class->meta; - - ( blessed($method_meta) && $method_meta->isa('Moose::Meta::Class') ) - || Moose->throw_error("$class already has a &meta function, but it does not return a Moose::Meta::Class ($method_meta)"); - - $meta = $method_meta; - } - - unless ( $meta->has_method("meta") ) { # don't overwrite + if (defined $meta_name) { # also check for inherited non moose 'meta' method? - # FIXME also skip this if the user requested by passing an option - $meta->add_method( - 'meta' => sub { - # re-initialize so it inherits properly - $metaclass->initialize( ref($_[0]) || $_[0] ); - } - ); + my $existing = $meta->get_method($meta_name); + if ($existing && !$existing->isa('Class::MOP::Method::Meta')) { + Carp::cluck "Moose is overwriting an existing method named " + . "$meta_name in class $class with a method " + . "which returns the class's metaclass. If this is " + . "actually what you want, you should remove the " + . "existing method, otherwise, you should rename or " + . "disable this generated method using the " + . "'-meta_name' option to 'use Moose'."; + } + $meta->_add_meta_method($meta_name); } # make sure they inherit from Moose::Object @@ -254,6 +248,7 @@ $_->make_immutable( Moose::Meta::Method::Augmented Moose::Meta::Role + Moose::Meta::Role::Attribute Moose::Meta::Role::Method Moose::Meta::Role::Method::Required Moose::Meta::Role::Method::Conflicting @@ -267,16 +262,19 @@ $_->make_immutable( Moose::Meta::Role::Application::ToInstance ); +Moose::Meta::Mixin::AttributeCore->meta->make_immutable( + inline_constructor => 0, + constructor_name => undef, +); + 1; +# ABSTRACT: A postmodern object system for Perl 5 + __END__ =pod -=head1 NAME - -Moose - A postmodern object system for Perl 5 - =head1 SYNOPSIS package Point; @@ -308,7 +306,7 @@ Moose - A postmodern object system for Perl 5 Moose is an extension of the Perl 5 object system. The main goal of Moose is to make Perl 5 Object Oriented programming -easier, more consistent and less tedious. With Moose you can to think +easier, more consistent, and less tedious. With Moose you can think more about what you want to do and less about the mechanics of OOP. Additionally, Moose is built on top of L, which is a @@ -341,7 +339,12 @@ Much of the Moose documentation has been translated into other languages. =over 4 -=item L +=item Japanese + +Japanese docs can be found at +L. The +source POD files can be found in GitHub: +L =back @@ -351,8 +354,10 @@ Moose makes every attempt to provide as much convenience as possible during class construction/definition, but still stay out of your way if you want it 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. +When you C, Moose will set the class's parent class to +L, I the class using Moose already has a parent +class. In addition, specifying a parent with C will change the parent +class. Moose will also manage all attributes (including inherited ones) that are defined with C. And (assuming you call C, which is inherited from @@ -390,10 +395,31 @@ actually Ces onto the class's C<@ISA>, whereas C will replace it. This is important to ensure that classes which do not have superclasses still properly inherit from L. +Each superclass can be followed by a hash reference with options. Currently, +only L<-version|Class::MOP/Class Loading Options> is recognized: + + extends 'My::Parent' => { -version => 0.01 }, + 'My::OtherParent' => { -version => 0.03 }; + +An exception will be thrown if the version requirements are not +satisfied. + =item B This will apply a given set of C<@roles> to the local class. +Like with C, each specified role can be followed by a hash +reference with a L<-version|Class::MOP/Class Loading Options> option: + + with 'My::Role' => { -version => 0.32 }, + 'My::Otherrole' => { -version => 0.23 }; + +The specified version requirements must be satisfied, otherwise an +exception will be thrown. + +If your role takes options or arguments, they can be passed along in the +hash reference as well. + =item B %options> This will install an attribute of a given C<$name> into the current class. If @@ -429,9 +455,9 @@ for information on how to define a new type, and how to retrieve type meta-data) =item I (1|0)> 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. +the value passed into any accessors or constructors. You B supply a type +constraint, and that type constraint B define a coercion. See +L for an example. =item I $role_name> @@ -449,7 +475,9 @@ say anything about the attribute's value, which can be C. This will tell the class to store the value of this attribute as a weakened reference. If an attribute is a weakened reference, it B also be -coerced. +coerced. Note that when a weak ref expires, the attribute's value becomes +undefined, and is still considered to be set for purposes of predicate, +default, etc. =item I (1|0)> @@ -458,15 +486,20 @@ 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 C or C. +This tells the accessor to automatically dereference the value of this +attribute when called in list context. The accessor will still return a +reference when called in scalar context. If this behavior isn't desirable, +L or +L may be a better +choice. The I option is only legal if your I 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 and the updated value. If the attribute already had a -value, this will be passed as the third value to the trigger. +the value of the attribute is set. The CODE ref is passed the +instance itself, the updated value, and the original value if the +attribute was already set. You B have a trigger on a read-only attribute. @@ -474,7 +507,7 @@ 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 | DUCKTYPE | CODE> +=item I ARRAY | HASH | REGEXP | ROLE | ROLETYPE | DUCKTYPE | CODE> The I option provides Moose classes with automated delegation features. This is a pretty complex and powerful option. It accepts many different option @@ -537,7 +570,7 @@ quick example (soon to be expanded into a Moose::Cookbook recipe): has 'parent' => ( is => 'rw', isa => 'Tree', - weak_ref => 1, + weak_ref => 1, handles => { parent_node => 'node', siblings => 'children', @@ -570,18 +603,19 @@ 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 +=item C or 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). +With the role option, you specify the name of a role or a +L 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 With the duck type option, you pass a duck type object whose "interface" then -becomes the list of methods to handle. The "interface" can be defined as; the +becomes the list of methods to handle. The "interface" can be defined as the list of methods passed to C to create a duck type object. For more information on C please check L. @@ -604,7 +638,7 @@ a HASH ref) of the methods you want mapped. 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, see +but they are still a fairly advanced topic and too much to cover here. See L for more information. See L for details on how a metaclass name @@ -627,7 +661,7 @@ example. 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. +and/or L for more information. =item I => SCALAR | CODE @@ -642,16 +676,19 @@ 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. +Note that the predicate will return true even for a C attribute +whose value has expired. + =item I => (0|1) Automatically define lazy => 1 as well as builder => "_build_$attr", clearer => @@ -786,11 +823,11 @@ B overridden, or removed. =back -=item B sub { ... }> +=item B sub { ... }> -=item B sub { ... }> +=item B sub { ... }> -=item B sub { ... }> +=item B sub { ... }> These three items are syntactic sugar for the before, after, and around method modifier features that L provides. More information on these may be @@ -830,7 +867,7 @@ all the time. =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. @@ -930,7 +967,17 @@ for you. =head2 B -An alias for C, used by internally by Moose. +An alias for C, used internally by Moose. + +=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 METACLASS COMPATIBILITY AND MOOSE @@ -939,32 +986,19 @@ 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. +when you set the superclasses for a class, in addition to the cases that +C handles. -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. +Moose 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 +is a subclass of the parent's metaclass which 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. @@ -972,16 +1006,6 @@ 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 @@ -1012,9 +1036,9 @@ 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. +You can also visit us at C<#moose> on L +This channel is quite active, and questions at all levels (on Moose-related +topics ;) are welcome. =head1 ACKNOWLEDGEMENTS @@ -1043,7 +1067,7 @@ early ideas/feature-requests/encouragement/bug-finding. =item L -This is the official web home of Moose, it contains links to our public SVN repository +This is the official web home of Moose, it contains links to our public git repository as well as links to a number of talks and articles on Moose and Moose related technologies. @@ -1067,7 +1091,7 @@ See L for extensions. =item The Art of the MetaObject Protocol -I mention this in the L docs too, this book was critical in +I mention this in the L docs too, as this book was critical in the development of both modules and is highly recommended. =back @@ -1092,6 +1116,9 @@ exception. Please report any bugs to C, or through the web interface at L. +You can also discuss feature requests or possible bugs on the Moose mailing +list (moose@perl.org) or on IRC at L. + =head1 FEATURE REQUESTS We are very strict about what features we add to the Moose core, especially @@ -1106,36 +1133,30 @@ L to discuss. The L has more detail about how and when you can contribute. -=head1 AUTHOR - -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 +=head1 CABAL -However there are only a few people with the rights to release a new version +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 +the wider purview of Moose. They help maintain not just the code but the community as well. Stevan (stevan) Little Estevan@iinteractive.comE +Jesse (doy) Luehrs Edoy at tozt dot netE + Yuval (nothingmuch) Kogman Shawn (sartak) Moore Esartak@bestpractical.comE -Dave (autarch) Rolsky Eautarch@urth.orgE - -Jesse (doy) Luehrs Edoy at tozt dot netE - Hans Dieter (confound) Pearcey Ehdp@pobox.comE Chris (perigrin) Prather Florian Ragwitz Erafl@debian.orgE -=head2 OTHER CONTRIBUTORS +Dave (autarch) Rolsky Eautarch@urth.orgE + +=head1 CONTRIBUTORS Aankhen @@ -1143,47 +1164,56 @@ Adam (Alias) Kennedy Anders (Debolaz) Nor Berle -Nathan (kolibrie) Gray +Chris (perigrin) Prather Christian (chansen) Hansen +Cory (gphat) Watson + +Dylan Hardison (doc fixes) + Eric (ewilhelm) Wilhelm +Evan Carroll + +Florian (rafl) Ragwitz + Guillermo (groditi) Roditi +Jason May + +Jay Hannah + Jess (castaway) Robinson -Matt (mst) Trout +Jonathan (jrockway) Rockway -Robert (phaylon) Sedlacek +Matt (mst) Trout -Robert (rlb3) Boone +Nathan (kolibrie) Gray -Scott (konobi) McWhirter +Paul (frodwith) Driver -Shlomi (rindolf) Fish +Piotr (dexter) Roszatycki -Wallace (wreis) Reis +Robert Buels -Jonathan (jrockway) Rockway +Robert (phaylon) Sedlacek -Piotr (dexter) Roszatycki +Robert (rlb3) Boone Sam (mugwump) Vilain -Cory (gphat) Watson - -Dylan Hardison (doc fixes) +Scott (konobi) McWhirter -... and many other #moose folks +Shawn (Sartak) Moore -=head1 COPYRIGHT AND LICENSE +Shlomi (rindolf) Fish -Copyright 2006-2009 by Infinity Interactive, Inc. +Tom (dec) Lanyon -L +Wallace (wreis) Reis -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +... and many other #moose folks =cut