Commit | Line | Data |
fcd84ca9 |
1 | |
2 | package Moose::Object; |
3 | |
4 | use strict; |
5 | use warnings; |
648e79ae |
6 | |
f25f9912 |
7 | use Devel::GlobalDestruction (); |
8 | use MRO::Compat (); |
9 | use Scalar::Util (); |
10 | use Try::Tiny (); |
2eaf25da |
11 | |
9922fa6f |
12 | use if ( not our $__mx_is_compiled ), 'Moose::Meta::Class'; |
13 | use if ( not our $__mx_is_compiled ), metaclass => 'Moose::Meta::Class'; |
bc1e29b5 |
14 | |
3eb89f70 |
15 | our $VERSION = '1.01'; |
e606ae5f |
16 | $VERSION = eval $VERSION; |
d44714be |
17 | our $AUTHORITY = 'cpan:STEVAN'; |
fcd84ca9 |
18 | |
19 | sub new { |
2c0cbef7 |
20 | my $class = shift; |
62c8675e |
21 | |
e606ae5f |
22 | my $params = $class->BUILDARGS(@_); |
2eaf25da |
23 | |
f25f9912 |
24 | my $real_class = Scalar::Util::blessed($class) || $class; |
2eaf25da |
25 | my $self = Class::MOP::Class->initialize($real_class)->new_object($params); |
26 | |
e606ae5f |
27 | $self->BUILDALL($params); |
2eaf25da |
28 | |
e606ae5f |
29 | return $self; |
30 | } |
31 | |
32 | sub BUILDARGS { |
33 | my $class = shift; |
a62dcd43 |
34 | if ( scalar @_ == 1 ) { |
35 | unless ( defined $_[0] && ref $_[0] eq 'HASH' ) { |
46047bea |
36 | Class::MOP::class_of($class)->throw_error( |
a62dcd43 |
37 | "Single parameters to new() must be a HASH ref", |
38 | data => $_[0] ); |
86629f93 |
39 | } |
a62dcd43 |
40 | return { %{ $_[0] } }; |
41 | } |
8a157bab |
42 | else { |
e606ae5f |
43 | return {@_}; |
8a157bab |
44 | } |
fcd84ca9 |
45 | } |
46 | |
c0e30cf5 |
47 | sub BUILDALL { |
d03bd989 |
48 | # NOTE: we ask Perl if we even |
d44714be |
49 | # need to do this first, to avoid |
50 | # extra meta level calls |
17819f17 |
51 | return unless $_[0]->can('BUILD'); |
fb1e11d5 |
52 | my ($self, $params) = @_; |
505033d9 |
53 | foreach my $method (reverse Class::MOP::class_of($self)->find_all_methods_by_name('BUILD')) { |
b8f014e7 |
54 | $method->{code}->execute($self, $params); |
fb1e11d5 |
55 | } |
c0e30cf5 |
56 | } |
57 | |
58 | sub DEMOLISHALL { |
8955a780 |
59 | my $self = shift; |
d9359278 |
60 | my ($in_global_destruction) = @_; |
8955a780 |
61 | |
62 | # NOTE: we ask Perl if we even |
cb5c79c9 |
63 | # need to do this first, to avoid |
8955a780 |
64 | # extra meta level calls |
17819f17 |
65 | return unless $self->can('DEMOLISH'); |
8955a780 |
66 | |
2bc1eab6 |
67 | my @isa; |
68 | if ( my $meta = Class::MOP::class_of($self ) ) { |
69 | @isa = $meta->linearized_isa; |
70 | } else { |
71 | # We cannot count on being able to retrieve a previously made |
72 | # metaclass, _or_ being able to make a new one during global |
73 | # destruction. However, we should still be able to use mro at |
74 | # that time (at least tests suggest so ;) |
75 | my $class_name = ref $self; |
76 | @isa = @{ mro::get_linear_isa($class_name) } |
77 | } |
78 | |
79 | foreach my $class (@isa) { |
c063fc8b |
80 | no strict 'refs'; |
81 | my $demolish = *{"${class}::DEMOLISH"}{CODE}; |
82 | $self->$demolish($in_global_destruction) |
83 | if defined $demolish; |
3a0c064a |
84 | } |
85 | } |
86 | |
d03bd989 |
87 | sub DESTROY { |
b288593e |
88 | my $self = shift; |
89 | |
90 | local $?; |
91 | |
f25f9912 |
92 | Try::Tiny::try { |
93 | $self->DEMOLISHALL(Devel::GlobalDestruction::in_global_destruction); |
b288593e |
94 | } |
f25f9912 |
95 | Try::Tiny::catch { |
b288593e |
96 | # Without this, Perl will warn "\t(in cleanup)$@" because of some |
97 | # bizarre fucked-up logic deep in the internals. |
98 | no warnings 'misc'; |
99 | die $_; |
100 | }; |
101 | |
c989424b |
102 | return; |
c0e30cf5 |
103 | } |
104 | |
e606ae5f |
105 | # support for UNIVERSAL::DOES ... |
106 | BEGIN { |
107 | my $does = UNIVERSAL->can("DOES") ? "SUPER::DOES" : "isa"; |
108 | eval 'sub DOES { |
109 | my ( $self, $class_or_role_name ) = @_; |
110 | return $self->'.$does.'($class_or_role_name) |
111 | || $self->does($class_or_role_name); |
112 | }'; |
113 | } |
114 | |
d03bd989 |
115 | # new does() methods will be created |
50bc108b |
116 | # as appropiate see Moose::Meta::Role |
0677220d |
117 | sub does { |
bdabd620 |
118 | my ($self, $role_name) = @_; |
66d33a5c |
119 | my $meta = Class::MOP::class_of($self); |
be05faea |
120 | (defined $role_name) |
d9de4f04 |
121 | || $meta->throw_error("You must supply a role name to does()"); |
b82ef9c3 |
122 | return 1 if $meta->can('does_role') && $meta->does_role($role_name); |
d03bd989 |
123 | return 0; |
0677220d |
124 | } |
ef333f17 |
125 | |
d03bd989 |
126 | sub dump { |
f742dfef |
127 | my $self = shift; |
128 | require Data::Dumper; |
1a386a6c |
129 | local $Data::Dumper::Maxdepth = shift if @_; |
f742dfef |
130 | Data::Dumper::Dumper $self; |
131 | } |
132 | |
fcd84ca9 |
133 | 1; |
134 | |
135 | __END__ |
136 | |
137 | =pod |
138 | |
139 | =head1 NAME |
140 | |
e522431d |
141 | Moose::Object - The base object for Moose |
fcd84ca9 |
142 | |
fcd84ca9 |
143 | =head1 DESCRIPTION |
144 | |
080e3614 |
145 | This class is the default base class for all Moose-using classes. When |
146 | you C<use Moose> in this class, your class will inherit from this |
147 | class. |
6ba6d68c |
148 | |
080e3614 |
149 | It provides a default constructor and destructor, which run the |
150 | C<BUILDALL> and C<DEMOLISHALL> methods respectively. |
151 | |
152 | You don't actually I<need> to inherit from this in order to use Moose, |
153 | but it makes it easier to take advantage of all of Moose's features. |
6ba6d68c |
154 | |
fcd84ca9 |
155 | =head1 METHODS |
156 | |
157 | =over 4 |
158 | |
080e3614 |
159 | =item B<< Moose::Object->new(%params) >> |
160 | |
161 | This method calls C<< $class->BUILDARGS(@_) >>, and then creates a new |
162 | instance of the appropriate class. Once the instance is created, it |
163 | calls C<< $instance->BUILDALL($params) >>. |
fcd84ca9 |
164 | |
080e3614 |
165 | =item B<< Moose::Object->BUILDARGS(%params) >> |
6ba6d68c |
166 | |
080e3614 |
167 | The default implementation of this method accepts a hash or hash |
168 | reference of named parameters. If it receives a single argument that |
169 | I<isn't> a hash reference it throws an error. |
fcd84ca9 |
170 | |
080e3614 |
171 | You can override this method in your class to handle other types of |
172 | options passed to the constructor. |
e606ae5f |
173 | |
080e3614 |
174 | This method should always return a hash reference of named options. |
e606ae5f |
175 | |
080e3614 |
176 | =item B<< $object->BUILDALL($params) >> |
e522431d |
177 | |
080e3614 |
178 | This method will call every C<BUILD> method in the inheritance |
179 | hierarchy, starting with the most distant parent class and ending with |
180 | the object's class. |
c0e30cf5 |
181 | |
080e3614 |
182 | The C<BUILD> method will be passed the hash reference returned by |
183 | C<BUILDARGS>. |
e522431d |
184 | |
080e3614 |
185 | =item B<< $object->DEMOLISHALL >> |
c0e30cf5 |
186 | |
080e3614 |
187 | This will call every C<DEMOLISH> method in the inheritance hierarchy, |
188 | starting with the object's class and ending with the most distant |
c3fdacda |
189 | parent. C<DEMOLISHALL> and C<DEMOLISH> will receive a boolean |
190 | indicating whether or not we are currently in global destruction. |
e522431d |
191 | |
080e3614 |
192 | =item B<< $object->does($role_name) >> |
ef333f17 |
193 | |
080e3614 |
194 | This returns true if the object does the given role. |
02a0fb52 |
195 | |
e606ae5f |
196 | =item B<DOES ($class_or_role_name)> |
197 | |
080e3614 |
198 | This is a a Moose role-aware implementation of L<UNIVERSAL/DOES>. |
e606ae5f |
199 | |
080e3614 |
200 | This is effectively the same as writing: |
e606ae5f |
201 | |
080e3614 |
202 | $object->does($name) || $object->isa($name) |
f742dfef |
203 | |
080e3614 |
204 | This method will work with Perl 5.8, which did not implement |
205 | C<UNIVERSAL::DOES>. |
f742dfef |
206 | |
080e3614 |
207 | =item B<< $object->dump($maxdepth) >> |
f742dfef |
208 | |
080e3614 |
209 | This is a handy utility for C<Data::Dumper>ing an object. By default, |
210 | the maximum depth is 1, to avoid making a mess. |
f742dfef |
211 | |
fcd84ca9 |
212 | =back |
213 | |
214 | =head1 BUGS |
215 | |
d4048ef3 |
216 | See L<Moose/BUGS> for details on reporting bugs. |
fcd84ca9 |
217 | |
fcd84ca9 |
218 | =head1 AUTHOR |
219 | |
220 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
221 | |
222 | =head1 COPYRIGHT AND LICENSE |
223 | |
7e0492d3 |
224 | Copyright 2006-2010 by Infinity Interactive, Inc. |
fcd84ca9 |
225 | |
226 | L<http://www.iinteractive.com> |
227 | |
228 | This library is free software; you can redistribute it and/or modify |
d03bd989 |
229 | it under the same terms as Perl itself. |
fcd84ca9 |
230 | |
9922fa6f |
231 | =cut |