t/030_roles/005_role_conflict_detection.t

   1 #!/usr/bin/perl
   2
   3 use strict;
   4 use warnings;
   5
   6 use Test::More;
   7 use Test::Exception;
   8
   9 =pod
  10
  11 Mutually recursive roles.
  12
  13 =cut
  14
  15 {
  16     package Role::Foo;
  17     use Mouse::Role;
  18
  19     requires 'foo';
  20
  21     sub bar { 'Role::Foo::bar' }
  22
  23     package Role::Bar;
  24     use Mouse::Role;
  25
  26     requires 'bar';
  27
  28     sub foo { 'Role::Bar::foo' }
  29 }
  30
  31 {
  32     package My::Test1;
  33     use Mouse;
  34
  35     ::lives_ok {
  36         with 'Role::Foo', 'Role::Bar';
  37     } '... our mutually recursive roles combine okay';
  38
  39     package My::Test2;
  40     use Mouse;
  41
  42     ::lives_ok {
  43         with 'Role::Bar', 'Role::Foo';
  44     } '... our mutually recursive roles combine okay (no matter what order)';
  45 }
  46
  47 my $test1 = My::Test1->new;
  48 isa_ok($test1, 'My::Test1');
  49
  50 ok($test1->does('Role::Foo'), '... $test1 does Role::Foo');
  51 ok($test1->does('Role::Bar'), '... $test1 does Role::Bar');
  52
  53 can_ok($test1, 'foo');
  54 can_ok($test1, 'bar');
  55
  56 is($test1->foo, 'Role::Bar::foo', '... $test1->foo worked');
  57 is($test1->bar, 'Role::Foo::bar', '... $test1->bar worked');
  58
  59 my $test2 = My::Test2->new;
  60 isa_ok($test2, 'My::Test2');
  61
  62 ok($test2->does('Role::Foo'), '... $test2 does Role::Foo');
  63 ok($test2->does('Role::Bar'), '... $test2 does Role::Bar');
  64
  65 can_ok($test2, 'foo');
  66 can_ok($test2, 'bar');
  67
  68 is($test2->foo, 'Role::Bar::foo', '... $test2->foo worked');
  69 is($test2->bar, 'Role::Foo::bar', '... $test2->bar worked');
  70
  71 # check some meta-stuff
  72
  73 ok(Role::Foo->meta->has_method('bar'), '... it still has the bar method');
  74 ok(Role::Foo->meta->requires_method('foo'), '... it still has the required foo method');
  75
  76 ok(Role::Bar->meta->has_method('foo'), '... it still has the foo method');
  77 ok(Role::Bar->meta->requires_method('bar'), '... it still has the required bar method');
  78
  79 =pod
  80
  81 Role method conflicts
  82
  83 =cut
  84
  85 {
  86     package Role::Bling;
  87     use Mouse::Role;
  88
  89     sub bling { 'Role::Bling::bling' }
  90
  91     package Role::Bling::Bling;
  92     use Mouse::Role;
  93
  94     sub bling { 'Role::Bling::Bling::bling' }
  95 }
  96
  97 {
  98     package My::Test3;
  99     use Mouse;
 100
 101     ::throws_ok {
 102         with 'Role::Bling', 'Role::Bling::Bling';
 103     } qr/Due to a method name conflict in roles 'Role::Bling' and 'Role::Bling::Bling', the method 'bling' must be implemented or excluded by 'My::Test3'/, '... role methods conflict and method was required';
 104
 105     package My::Test4;
 106     use Mouse;
 107
 108     ::lives_ok {
 109         with 'Role::Bling';
 110         with 'Role::Bling::Bling';
 111     } '... role methods didnt conflict when manually combined';
 112
 113     package My::Test5;
 114     use Mouse;
 115
 116     ::lives_ok {
 117         with 'Role::Bling::Bling';
 118         with 'Role::Bling';
 119     } '... role methods didnt conflict when manually combined (in opposite order)';
 120
 121     package My::Test6;
 122     use Mouse;
 123
 124     ::lives_ok {
 125         with 'Role::Bling::Bling', 'Role::Bling';
 126     } '... role methods didnt conflict when manually resolved';
 127
 128     sub bling { 'My::Test6::bling' }
 129 }
 130
 131 ok(!My::Test3->meta->has_method('bling'), '... we didnt get any methods in the conflict');
 132 ok(My::Test4->meta->has_method('bling'), '... we did get the method when manually dealt with');
 133 ok(My::Test5->meta->has_method('bling'), '... we did get the method when manually dealt with');
 134 ok(My::Test6->meta->has_method('bling'), '... we did get the method when manually dealt with');
 135
 136 ok(!My::Test3->does('Role::Bling'), '... our class does() the correct roles');
 137 ok(!My::Test3->does('Role::Bling::Bling'), '... our class does() the correct roles');
 138 ok(My::Test4->does('Role::Bling'), '... our class does() the correct roles');
 139 ok(My::Test4->does('Role::Bling::Bling'), '... our class does() the correct roles');
 140 ok(My::Test5->does('Role::Bling'), '... our class does() the correct roles');
 141 ok(My::Test5->does('Role::Bling::Bling'), '... our class does() the correct roles');
 142 ok(My::Test6->does('Role::Bling'), '... our class does() the correct roles');
 143 ok(My::Test6->does('Role::Bling::Bling'), '... our class does() the correct roles');
 144
 145 is(My::Test4->bling, 'Role::Bling::bling', '... and we got the first method that was added');
 146 is(My::Test5->bling, 'Role::Bling::Bling::bling', '... and we got the first method that was added');
 147 is(My::Test6->bling, 'My::Test6::bling', '... and we got the local method');
 148
 149 # check how this affects role compostion
 150
 151 {
 152     package Role::Bling::Bling::Bling;
 153     use Mouse::Role;
 154
 155     with 'Role::Bling::Bling';
 156
 157     sub bling { 'Role::Bling::Bling::Bling::bling' }
 158 }
 159
 160 ok(Role::Bling::Bling->meta->has_method('bling'), '... still got the bling method in Role::Bling::Bling');
 161 ok(Role::Bling::Bling->meta->does_role('Role::Bling::Bling'), '... our role correctly does() the other role');
 162 ok(Role::Bling::Bling::Bling->meta->has_method('bling'), '... dont have the bling method in Role::Bling::Bling::Bling');
 163 is(Role::Bling::Bling::Bling->meta->get_method('bling')->(),
 164     'Role::Bling::Bling::Bling::bling',
 165     '... still got the bling method in Role::Bling::Bling::Bling');
 166
 167
 168 =pod
 169
 170 Role attribute conflicts
 171
 172 =cut
 173
 174 {
 175     package Role::Boo;
 176     use Mouse::Role;
 177
 178     has 'ghost' => (is => 'ro', default => 'Role::Boo::ghost');
 179
 180     package Role::Boo::Hoo;
 181     use Mouse::Role;
 182
 183     has 'ghost' => (is => 'ro', default => 'Role::Boo::Hoo::ghost');
 184 }
 185
 186 {
 187     package My::Test7;
 188     use Mouse;
 189
 190     ::throws_ok {
 191         with 'Role::Boo', 'Role::Boo::Hoo';
 192     } qr/We have encountered an attribute conflict/,
 193       '... role attrs conflict and method was required';
 194
 195     package My::Test8;
 196     use Mouse;
 197
 198     ::lives_ok {
 199         with 'Role::Boo';
 200         with 'Role::Boo::Hoo';
 201     } '... role attrs didnt conflict when manually combined';
 202
 203     package My::Test9;
 204     use Mouse;
 205
 206     ::lives_ok {
 207         with 'Role::Boo::Hoo';
 208         with 'Role::Boo';
 209     } '... role attrs didnt conflict when manually combined';
 210
 211     package My::Test10;
 212     use Mouse;
 213
 214     has 'ghost' => (is => 'ro', default => 'My::Test10::ghost');
 215
 216     ::throws_ok {
 217         with 'Role::Boo', 'Role::Boo::Hoo';
 218     } qr/We have encountered an attribute conflict/,
 219       '... role attrs conflict and cannot be manually disambiguted';
 220
 221 }
 222
 223 ok(!My::Test7->meta->has_attribute('ghost'), '... we didnt get any attributes in the conflict');
 224 ok(My::Test8->meta->has_attribute('ghost'), '... we did get an attributes when manually composed');
 225 ok(My::Test9->meta->has_attribute('ghost'), '... we did get an attributes when manually composed');
 226 ok(My::Test10->meta->has_attribute('ghost'), '... we did still have an attribute ghost (conflict does not mess with class)');
 227
 228 ok(!My::Test7->does('Role::Boo'), '... our class does() the correct roles');
 229 ok(!My::Test7->does('Role::Boo::Hoo'), '... our class does() the correct roles');
 230 ok(My::Test8->does('Role::Boo'), '... our class does() the correct roles');
 231 ok(My::Test8->does('Role::Boo::Hoo'), '... our class does() the correct roles');
 232 ok(My::Test9->does('Role::Boo'), '... our class does() the correct roles');
 233 ok(My::Test9->does('Role::Boo::Hoo'), '... our class does() the correct roles');
 234 ok(!My::Test10->does('Role::Boo'), '... our class does() the correct roles');
 235 ok(!My::Test10->does('Role::Boo::Hoo'), '... our class does() the correct roles');
 236
 237 can_ok('My::Test8', 'ghost');
 238 can_ok('My::Test9', 'ghost');
 239 can_ok('My::Test10', 'ghost');
 240
 241 is(My::Test8->new->ghost, 'Role::Boo::ghost', '... got the expected default attr value');
 242 is(My::Test9->new->ghost, 'Role::Boo::Hoo::ghost', '... got the expected default attr value');
 243 is(My::Test10->new->ghost, 'My::Test10::ghost', '... got the expected default attr value');
 244
 245 =pod
 246
 247 Role override method conflicts
 248
 249 =cut
 250
 251 {
 252     package Role::Plot;
 253     use Mouse::Role;
 254
 255     override 'twist' => sub {
 256         super() . ' -> Role::Plot::twist';
 257     };
 258
 259     package Role::Truth;
 260     use Mouse::Role;
 261
 262     override 'twist' => sub {
 263         super() . ' -> Role::Truth::twist';
 264     };
 265 }
 266
 267 {
 268     package My::Test::Base;
 269     use Mouse;
 270
 271     sub twist { 'My::Test::Base::twist' }
 272
 273     package My::Test11;
 274     use Mouse;
 275
 276     extends 'My::Test::Base';
 277
 278     ::lives_ok {
 279         with 'Role::Truth';
 280     } '... composed the role with override okay';
 281
 282     package My::Test12;
 283     use Mouse;
 284
 285     extends 'My::Test::Base';
 286
 287     ::lives_ok {
 288        with 'Role::Plot';
 289     } '... composed the role with override okay';
 290
 291     package My::Test13;
 292     use Mouse;
 293
 294     ::dies_ok {
 295         with 'Role::Plot';
 296     } '... cannot compose it because we have no superclass';
 297
 298     package My::Test14;
 299     use Mouse;
 300
 301     extends 'My::Test::Base';
 302
 303     ::throws_ok {
 304         with 'Role::Plot', 'Role::Truth';
 305     } qr/Two \'override\' methods of the same name encountered/,
 306       '... cannot compose it because we have no superclass';
 307 }
 308
 309 ok(My::Test11->meta->has_method('twist'), '... the twist method has been added');
 310 ok(My::Test12->meta->has_method('twist'), '... the twist method has been added');
 311 ok(!My::Test13->meta->has_method('twist'), '... the twist method has not been added');
 312 ok(!My::Test14->meta->has_method('twist'), '... the twist method has not been added');
 313
 314 ok(!My::Test11->does('Role::Plot'), '... our class does() the correct roles');
 315 ok(My::Test11->does('Role::Truth'), '... our class does() the correct roles');
 316 ok(!My::Test12->does('Role::Truth'), '... our class does() the correct roles');
 317 ok(My::Test12->does('Role::Plot'), '... our class does() the correct roles');
 318 ok(!My::Test13->does('Role::Plot'), '... our class does() the correct roles');
 319 ok(!My::Test14->does('Role::Truth'), '... our class does() the correct roles');
 320 ok(!My::Test14->does('Role::Plot'), '... our class does() the correct roles');
 321
 322 is(My::Test11->twist(), 'My::Test::Base::twist -> Role::Truth::twist', '... got the right method return');
 323 is(My::Test12->twist(), 'My::Test::Base::twist -> Role::Plot::twist', '... got the right method return');
 324 ok(!My::Test13->can('twist'), '... no twist method here at all');
 325 is(My::Test14->twist(), 'My::Test::Base::twist', '... got the right method return (from superclass)');
 326
 327 {
 328     package Role::Reality;
 329     use Mouse::Role;
 330
 331     ::throws_ok {
 332         with 'Role::Plot';
 333     } qr/A local method of the same name as been found/,
 334     '... could not compose roles here, it dies';
 335
 336     sub twist {
 337         'Role::Reality::twist';
 338     }
 339 }
 340
 341 ok(Role::Reality->meta->has_method('twist'), '... the twist method has not been added');
 342 #ok(!Role::Reality->meta->does_role('Role::Plot'), '... our role does() the correct roles');
 343 is(Role::Reality->meta->get_method('twist')->(),
 344     'Role::Reality::twist',
 345     '... the twist method returns the right value');
 346
 347 # Ovid's test case from rt.cpan.org #44
 348 {
 349     package Role1;
 350     use Mouse::Role;
 351
 352     sub foo {}
 353 }
 354 {
 355     package Role2;
 356     use Mouse::Role;
 357
 358     sub foo {}
 359 }
 360 {
 361     package Conflicts;
 362     use Mouse;
 363
 364     ::throws_ok {
 365         with qw(Role1 Role2);
 366     } qr/Due to a method name conflict in roles 'Role1' and 'Role2', the method 'foo' must be implemented or excluded by 'Conflicts'/;
 367 }
 368
 369 =pod
 370
 371 Role conflicts between attributes and methods
 372
 373 [15:23]  <kolibrie> when class defines method and role defines method, class wins
 374 [15:24]  <kolibrie> when class 'has'   method and role defines method, class wins
 375 [15:24]  <kolibrie> when class defines method and role 'has'   method, role wins
 376 [15:24]  <kolibrie> when class 'has'   method and role 'has'   method, role wins
 377 [15:24]  <kolibrie> which means when class 'has' method and two roles 'has' method, no tiebreak is detected
 378 [15:24]  <perigrin> this is with role and has declaration in the exact same order in every case?
 379 [15:25]  <kolibrie> yes
 380 [15:25]  <perigrin> interesting
 381 [15:25]  <kolibrie> that's what I thought
 382 [15:26]  <kolibrie> does that sound like something I should write a test for?
 383 [15:27]  <perigrin> stevan, ping?
 384 [15:27]  <perigrin> I'm not sure what the right answer for composition is.
 385 [15:27]  <perigrin> who should win
 386 [15:27]  <perigrin> if I were to guess I'd say the class should always win.
 387 [15:27]  <kolibrie> that would be my guess, but I thought I would ask to make sure
 388 [15:29]  <stevan> kolibrie: please write a test
 389 [15:29]  <stevan> I am not exactly sure who should win either,.. but I suspect it is not working correctly right now
 390 [15:29]  <stevan> I know exactly why it is doing what it is doing though
 391
 392 Now I have to decide actually what happens, and how to fix it.
 393 - SL
 394
 395 {
 396     package Role::Method;
 397     use Mouse::Role;
 398
 399     sub ghost { 'Role::Method::ghost' }
 400
 401     package Role::Method2;
 402     use Mouse::Role;
 403
 404     sub ghost { 'Role::Method2::ghost' }
 405
 406     package Role::Attribute;
 407     use Mouse::Role;
 408
 409     has 'ghost' => (is => 'ro', default => 'Role::Attribute::ghost');
 410
 411     package Role::Attribute2;
 412     use Mouse::Role;
 413
 414     has 'ghost' => (is => 'ro', default => 'Role::Attribute2::ghost');
 415 }
 416
 417 {
 418     package My::Test15;
 419     use Mouse;
 420
 421     ::lives_ok {
 422        with 'Role::Method';
 423     } '... composed the method role into the method class';
 424
 425     sub ghost { 'My::Test15::ghost' }
 426
 427     package My::Test16;
 428     use Mouse;
 429
 430     ::lives_ok {
 431        with 'Role::Method';
 432     } '... composed the method role into the attribute class';
 433
 434     has 'ghost' => (is => 'ro', default => 'My::Test16::ghost');
 435
 436     package My::Test17;
 437     use Mouse;
 438
 439     ::lives_ok {
 440        with 'Role::Attribute';
 441     } '... composed the attribute role into the method class';
 442
 443     sub ghost { 'My::Test17::ghost' }
 444
 445     package My::Test18;
 446     use Mouse;
 447
 448     ::lives_ok {
 449        with 'Role::Attribute';
 450     } '... composed the attribute role into the attribute class';
 451
 452     has 'ghost' => (is => 'ro', default => 'My::Test18::ghost');
 453
 454     package My::Test19;
 455     use Mouse;
 456
 457     ::lives_ok {
 458        with 'Role::Method', 'Role::Method2';
 459     } '... composed method roles into class with method tiebreaker';
 460
 461     sub ghost { 'My::Test19::ghost' }
 462
 463     package My::Test20;
 464     use Mouse;
 465
 466     ::lives_ok {
 467        with 'Role::Method', 'Role::Method2';
 468     } '... composed method roles into class with attribute tiebreaker';
 469
 470     has 'ghost' => (is => 'ro', default => 'My::Test20::ghost');
 471
 472     package My::Test21;
 473     use Mouse;
 474
 475     ::lives_ok {
 476        with 'Role::Attribute', 'Role::Attribute2';
 477     } '... composed attribute roles into class with method tiebreaker';
 478
 479     sub ghost { 'My::Test21::ghost' }
 480
 481     package My::Test22;
 482     use Mouse;
 483
 484     ::lives_ok {
 485        with 'Role::Attribute', 'Role::Attribute2';
 486     } '... composed attribute roles into class with attribute tiebreaker';
 487
 488     has 'ghost' => (is => 'ro', default => 'My::Test22::ghost');
 489
 490     package My::Test23;
 491     use Mouse;
 492
 493     ::lives_ok {
 494         with 'Role::Method', 'Role::Attribute';
 495     } '... composed method and attribute role into class with method tiebreaker';
 496
 497     sub ghost { 'My::Test23::ghost' }
 498
 499     package My::Test24;
 500     use Mouse;
 501
 502     ::lives_ok {
 503         with 'Role::Method', 'Role::Attribute';
 504     } '... composed method and attribute role into class with attribute tiebreaker';
 505
 506     has 'ghost' => (is => 'ro', default => 'My::Test24::ghost');
 507
 508     package My::Test25;
 509     use Mouse;
 510
 511     ::lives_ok {
 512         with 'Role::Attribute', 'Role::Method';
 513     } '... composed attribute and method role into class with method tiebreaker';
 514
 515     sub ghost { 'My::Test25::ghost' }
 516
 517     package My::Test26;
 518     use Mouse;
 519
 520     ::lives_ok {
 521         with 'Role::Attribute', 'Role::Method';
 522     } '... composed attribute and method role into class with attribute tiebreaker';
 523
 524     has 'ghost' => (is => 'ro', default => 'My::Test26::ghost');
 525 }
 526
 527 my $test15 = My::Test15->new;
 528 isa_ok($test15, 'My::Test15');
 529 is($test15->ghost, 'My::Test15::ghost', '... we access the method from the class and ignore the role method');
 530
 531 my $test16 = My::Test16->new;
 532 isa_ok($test16, 'My::Test16');
 533 is($test16->ghost, 'My::Test16::ghost', '... we access the attribute from the class and ignore the role method');
 534
 535 my $test17 = My::Test17->new;
 536 isa_ok($test17, 'My::Test17');
 537 is($test17->ghost, 'My::Test17::ghost', '... we access the method from the class and ignore the role attribute');
 538
 539 my $test18 = My::Test18->new;
 540 isa_ok($test18, 'My::Test18');
 541 is($test18->ghost, 'My::Test18::ghost', '... we access the attribute from the class and ignore the role attribute');
 542
 543 my $test19 = My::Test19->new;
 544 isa_ok($test19, 'My::Test19');
 545 is($test19->ghost, 'My::Test19::ghost', '... we access the method from the class and ignore the role methods');
 546
 547 my $test20 = My::Test20->new;
 548 isa_ok($test20, 'My::Test20');
 549 is($test20->ghost, 'My::Test20::ghost', '... we access the attribute from the class and ignore the role methods');
 550
 551 my $test21 = My::Test21->new;
 552 isa_ok($test21, 'My::Test21');
 553 is($test21->ghost, 'My::Test21::ghost', '... we access the method from the class and ignore the role attributes');
 554
 555 my $test22 = My::Test22->new;
 556 isa_ok($test22, 'My::Test22');
 557 is($test22->ghost, 'My::Test22::ghost', '... we access the attribute from the class and ignore the role attributes');
 558
 559 my $test23 = My::Test23->new;
 560 isa_ok($test23, 'My::Test23');
 561 is($test23->ghost, 'My::Test23::ghost', '... we access the method from the class and ignore the role method and attribute');
 562
 563 my $test24 = My::Test24->new;
 564 isa_ok($test24, 'My::Test24');
 565 is($test24->ghost, 'My::Test24::ghost', '... we access the attribute from the class and ignore the role method and attribute');
 566
 567 my $test25 = My::Test25->new;
 568 isa_ok($test25, 'My::Test25');
 569 is($test25->ghost, 'My::Test25::ghost', '... we access the method from the class and ignore the role attribute and method');
 570
 571 my $test26 = My::Test26->new;
 572 isa_ok($test26, 'My::Test26');
 573 is($test26->ghost, 'My::Test26::ghost', '... we access the attribute from the class and ignore the role attribute and method');
 574
 575 =cut
 576
 577 done_testing;