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