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