1 package Moose::Cookbook;
3 # ABSTRACT: How to cook a Moose
12 The Moose cookbook is a series of recipes showing various Moose
13 features. Most recipes present some code demonstrating some feature,
14 and then explain the details of the code.
16 You should probably read the L<Moose::Manual> first. The manual
17 explains Moose concepts without being too code-heavy.
23 These recipes will give you a good overview of Moose's capabilities, starting
24 with simple attribute declaration, and moving on to more powerful features like
25 laziness, types, type coercion, method modifiers, and more.
29 =item L<Moose::Cookbook::Basics::Point_AttributesAndSubclassing>
31 A simple Moose-based class. Demonstrates basic Moose attributes and subclassing.
33 =item L<Moose::Cookbook::Basics::Recipe2> - A simple B<BankAccount> example
35 A slightly more complex Moose class. Demonstrates using a method
36 modifier in a subclass.
38 =item L<Moose::Cookbook::Basics::Recipe3> - A lazy B<BinaryTree> example
40 Demonstrates several attribute features, including types, weak
41 references, predicates ("does this object have a foo?"), defaults,
42 laziness, and triggers.
44 =item L<Moose::Cookbook::Basics::Recipe4> - Subtypes, and modeling a simple B<Company> class hierarchy
46 Introduces the creation and use of custom types, a C<BUILD> method,
47 and the use of C<override> in a subclass.
49 =item L<Moose::Cookbook::Basics::Recipe5> - More subtypes, coercion in a B<Request> class
51 More type examples, including the use of type coercions.
53 =item L<Moose::Cookbook::Basics::Recipe6> - The augment/inner example
55 Demonstrates the use of C<augment> method modifiers, a way of turning
56 the usual method overriding style "inside-out".
58 =item L<Moose::Cookbook::Basics::Recipe7> - Making Moose fast with immutable
60 Making a class immutable greatly increases the speed of accessors and
63 =item L<Moose::Cookbook::Basics::Recipe8> - Builder methods and lazy_build
65 The builder feature provides an inheritable and role-composable way to
66 provide a default attribute value.
68 =item L<Moose::Cookbook::Basics::Recipe9> - Operator overloading, subtypes, and coercion
70 Demonstrates using operator overloading, coercion, and subtypes to
71 model how eye color is determined during reproduction.
73 =item L<Moose::Cookbook::Basics::Recipe10> - Using BUILDARGS and BUILD to hook into object construction
75 This recipe demonstrates the use of C<BUILDARGS> and C<BUILD> to hook
76 into object construction.
78 =item L<Moose::Cookbook::Basics::Recipe11> - Extending a non-Moose base class
80 In this recipe, we make a Moose-based subclass of L<DateTime>, a
81 module which does not use Moose itself.
87 These recipes will show you how to use Moose roles.
91 =item L<Moose::Cookbook::Roles::Recipe1> - The Moose::Role example
93 Demonstrates roles, which are also sometimes known as traits or
94 mix-ins. Roles provide a method of code re-use which is orthogonal to
97 =item L<Moose::Cookbook::Roles::Recipe2> - Advanced Role Composition - method exclusion and aliasing
99 Sometimes you just want to include part of a role in your
100 class. Sometimes you want the whole role but one of its methods
101 conflicts with one in your class. With method exclusion and aliasing,
102 you can work around these problems.
104 =item L<Moose::Cookbook::Roles::Recipe3> - Applying a role to an object instance
106 In this recipe, we apply a role to an existing object instance.
112 These recipes show you how to write your own meta classes, which lets
113 you extend the object system provided by Moose.
117 =item L<Moose::Cookbook::Meta::Recipe1> - Welcome to the meta-world (Why Go Meta?)
119 If you're wondering what all this "meta" stuff is, and why you should
120 care about it, read this "recipe".
122 =item L<Moose::Cookbook::Meta::Recipe3> - Labels implemented via attribute traits
124 Extending Moose's attribute metaclass is a great way to add
125 functionality. However, attributes can only have one metaclass.
126 Applying roles to the attribute metaclass lets you provide
127 composable attribute functionality.
129 =item L<Moose::Cookbook::Meta::Recipe5> - The "table" attribute implemented as a metaclass trait
131 This recipe takes the class metaclass we saw in the previous recipe
132 and reimplements it as a metaclass trait.
134 =item L<Moose::Cookbook::Meta::Recipe6> - A method metaclass for marking methods public or private
136 This recipe shows a custom method metaclass that implements making a
139 =item L<Moose::Cookbook::Meta::Recipe7> - Using a blessed array reference as an object instance
141 This recipe shows an example of how you create your own meta-instance
142 class. The meta-instance determines the internal structure of object
143 instances and provide access to attribute slots.
145 =item Moose::Cookbook::Meta::Recipe8 - Hooking into immutabilization (TODO)
147 Moose has a feature known as "immutabilization". By calling C<<
148 __PACKAGE__->meta()->make_immutable() >> after defining your class
149 (attributes, roles, etc), you tell Moose to optimize things like
150 object creation, attribute access, and so on.
152 If you are creating your own metaclasses, you may need to hook into
153 the immutabilization system. This cuts across a number of spots,
154 including the metaclass class, meta method classes, and possibly the
155 meta-instance class as well.
157 This recipe shows you how to write extensions which immutabilize
162 =head2 Extending Moose
164 These recipes cover some more ways to extend Moose, and will be useful
165 if you plan to write your own C<MooseX> module.
169 =item L<Moose::Cookbook::Extending::Recipe1> - Moose extension overview
171 There are quite a few ways to extend Moose. This recipe provides an
172 overview of each method, and provides recommendations for when each is
175 =item L<Moose::Cookbook::Extending::Recipe2> - Providing a base object class role
177 Many base object class extensions can be implemented as roles. This
178 example shows how to provide a base object class debugging role that
179 is applied to any class that uses a notional C<MooseX::Debugging>
182 =item L<Moose::Cookbook::Extending::Recipe3> - Providing an alternate base object class
184 You may find that you want to provide an alternate base object class
185 along with a meta extension, or maybe you just want to add some
186 functionality to all your classes without typing C<extends
187 'MyApp::Base'> over and over.
189 =item L<Moose::Cookbook::Extending::Recipe4> - Acting like Moose.pm and providing sugar Moose-style
191 This recipe shows how to provide a replacement for C<Moose.pm>. You
192 may want to do this as part of the API for a C<MooseX> module,
193 especially if you want to default to a new metaclass class or base
202 =item L<Moose::Cookbook::Snack::Keywords>
204 =item L<Moose::Cookbook::Snack::Types>
212 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>