lib/Moose/Cookbook.pod

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