0bdeae5d9e03a21d1ab153d82599f55c7f3ec25e
[gitmo/Moose.git] / lib / Moose / Cookbook / Extending / Recipe2.pod
1
2 =pod
3
4 =head1 NAME
5
6 Moose::Cookbook::Extending::Recipe2 - Providing a role for the base object class
7
8 =head1 SYNOPSIS
9
10   package MooseX::Debugging;
11
12   use strict;
13   use warnings;
14
15   use Moose::Exporter;
16   use Moose::Util::MetaRole;
17   use MooseX::Debugging::Role::Object;
18
19   Moose::Exporter->setup_import_methods();
20
21   sub init_meta {
22       shift;
23       my %options = @_;
24
25       Moose::Util::MetaRole::apply_base_object_roles(
26           for_class => $options{for_class},
27           role      => ['MooseX::Debugging::Role::Object'],
28       );
29   }
30
31
32   package MooseX::Debugging::Role::Object;
33
34   after 'BUILD' => sub {
35       my $self = shift;
36
37       warn "Made a new " . ref $self . " object\n";
38   }
39
40 =head1 DESCRIPTION
41
42 In this example, we provide a role for the base object class that adds
43 some simple debugging output. Every time an object is created, it
44 spits out a warning saying what type of object it was.
45
46 Obviously, a real debugging role would do something more interesting,
47 but this recipe is all about how we apply that role.
48
49 In this case, with the combination of L<Moose::Exporter> and
50 L<Moose::Util::MetaRole>, we ensure that when a module does "S<use
51 MooseX::Debugging>", it automatically gets the debugging role applied
52 to its base object class.
53
54 =head1 AUTHOR
55
56 Dave Rolsky E<lt>autarch@urth.orgE<gt>
57
58 =head1 COPYRIGHT AND LICENSE
59
60 Copyright 2008 by Infinity Interactive, Inc.
61
62 L<http://www.iinteractive.com>
63
64 This library is free software; you can redistribute it and/or modify
65 it under the same terms as Perl itself.
66
67 =cut
68