t/044_role_conflict_detection.t

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