X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoo.pm;h=3af5e7ca976dc526f9545552c79d0aee657c89ad;hb=3d49ee2792c487353cae59f59cde2e5aaba6d545;hp=662cd3dfd21032803e58e17a652e324462e170db;hpb=a958e36d1418a48d2edf59c61fb73941a135f7d5;p=gitmo%2FMoo.git diff --git a/lib/Moo.pm b/lib/Moo.pm index 662cd3d..3af5e7c 100644 --- a/lib/Moo.pm +++ b/lib/Moo.pm @@ -2,10 +2,14 @@ package Moo; use strictures 1; use Moo::_Utils; +use B 'perlstring'; +use Sub::Defer (); -our $VERSION = '0.009006'; # 0.9.6 +our $VERSION = '0.091004'; # 0.91.4 $VERSION = eval $VERSION; +require Moo::sification; + our %MAKERS; sub import { @@ -13,30 +17,41 @@ sub import { my $class = shift; strictures->import; return if $MAKERS{$target}; # already exported into this package - *{_getglob("${target}::extends")} = sub { + _install_coderef "${target}::extends" => "Moo::extends" => sub { _load_module($_) for @_; # Can't do *{...} = \@_ or 5.10.0's mro.pm stops seeing @ISA @{*{_getglob("${target}::ISA")}{ARRAY}} = @_; + if (my $old = delete $Moo::MAKERS{$target}{constructor}) { + delete _getstash($target)->{new}; + Moo->_constructor_maker_for($target) + ->register_attribute_specs(%{$old->all_attribute_specs}); + } + $Moo::HandleMoose::MOUSE{$target} = [ + grep defined, map Mouse::Util::find_meta($_), @_ + ] if $INC{"Mouse.pm"}; + $class->_maybe_reset_handlemoose($target); + return; }; - *{_getglob("${target}::with")} = sub { + _install_coderef "${target}::with" => "Moo::with" => sub { require Moo::Role; - die "Only one role supported at a time by with" if @_ > 1; - Moo::Role->apply_role_to_package($target, $_[0]); + Moo::Role->apply_roles_to_package($target, $_[0]); + $class->_maybe_reset_handlemoose($target); }; $MAKERS{$target} = {}; - *{_getglob("${target}::has")} = sub { + _install_coderef "${target}::has" => "Moo::has" => sub { my ($name, %spec) = @_; - ($MAKERS{$target}{accessor} ||= do { - require Method::Generate::Accessor; - Method::Generate::Accessor->new - })->generate_method($target, $name, \%spec); $class->_constructor_maker_for($target) ->register_attribute_specs($name, \%spec); + $class->_accessor_maker_for($target) + ->generate_method($target, $name, \%spec); + $class->_maybe_reset_handlemoose($target); + return; }; foreach my $type (qw(before after around)) { - *{_getglob "${target}::${type}"} = sub { + _install_coderef "${target}::${type}" => "Moo::${type}" => sub { require Class::Method::Modifiers; _install_modifier($target, $type, @_); + return; }; } { @@ -45,6 +60,41 @@ sub import { require Moo::Object; ('Moo::Object'); } unless @{"${target}::ISA"}; } + if ($INC{'Moo/HandleMoose.pm'}) { + Moo::HandleMoose::inject_fake_metaclass_for($target); + } +} + +sub _maybe_reset_handlemoose { + my ($class, $target) = @_; + if ($INC{"Moo/HandleMoose.pm"}) { + Moo::HandleMoose::maybe_reinject_fake_metaclass_for($target); + } +} + +sub _accessor_maker_for { + my ($class, $target) = @_; + return unless $MAKERS{$target}; + $MAKERS{$target}{accessor} ||= do { + my $maker_class = do { + if (my $m = do { + if (my $defer_target = + (Sub::Defer::defer_info($target->can('new'))||[])->[0] + ) { + my ($pkg) = ($defer_target =~ /^(.*)::[^:]+$/); + $MAKERS{$pkg} && $MAKERS{$pkg}{accessor}; + } else { + undef; + } + }) { + ref($m); + } else { + require Method::Generate::Accessor; + 'Method::Generate::Accessor' + } + }; + $maker_class->new; + } } sub _constructor_maker_for { @@ -74,18 +124,21 @@ sub _constructor_maker_for { $moo_constructor = 1; # no other constructor, make a Moo one } }; - Method::Generate::Constructor + ($con ? ref($con) : 'Method::Generate::Constructor') ->new( package => $target, - accessor_generator => do { - require Method::Generate::Accessor; - Method::Generate::Accessor->new; - }, + accessor_generator => $class->_accessor_maker_for($target), construction_string => ( $moo_constructor ? ($con ? $con->construction_string : undef) : ('$class->'.$target.'::SUPER::new(@_)') - ) + ), + subconstructor_handler => ( + ' if ($Moo::MAKERS{$class}) {'."\n" + .' '.$class.'->_constructor_maker_for($class,'.perlstring($target).');'."\n" + .' return $class->new(@_)'.";\n" + .' }'."\n" + ), ) ->install_delayed ->register_attribute_specs(%{$con?$con->all_attribute_specs:{}}) @@ -93,21 +146,14 @@ sub _constructor_maker_for { } 1; +=pod + +=encoding utf-8 =head1 NAME Moo - Minimalist Object Orientation (with Moose compatiblity) -=head1 WARNING WARNING WARNING - -This is a 0.9 release because we're fairly sure it works. For us. Until it's -tested in the wild, we make no guarantees it also works for you. - -If this module does something unexpected, please submit a failing test. - -But if it eats your cat, sleeps with your boyfriend, or pushes grandma down -the stairs to save her from the terrible secret of space, it's not our fault. - =head1 SYNOPSIS package Cat::Food; @@ -182,6 +228,35 @@ Hence - Moo exists as its name - Minimal Object Orientation - with a pledge to make it smooth to upgrade to L when you need more than minimal features. +=head1 Moo and Moose - NEW, EXPERIMENTAL + +If L detects L being loaded, it will automatically register +metaclasses for your L and L packages, so you should be able +to use them in L code without it ever realising you aren't using +L everywhere. + +Extending a L class or consuming a L should also work. + +So should extending a L class or consuming a L. + +This means that there is no need for anything like L for Moo +code - Moo and Moose code should simply interoperate without problem. To +handle L code, you'll likely need an empty Moo role or class consuming +or extending the L stuff since it doesn't register true L +metaclasses like we do. + +However, these features are new as of 0.91.0 (0.091000) so while serviceable, +they are absolutely certain to not be 100% yet; please do report bugs. + +If you need to disable the metaclass creation, add: + + no Moo::sification; + +to your code before Moose is loaded, but bear in mind that this switch is +currently global and turns the mechanism off entirely, so don't put this +in library code, only in a top level script as a temporary measure while +you send a bug report. + =head1 IMPORTED METHODS =head2 new @@ -194,14 +269,42 @@ or =head2 BUILDARGS -This feature from Moose is not yet supported. + sub BUILDARGS { + my ( $class, @args ) = @_; + + unshift @args, "attr1" if @args % 2 == 1; + + return { @args }; + }; + + Foo::Bar->new( 3 ); + +The default implementation of this method accepts a hash or hash reference of +named parameters. If it receives a single argument that isn't a hash reference +it throws an error. + +You can override this method in your class to handle other types of options +passed to the constructor. + +This method should always return a hash reference of named options. + +=head2 BUILD + +Define a C method on your class and the constructor will automatically +call the C method from parent down to child after the object has +been instantiated. Typically this is used for object validation or possibly +logging. -=head2 BUILDALL +=head2 DEMOLISH -Don't override (or probably even call) this method. Instead, you can define -a C method on your class and the constructor will automatically call the -C method from parent down to child after the object has been -instantiated. Typically this is used for object validation or possibly logging. +If you have a C method anywhere in your inheritance hierarchy, +a C method is created on first object construction which will call +C<< $instance->DEMOLISH($in_global_destruction) >> for each C +method from child upwards to parents. + +Note that the C method is created on first construction of an object +of your class in order to not add overhead to classes without C +methods; this may prove slightly surprising if you try and define your own. =head2 does @@ -226,10 +329,13 @@ them like 'use base' would. =head2 with with 'Some::Role1'; - with 'Some::Role2'; -Composes a L into current class. Only one role may be composed in -at a time to allow the code to remain as simple as possible. +or + + with 'Some::Role1', 'Some::Role2'; + +Composes one or more L (or L) roles into the current +class. An error will be raised if these roles have conflicting methods. =head2 has @@ -245,9 +351,24 @@ The options for C are as follows: =item * is -B, must be C or C. Unsurprisingly, C generates an -accessor that will not respond to arguments; to be clear: a getter only. C -will create a perlish getter/setter. +B, may be C, C, C or C. + +C generates an accessor that dies if you attempt to write to it - i.e. +a getter only - by defaulting C to the name of the attribute. + +C generates a normal getter/setter by defaulting C to the +name of the attribute. + +C generates a reader like C, but also sets C to 1 and +C to C<_build_${attribute_name}> to allow on-demand generated +attributes. This feature was my attempt to fix my incompetence when +originally designing C, and is also implemented by +L. + +C generates a reader like C, but also sets C to +C<_set_${attribute_name}> for attributes that are designed to be written +from inside of the class, but read-only from outside. +This feature comes from L. =item * isa @@ -261,11 +382,29 @@ one should do L -=item * coerce +Since L does B run the C check before C if a coercion +subroutine has been supplied, C checks are not structural to your code +and can, if desired, be omitted on non-debug builds (although if this results +in an uncaught bug causing your program to break, the L authors guarantee +nothing except that you get to keep both halves). + +If you want L style named types, look at +L. + +To cause your C entries to be automatically mapped to named +L objects (rather than the default behaviour +of creating an anonymous type), set: -This Moose feature is not yet supported + $Moo::HandleMoose::TYPE_MAP{$isa_coderef} = sub { + require MooseX::Types::Something; + return MooseX::Types::Something::TypeName(); + }; + +Note that this example is purely illustrative; anything that returns a +L object or something similar enough to it to +make L happy is fine. -=begin hide +=item * coerce Takes a coderef which is meant to coerce the attribute. The basic idea is to do something like the following: @@ -274,14 +413,41 @@ do something like the following: $_[0] + 1 unless $_[0] % 2 }, +Note that L will always fire your coercion - this is to permit +isa entries to be used purely for bug trapping, whereas coercions are +always structural to your code. We do, however, apply any supplied C +check after the coercion has run to ensure that it returned a valid value. + L -=end hide +=item * handles + +Takes a string + + handles => 'RobotRole' + +Where C is a role (L) that defines an interface which +becomes the list of methods to handle. + +Takes a list of methods + + handles => [ qw( one two ) ] + +Takes a hashref + + handles => { + un => 'one', + } =item * trigger -Takes a coderef which will get called any time the attribute is set. Coderef -will be invoked against the object with the new value as an argument. +Takes a coderef which will get called any time the attribute is set. This +includes the constructor. Coderef will be invoked against the object with the +new value as an argument. + +If you set this to just C<1>, it generates a trigger which calls the +C<_trigger_${attr_name}> method on C<$self>. This feature comes from +L. Note that Moose also passes the old value, if any; this feature is not yet supported. @@ -305,8 +471,10 @@ L Takes a method name which will return true if an attribute has a value. -A common example of this would be to call it C, implying that the -object has a C<$foo> set. +If you set this to just C<1>, the predicate is automatically named +C if your attribute's name does not start with an +underscore, or <_has_${attr_name_without_the_underscore}> if it does. +This feature comes from L. =item * builder @@ -319,10 +487,18 @@ Moo will call $self->$builder; +If you set this to just C<1>, the predicate is automatically named +C<_build_${attr_name}>. This feature comes from L. + =item * clearer Takes a method name which will clear the attribute. +If you set this to just C<1>, the clearer is automatically named +C if your attribute's name does not start with an +underscore, or <_clear_${attr_name_without_the_underscore}> if it does. +This feature comes from L. + =item * lazy B. Set this if you want values for the attribute to be grabbed @@ -333,6 +509,18 @@ another attribute to be set. B. Set this if the attribute must be passed on instantiation. +=item * reader + +The value of this attribute will be the name of the method to get the value of +the attribute. If you like Java style methods, you might set this to +C + +=item * writer + +The value of this attribute will be the name of the method to set the value of +the attribute. If you like Java style methods, you might set this to +C + =item * weak_ref B. Set this if you want the reference that the attribute contains to @@ -344,6 +532,7 @@ leaks. Takes the name of the key to look for at instantiation time of the object. A common use of this is to make an underscored attribute have a non-underscored initialization name. C means that passing the value in on instantiation +is ignored. =back @@ -376,33 +565,94 @@ aware can take advantage of this. =head1 INCOMPATIBILITIES WITH MOOSE -You can only compose one role at a time. If your application is large or -complex enough to warrant complex composition, you wanted L. - -There is no complex type system. C is verified with a coderef, if you +There is no built in type system. C is verified with a coderef, if you need complex types, just make a library of coderefs, or better yet, functions -that return quoted subs. +that return quoted subs. L provides a similar API +to L so that you can write + + has days_to_live => (is => 'ro', isa => Int); + +and have it work with both; it is hoped that providing only subrefs as an +API will encourage the use of other type systems as well, since it's +probably the weakest part of Moose design-wise. C is not supported in core since the author considers it to be a -bad idea but may be supported by an extension in future. +bad idea but may be supported by an extension in future. Meanwhile C or +C are more likely to be able to fulfill your needs. There is no meta object. If you need this level of complexity you wanted L - Moo succeeds at being small because it explicitly does not -provide a metaprotocol. +provide a metaprotocol. However, if you load L, then + + Class::MOP::class_of($moo_class_or_role) + +will return an appropriate metaclass pre-populated by L. No support for C, C, C, or C - override can be handled by around albeit with a little more typing, and the author considers augment to be a bad idea. +The C method is not provided by default. The author suggests loading +L into C (via C for example) and +using C<$obj-E$::Dwarn()> instead. + L only supports coderefs, because doing otherwise is usually a mistake anyway. -C is not supported per se, but of course it will work if you -manually set all the options it implies. +C is not supported; you are instead encouraged to use the +C 'lazy'> option supported by L and L. C is not supported since the author considers it a bad idea. -C is not supported since it's a very poor replacement for POD. +C will show up in a L metaclass created from your class +but is otherwise ignored. Then again, L ignores it as well, so this +is arguably not an incompatibility. + +Since C does not require C to be defined but L does +require it, the metaclass inflation for coerce-alone is a trifle insane +and if you attempt to subtype the result will almost certainly break. + +Handling of warnings: when you C we enable FATAL warnings. The nearest +similar invocation for L would be: + + use Moose; + use warnings FATAL => "all"; + +Additionally, L supports a set of attribute option shortcuts intended to +reduce common boilerplate. The set of shortcuts is the same as in the L +module L as of its version 0.009+. So if you: + + package MyClass; + use Moo; + +The nearest L invocation would be: + + package MyClass; + + use Moose; + use warnings FATAL => "all"; + use MooseX::AttributeShortcuts; + +or, if you're inheriting from a non-Moose class, + + package MyClass; + + use Moose; + use MooseX::NonMoose; + use warnings FATAL => "all"; + use MooseX::AttributeShortcuts; + +Finally, Moose requires you to call + + __PACKAGE__->meta->make_immutable; + +at the end of your class to get an inlined (i.e. not horribly slow) +constructor. Moo does it automatically the first time ->new is called +on your class. + +=head1 SUPPORT + +IRC: #web-simple on irc.perl.org =head1 AUTHOR @@ -420,6 +670,14 @@ jnap - John Napiorkowski (cpan:JJNAPIORK) ribasushi - Peter Rabbitson (cpan:RIBASUSHI) +chip - Chip Salzenberg (cpan:CHIPS) + +ajgb - Alex J. G. Burzyński (cpan:AJGB) + +doy - Jesse Luehrs (cpan:DOY) + +perigrin - Chris Prather (cpan:PERIGRIN) + =head1 COPYRIGHT Copyright (c) 2010-2011 the Moo L and L