X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FCookbook.pod;h=0f106ca07236703b053c40c0f5fb1c7ae4ca8703;hb=b5a10bf862744c97e1e9e0fb9ebb57366ac42e19;hp=67f6669f1c4ba63a9dc0806349a96eb7c760b032;hpb=a8b3fe6201d7f6ec5d22a3c09331cfae97633de0;p=gitmo%2FMoose.git diff --git a/lib/Moose/Cookbook.pod b/lib/Moose/Cookbook.pod index 67f6669..0f106ca 100644 --- a/lib/Moose/Cookbook.pod +++ b/lib/Moose/Cookbook.pod @@ -19,6 +19,11 @@ for common questions and problems people have with Moose. =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. + =over 4 =item L - The (always classic) B example @@ -34,7 +39,7 @@ modifier in a subclass. Demonstrates several attribute features, including types, weak references, predicates ("does this object have a foo?"), defaults, and -lazy attribute construction. +lazy attribute uction. =item L - Subtypes, and modeling a simple B class hierarchy @@ -68,13 +73,15 @@ provide a default attribute value. =item L - Operator overloading, subtypes, and coercion -Demonstrates using operator overloading, coercion, and sub types to +Demonstrates using operator overloading, coercion, and subtypes to model how eye color is determined during reproduction. =back =head2 Moose Roles +These recipes will show you how to use Moose roles. + =over 4 =item L - The Moose::Role example @@ -98,40 +105,103 @@ I =head2 Meta Moose +These recipes show you how to write your own meta classes, which lets +you extend the object system provide by Moose. + =over 4 =item L - Welcome to the meta-world (Why Go Meta?) -I +If you're wondering what all this "meta" stuff is, and why you should +care about it, read this "recipe". -=item L - The meta-attribute example +=item L - A meta-attribute, attributes with labels 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. -=item L - The meta-attribute trait example +=item L - Labels implemented via attribute traits 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-instance example (TODO) +=item L - Adding a "table" attribute to the metaclass -I +If you want to store more information about your classes, you'll have +to extend C. Doing so is simple, but you'll +probably also want to provide some sugar, so see +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 +and reimplements it as a metaclass trait. -=item L - The meta-class example (TODO) +=item L - Hooking into the immutabilization system (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. + +=item L - I (TODO) I =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 - 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. + +=item L - Providing a base object class role (TODO) + +Many base object class extensions can be implemented as roles. This +example shows how to provide a base object class debugging role. + +=item L - Providing an alternate base object class + +You may find that you want to provide an alternate base object class +along with a meta extension, or maybe you just want to add some +functionality to all your classes without typing C over and over. + +=item L - Acting like Moose.pm and providing sugar Moose-style + +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 + =head1 SNACKS =over 4 +=item L + =item L =back