Comment out alias/excludes warnings for 1.12 release
[gitmo/Moose.git] / lib / Moose / Cookbook.pod
1
2 =pod
3
4 =head1 NAME
5
6 Moose::Cookbook - How to cook a Moose
7
8 =head1 DESCRIPTION
9
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.
13
14 You should probably read the L<Moose::Manual> first. The manual
15 explains Moose concepts without being too code-heavy.
16
17 =head1 RECIPES
18
19 =head2 Basic Moose
20
21 These recipes will give you a good overview of Moose's capabilities, starting
22 with simple attribute declaration, and moving on to more powerful features like
23 laziness, types, type coercion, method modifiers, and more.
24
25 =over 4
26
27 =item L<Moose::Cookbook::Basics::Recipe1> - The (always classic) B<Point> example
28
29 A simple Moose-based class. Demonstrates Moose attributes and subclassing.
30
31 =item L<Moose::Cookbook::Basics::Recipe2> - A simple B<BankAccount> example
32
33 A slightly more complex Moose class. Demonstrates using a method
34 modifier in a subclass.
35
36 =item L<Moose::Cookbook::Basics::Recipe3> - A lazy B<BinaryTree> example
37
38 Demonstrates several attribute features, including types, weak
39 references, predicates ("does this object have a foo?"), defaults,
40 laziness, and triggers.
41
42 =item L<Moose::Cookbook::Basics::Recipe4> - Subtypes, and modeling a simple B<Company> class hierarchy
43
44 Introduces the creation and use of custom types, a C<BUILD> method,
45 and the use of C<override> in a subclass.
46
47 =item L<Moose::Cookbook::Basics::Recipe5> - More subtypes, coercion in a B<Request> class
48
49 More type examples, including the use of type coercions.
50
51 =item L<Moose::Cookbook::Basics::Recipe6> - The augment/inner example
52
53 Demonstrates the use of C<augment> method modifiers, a way of turning
54 the usual method overriding style "inside-out".
55
56 =item L<Moose::Cookbook::Basics::Recipe7> - Making Moose fast with immutable
57
58 Making a class immutable greatly increases the speed of accessors and
59 object construction.
60
61 =item L<Moose::Cookbook::Basics::Recipe8> - Builder methods and lazy_build
62
63 The builder feature provides an inheritable and role-composable way to
64 provide a default attribute value.
65
66 =item L<Moose::Cookbook::Basics::Recipe9> - Operator overloading, subtypes, and coercion
67
68 Demonstrates using operator overloading, coercion, and subtypes to
69 model how eye color is determined during reproduction.
70
71 =item L<Moose::Cookbook::Basics::Recipe10> - Using BUILDARGS and BUILD to hook into object construction
72
73 This recipe demonstrates the use of C<BUILDARGS> and C<BUILD> to hook
74 into object construction.
75
76 =item L<Moose::Cookbook::Basics::Recipe11> - Extending a non-Moose base class
77
78 In this recipe, we make a Moose-based subclass of L<DateTime>, a
79 module which does not use Moose itself.
80
81 =back
82
83 =head2 Moose Roles
84
85 These recipes will show you how to use Moose roles.
86
87 =over 4
88
89 =item L<Moose::Cookbook::Roles::Recipe1> - The Moose::Role example
90
91 Demonstrates roles, which are also sometimes known as traits or
92 mix-ins. Roles provide a method of code re-use which is orthogonal to
93 subclassing.
94
95 =item L<Moose::Cookbook::Roles::Recipe2> - Advanced Role Composition - method exclusion and aliasing
96
97 Sometimes you just want to include part of a role in your
98 class. Sometimes you want the whole role but one of its methods
99 conflicts with one in your class. With method exclusion and aliasing,
100 you can work around these problems.
101
102 =item L<Moose::Cookbook::Roles::Recipe3> - Applying a role to an object instance
103
104 In this recipe, we apply a role to an existing object instance.
105
106 =back
107
108 =head2 Meta Moose
109
110 These recipes show you how to write your own meta classes, which lets
111 you extend the object system provided by Moose.
112
113 =over 4
114
115 =item L<Moose::Cookbook::Meta::Recipe1> - Welcome to the meta-world (Why Go Meta?)
116
117 If you're wondering what all this "meta" stuff is, and why you should
118 care about it, read this "recipe".
119
120 =item L<Moose::Cookbook::Meta::Recipe2> - A meta-attribute, attributes with labels
121
122 One way to extend Moose is to provide your own attribute
123 metaclasses. Attribute metaclasses let you extend attribute
124 declarations (with C<has>) and behavior to provide additional
125 attribute functionality.
126
127 =item L<Moose::Cookbook::Meta::Recipe3> - Labels implemented via attribute traits
128
129 Extending Moose's attribute metaclass is a great way to add
130 functionality. However, attributes can only have one metaclass.
131 Applying roles to the attribute metaclass lets you provide
132 composable attribute functionality.
133
134 =item L<Moose::Cookbook::Meta::Recipe4> - Adding a "table" attribute to the metaclass
135
136 If you want to store more information about your classes, you'll have
137 to extend C<Moose::Meta::Class>. Doing so is simple, but you'll
138 probably also want to provide some sugar, so see
139 L<Moose::Cookbook::Extending::Recipe2> as well.
140
141 =item L<Moose::Cookbook::Meta::Recipe5> - The "table" attribute implemented as a metaclass trait
142
143 This recipe takes the class metaclass we saw in the previous recipe
144 and reimplements it as a metaclass trait.
145
146 =item L<Moose::Cookbook::Meta::Recipe6> - A method metaclass for marking methods public or private
147
148 This recipe shows a custom method metaclass that implements making a
149 method private.
150
151 =item L<Moose::Cookbook::Meta::Recipe7> - Using a blessed array reference as an object instance
152
153 This recipe shows an example of how you create your own meta-instance
154 class. The meta-instance determines the internal structure of object
155 instances and provide access to attribute slots.
156
157 =item Moose::Cookbook::Meta::Recipe8 - Hooking into immutabilization (TODO)
158
159 Moose has a feature known as "immutabilization". By calling C<<
160 __PACKAGE__->meta()->make_immutable() >> after defining your class
161 (attributes, roles, etc), you tell Moose to optimize things like
162 object creation, attribute access, and so on.
163
164 If you are creating your own metaclasses, you may need to hook into
165 the immutabilization system. This cuts across a number of spots,
166 including the metaclass class, meta method classes, and possibly the
167 meta-instance class as well.
168
169 This recipe shows you how to write extensions which immutabilize
170 properly.
171
172 =back
173
174 =head2 Extending Moose
175
176 These recipes cover some more ways to extend Moose, and will be useful
177 if you plan to write your own C<MooseX> module.
178
179 =over 4
180
181 =item L<Moose::Cookbook::Extending::Recipe1> - Moose extension overview
182
183 There are quite a few ways to extend Moose. This recipe provides an
184 overview of each method, and provides recommendations for when each is
185 appropriate.
186
187 =item L<Moose::Cookbook::Extending::Recipe2> - Providing a base object class role
188
189 Many base object class extensions can be implemented as roles. This
190 example shows how to provide a base object class debugging role that
191 is applied to any class that uses a notional C<MooseX::Debugging>
192 module.
193
194 =item L<Moose::Cookbook::Extending::Recipe3> - Providing an alternate base object class
195
196 You may find that you want to provide an alternate base object class
197 along with a meta extension, or maybe you just want to add some
198 functionality to all your classes without typing C<extends
199 'MyApp::Base'> over and over.
200
201 =item L<Moose::Cookbook::Extending::Recipe4> - Acting like Moose.pm and providing sugar Moose-style
202
203 This recipe shows how to provide a replacement for C<Moose.pm>. You
204 may want to do this as part of the API for a C<MooseX> module,
205 especially if you want to default to a new metaclass class or base
206 object class.
207
208 =back
209
210 =head1 SNACKS
211
212 =over 4
213
214 =item L<Moose::Cookbook::Snack::Keywords>
215
216 =item L<Moose::Cookbook::Snack::Types>
217
218 =back
219
220 =head1 SEE ALSO
221
222 =over 4
223
224 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>
225
226 =back
227
228 =head1 AUTHOR
229
230 Stevan Little E<lt>stevan@iinteractive.comE<gt>
231
232 =head1 COPYRIGHT AND LICENSE
233
234 Copyright 2006-2010 by Infinity Interactive, Inc.
235
236 L<http://www.iinteractive.com>
237
238 This library is free software; you can redistribute it and/or modify
239 it under the same terms as Perl itself.
240
241 =cut