X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FCookbook.pod;h=c11f0681f38c8965900945bb82169349ae8995ef;hb=6cdf1d652c8076c547e7f8e81e90a474d125a60c;hp=262d4888a83cd30215fe059f35b8275a388e2908;hpb=c8d5f1e1afb0a13f2a0d66b55f7fa550e4b38d1d;p=gitmo%2FMoose.git diff --git a/lib/Moose/Cookbook.pod b/lib/Moose/Cookbook.pod index 262d488..c11f068 100644 --- a/lib/Moose/Cookbook.pod +++ b/lib/Moose/Cookbook.pod @@ -7,28 +7,26 @@ Moose::Cookbook - How to cook a Moose =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 idea of what Moose is capable, -starting with simple attribute declaration, and moving on to more -powerful features like laziness, types, type coercion, method -modifiers, and more. +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 -A simple Moose-based class. Demonstrated Moose attributes and subclassing. +A simple Moose-based class. Demonstrates Moose attributes and subclassing. =item L - A simple B example @@ -38,8 +36,8 @@ modifier in a subclass. =item L - A lazy B example Demonstrates several attribute features, including types, weak -references, predicates ("does this object have a foo?"), defaults, and -lazy attribute uction. +references, predicates ("does this object have a foo?"), defaults, +laziness, and triggers. =item L - Subtypes, and modeling a simple B class hierarchy @@ -60,22 +58,26 @@ the usual method overriding style "inside-out". Making a class immutable greatly increases the speed of accessors and object construction. -=item L - Managing complex relations with trigger (TODO) - -I - -Work off of this http://code2.0beta.co.uk/moose/svn/Moose/trunk/t/200_examples/007_Child_Parent_attr_inherit.t - -=item L - Builder methods and lazy_build +=item L - Builder methods and lazy_build The builder feature provides an inheritable and role-composable way to provide a default attribute value. -=item L - Operator overloading, subtypes, and coercion +=item L - Operator overloading, subtypes, and coercion Demonstrates using operator overloading, coercion, and subtypes to model how eye color is determined during reproduction. +=item L - Using BUILDARGS and BUILD to hook into object construction + +This recipe demonstrates the use of C and C to hook +into object construction. + +=item L - Extending a non-Moose base class + +In this recipe, we make a Moose-based subclass of L, a +module which does not use Moose itself. + =back =head2 Moose Roles @@ -84,29 +86,29 @@ These recipes will show you how to use Moose roles. =over 4 -=item L - The Moose::Role example +=item L - The Moose::Role example 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 - method exclusion and aliasing +=item L - Advanced Role Composition - method exclusion and aliasing Sometimes you just want to include part of a role in your -class. Sometimes you want the whole role but one if its methods +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 - Applying a role to an object instance -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 provide by Moose. +you extend the object system provided by Moose. =over 4 @@ -138,10 +140,21 @@ L as well. =item L - The "table" attribute implemented as a metaclass trait -This example takes the class metaclass we saw in the previous recipe +This recipe takes the class metaclass we saw in the previous recipe and reimplements it as a metaclass trait. -=item L - Hooking into the immutabilization system (TODO) +=item L - A method metaclass for marking methods public or private + +This recipe shows a custom method metaclass that implements making a +method private. + +=item L - Using a blessed array reference as an object instance + +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 Moose::Cookbook::Meta::Recipe8 - Hooking into immutabilization (TODO) Moose has a feature known as "immutabilization". By calling C<< __PACKAGE__->meta()->make_immutable() >> after defining your class @@ -156,10 +169,6 @@ meta-instance class as well. This recipe shows you how to write extensions which immutabilize properly. -=item L - I (TODO) - -I - =back =head2 Extending Moose @@ -171,14 +180,16 @@ if you plan to write your own C module. =item L - Moose extension overview -There are quite a number of ways to extend Moose. This recipe explains -provides an overview of each method, and provides recommendations for -when each is appropriate. +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 - Providing a base object class role Many base object class extensions can be implemented as roles. This -example shows how to provide a base object class debugging role. +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 - Providing an alternate base object class @@ -220,7 +231,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L