X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FCookbook.pod;h=8e96f7129ef5ed674219cba84039f9d1cda5ae84;hb=refs%2Fheads%2Frfc%2Fdeprecate-nonarrayref-enum;hp=70f4294a241c885e4f93199bf41f36af7314fd14;hpb=f7f3648d0b31f6b8c9505df3830943f0fe93b657;p=gitmo%2FMoose.git diff --git a/lib/Moose/Cookbook.pod b/lib/Moose/Cookbook.pod index 70f4294..8e96f71 100644 --- a/lib/Moose/Cookbook.pod +++ b/lib/Moose/Cookbook.pod @@ -1,115 +1,194 @@ +package Moose::Cookbook; -=pod +# ABSTRACT: How to cook a Moose + +__END__ -=head1 NAME -Moose::Cookbook - How to cook a Moose +=pod =head1 DESCRIPTION -The Moose cookbook is a series of recipes taken from the Moose -test suite. Each recipe presents some code, which demonstrates -some of the features of Moose, and then proceeds to explain the -details of the code. +The Moose cookbook is a series of recipes showing various Moose +features. Most recipes present some code demonstrating some feature, +and then explain the details of the code. -We also provide a L and a L -for common questions and problems people have with Moose. +You should probably read the L first. The manual +explains Moose concepts without being too code-heavy. =head1 RECIPES =head2 Basic Moose +These recipes will give you a good overview of Moose's capabilities, starting +with simple attribute declaration, and moving on to more powerful features like +laziness, types, type coercion, method modifiers, and more. + =over 4 -=item L - The (always classic) B example +=item L -A simple Moose-based class. Demonstrated Moose attributes and subclassing. +A simple Moose-based class. Demonstrates basic Moose attributes and subclassing. -=item L - A simple B example +=item L -A slightly more complex Moose class. Demonstrates using a method -modifier in a subclass. +A slightly more complex Moose class. Demonstrates using a method modifier in a +subclass. -=item L - A lazy B example +=item L Demonstrates several attribute features, including types, weak -references, predicates ("does this object have a foo?"), defaults, and -lazy attribute construction. +references, predicates ("does this object have a foo?"), defaults, +laziness, and triggers. -=item L - Subtypes, and modeling a simple B class hierarchy +=item L -Introduces the creation and use of custom types, a C method, -and the use of C in a subclass. +Introduces the creation and use of custom types, a C method, and the +use of C in a subclass. This recipe also shows how to model a set of +classes that could be used to model companies, people, employees, etc. -=item L - More subtypes, coercion in a B class +=item L -More type examples, including the use of type coercions. +This recipe covers more subtype creation, including the use of type coercions. -=item L - The augment/inner example +=item L -Demonstrates the use of C method modifiers, a way of turning -the usual method overriding style "inside-out". +Making a class immutable greatly increases the speed of accessors and +object construction. -=item L - Making Moose fast with immutable (TODO) +=item L - Builder methods and lazy_build -I +The builder feature provides an inheritable and role-composable way to +provide a default attribute value. -=item L - ?? +=item L -I +Demonstrates using operator overloading, coercion, and subtypes to +model how eye color is determined during reproduction. -=item L - ?? +=item L -I +This recipe demonstrates the use of C and C to hook +into object construction. + +=item L + +In this recipe, we make a Moose-based subclass of L, a +module which does not use Moose itself. + +=item L + +Demonstrates the use of C method modifiers, a way of turning +the usual method overriding style "inside-out". =back =head2 Moose Roles +These recipes will show you how to use Moose roles. + =over 4 -=item L - The Moose::Role example +=item L Demonstrates roles, which are also sometimes known as traits or mix-ins. Roles provide a method of code re-use which is orthogonal to subclassing. -=item L - Advanced Role Composition (TODO) +=item L -I +Sometimes you just want to include part of a role in your +class. Sometimes you want the whole role but one of its methods +conflicts with one in your class. With method exclusion and aliasing, +you can work around these problems. -=item L - Runtime Role Composition (TODO) +=item L -I +In this recipe, we apply a role to an existing object instance. =back =head2 Meta Moose +These recipes show you how to write your own meta classes, which lets +you extend the object system provided by Moose. + =over 4 -=item L - Welcome to the meta-world (TODO) +=item L + +If you're wondering what all this "meta" stuff is, and why you should +care about it, read this "recipe". + +=item L -I +Extending Moose's attribute metaclass is a great way to add +functionality. However, attributes can only have one metaclass. +Applying roles to the attribute metaclass lets you provide +composable attribute functionality. -=item L - The meta-attribute example +=item L -One way to extend Moose is to provide your own attribute -metaclasses. Attribute metaclasses let you extend attribute -declarations (with C) and behavior to provide additional -attribute functionality. +This recipe takes the class metaclass we saw in the previous recipe +and reimplements it as a metaclass trait. -=item L - The meta-attribute trait example (TODO) +=item L -I +This recipe shows a custom method metaclass that implements making a +method private. -=item L - The meta-instance example (TODO) +=item L -I +This recipe shows an example of how you create your own meta-instance +class. The meta-instance determines the internal structure of object +instances and provide access to attribute slots. -=item L - The meta-class example (TODO) +In this particular instance, we use a blessed glob reference as the instance +instead of a blessed hash reference. -I +=item Hooking into immutabilization (TODO) + +Moose has a feature known as "immutabilization". By calling C<< +__PACKAGE__->meta()->make_immutable() >> after defining your class +(attributes, roles, etc), you tell Moose to optimize things like +object creation, attribute access, and so on. + +If you are creating your own metaclasses, you may need to hook into +the immutabilization system. This cuts across a number of spots, +including the metaclass class, meta method classes, and possibly the +meta-instance class as well. + +This recipe shows you how to write extensions which immutabilize +properly. + +=back + +=head2 Extending Moose + +These recipes cover some more ways to extend Moose, and will be useful +if you plan to write your own C module. + +=over 4 + +=item L + +There are quite a few ways to extend Moose. This recipe provides an +overview of each method, and provides recommendations for when each is +appropriate. + +=item L + +Many base object class extensions can be implemented as roles. This +example shows how to provide a base object class debugging role that +is applied to any class that uses a notional C +module. + +=item L + +This recipe shows how to provide a replacement for C. You +may want to do this as part of the API for a C module, +especially if you want to default to a new metaclass class or base +object class. =back @@ -117,29 +196,33 @@ I =over 4 +=item L + =item L =back -=head1 SEE ALSO +=head1 Legacy Recipes + +These cover topics that are no longer considered best practice. We've kept +them in case in you encounter these usages in the wild. =over 4 -=item L +=item L -=back +=item L -=head1 AUTHOR +=item L -Stevan Little Estevan@iinteractive.comE +=back -=head1 COPYRIGHT AND LICENSE +=head1 SEE ALSO -Copyright 2006-2008 by Infinity Interactive, Inc. +=over 4 -L +=item L -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +=back =cut