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 taken from the Moose
  11 test suite. Each recipe presents some code, which demonstrates
  12 some of the features of Moose, and then proceeds to explain the
  13 details of the code.
  14
  15 We also provide a L<Moose::Cookbook::FAQ> and a L<Moose::Cookbook::WTF>
  16 for common questions and problems people have with Moose.
  17
  18 =head1 RECIPES
  19
  20 =head2 Basic Moose
  21
  22 =over 4
  23
  24 =item L<Moose::Cookbook::Basics::Recipe1> - The (always classic) B<Point> example
  25
  26 A simple Moose-based class. Demonstrated Moose attributes and subclassing.
  27
  28 =item L<Moose::Cookbook::Basics::Recipe2> - A simple B<BankAccount> example
  29
  30 A slightly more complex Moose class. Demonstrates using a method
  31 modifier in a subclass.
  32
  33 =item L<Moose::Cookbook::Basics::Recipe3> - A lazy B<BinaryTree> example
  34
  35 Demonstrates several attribute features, including types, weak
  36 references, predicates ("does this object have a foo?"), defaults, and
  37 lazy attribute uction.
  38
  39 =item L<Moose::Cookbook::Basics::Recipe4> - Subtypes, and modeling a simple B<Company> class hierarchy
  40
  41 Introduces the creation and use of custom types, a C<BUILD> method,
  42 and the use of C<override> in a subclass.
  43
  44 =item L<Moose::Cookbook::Basics::Recipe5> - More subtypes, coercion in a B<Request> class
  45
  46 More type examples, including the use of type coercions.
  47
  48 =item L<Moose::Cookbook::Basics::Recipe6> - The augment/inner example
  49
  50 Demonstrates the use of C<augment> method modifiers, a way of turning
  51 the usual method overriding style "inside-out".
  52
  53 =item L<Moose::Cookbook::Basics::Recipe7> - Making Moose fast with immutable
  54
  55 Making a class immutable greatly increases the speed of accessors and
  56 object construction.
  57
  58 =item L<Moose::Cookbook::Basics::Recipe8> - Managing complex relations with trigger (TODO)
  59
  60 I<abstract goes here>
  61
  62 Work off of this http://code2.0beta.co.uk/moose/svn/Moose/trunk/t/200_examples/007_Child_Parent_attr_inherit.t
  63
  64 =item L<Moose::Cookbook::Basics::Recipe9> - Builder methods and lazy_build
  65
  66 The builder feature provides an inheritable and role-composable way to
  67 provide a default attribute value.
  68
  69 =item L<Moose::Cookbook::Basics::Recipe10> - Operator overloading, subtypes, and coercion
  70
  71 Demonstrates using operator overloading, coercion, and subtypes to
  72 model how eye color is determined during reproduction.
  73
  74 =back
  75
  76 =head2 Moose Roles
  77
  78 =over 4
  79
  80 =item L<Moose::Cookbook::Role::Recipe1> - The Moose::Role example
  81
  82 Demonstrates roles, which are also sometimes known as traits or
  83 mix-ins. Roles provide a method of code re-use which is orthogonal to
  84 subclassing.
  85
  86 =item L<Moose::Cookbook::Role::Recipe2> - Advanced Role Composition - method exclusion and aliasing
  87
  88 Sometimes you just want to include part of a role in your
  89 class. Sometimes you want the whole role but one if its methods
  90 conflicts with one in your class. With method exclusion and aliasing,
  91 you can work around these problems.
  92
  93 =item L<Moose::Cookbook::Role::Recipe3> - Runtime Role Composition (TODO)
  94
  95 I<abstract goes here>
  96
  97 =back
  98
  99 =head2 Meta Moose
 100
 101 =over 4
 102
 103 =item L<Moose::Cookbook::Meta::Recipe1> - Welcome to the meta-world (Why Go Meta?)
 104
 105 I<abstract goes here>
 106
 107 =item L<Moose::Cookbook::Meta::Recipe2> - A meta-attribute, attributes with labels
 108
 109 One way to extend Moose is to provide your own attribute
 110 metaclasses. Attribute metaclasses let you extend attribute
 111 declarations (with C<has>) and behavior to provide additional
 112 attribute functionality.
 113
 114 =item L<Moose::Cookbook::Meta::Recipe3> - Labels implemented via attribute traits
 115
 116 Extending Moose's attribute metaclass is a great way to add
 117 functionality. However, attributes can only have one metaclass.
 118 Applying roles to the attribute metaclass lets you provide
 119 composable attribute functionality.
 120
 121 =item L<Moose::Cookbook::Meta::Recipe4> - Adding a "table" attribute to the metaclass
 122
 123 If you want to store more information about your classes, you'll have
 124 to extend C<Moose::Meta::Class>. Doing so is simple, but you'll
 125 probably also want to provide some sugar, so see
 126 L<Moose::Cookbook::Meta::Recipe6> as well.
 127
 128 =item L<Moose::Cookbook::Meta::Recipe5> - The "table" attribute implemented via a metaclass trait
 129
 130 I<abstract goes here>
 131
 132 =item L<Moose::Cookbook::Meta::Recipe6> - I<meta-instance> (TODO)
 133
 134 I<abstract goes here>
 135
 136 =head2 Extending Moose
 137
 138 =item L<Moose::Cookbook::Extending::Recipe1> - Providing an alternate base object class
 139
 140 You may find that you want to provide an alternate base object class
 141 along with a meta extension, or maybe you just want to add some
 142 functionality to all your classes without typing C<extends
 143 'MyApp::Base'> over and over.
 144
 145 =item L<Moose::Cookbook::Extending::Recipe2> - Acting like Moose.pm and providing sugar Moose-style
 146
 147 You'll often find that you want to provide a replacement for
 148 C<Moose.pm> as part of a meta extension. This is especially true if
 149 you want to write default to your own metaclass or base object class.
 150
 151 =back
 152
 153 =head1 SNACKS
 154
 155 =over 4
 156
 157 =item L<Moose::Cookbook::Snack::Keywords>
 158
 159 =item L<Moose::Cookbook::Snack::Types>
 160
 161 =back
 162
 163 =head1 SEE ALSO
 164
 165 =over 4
 166
 167 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>
 168
 169 =back
 170
 171 =head1 AUTHOR
 172
 173 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 174
 175 =head1 COPYRIGHT AND LICENSE
 176
 177 Copyright 2006-2008 by Infinity Interactive, Inc.
 178
 179 L<http://www.iinteractive.com>
 180
 181 This library is free software; you can redistribute it and/or modify
 182 it under the same terms as Perl itself.
 183
 184 =cut