+package Moose::Cookbook;
-=pod
+# ABSTRACT: How to cook a Moose
+
+__END__
-=head1 NAME
-Moose::Cookbook - How to cook a Moose
+=pod
=head1 DESCRIPTION
=over 4
-=item L<Moose::Cookbook::Basics::Recipe1> - The (always classic) B<Point> example
+=item L<Moose::Cookbook::Basics::Point_AttributesAndSubclassing>
-A simple Moose-based class. Demonstrates Moose attributes and subclassing.
+A simple Moose-based class. Demonstrates basic Moose attributes and subclassing.
-=item L<Moose::Cookbook::Basics::Recipe2> - A simple B<BankAccount> example
+=item L<Moose::Cookbook::Basics::BankAccount_MethodModifiersAndSubclassing>
-A slightly more complex Moose class. Demonstrates using a method
-modifier in a subclass.
+A slightly more complex Moose class. Demonstrates using a method modifier in a
+subclass.
-=item L<Moose::Cookbook::Basics::Recipe3> - A lazy B<BinaryTree> example
+=item L<Moose::Cookbook::Basics::BinaryTree_AttributeFeatures>
Demonstrates several attribute features, including types, weak
references, predicates ("does this object have a foo?"), defaults,
laziness, and triggers.
-=item L<Moose::Cookbook::Basics::Recipe4> - Subtypes, and modeling a simple B<Company> class hierarchy
-
-Introduces the creation and use of custom types, a C<BUILD> method,
-and the use of C<override> in a subclass.
+=item L<Moose::Cookbook::Basics::Company_Subtypes>
-=item L<Moose::Cookbook::Basics::Recipe5> - More subtypes, coercion in a B<Request> class
+Introduces the creation and use of custom types, a C<BUILD> method, and the
+use of C<override> in a subclass. This recipe also shows how to model a set of
+classes that could be used to model companies, people, employees, etc.
-More type examples, including the use of type coercions.
+=item L<Moose::Cookbook::Basics::HTTP_SubtypesAndCoercion>
-=item L<Moose::Cookbook::Basics::Recipe6> - The augment/inner example
-
-Demonstrates the use of C<augment> method modifiers, a way of turning
-the usual method overriding style "inside-out".
+This recipe covers more subtype creation, including the use of type coercions.
-=item L<Moose::Cookbook::Basics::Recipe7> - Making Moose fast with immutable
+=item L<Moose::Cookbook::Basics::Immutable>
Making a class immutable greatly increases the speed of accessors and
object construction.
-=item L<Moose::Cookbook::Basics::Recipe8> - Builder methods and lazy_build
+=item L<Moose::Cookbook::Basics::BinaryTree_BuilderAndLazyBuild> - Builder methods and lazy_build
The builder feature provides an inheritable and role-composable way to
provide a default attribute value.
-=item L<Moose::Cookbook::Basics::Recipe9> - Operator overloading, subtypes, and coercion
+=item L<Moose::Cookbook::Basics::Genome_OverloadingSubtypesAndCoercion>
Demonstrates using operator overloading, coercion, and subtypes to
model how eye color is determined during reproduction.
-=item L<Moose::Cookbook::Basics::Recipe10> - Using BUILDARGS and BUILD to hook into object construction
+=item L<Moose::Cookbook::Basics::Person_BUILDARGSAndBUILD>
This recipe demonstrates the use of C<BUILDARGS> and C<BUILD> to hook
into object construction.
-=item L<Moose::Cookbook::Basics::Recipe11> - Extending a non-Moose base class
+=item L<Moose::Cookbook::Basics::DateTime_ExtendingNonMooseParent>
In this recipe, we make a Moose-based subclass of L<DateTime>, a
module which does not use Moose itself.
+=item L<Moose::Cookbook::Basics::Document_AugmentAndInner>
+
+Demonstrates the use of C<augment> method modifiers, a way of turning
+the usual method overriding style "inside-out".
+
=back
=head2 Moose Roles
=over 4
-=item L<Moose::Cookbook::Roles::Recipe1> - The Moose::Role example
+=item L<Moose::Cookbook::Roles::Comparable_CodeReuse>
Demonstrates roles, which are also sometimes known as traits or
mix-ins. Roles provide a method of code re-use which is orthogonal to
subclassing.
-=item L<Moose::Cookbook::Roles::Recipe2> - Advanced Role Composition - method exclusion and aliasing
+=item L<Moose::Cookbook::Roles::Restartable_AdvancedComposition>
Sometimes you just want to include part of a role in your
class. Sometimes you want the whole role but one of its methods
conflicts with one in your class. With method exclusion and aliasing,
you can work around these problems.
-=item L<Moose::Cookbook::Roles::Recipe3> - Applying a role to an object instance
+=item L<Moose::Cookbook::Roles::ApplicationToInstance>
In this recipe, we apply a role to an existing object instance.
=over 4
-=item L<Moose::Cookbook::Meta::Recipe1> - Welcome to the meta-world (Why Go Meta?)
+=item L<Moose::Cookbook::Meta::WhyMeta>
If you're wondering what all this "meta" stuff is, and why you should
care about it, read this "recipe".
-=item L<Moose::Cookbook::Meta::Recipe2> - A meta-attribute, attributes with labels
-
-One way to extend Moose is to provide your own attribute
-metaclasses. Attribute metaclasses let you extend attribute
-declarations (with C<has>) and behavior to provide additional
-attribute functionality.
-
-=item L<Moose::Cookbook::Meta::Recipe3> - Labels implemented via attribute traits
+=item L<Moose::Cookbook::Meta::Labeled_AttributeTrait>
Extending Moose's attribute metaclass is a great way to add
functionality. However, attributes can only have one metaclass.
Applying roles to the attribute metaclass lets you provide
composable attribute functionality.
-=item L<Moose::Cookbook::Meta::Recipe4> - Adding a "table" attribute to the metaclass
-
-If you want to store more information about your classes, you'll have
-to extend C<Moose::Meta::Class>. Doing so is simple, but you'll
-probably also want to provide some sugar, so see
-L<Moose::Cookbook::Extending::Recipe2> as well.
-
-=item L<Moose::Cookbook::Meta::Recipe5> - The "table" attribute implemented as a metaclass trait
+=item L<Moose::Cookbook::Meta::Table_MetaclassTrait>
This recipe takes the class metaclass we saw in the previous recipe
and reimplements it as a metaclass trait.
-=item L<Moose::Cookbook::Meta::Recipe6> - A method metaclass for marking methods public or private
+=item L<Moose::Cookbook::Meta::PrivateOrPublic_MethodMetaclass>
This recipe shows a custom method metaclass that implements making a
method private.
-=item L<Moose::Cookbook::Meta::Recipe7> - Using a blessed array reference as an object instance
+=item L<Moose::Cookbook::Meta::GlobRef_InstanceMetaclass>
This recipe shows an example of how you create your own meta-instance
class. The meta-instance determines the internal structure of object
instances and provide access to attribute slots.
-=item Moose::Cookbook::Meta::Recipe8 - Hooking into immutabilization (TODO)
+In this particular instance, we use a blessed glob reference as the instance
+instead of a blessed hash reference.
+
+=item Hooking into immutabilization (TODO)
Moose has a feature known as "immutabilization". By calling C<<
__PACKAGE__->meta()->make_immutable() >> after defining your class
=over 4
-=item L<Moose::Cookbook::Extending::Recipe1> - Moose extension overview
+=item L<Moose::Cookbook::Extending::ExtensionOverview>
There are quite a few ways to extend Moose. This recipe provides an
overview of each method, and provides recommendations for when each is
appropriate.
-=item L<Moose::Cookbook::Extending::Recipe2> - Providing a base object class role
+=item L<Moose::Cookbook::Extending::Debugging_BaseClassRole>
Many base object class extensions can be implemented as roles. This
example shows how to provide a base object class debugging role that
is applied to any class that uses a notional C<MooseX::Debugging>
module.
-=item L<Moose::Cookbook::Extending::Recipe3> - Providing an alternate base object class
-
-You may find that you want to provide an alternate base object class
-along with a meta extension, or maybe you just want to add some
-functionality to all your classes without typing C<extends
-'MyApp::Base'> over and over.
-
-=item L<Moose::Cookbook::Extending::Recipe4> - Acting like Moose.pm and providing sugar Moose-style
+=item L<Moose::Cookbook::Extending::Mooseish_MooseSugar>
This recipe shows how to provide a replacement for C<Moose.pm>. You
may want to do this as part of the API for a C<MooseX> module,
=back
-=head1 SEE ALSO
+=head1 Legacy Recipes
-=over 4
+These cover topics that are no longer considered best practice. We've kept
+them in case in you encounter these usages in the wild.
-=item L<http://www.gsph.com/index.php?Lang=En&ID=291>
+=over 4
-=back
+=item L<Moose::Cookbook::Meta::Labeled_AttributeMetaclass>
-=head1 AUTHOR
+=item L<Moose::Cookbook::Meta::Table_ClassMetaclass>
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
+=back
-=head1 COPYRIGHT AND LICENSE
+=head1 SEE ALSO
-Copyright 2006-2009 by Infinity Interactive, Inc.
+=over 4
-L<http://www.iinteractive.com>
+=item L<http://www.gsph.com/index.php?Lang=En&ID=291>
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+=back
=cut
projects / gitmo/Moose.git / blobdiff