add some more tests (including some TODOs)
[gitmo/Moose.git] / lib / Moose / Meta / Method / Destructor.pm
CommitLineData
acf10771 1
2package Moose::Meta::Method::Destructor;
3
4use strict;
5use warnings;
6
b288593e 7use Devel::GlobalDestruction ();
acf10771 8use Scalar::Util 'blessed', 'weaken';
b288593e 9use Try::Tiny ();
acf10771 10
b6cca0d5 11our $VERSION = '1.14';
e606ae5f 12$VERSION = eval $VERSION;
acf10771 13our $AUTHORITY = 'cpan:STEVAN';
14
badb7e89 15use base 'Moose::Meta::Method',
f4aef447 16 'Class::MOP::Method::Inlined';
acf10771 17
18sub new {
19 my $class = shift;
20 my %options = @_;
d03bd989 21
46cb090f 22 (ref $options{options} eq 'HASH')
23 || $class->throw_error("You must pass a hash of options", data => $options{options});
24
1b2aea39 25 ($options{package_name} && $options{name})
46cb090f 26 || $class->throw_error("You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT");
27
acf10771 28 my $self = bless {
29 # from our superclass
d03bd989 30 'body' => undef,
e606ae5f 31 'package_name' => $options{package_name},
d03bd989 32 'name' => $options{name},
acf10771 33 # ...
d03bd989 34 'options' => $options{options},
e606ae5f 35 'associated_metaclass' => $options{metaclass},
acf10771 36 } => $class;
37
d03bd989 38 # we don't want this creating
39 # a cycle in the code, if not
acf10771 40 # needed
d03bd989 41 weaken($self->{'associated_metaclass'});
acf10771 42
bfaa304c 43 $self->_initialize_body;
acf10771 44
d03bd989 45 return $self;
acf10771 46}
47
d03bd989 48## accessors
acf10771 49
e606ae5f 50sub options { (shift)->{'options'} }
acf10771 51
52## method
53
a7b097bb 54sub is_needed {
55 my $self = shift;
56 my $metaclass = shift;
57
58 ( blessed $metaclass && $metaclass->isa('Class::MOP::Class') )
59 || $self->throw_error(
60 "The is_needed method expected a metaclass object as its arugment");
61
8c86556c 62 return $metaclass->find_method_by_name("DEMOLISHALL");
9d22affb 63}
acf10771 64
415e6f85 65sub initialize_body {
8b7cb9ab 66 Carp::cluck('The initialize_body method has been made private.'
67 . " The public version is deprecated and will be removed in a future release.\n");
bfaa304c 68 shift->_initialize_body;
69}
70
71sub _initialize_body {
acf10771 72 my $self = shift;
73 # TODO:
d03bd989 74 # the %options should also include a both
75 # a call 'initializer' and call 'SUPER::'
76 # options, which should cover approx 90%
77 # of the possible use cases (even if it
78 # requires some adaption on the part of
acf10771 79 # the author, after all, nothing is free)
d03bd989 80
9d22affb 81 my @DEMOLISH_methods = $self->associated_metaclass->find_all_methods_by_name('DEMOLISH');
d03bd989 82
8c86556c 83 my $source;
25818121 84 $source = 'sub {' . "\n";
85 $source .= 'my $self = shift;' . "\n";
86 $source .= 'return $self->Moose::Object::DESTROY(@_)' . "\n";
87 $source .= ' if Scalar::Util::blessed($self) ne ';
88 $source .= "'" . $self->associated_metaclass->name . "'";
89 $source .= ';' . "\n";
d03bd989 90
25818121 91 if ( @DEMOLISH_methods ) {
b288593e 92 $source .= 'local $?;' . "\n";
d03bd989 93
b288593e 94 $source .= 'my $in_global_destruction = Devel::GlobalDestruction::in_global_destruction;' . "\n";
95
96 $source .= 'Try::Tiny::try {' . "\n";
97
98 $source .= '$self->' . $_->{class} . '::DEMOLISH($in_global_destruction);' . "\n"
99 for @DEMOLISH_methods;
100
101 $source .= '}';
102 $source .= q[ Try::Tiny::catch { no warnings 'misc'; die $_ };] . "\n";
103 $source .= 'return;' . "\n";
104
8c86556c 105 }
acf10771 106
25818121 107 $source .= '}';
108
d03bd989 109 warn $source if $self->options->{debug};
110
34aab661 111 my ( $code, $e ) = $self->_compile_code(
497442e8 112 environment => {},
113 code => $source,
34aab661 114 );
115
116 $self->throw_error(
117 "Could not eval the destructor :\n\n$source\n\nbecause :\n\n$e",
118 error => $e, data => $source )
119 if $e;
497442e8 120
e606ae5f 121 $self->{'body'} = $code;
acf10771 122}
123
124
1251;
126
127__END__
128
129=pod
130
d03bd989 131=head1 NAME
587ae0d2 132
133Moose::Meta::Method::Destructor - Method Meta Object for destructors
134
587ae0d2 135=head1 DESCRIPTION
136
bcb81995 137This class is a subclass of L<Class::MOP::Class::Generated> that
138provides Moose-specific functionality for inlining destructors.
139
140To understand this class, you should read the the
141L<Class::MOP::Class::Generated> documentation as well.
142
143=head1 INHERITANCE
144
145C<Moose::Meta::Method::Destructor> is a subclass of
146L<Moose::Meta::Method> I<and> L<Class::MOP::Method::Generated>.
d44714be 147
587ae0d2 148=head1 METHODS
149
150=over 4
151
bcac984a 152=item B<< Moose::Meta::Method::Destructor->new(%options) >>
bcb81995 153
154This constructs a new object. It accepts the following options:
155
156=over 8
587ae0d2 157
bcb81995 158=item * package_name
587ae0d2 159
bcb81995 160The package for the class in which the destructor is being
161inlined. This option is required.
587ae0d2 162
bcb81995 163=item * name
587ae0d2 164
bcb81995 165The name of the destructor method. This option is required.
166
167=item * metaclass
168
169The metaclass for the class this destructor belongs to. This is
170optional, as it can be set later by calling C<<
171$metamethod->attach_to_class >>.
172
173=back
587ae0d2 174
bcb81995 175=item B<< Moose::Meta;:Method::Destructor->is_needed($metaclass) >>
587ae0d2 176
bcb81995 177Given a L<Moose::Meta::Class> object, this method returns a boolean
178indicating whether the class needs a destructor. If the class or any
179of its parents defines a C<DEMOLISH> method, it needs a destructor.
587ae0d2 180
181=back
182
c5fc2c21 183=head1 BUGS
184
185See L<Moose/BUGS> for details on reporting bugs.
186
587ae0d2 187=head1 AUTHORS
188
189Stevan Little E<lt>stevan@iinteractive.comE<gt>
190
191=head1 COPYRIGHT AND LICENSE
192
7e0492d3 193Copyright 2006-2010 by Infinity Interactive, Inc.
587ae0d2 194
195L<http://www.iinteractive.com>
196
197This library is free software; you can redistribute it and/or modify
d03bd989 198it under the same terms as Perl itself.
587ae0d2 199
200=cut
201