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 =back
  70
  71 =head2 Moose Roles
  72
  73 =over 4
  74
  75 =item L<Moose::Cookbook::Recipe10> - The Moose::Role example
  76
  77 Demonstrates roles, which are also sometimes known as traits or
  78 mix-ins. Roles provide a method of code re-use which is orthogonal to
  79 subclassing.
  80
  81 =item L<Moose::Cookbook::Recipe11> - Advanced Role Composition (TODO)
  82
  83 I<abstract goes here>
  84
  85 =item L<Moose::Cookbook::Recipe12> - Runtime Role Composition (TODO)
  86
  87 I<abstract goes here>
  88
  89 =back
  90
  91 =head2 Meta Moose
  92
  93 =over 4
  94
  95 =item L<Moose::Cookbook::Recipe20> - Welcome to the meta-world (TODO)
  96
  97 I<abstract goes here>
  98
  99 =item L<Moose::Cookbook::Recipe21> - The meta-attribute example
 100
 101 One way to extend Moose is to provide your own attribute
 102 metaclasses. Attribute metaclasses let you extend attribute
 103 declarations (with C<has>) and behavior to provide additional
 104 attribute functionality.
 105
 106 =item L<Moose::Cookbook::Recipe22> - The meta-attribute trait example (TODO)
 107
 108 I<abstract goes here>
 109
 110 =item L<Moose::Cookbook::Recipe23> - The meta-instance example (TODO)
 111
 112 I<abstract goes here>
 113
 114 =item L<Moose::Cookbook::Recipe24> - The meta-class example (TODO)
 115
 116 I<abstract goes here>
 117
 118 =back
 119
 120 =head1 SNACKS
 121
 122 =over 4
 123
 124 =item L<Moose::Cookbook::Snack::Types>
 125
 126 =back
 127
 128 =head1 SEE ALSO
 129
 130 =over 4
 131
 132 =item L<http://www.gsph.com/index.php?Lang=En&ID=291>
 133
 134 =back
 135
 136 =head1 AUTHOR
 137
 138 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 139
 140 =head1 COPYRIGHT AND LICENSE
 141
 142 Copyright 2006-2008 by Infinity Interactive, Inc.
 143
 144 L<http://www.iinteractive.com>
 145
 146 This library is free software; you can redistribute it and/or modify
 147 it under the same terms as Perl itself.
 148
 149 =cut