Commit | Line | Data |
471c4f09 |
1 | |
2 | =pod |
3 | |
4 | =head1 NAME |
5 | |
6 | Moose::Cookbook - How to cook a Moose |
7 | |
8 | =head1 DESCRIPTION |
9 | |
4711f5f7 |
10 | The Moose cookbook is a series of recipes taken from the Moose |
471c4f09 |
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 | |
734d1752 |
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 | |
471c4f09 |
18 | =head1 RECIPES |
19 | |
496b74ab |
20 | =head2 Basic Moose |
21 | |
471c4f09 |
22 | =over 4 |
23 | |
021b8139 |
24 | =item L<Moose::Cookbook::Basics::Recipe1> - The (always classic) B<Point> example |
471c4f09 |
25 | |
f7f3648d |
26 | A simple Moose-based class. Demonstrated Moose attributes and subclassing. |
cb2478d4 |
27 | |
021b8139 |
28 | =item L<Moose::Cookbook::Basics::Recipe2> - A simple B<BankAccount> example |
471c4f09 |
29 | |
f7f3648d |
30 | A slightly more complex Moose class. Demonstrates using a method |
31 | modifier in a subclass. |
cb2478d4 |
32 | |
021b8139 |
33 | =item L<Moose::Cookbook::Basics::Recipe3> - A lazy B<BinaryTree> example |
471c4f09 |
34 | |
f7f3648d |
35 | Demonstrates several attribute features, including types, weak |
36 | references, predicates ("does this object have a foo?"), defaults, and |
37 | lazy attribute construction. |
cb2478d4 |
38 | |
021b8139 |
39 | =item L<Moose::Cookbook::Basics::Recipe4> - Subtypes, and modeling a simple B<Company> class hierarchy |
471c4f09 |
40 | |
f7f3648d |
41 | Introduces the creation and use of custom types, a C<BUILD> method, |
42 | and the use of C<override> in a subclass. |
cb2478d4 |
43 | |
021b8139 |
44 | =item L<Moose::Cookbook::Basics::Recipe5> - More subtypes, coercion in a B<Request> class |
471c4f09 |
45 | |
f7f3648d |
46 | More type examples, including the use of type coercions. |
cb2478d4 |
47 | |
021b8139 |
48 | =item L<Moose::Cookbook::Basics::Recipe6> - The augment/inner example |
496b74ab |
49 | |
f7f3648d |
50 | Demonstrates the use of C<augment> method modifiers, a way of turning |
51 | the usual method overriding style "inside-out". |
cb2478d4 |
52 | |
021b8139 |
53 | =item L<Moose::Cookbook::Basics::Recipe7> - Making Moose fast with immutable |
496b74ab |
54 | |
5de2944f |
55 | Making a class immutable greatly increases the speed of accessors and |
56 | object construction. |
cb2478d4 |
57 | |
021b8139 |
58 | =item L<Moose::Cookbook::Basics::Recipe8> - Managing complex relations with trigger (TODO) |
496b74ab |
59 | |
cb2478d4 |
60 | I<abstract goes here> |
61 | |
2be55428 |
62 | Work off of this http://code2.0beta.co.uk/moose/svn/Moose/trunk/t/200_examples/007_Child_Parent_attr_inherit.t |
63 | |
021b8139 |
64 | =item L<Moose::Cookbook::Basics::Recipe9> - Builder methods and lazy_build |
496b74ab |
65 | |
fbd7ad7a |
66 | The builder feature provides an inheritable and role-composable way to |
67 | provide a default attribute value. |
cb2478d4 |
68 | |
58d129ba |
69 | =item L<Moose::Cookbook::Basics::Recipe10> - Operator overloading, subtypes, and coercion |
c2a0627f |
70 | |
58d129ba |
71 | Demonstrates how operator overloading, coercion, and sub types can be |
72 | used to model how eye color is determined during reproduction. |
c2a0627f |
73 | |
496b74ab |
74 | =back |
75 | |
76 | =head2 Moose Roles |
77 | |
78 | =over 4 |
79 | |
021b8139 |
80 | =item L<Moose::Cookbook::Role::Recipe1> - The Moose::Role example |
496b74ab |
81 | |
f7f3648d |
82 | Demonstrates roles, which are also sometimes known as traits or |
83 | mix-ins. Roles provide a method of code re-use which is orthogonal to |
84 | subclassing. |
cb2478d4 |
85 | |
021b8139 |
86 | =item L<Moose::Cookbook::Role::Recipe2> - Advanced Role Composition - method exclusion and aliasing |
496b74ab |
87 | |
2e3d0a0a |
88 | Sometimes you just want to include part of a role in your |
89 | class. Sometimes you want the whole role but one if its methods |
90 | conflicts with one in your class. With method exclusion and aliasing, |
91 | you can work around these problems. |
cb2478d4 |
92 | |
021b8139 |
93 | =item L<Moose::Cookbook::Role::Recipe3> - Runtime Role Composition (TODO) |
104379bc |
94 | |
cb2478d4 |
95 | I<abstract goes here> |
96 | |
496b74ab |
97 | =back |
98 | |
99 | =head2 Meta Moose |
100 | |
101 | =over 4 |
102 | |
17a65b17 |
103 | =item L<Moose::Cookbook::Meta::Recipe1> - Welcome to the meta-world (Why Go Meta?) |
496b74ab |
104 | |
cb2478d4 |
105 | I<abstract goes here> |
106 | |
021b8139 |
107 | =item L<Moose::Cookbook::Meta::Recipe2> - The meta-attribute example |
496b74ab |
108 | |
f7f3648d |
109 | One way to extend Moose is to provide your own attribute |
110 | metaclasses. Attribute metaclasses let you extend attribute |
111 | declarations (with C<has>) and behavior to provide additional |
112 | attribute functionality. |
cb2478d4 |
113 | |
021b8139 |
114 | =item L<Moose::Cookbook::Meta::Recipe3> - The meta-attribute trait example |
a7d0cd00 |
115 | |
aff0421c |
116 | Extending Moose's attribute metaclass is a great way to add |
117 | functionality. However, attributes can only have one metaclass. |
118 | Applying roles to the attribute metaclass lets you provide |
119 | composable attribute functionality. |
cb2478d4 |
120 | |
021b8139 |
121 | =item L<Moose::Cookbook::Meta::Recipe4> - The meta-instance example (TODO) |
24a8fe99 |
122 | |
cb2478d4 |
123 | I<abstract goes here> |
124 | |
496b74ab |
125 | =item L<Moose::Cookbook::Recipe24> - The meta-class example (TODO) |
1edfdf1c |
126 | |
cb2478d4 |
127 | I<abstract goes here> |
128 | |
129 | =back |
130 | |
131 | =head1 SNACKS |
132 | |
133 | =over 4 |
134 | |
135 | =item L<Moose::Cookbook::Snack::Types> |
136 | |
471c4f09 |
137 | =back |
138 | |
139 | =head1 SEE ALSO |
140 | |
141 | =over 4 |
142 | |
8bdc7f13 |
143 | =item L<http://www.gsph.com/index.php?Lang=En&ID=291> |
471c4f09 |
144 | |
145 | =back |
146 | |
147 | =head1 AUTHOR |
148 | |
149 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
150 | |
151 | =head1 COPYRIGHT AND LICENSE |
152 | |
778db3ac |
153 | Copyright 2006-2008 by Infinity Interactive, Inc. |
471c4f09 |
154 | |
155 | L<http://www.iinteractive.com> |
156 | |
157 | This library is free software; you can redistribute it and/or modify |
158 | it under the same terms as Perl itself. |
159 | |
f7f3648d |
160 | =cut |