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::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::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::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 construction.
  38
  39 =item L<Moose::Cookbook::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::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::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::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::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::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::Recipe12> - Create Humans and their Spawn
  70
  71 Shows how operator overloading, coercion, and sub types can be used
  72 to mimmick the human reproductive system (well, the selection of genes
  73 at least).  Assumes a basic understanding of Moose.
  74
  75 =back
  76
  77 =head2 Moose Roles
  78
  79 =over 4
  80
  81 =item L<Moose::Cookbook::Recipe10> - The Moose::Role example
  82
  83 Demonstrates roles, which are also sometimes known as traits or
  84 mix-ins. Roles provide a method of code re-use which is orthogonal to
  85 subclassing.
  86
  87 =item L<Moose::Cookbook::Recipe11> - Advanced Role Composition - method exclusion and aliasing
  88
  89 Sometimes you just want to include part of a role in your
  90 class. Sometimes you want the whole role but one if its methods
  91 conflicts with one in your class. With method exclusion and aliasing,
  92 you can work around these problems.
  93
  94 =item L<Moose::Cookbook::Recipe12> - Runtime Role Composition (TODO)
  95
  96 I<abstract goes here>
  97
  98 =back
  99
 100 =head2 Meta Moose
 101
 102 =over 4
 103
 104 =item L<Moose::Cookbook::Recipe20> - Welcome to the meta-world (TODO)
 105
 106 I<abstract goes here>
 107
 108 =item L<Moose::Cookbook::Recipe21> - The meta-attribute example
 109
 110 One way to extend Moose is to provide your own attribute
 111 metaclasses. Attribute metaclasses let you extend attribute
 112 declarations (with C<has>) and behavior to provide additional
 113 attribute functionality.
 114
 115 =item L<Moose::Cookbook::Recipe22> - The meta-attribute trait example
 116
 117 Extending Moose's attribute metaclass is a great way to add
 118 functionality. However, attributes can only have one metaclass.
 119 Applying roles to the attribute metaclass lets you provide
 120 composable attribute functionality.
 121
 122 =item L<Moose::Cookbook::Recipe23> - The meta-instance example (TODO)
 123
 124 I<abstract goes here>
 125
 126 =item L<Moose::Cookbook::Recipe24> - The meta-class example (TODO)
 127
 128 I<abstract goes here>
 129
 130 =back
 131
 132 =head1 SNACKS
 133
 134 =over 4
 135
 136 =item L<Moose::Cookbook::Snack::Types>
 137
 138 =back
 139
 140 =head1 SEE ALSO
 141
 142 =over 4
 143
 144 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>
 145
 146 =back
 147
 148 =head1 AUTHOR
 149
 150 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 151
 152 =head1 COPYRIGHT AND LICENSE
 153
 154 Copyright 2006-2008 by Infinity Interactive, Inc.
 155
 156 L<http://www.iinteractive.com>
 157
 158 This library is free software; you can redistribute it and/or modify
 159 it under the same terms as Perl itself.
 160
 161 =cut