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