X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose.pm;h=2b2f8b108ba9d4f06340a664641de5d0ad9f441d;hb=457ad5fca1742d8f2a1a3561fab578e862344120;hp=e67c48bbf8aebc036d76b9783cdc9bb815e541e6;hpb=2f29843cdf35144014ed085f226ccd053adc6067;p=gitmo%2FMoose.git diff --git a/lib/Moose.pm b/lib/Moose.pm index e67c48b..2b2f8b1 100644 --- a/lib/Moose.pm +++ b/lib/Moose.pm @@ -4,7 +4,10 @@ package Moose; use strict; use warnings; -our $VERSION = '0.56'; +use 5.008; + +our $VERSION = '0.55_01'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use Scalar::Util 'blessed'; @@ -20,14 +23,22 @@ use Moose::Meta::TypeCoercion; use Moose::Meta::Attribute; use Moose::Meta::Instance; +use Moose::Object; + use Moose::Meta::Role; +use Moose::Meta::Role::Composite; +use Moose::Meta::Role::Application; +use Moose::Meta::Role::Application::RoleSummation; +use Moose::Meta::Role::Application::ToClass; +use Moose::Meta::Role::Application::ToRole; +use Moose::Meta::Role::Application::ToInstance; +use Moose::Meta::Role::Application::ToMetaclassInstance; -use Moose::Object; use Moose::Util::TypeConstraints; use Moose::Util (); sub extends { - my $class = caller(); + my $class = shift; croak "Must derive at least one class" unless @_; @@ -45,36 +56,36 @@ 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 = $class->meta->_fix_metaclass_incompatability(@supers); + my $meta = Moose::Meta::Class->initialize($class)->_fix_metaclass_incompatability(@supers); $meta->superclasses(@supers); } sub with { - my $class = caller(); - Moose::Util::apply_all_roles($class->meta, @_); + my $class = shift; + Moose::Util::apply_all_roles(Class::MOP::Class->initialize($class), @_); } sub has { - my $class = caller(); + my $class = shift; my $name = shift; croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1; my %options = @_; my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ]; - $class->meta->add_attribute( $_, %options ) for @$attrs; + Class::MOP::Class->initialize($class)->add_attribute( $_, %options ) for @$attrs; } sub before { - my $class = caller(); + my $class = shift; Moose::Util::add_method_modifier($class, 'before', \@_); } sub after { - my $class = caller(); + my $class = shift; Moose::Util::add_method_modifier($class, 'after', \@_); } sub around { - my $class = caller(); + my $class = shift; Moose::Util::add_method_modifier($class, 'around', \@_); } @@ -83,9 +94,9 @@ sub super { } sub override { - my $class = caller(); + my $class = shift; my ( $name, $method ) = @_; - $class->meta->add_override_method_modifier( $name => $method ); + Class::MOP::Class->initialize($class)->add_override_method_modifier( $name => $method ); } sub inner { @@ -103,44 +114,47 @@ sub inner { } sub augment { - my $class = caller(); + my $class = shift; my ( $name, $method ) = @_; - $class->meta->add_augment_method_modifier( $name => $method ); + Class::MOP::Class->initialize($class)->add_augment_method_modifier( $name => $method ); } sub make_immutable { - my $class = caller(); + my $class = shift; cluck "The make_immutable keyword has been deprecated, " . "please go back to __PACKAGE__->meta->make_immutable\n"; - $class->meta->make_immutable(@_); + Class::MOP::Class->initialize($class)->make_immutable(@_); } -my $exporter = Moose::Exporter->build_import_methods( - export => [ - qw( extends with has before after around override augment make_immutable super inner ), +Moose::Exporter->setup_import_methods( + with_caller => [ + qw( extends with has before after around override augment make_immutable ) + ], + as_is => [ + qw( super inner ), \&Carp::confess, \&Scalar::Util::blessed, ], ); -# This exists for backwards compat sub init_meta { - my ( $class, $base_class, $metaclass ) = @_; - - __PACKAGE__->_init_meta( for_class => $class, - object_base_class => $base_class, - metaclass_class => $metaclass, - ); -} + # This used to be called as a function. This hack preserves + # backwards compatibility. + if ( $_[0] ne __PACKAGE__ ) { + return __PACKAGE__->init_meta( + for_class => $_[0], + base_class => $_[1], + metaclass => $_[2], + ); + } -sub _init_meta { shift; my %args = @_; my $class = $args{for_class} - or confess "Cannot call _init_meta without specifying a for_class"; - my $base_class = $args{object_base_class} || 'Moose::Object'; - my $metaclass = $args{metaclass_class} || 'Moose::Meta::Class'; + or confess "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." @@ -151,27 +165,63 @@ sub _init_meta { unless find_type_constraint($class); my $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)"; + } + } else { + # no metaclass, no 'meta' method + + # now we check whether our ancestors have metaclass, and if so borrow that + my ( undef, @isa ) = @{ $class->mro::get_linear_isa }; + + 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)); + + # if we have an ancestor metaclass that inherits $metaclass, we use + # that. This is like _fix_metaclass_incompatability, but we can do it now. + + # the case of having an ancestry is not very common, but arises in + # e.g. Reaction + unless ( $metaclass->isa( $ancestor_meta_class ) ) { + if ( $ancestor_meta_class->isa($metaclass) ) { + $metaclass = $ancestor_meta_class; + } + } + } + + $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 - $meta = $class->meta(); - ( blessed($meta) && $meta->isa('Moose::Meta::Class') ) - || confess "You already have a &meta function, but it does not return a Moose::Meta::Class"; + 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)"; + + $meta = $method_meta; } - else { - # NOTE: - # this is broken currently, we actually need - # to allow the possiblity of an inherited - # meta, which will not be visible until the - # user 'extends' first. This needs to have - # more intelligence to it - $meta = $metaclass->initialize($class); + + unless ( $meta->has_method("meta") ) { # don't overwrite + # 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( blessed( $_[0] ) || $_[0] ); + $metaclass->initialize( ref($_[0]) || $_[0] ); } ); } @@ -183,32 +233,54 @@ sub _init_meta { return $meta; } +# This may be used in some older MooseX extensions. +sub _get_caller { + goto &Moose::Exporter::_get_caller; +} + ## make 'em all immutable $_->meta->make_immutable( - inline_constructor => 0, + inline_constructor => 1, + constructor_name => "_new", inline_accessors => 1, # these are Class::MOP accessors, so they need inlining ) - for ( - 'Moose::Meta::Attribute', - 'Moose::Meta::Class', - 'Moose::Meta::Instance', - - 'Moose::Meta::TypeConstraint', - 'Moose::Meta::TypeConstraint::Union', - 'Moose::Meta::TypeConstraint::Parameterized', - 'Moose::Meta::TypeCoercion', - - 'Moose::Meta::Method', - 'Moose::Meta::Method::Accessor', - 'Moose::Meta::Method::Constructor', - 'Moose::Meta::Method::Destructor', - 'Moose::Meta::Method::Overriden', - - 'Moose::Meta::Role', - 'Moose::Meta::Role::Method', - 'Moose::Meta::Role::Method::Required', - ); + for (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 + + Moose::Meta::Method + Moose::Meta::Method::Accessor + Moose::Meta::Method::Constructor + Moose::Meta::Method::Destructor + Moose::Meta::Method::Overriden + Moose::Meta::Method::Augmented + + Moose::Meta::Role + Moose::Meta::Role::Method + Moose::Meta::Role::Method::Required + + Moose::Meta::Role::Composite + + Moose::Meta::Role::Application + Moose::Meta::Role::Application::RoleSummation + Moose::Meta::Role::Application::ToClass + Moose::Meta::Role::Application::ToRole + Moose::Meta::Role::Application::ToInstance + Moose::Meta::Role::Application::ToMetaclassInstance +)); 1; @@ -259,6 +331,14 @@ metaclass system for Perl 5. This means that Moose not only makes building normal Perl 5 objects better, but it provides the power of metaclass programming as well. +=head2 New to Moose? + +If you're new to Moose, the best place to start is the +L. The 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 can do, you can use the API documentation to get more +detail on features which interest you. + =head2 Moose Extensions The C namespace is the official place to find Moose extensions. @@ -512,16 +592,13 @@ B as the metaclass name. This tells Moose to take the list of C<@role_names> and apply them to the attribute meta-object. This is very similar to the I option, but -allows you to use more than one extension at a time. This too is an advanced -topic, we don't yet have a cookbook for it though. +allows you to use more than one extension at a time. -As with I, the default behavior is to just load C<$role_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 trait. If there is no -C method, it will fall back to using -B as the trait name. +See L for details on how a trait name is +resolved to a class name. + +Also see L for a metaclass trait +example. =back @@ -681,6 +758,36 @@ C anywhere you need to test for an object's class name. =back +=head1 METACLASS TRAITS + +When you use Moose, you can also specify traits which will be applied +to your metaclass: + + use Moose -traits => 'My::Trait'; + +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 + +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 +for for a class matching +B. The C<$type> +variable here will be one of B or B, depending on +what the trait is being applied to. + +If a class with this long name exists, Moose checks to see if it has +the method C. This method is expected to +return the I class name of the trait. If there is no +C method, it will fall back to using +B as the trait name. + +If all this is confusing, take a look at +L, which demonstrates how to create an +attribute trait. + =head1 UNIMPORTING FUNCTIONS =head2 B @@ -704,45 +811,72 @@ 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. The basic premise is to have something that sets up your class' -metaclass and export the moose declarators (C, C, C,...). -Here is an example: +Moose also offers some options for extending or embedding it into your +own framework. There are several things you might want to do as part +of such a framework. First, you probably want to export Moose's sugar +functions (C, C, etc) for users of the +framework. Second, you may want to provide additional sugar of your +own. Third, you may want to provide your own object base class instead +of L, and/or your own metaclass class instead of +L. - package MyFramework; - use Moose; +The exporting needs can be asily satisfied by using +L, which is what C itself uses for +exporting. L lets you "export like Moose". - sub import { - my $CALLER = caller(); +If you define an C method in a module that uses +L, then this method will be called I +C's own C. This gives you a chance to provide an +alternate object base class or metaclass class. - strict->import; - warnings->import; +Here is a simple example: + + package MyFramework; - # we should never export to main - return if $CALLER eq 'main'; - Moose::init_meta( $CALLER, 'MyFramework::Base' ); - Moose->import({into => $CALLER}); + use strict; + use warnings; - # Do my custom framework stuff + use Moose (); # no need to get Moose's exports + use Moose::Exporter; - return 1; + Moose::Exporter->setup_import_methods( also => 'Moose' ); + + sub init_meta { + shift; + return Moose->init_meta( @_, base_class => 'MyFramework::Base' ); } -=head2 B +In this example, any class that includes C will get +all of C's sugar functions, and will have their superclass +set to C. -Moose's C method supports the L form of C<{into =E $pkg}> -and C<{into_level =E 1}> +Additionally, that class can include C to unimport -=head2 B +=head2 B<< Moose->init_meta(for_class => $class, base_class => $baseclass, metaclass => $metaclass) >> -Moose does some boot strapping: it creates a metaclass object for your class, -and then injects a C accessor into your class to retrieve it. Then it -sets your baseclass to Moose::Object or the value you pass in unless you already -have one. This is all done via C which takes the name of your class -and optionally a baseclass and a metaclass as arguments. +The C method sets up the metaclass object for the class +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. For more detail on this topic, see L. +This method used to be documented as a function which accepted +positional parameters. This calling style will still work for +backwards compatibility, but is deprecated. + +=head2 B + +Moose's C method supports the L form of C<{into =E $pkg}> +and C<{into_level =E 1}>. + +B: Doing this is more or less deprecated. Use L +instead, which lets you stack multiple C-alike modules +sanely. It handles getting the exported functions into the right place +for you. + =head1 CAVEATS =over 4