6 Moose::Cookbook - How to cook a Moose
10 The Moose cookbook is a series of recipes showing various Moose
11 features. Most recipes present some code demonstrating some feature,
12 and then explain the details of the code.
14 You should probably read the L<Moose::Manual> first. The manual
15 explains Moose concepts without being too code-heavy.
21 These recipes will give you a good idea of what Moose is capable,
22 starting with simple attribute declaration, and moving on to more
23 powerful features like laziness, types, type coercion, method
28 =item L<Moose::Cookbook::Basics::Recipe1> - The (always classic) B<Point> example
30 A simple Moose-based class. Demonstrated Moose attributes and subclassing.
32 =item L<Moose::Cookbook::Basics::Recipe2> - A simple B<BankAccount> example
34 A slightly more complex Moose class. Demonstrates using a method
35 modifier in a subclass.
37 =item L<Moose::Cookbook::Basics::Recipe3> - A lazy B<BinaryTree> example
39 Demonstrates several attribute features, including types, weak
40 references, predicates ("does this object have a foo?"), defaults,
41 laziness, and triggers.
43 =item L<Moose::Cookbook::Basics::Recipe4> - Subtypes, and modeling a simple B<Company> class hierarchy
45 Introduces the creation and use of custom types, a C<BUILD> method,
46 and the use of C<override> in a subclass.
48 =item L<Moose::Cookbook::Basics::Recipe5> - More subtypes, coercion in a B<Request> class
50 More type examples, including the use of type coercions.
52 =item L<Moose::Cookbook::Basics::Recipe6> - The augment/inner example
54 Demonstrates the use of C<augment> method modifiers, a way of turning
55 the usual method overriding style "inside-out".
57 =item L<Moose::Cookbook::Basics::Recipe7> - Making Moose fast with immutable
59 Making a class immutable greatly increases the speed of accessors and
62 =item L<Moose::Cookbook::Basics::Recipe8> - Managing complex relations with trigger (TODO)
66 Work off of this http://code2.0beta.co.uk/moose/svn/Moose/trunk/t/200_examples/007_Child_Parent_attr_inherit.t
68 =item L<Moose::Cookbook::Basics::Recipe9> - Builder methods and lazy_build
70 The builder feature provides an inheritable and role-composable way to
71 provide a default attribute value.
73 =item L<Moose::Cookbook::Basics::Recipe10> - Operator overloading, subtypes, and coercion
75 Demonstrates using operator overloading, coercion, and subtypes to
76 model how eye color is determined during reproduction.
78 =item L<Moose::Cookbook::Basics::Recipe11> - BUILD and BUILDARGS (TODO)
80 We need a good recipe demonstrating how these work.
86 These recipes will show you how to use Moose roles.
90 =item L<Moose::Cookbook::Roles::Recipe1> - The Moose::Role example
92 Demonstrates roles, which are also sometimes known as traits or
93 mix-ins. Roles provide a method of code re-use which is orthogonal to
96 =item L<Moose::Cookbook::Roles::Recipe2> - Advanced Role Composition - method exclusion and aliasing
98 Sometimes you just want to include part of a role in your
99 class. Sometimes you want the whole role but one if its methods
100 conflicts with one in your class. With method exclusion and aliasing,
101 you can work around these problems.
103 =item L<Moose::Cookbook::Roles::Recipe3> - Runtime Role Composition (TODO)
105 I<abstract goes here>
111 These recipes show you how to write your own meta classes, which lets
112 you extend the object system provide by Moose.
116 =item L<Moose::Cookbook::Meta::Recipe1> - Welcome to the meta-world (Why Go Meta?)
118 If you're wondering what all this "meta" stuff is, and why you should
119 care about it, read this "recipe".
121 =item L<Moose::Cookbook::Meta::Recipe2> - A meta-attribute, attributes with labels
123 One way to extend Moose is to provide your own attribute
124 metaclasses. Attribute metaclasses let you extend attribute
125 declarations (with C<has>) and behavior to provide additional
126 attribute functionality.
128 =item L<Moose::Cookbook::Meta::Recipe3> - Labels implemented via attribute traits
130 Extending Moose's attribute metaclass is a great way to add
131 functionality. However, attributes can only have one metaclass.
132 Applying roles to the attribute metaclass lets you provide
133 composable attribute functionality.
135 =item L<Moose::Cookbook::Meta::Recipe4> - Adding a "table" attribute to the metaclass
137 If you want to store more information about your classes, you'll have
138 to extend C<Moose::Meta::Class>. Doing so is simple, but you'll
139 probably also want to provide some sugar, so see
140 L<Moose::Cookbook::Extending::Recipe2> as well.
142 =item L<Moose::Cookbook::Meta::Recipe5> - The "table" attribute implemented as a metaclass trait
144 This example takes the class metaclass we saw in the previous recipe
145 and reimplements it as a metaclass trait.
147 =item L<Moose::Cookbook::Meta::Recipe6> - Hooking into the immutabilization system (TODO)
149 Moose has a feature known as "immutabilization". By calling C<<
150 __PACKAGE__->meta()->make_immutable() >> after defining your class
151 (attributes, roles, etc), you tell Moose to optimize things like
152 object creation, attribute access, and so on.
154 If you are creating your own metaclasses, you may need to hook into
155 the immutabilization system. This cuts across a number of spots,
156 including the metaclass class, meta method classes, and possibly the
157 meta-instance class as well.
159 This recipe shows you how to write extensions which immutabilize
162 =item L<Moose::Cookbook::Meta::Recipe7> - I<meta-instance> (TODO)
164 I<abstract goes here>
168 =head2 Extending Moose
170 These recipes cover some more ways to extend Moose, and will be useful
171 if you plan to write your own C<MooseX> module.
175 =item L<Moose::Cookbook::Extending::Recipe1> - Moose extension overview
177 There are quite a number of ways to extend Moose. This recipe explains
178 provides an overview of each method, and provides recommendations for
179 when each is appropriate.
181 =item L<Moose::Cookbook::Extending::Recipe2> - Providing a base object class role
183 Many base object class extensions can be implemented as roles. This
184 example shows how to provide a base object class debugging role that
185 is applied to any class that uses a notional C<MooseX::Debugging>
188 =item L<Moose::Cookbook::Extending::Recipe3> - Providing an alternate base object class
190 You may find that you want to provide an alternate base object class
191 along with a meta extension, or maybe you just want to add some
192 functionality to all your classes without typing C<extends
193 'MyApp::Base'> over and over.
195 =item L<Moose::Cookbook::Extending::Recipe4> - Acting like Moose.pm and providing sugar Moose-style
197 This recipe shows how to provide a replacement for C<Moose.pm>. You
198 may want to do this as part of the API for a C<MooseX> module,
199 especially if you want to default to a new metaclass class or base
208 =item L<Moose::Cookbook::Snack::Keywords>
210 =item L<Moose::Cookbook::Snack::Types>
218 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>
224 Stevan Little E<lt>stevan@iinteractive.comE<gt>
226 =head1 COPYRIGHT AND LICENSE
228 Copyright 2006-2009 by Infinity Interactive, Inc.
230 L<http://www.iinteractive.com>
232 This library is free software; you can redistribute it and/or modify
233 it under the same terms as Perl itself.