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::BankAccount_MethodModifiersAndSubclassing>
35 A slightly more complex Moose class. Demonstrates using a method modifier in a
38 =item L<Moose::Cookbook::Basics::BinaryTree_AttributeFeatures>
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::Company_Subtypes>
46 Introduces the creation and use of custom types, a C<BUILD> method, and the
47 use of C<override> in a subclass. This recipe also shows how to model a set of
48 classes that could be used to model companies, people, employees, etc.
50 =item L<Moose::Cookbook::Basics::HTTP_SubtypesAndCoercion>
52 This recipe covers more subtype creation, including the use of type coercions.
54 =item L<Moose::Cookbook::Basics::Immutable>
56 Making a class immutable greatly increases the speed of accessors and
59 =item L<Moose::Cookbook::Basics::BinaryTree_BuilderAndLazyBuild> - Builder methods and lazy_build
61 The builder feature provides an inheritable and role-composable way to
62 provide a default attribute value.
64 =item L<Moose::Cookbook::Basics::Genome_OverloadingSubtypesAndCoercion>
66 Demonstrates using operator overloading, coercion, and subtypes to
67 model how eye color is determined during reproduction.
69 =item L<Moose::Cookbook::Basics::Person_BUILDARGSAndBUILD>
71 This recipe demonstrates the use of C<BUILDARGS> and C<BUILD> to hook
72 into object construction.
74 =item L<Moose::Cookbook::Basics::DateTime_ExtendingNonMooseParent>
76 In this recipe, we make a Moose-based subclass of L<DateTime>, a
77 module which does not use Moose itself.
79 =item L<Moose::Cookbook::Basics::Document_AugmentAndInner>
81 Demonstrates the use of C<augment> method modifiers, a way of turning
82 the usual method overriding style "inside-out".
88 These recipes will show you how to use Moose roles.
92 =item L<Moose::Cookbook::Roles::Comparable_CodeReuse>
94 Demonstrates roles, which are also sometimes known as traits or
95 mix-ins. Roles provide a method of code re-use which is orthogonal to
98 =item L<Moose::Cookbook::Roles::Restartable_AdvancedComposition>
100 Sometimes you just want to include part of a role in your
101 class. Sometimes you want the whole role but one of its methods
102 conflicts with one in your class. With method exclusion and aliasing,
103 you can work around these problems.
105 =item L<Moose::Cookbook::Roles::ApplicationToInstance>
107 In this recipe, we apply a role to an existing object instance.
113 These recipes show you how to write your own meta classes, which lets
114 you extend the object system provided by Moose.
118 =item L<Moose::Cookbook::Meta::WhyMeta>
120 If you're wondering what all this "meta" stuff is, and why you should
121 care about it, read this "recipe".
123 =item L<Moose::Cookbook::Meta::Labeled_AttributeTrait>
125 Extending Moose's attribute metaclass is a great way to add
126 functionality. However, attributes can only have one metaclass.
127 Applying roles to the attribute metaclass lets you provide
128 composable attribute functionality.
130 =item L<Moose::Cookbook::Meta::Table_MetaclassTrait>
132 This recipe takes the class metaclass we saw in the previous recipe
133 and reimplements it as a metaclass trait.
135 =item L<Moose::Cookbook::Meta::PrivateOrPublic_MethodMetaclass>
137 This recipe shows a custom method metaclass that implements making a
140 =item L<Moose::Cookbook::Meta::GlobRef_InstanceMetaclass>
142 This recipe shows an example of how you create your own meta-instance
143 class. The meta-instance determines the internal structure of object
144 instances and provide access to attribute slots.
146 In this particular instance, we use a blessed glob reference as the instance
147 instead of a blessed hash reference.
149 =item Hooking into immutabilization (TODO)
151 Moose has a feature known as "immutabilization". By calling C<<
152 __PACKAGE__->meta()->make_immutable() >> after defining your class
153 (attributes, roles, etc), you tell Moose to optimize things like
154 object creation, attribute access, and so on.
156 If you are creating your own metaclasses, you may need to hook into
157 the immutabilization system. This cuts across a number of spots,
158 including the metaclass class, meta method classes, and possibly the
159 meta-instance class as well.
161 This recipe shows you how to write extensions which immutabilize
166 =head2 Extending Moose
168 These recipes cover some more ways to extend Moose, and will be useful
169 if you plan to write your own C<MooseX> module.
173 =item L<Moose::Cookbook::Extending::ExtensionOverview>
175 There are quite a few ways to extend Moose. This recipe provides an
176 overview of each method, and provides recommendations for when each is
179 =item L<Moose::Cookbook::Extending::Debugging_BaseClassRole>
181 Many base object class extensions can be implemented as roles. This
182 example shows how to provide a base object class debugging role that
183 is applied to any class that uses a notional C<MooseX::Debugging>
186 =item L<Moose::Cookbook::Extending::Mooseish_MooseSugar>
188 This recipe shows how to provide a replacement for C<Moose.pm>. You
189 may want to do this as part of the API for a C<MooseX> module,
190 especially if you want to default to a new metaclass class or base
199 =item L<Moose::Cookbook::Snack::Keywords>
201 =item L<Moose::Cookbook::Snack::Types>
205 =head1 Legacy Recipes
207 These cover topics that are no longer considered best practice. We've kept
208 them in case in you encounter these usages in the wild.
212 =item L<Moose::Cookbook::Legacy::Labeled_AttributeMetaclass>
214 =item L<Moose::Cookbook::Legacy::Table_ClassMetaclass>
216 =item L<Moose::Cookbook::Legacy::Debugging_BaseClassReplacement>
224 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>