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> - Managing complex relations with trigger (TODO)
  62
  63 I<abstract goes here>
  64
  65 Work off of this http://code2.0beta.co.uk/moose/svn/Moose/trunk/t/200_examples/007_Child_Parent_attr_inherit.t
  66
  67 =item L<Moose::Cookbook::Basics::Recipe9> - Builder methods and lazy_build
  68
  69 The builder feature provides an inheritable and role-composable way to
  70 provide a default attribute value.
  71
  72 =item L<Moose::Cookbook::Basics::Recipe10> - Operator overloading, subtypes, and coercion
  73
  74 Demonstrates using operator overloading, coercion, and subtypes to
  75 model how eye color is determined during reproduction.
  76
  77 =item L<Moose::Cookbook::Basics::Recipe11> - Using BUILDARGS and BUILD to hook into object construction
  78
  79 This recipe demonstrates the use of C<BUILDARGS> and C<BUILD> to hook
  80 into object construction.
  81
  82 =back
  83
  84 =head2 Moose Roles
  85
  86 These recipes will show you how to use Moose roles.
  87
  88 =over 4
  89
  90 =item L<Moose::Cookbook::Roles::Recipe1> - The Moose::Role example
  91
  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
  94 subclassing.
  95
  96 =item L<Moose::Cookbook::Roles::Recipe2> - Advanced Role Composition - method exclusion and aliasing
  97
  98 Sometimes you just want to include part of a role in your
  99 class. Sometimes you want the whole role but one of its methods
 100 conflicts with one in your class. With method exclusion and aliasing,
 101 you can work around these problems.
 102
 103 =item L<Moose::Cookbook::Roles::Recipe3> - Applying a role to an object instance
 104
 105 In this recipe, we apply a role to an existing object instance.
 106
 107 =back
 108
 109 =head2 Meta Moose
 110
 111 These recipes show you how to write your own meta classes, which lets
 112 you extend the object system provided by Moose.
 113
 114 =over 4
 115
 116 =item L<Moose::Cookbook::Meta::Recipe1> - Welcome to the meta-world (Why Go Meta?)
 117
 118 If you're wondering what all this "meta" stuff is, and why you should
 119 care about it, read this "recipe".
 120
 121 =item L<Moose::Cookbook::Meta::Recipe2> - A meta-attribute, attributes with labels
 122
 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.
 127
 128 =item L<Moose::Cookbook::Meta::Recipe3> - Labels implemented via attribute traits
 129
 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.
 134
 135 =item L<Moose::Cookbook::Meta::Recipe4> - Adding a "table" attribute to the metaclass
 136
 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.
 141
 142 =item L<Moose::Cookbook::Meta::Recipe5> - The "table" attribute implemented as a metaclass trait
 143
 144 This recipe takes the class metaclass we saw in the previous recipe
 145 and reimplements it as a metaclass trait.
 146
 147 =item L<Moose::Cookbook::Meta::Recipe6> - A method metaclass for marking methods public or private
 148
 149 This recipe shows a custom method metaclass that implements making a
 150 method private.
 151
 152 =item L<Moose::Cookbook::Meta::Recipe7> - Using a blessed array reference as an object instance
 153
 154 This recipe shows an example of how you create your own meta-instance
 155 class. The meta-instance determines the internal structure of object
 156 instances and provide access to attribute slots.
 157
 158 =item L<Moose::Cookbook::Meta::Recipe8> - Hooking into immutabilization (TODO)
 159
 160 Moose has a feature known as "immutabilization". By calling C<<
 161 __PACKAGE__->meta()->make_immutable() >> after defining your class
 162 (attributes, roles, etc), you tell Moose to optimize things like
 163 object creation, attribute access, and so on.
 164
 165 If you are creating your own metaclasses, you may need to hook into
 166 the immutabilization system. This cuts across a number of spots,
 167 including the metaclass class, meta method classes, and possibly the
 168 meta-instance class as well.
 169
 170 This recipe shows you how to write extensions which immutabilize
 171 properly.
 172
 173 =back
 174
 175 =head2 Extending Moose
 176
 177 These recipes cover some more ways to extend Moose, and will be useful
 178 if you plan to write your own C<MooseX> module.
 179
 180 =over 4
 181
 182 =item L<Moose::Cookbook::Extending::Recipe1> - Moose extension overview
 183
 184 There are quite a few ways to extend Moose. This recipe provides an
 185 overview of each method, and provides recommendations for when each is
 186 appropriate.
 187
 188 =item L<Moose::Cookbook::Extending::Recipe2> - Providing a base object class role
 189
 190 Many base object class extensions can be implemented as roles. This
 191 example shows how to provide a base object class debugging role that
 192 is applied to any class that uses a notional C<MooseX::Debugging>
 193 module.
 194
 195 =item L<Moose::Cookbook::Extending::Recipe3> - Providing an alternate base object class
 196
 197 You may find that you want to provide an alternate base object class
 198 along with a meta extension, or maybe you just want to add some
 199 functionality to all your classes without typing C<extends
 200 'MyApp::Base'> over and over.
 201
 202 =item L<Moose::Cookbook::Extending::Recipe4> - Acting like Moose.pm and providing sugar Moose-style
 203
 204 This recipe shows how to provide a replacement for C<Moose.pm>. You
 205 may want to do this as part of the API for a C<MooseX> module,
 206 especially if you want to default to a new metaclass class or base
 207 object class.
 208
 209 =back
 210
 211 =head1 SNACKS
 212
 213 =over 4
 214
 215 =item L<Moose::Cookbook::Snack::Keywords>
 216
 217 =item L<Moose::Cookbook::Snack::Types>
 218
 219 =back
 220
 221 =head1 SEE ALSO
 222
 223 =over 4
 224
 225 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>
 226
 227 =back
 228
 229 =head1 AUTHOR
 230
 231 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 232
 233 =head1 COPYRIGHT AND LICENSE
 234
 235 Copyright 2006-2009 by Infinity Interactive, Inc.
 236
 237 L<http://www.iinteractive.com>
 238
 239 This library is free software; you can redistribute it and/or modify
 240 it under the same terms as Perl itself.
 241
 242 =cut