Make get_method_map private (as _full_method_map) and deprecate the public
[gitmo/Class-MOP.git] / t / 003_methods.t
1 use strict;
2 use warnings;
3
4 use Test::More tests => 69;
5 use Test::Exception;
6
7 use Scalar::Util qw/reftype/;
8 use Sub::Name;
9
10 use Class::MOP;
11 use Class::MOP::Class;
12 use Class::MOP::Method;
13
14 {
15     # This package tries to test &has_method as exhaustively as
16     # possible. More corner cases are welcome :)
17     package Foo;
18
19     # import a sub
20     use Scalar::Util 'blessed';
21
22     sub pie;
23     sub cake ();
24
25     use constant FOO_CONSTANT => 'Foo-CONSTANT';
26
27     # define a sub in package
28     sub bar {'Foo::bar'}
29     *baz = \&bar;
30
31     # create something with the typeglob inside the package
32     *baaz = sub {'Foo::baaz'};
33
34     {    # method named with Sub::Name inside the package scope
35         no strict 'refs';
36         *{'Foo::floob'} = Sub::Name::subname 'floob' => sub {'!floob!'};
37     }
38
39     # We hateses the "used only once" warnings
40     {
41         my $temp1 = \&Foo::baz;
42         my $temp2 = \&Foo::baaz;
43     }
44
45     package OinkyBoinky;
46     our @ISA = "Foo";
47
48     sub elk {'OinkyBoinky::elk'}
49
50     package main;
51
52     sub Foo::blah { $_[0]->Foo::baz() }
53
54     {
55         no strict 'refs';
56         *{'Foo::bling'} = sub {'$$Bling$$'};
57         *{'Foo::bang'} = Sub::Name::subname 'Foo::bang' => sub {'!BANG!'};
58         *{'Foo::boom'} = Sub::Name::subname 'boom'      => sub {'!BOOM!'};
59
60         eval "package Foo; sub evaled_foo { 'Foo::evaled_foo' }";
61     }
62 }
63
64 my $Foo = Class::MOP::Class->initialize('Foo');
65
66 ok( $Foo->has_method('pie'),  '... got the method stub pie' );
67 ok( $Foo->has_method('cake'), '... got the constant method stub cake' );
68
69 my $foo = sub {'Foo::foo'};
70
71 ok( !UNIVERSAL::isa( $foo, 'Class::MOP::Method' ),
72     '... our method is not yet blessed' );
73
74 lives_ok {
75     $Foo->add_method( 'foo' => $foo );
76 }
77 '... we added the method successfully';
78
79 my $foo_method = $Foo->get_method('foo');
80
81 isa_ok( $foo_method, 'Class::MOP::Method' );
82
83 is( $foo_method->name, 'foo', '... got the right name for the method' );
84 is( $foo_method->package_name, 'Foo',
85     '... got the right package name for the method' );
86
87 ok( $Foo->has_method('foo'),
88     '... Foo->has_method(foo) (defined with Sub::Name)' );
89
90 is( $Foo->get_method('foo')->body, $foo,
91     '... Foo->get_method(foo) == \&foo' );
92 is( $Foo->get_method('foo')->execute, 'Foo::foo',
93     '... _method_foo->execute returns "Foo::foo"' );
94 is( Foo->foo(), 'Foo::foo', '... Foo->foo() returns "Foo::foo"' );
95
96 # now check all our other items ...
97
98 ok( $Foo->has_method('FOO_CONSTANT'),
99     '... not Foo->has_method(FOO_CONSTANT) (defined w/ use constant)' );
100 ok( !$Foo->has_method('bling'),
101     '... not Foo->has_method(bling) (defined in main:: using symbol tables (no Sub::Name))'
102 );
103
104 ok( $Foo->has_method('bar'), '... Foo->has_method(bar) (defined in Foo)' );
105 ok( $Foo->has_method('baz'),
106     '... Foo->has_method(baz) (typeglob aliased within Foo)' );
107 ok( $Foo->has_method('baaz'),
108     '... Foo->has_method(baaz) (typeglob aliased within Foo)' );
109 ok( $Foo->has_method('floob'),
110     '... Foo->has_method(floob) (defined in Foo:: using symbol tables and Sub::Name w/out package name)'
111 );
112 ok( $Foo->has_method('blah'),
113     '... Foo->has_method(blah) (defined in main:: using fully qualified package name)'
114 );
115 ok( $Foo->has_method('bang'),
116     '... Foo->has_method(bang) (defined in main:: using symbol tables and Sub::Name)'
117 );
118 ok( $Foo->has_method('evaled_foo'),
119     '... Foo->has_method(evaled_foo) (evaled in main::)' );
120
121 my $OinkyBoinky = Class::MOP::Class->initialize('OinkyBoinky');
122
123 ok( $OinkyBoinky->has_method('elk'),
124     "the method 'elk' is defined in OinkyBoinky" );
125
126 ok( !$OinkyBoinky->has_method('bar'),
127     "the method 'bar' is not defined in OinkyBoinky" );
128
129 ok( my $bar = $OinkyBoinky->find_method_by_name('bar'),
130     "but if you look in the inheritence chain then 'bar' does exist" );
131
132 is( reftype( $bar->body ), "CODE", "the returned value is a code ref" );
133
134 # calling get_method blessed them all
135 for my $method_name (
136     qw/baaz
137     bar
138     baz
139     floob
140     blah
141     bang
142     evaled_foo
143     FOO_CONSTANT/
144     ) {
145     isa_ok( $Foo->get_method($method_name), 'Class::MOP::Method' );
146     {
147         no strict 'refs';
148         is( $Foo->get_method($method_name)->body,
149             \&{ 'Foo::' . $method_name },
150             '... body matches CODE ref in package for ' . $method_name );
151     }
152 }
153
154 for my $method_name (
155     qw/
156     bling
157     /
158     ) {
159     is( ref( $Foo->get_package_symbol( '&' . $method_name ) ), 'CODE',
160         '... got the __ANON__ methods' );
161     {
162         no strict 'refs';
163         is( $Foo->get_package_symbol( '&' . $method_name ),
164             \&{ 'Foo::' . $method_name },
165             '... symbol matches CODE ref in package for ' . $method_name );
166     }
167 }
168
169 ok( !$Foo->has_method('blessed'),
170     '... !Foo->has_method(blessed) (imported into Foo)' );
171 ok( !$Foo->has_method('boom'),
172     '... !Foo->has_method(boom) (defined in main:: using symbol tables and Sub::Name w/out package name)'
173 );
174
175 ok( !$Foo->has_method('not_a_real_method'),
176     '... !Foo->has_method(not_a_real_method) (does not exist)' );
177 is( $Foo->get_method('not_a_real_method'), undef,
178     '... Foo->get_method(not_a_real_method) == undef' );
179
180 is_deeply(
181     [ sort $Foo->get_method_list ],
182     [qw(FOO_CONSTANT baaz bang bar baz blah cake evaled_foo floob foo pie)],
183     '... got the right method list for Foo'
184 );
185
186 is_deeply(
187     [ sort { $a->name cmp $b->name } $Foo->get_all_methods() ],
188     [
189         map { $Foo->get_method($_) }
190             qw(
191             FOO_CONSTANT
192             baaz
193             bang
194             bar
195             baz
196             blah
197             cake
198             evaled_foo
199             floob
200             foo
201             pie
202             )
203     ],
204     '... got the right list of applicable methods for Foo'
205 );
206
207 is( $Foo->remove_method('foo')->body, $foo, '... removed the foo method' );
208 ok( !$Foo->has_method('foo'),
209     '... !Foo->has_method(foo) we just removed it' );
210 dies_ok { Foo->foo } '... cannot call Foo->foo because it is not there';
211
212 is_deeply(
213     [ sort $Foo->get_method_list ],
214     [qw(FOO_CONSTANT baaz bang bar baz blah cake evaled_foo floob pie)],
215     '... got the right method list for Foo'
216 );
217
218 # ... test our class creator
219
220 my $Bar = Class::MOP::Class->create(
221     package      => 'Bar',
222     superclasses => ['Foo'],
223     methods      => {
224         foo => sub {'Bar::foo'},
225         bar => sub {'Bar::bar'},
226     }
227 );
228 isa_ok( $Bar, 'Class::MOP::Class' );
229
230 ok( $Bar->has_method('foo'), '... Bar->has_method(foo)' );
231 ok( $Bar->has_method('bar'), '... Bar->has_method(bar)' );
232
233 is( Bar->foo, 'Bar::foo', '... Bar->foo == Bar::foo' );
234 is( Bar->bar, 'Bar::bar', '... Bar->bar == Bar::bar' );
235
236 lives_ok {
237     $Bar->add_method( 'foo' => sub {'Bar::foo v2'} );
238 }
239 '... overwriting a method is fine';
240
241 is_deeply( [ Class::MOP::get_code_info( $Bar->get_method('foo')->body ) ],
242     [ "Bar", "foo" ], "subname applied to anonymous method" );
243
244 ok( $Bar->has_method('foo'), '... Bar-> (still) has_method(foo)' );
245 is( Bar->foo, 'Bar::foo v2', '... Bar->foo == "Bar::foo v2"' );
246
247 is_deeply(
248     [ sort $Bar->get_method_list ],
249     [qw(bar foo meta)],
250     '... got the right method list for Bar'
251 );
252
253 is_deeply(
254     [ sort { $a->name cmp $b->name } $Bar->get_all_methods() ],
255     [
256         $Foo->get_method('FOO_CONSTANT'),
257         $Foo->get_method('baaz'),
258         $Foo->get_method('bang'),
259         $Bar->get_method('bar'),
260         (
261             map { $Foo->get_method($_) }
262                 qw(
263                 baz
264                 blah
265                 cake
266                 evaled_foo
267                 floob
268                 )
269         ),
270         $Bar->get_method('foo'),
271         $Bar->get_method('meta'),
272         $Foo->get_method('pie'),
273     ],
274     '... got the right list of applicable methods for Bar'
275 );
276
277 my $method = Class::MOP::Method->wrap(
278     name         => 'objecty',
279     package_name => 'Whatever',
280     body         => sub {q{I am an object, and I feel an object's pain}},
281 );
282
283 Bar->meta->add_method( $method->name, $method );
284
285 my $new_method = Bar->meta->get_method('objecty');
286
287 isnt( $method, $new_method,
288     'add_method clones method objects as they are added' );
289 is( $new_method->original_method, $method,
290     '... the cloned method has the correct original method' )
291         or diag $new_method->dump;
292
293 {
294     package CustomAccessor;
295
296     use Class::MOP;
297
298     my $meta = Class::MOP::Class->initialize(__PACKAGE__);
299
300     $meta->add_attribute(
301         foo => (
302             accessor => 'foo',
303         )
304     );
305
306     {
307         no warnings 'redefine', 'once';
308         *foo = sub {
309             my $self = shift;
310             $self->{custom_store} = $_[0];
311         };
312     }
313
314     $meta->add_around_method_modifier(
315         'foo',
316         sub {
317             my $orig = shift;
318             $orig->(@_);
319         }
320     );
321
322     sub new {
323         return bless {}, shift;
324     }
325 }
326
327 {
328     my $o   = CustomAccessor->new;
329     my $str = 'string';
330
331     $o->foo($str);
332
333     is(
334         $o->{custom_store}, $str,
335         'Custom glob-assignment-created accessor still has method modifier'
336     );
337 }
338
339 {
340     # Since the sub reference below is not a closure, Perl caches it and uses
341     # the same reference each time through the loop. See RT #48985 for the
342     # bug.
343     foreach my $ns ( qw( Foo2 Bar2 Baz2 ) ) {
344         my $meta = Class::MOP::Class->create($ns);
345
346         my $sub = sub { };
347
348         $meta->add_method( 'foo', $sub );
349
350         my $method = $meta->get_method('foo');
351         ok( $method, 'Got the foo method back' );
352     }
353 }