Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 596 lines (504 sloc) 16.254 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
<?php
/**
* ObjectCollectionTest file
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests
* @package Cake.Test.Case.Utility
* @since CakePHP(tm) v 2.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/

App::uses('ObjectCollection', 'Utility');
App::uses('CakeEvent', 'Event');

/**
* A generic object class
*/
class GenericObject {

/**
* Constructor
*
* @param GenericObjectCollection $collection
* @param array $settings
*/
public function __construct(GenericObjectCollection $collection, $settings = array()) {
$this->_Collection = $collection;
$this->settings = $settings;
}

}

/**
* First Extension of Generic Object
*/
class FirstGenericObject extends GenericObject {

/**
* A generic callback
*/
public function callback() {
}

}

/**
* Second Extension of Generic Object
*/
class SecondGenericObject extends GenericObject {

public function callback() {
}

}

/**
* Third Extension of Generic Object
*/
class ThirdGenericObject extends GenericObject {

public function callback() {
}

}

/**
* A collection of Generic objects
*/
class GenericObjectCollection extends ObjectCollection {

/**
* Loads a generic object
*
* @param string $object Object name
* @param array $settings Settings array
* @return array List of loaded objects
*/
public function load($object, $settings = array()) {
list($plugin, $name) = pluginSplit($object);
if (isset($this->_loaded[$name])) {
return $this->_loaded[$name];
}
$objectClass = $name . 'GenericObject';
$this->_loaded[$name] = new $objectClass($this, $settings);
$enable = isset($settings['enabled']) ? $settings['enabled'] : true;
if ($enable === true) {
$this->enable($name);
}
return $this->_loaded[$name];
}

}

class ObjectCollectionTest extends CakeTestCase {

/**
* setUp
*
* @return void
*/
public function setUp() {
parent::setUp();
$this->Objects = new GenericObjectCollection();
}

/**
* tearDown
*
* @return void
*/
public function tearDown() {
parent::tearDown();
unset($this->Objects);
}

/**
* test triggering callbacks on loaded helpers
*
* @return void
*/
public function testLoad() {
$result = $this->Objects->load('First');
$this->assertInstanceOf('FirstGenericObject', $result);
$this->assertInstanceOf('FirstGenericObject', $this->Objects->First);

$result = $this->Objects->attached();
$this->assertEquals(array('First'), $result, 'attached() results are wrong.');

$this->assertTrue($this->Objects->enabled('First'));

$result = $this->Objects->load('First');
$this->assertSame($result, $this->Objects->First);
}

/**
* test unload()
*
* @return void
*/
public function testUnload() {
$this->Objects->load('First');
$this->Objects->load('Second');

$result = $this->Objects->attached();
$this->assertEquals(array('First', 'Second'), $result, 'loaded objects are wrong');

$this->Objects->unload('First');
$this->assertFalse(isset($this->Objects->First));
$this->assertTrue(isset($this->Objects->Second));

$result = $this->Objects->attached();
$this->assertEquals(array('Second'), $result, 'loaded objects are wrong');

$result = $this->Objects->enabled();
$this->assertEquals(array('Second'), $result, 'enabled objects are wrong');
}

/**
* Tests set()
*
* @return void
*/
public function testSet() {
$this->Objects->load('First');

$result = $this->Objects->attached();
$this->assertEquals(array('First'), $result, 'loaded objects are wrong');

$result = $this->Objects->set('First', new SecondGenericObject($this->Objects));
$this->assertInstanceOf('SecondGenericObject', $result['First'], 'set failed');

$result = $this->Objects->set('Second', new SecondGenericObject($this->Objects));
$this->assertInstanceOf('SecondGenericObject', $result['Second'], 'set failed');

$this->assertEquals(2, count($result));
}

/**
* creates mock classes for testing
*
* @return void
*/
protected function _makeMockClasses() {
if (!class_exists('TriggerMockFirstGenericObject')) {
$this->getMock('FirstGenericObject', array(), array(), 'TriggerMockFirstGenericObject', false);
}
if (!class_exists('TriggerMockSecondGenericObject')) {
$this->getMock('SecondGenericObject', array(), array(), 'TriggerMockSecondGenericObject', false);
}
if (!class_exists('TriggerMockThirdGenericObject')) {
$this->getMock('ThirdGenericObject', array(), array(), 'TriggerMockThirdGenericObject', false);
}
}

/**
* test triggering callbacks.
*
* @return void
*/
public function testTrigger() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->will($this->returnValue(true));
$this->Objects->TriggerMockSecond->expects($this->once())
->method('callback')
->will($this->returnValue(true));

$this->assertTrue($this->Objects->trigger('callback'));
}

/**
* test trigger and disabled objects
*
* @return void
*/
public function testTriggerWithDisabledObjects() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->will($this->returnValue(true));
$this->Objects->TriggerMockSecond->expects($this->never())
->method('callback')
->will($this->returnValue(true));

$this->Objects->disable('TriggerMockSecond');

$this->assertTrue($this->Objects->trigger('callback', array()));
}

/**
* test that the collectReturn option works.
*
* @return void
*/
public function testTriggerWithCollectReturn() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->will($this->returnValue(array('one', 'two')));
$this->Objects->TriggerMockSecond->expects($this->once())
->method('callback')
->will($this->returnValue(array('three', 'four')));

$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
array('one', 'two'),
array('three', 'four')
);
$this->assertEquals($expected, $result);
}

/**
* test that trigger with break & breakOn works.
*
* @return void
*/
public function testTriggerWithBreak() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->will($this->returnValue(false));
$this->Objects->TriggerMockSecond->expects($this->never())
->method('callback');

$result = $this->Objects->trigger(
'callback',
array(),
array('break' => true, 'breakOn' => false)
);
$this->assertFalse($result);
}

/**
* test that trigger with modParams works.
*
* @return void
*/
public function testTriggerWithModParams() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->with(array('value'))
->will($this->returnValue(array('new value')));

$this->Objects->TriggerMockSecond->expects($this->once())
->method('callback')
->with(array('new value'))
->will($this->returnValue(array('newer value')));

$result = $this->Objects->trigger(
'callback',
array(array('value')),
array('modParams' => 0)
);
$this->assertEquals(array('newer value'), $result);
}

/**
* test that setting modParams to an index that doesn't exist doesn't cause errors.
*
* @expectedException CakeException
* @return void
*/
public function testTriggerModParamsInvalidIndex() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->never())
->method('callback');

$this->Objects->TriggerMockSecond->expects($this->never())
->method('callback');

$result = $this->Objects->trigger(
'callback',
array(array('value')),
array('modParams' => 2)
);
}

/**
* test that returning null doesn't modify parameters.
*
* @return void
*/
public function testTriggerModParamsNullIgnored() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->with(array('value'))
->will($this->returnValue(null));

$this->Objects->TriggerMockSecond->expects($this->once())
->method('callback')
->with(array('value'))
->will($this->returnValue(array('new value')));

$result = $this->Objects->trigger(
'callback',
array(array('value')),
array('modParams' => 0)
);
$this->assertEquals(array('new value'), $result);
}

/**
* test order of callbacks triggering based on priority.
*
* @return void
*/
public function testTriggerPriority() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond', array('priority' => 5));

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$this->Objects->TriggerMockFirst->expects($this->any())
->method('callback')
->will($this->returnValue('1st'));
$this->Objects->TriggerMockSecond->expects($this->any())
->method('callback')
->will($this->returnValue('2nd'));

$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'1st'
);
$this->assertEquals($expected, $result);

$this->Objects->load('TriggerMockThird', array('priority' => 7));
$this->mockObjects[] = $this->Objects->TriggerMockThird;
$this->Objects->TriggerMockThird->expects($this->any())
->method('callback')
->will($this->returnValue('3rd'));

$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'3rd',
'1st'
);
$this->assertEquals($expected, $result);

$this->Objects->disable('TriggerMockFirst');
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'3rd'
);
$this->assertEquals($expected, $result);

$this->Objects->enable('TriggerMockFirst');
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'3rd',
'1st'
);
$this->assertEquals($expected, $result);

$this->Objects->disable('TriggerMockThird');
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'1st'
);
$this->assertEquals($expected, $result);

$this->Objects->enable('TriggerMockThird', false);
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'1st',
'3rd'
);
$this->assertEquals($expected, $result);

$this->Objects->setPriority('TriggerMockThird', 1);
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'3rd',
'2nd',
'1st'
);
$this->assertEquals($expected, $result);

$this->Objects->disable('TriggerMockThird');
$this->Objects->setPriority('TriggerMockThird', 11);
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'1st'
);
$this->assertEquals($expected, $result);

$this->Objects->enable('TriggerMockThird');
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'1st',
'3rd'
);
$this->assertEquals($expected, $result);

$this->Objects->setPriority('TriggerMockThird');
$result = $this->Objects->trigger('callback', array(), array('collectReturn' => true));
$expected = array(
'2nd',
'1st',
'3rd'
);
$this->assertEquals($expected, $result);
}

/**
* test normalizeObjectArray
*
* @return void
*/
public function testnormalizeObjectArray() {
$components = array(
'Html',
'Foo.Bar' => array('one', 'two'),
'Something',
'Banana.Apple' => array('foo' => 'bar')
);
$result = ObjectCollection::normalizeObjectArray($components);
$expected = array(
'Html' => array('class' => 'Html', 'settings' => array()),
'Bar' => array('class' => 'Foo.Bar', 'settings' => array('one', 'two')),
'Something' => array('class' => 'Something', 'settings' => array()),
'Apple' => array('class' => 'Banana.Apple', 'settings' => array('foo' => 'bar')),
);
$this->assertEquals($expected, $result);

// This is the result after Controller::_mergeVars
$components = array(
'Html' => null,
'Foo.Bar' => array('one', 'two'),
'Something' => null,
'Banana.Apple' => array('foo' => 'bar')
);
$result = ObjectCollection::normalizeObjectArray($components);
$this->assertEquals($expected, $result);
}

/**
* tests that passing an instance of CakeEvent to trigger will prepend the subject to the list of arguments
*
* @return void
*/
public function testDispatchEventWithSubject() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$subjectClass = new Object();
$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->with($subjectClass, 'first argument')
->will($this->returnValue(true));
$this->Objects->TriggerMockSecond->expects($this->once())
->method('callback')
->with($subjectClass, 'first argument')
->will($this->returnValue(true));

$event = new CakeEvent('callback', $subjectClass, array('first argument'));
$this->assertTrue($this->Objects->trigger($event));
}

/**
* tests that passing an instance of CakeEvent to trigger with omitSubject property
* will NOT prepend the subject to the list of arguments
*
* @return void
*/
public function testDispatchEventNoSubject() {
$this->_makeMockClasses();
$this->Objects->load('TriggerMockFirst');
$this->Objects->load('TriggerMockSecond');

$this->mockObjects[] = $this->Objects->TriggerMockFirst;
$this->mockObjects[] = $this->Objects->TriggerMockSecond;

$subjectClass = new Object();
$this->Objects->TriggerMockFirst->expects($this->once())
->method('callback')
->with('first argument')
->will($this->returnValue(true));
$this->Objects->TriggerMockSecond->expects($this->once())
->method('callback')
->with('first argument')
->will($this->returnValue(true));

$event = new CakeEvent('callback', $subjectClass, array('first argument'));
$event->omitSubject = true;
$this->assertTrue($this->Objects->trigger($event));
}

}
Something went wrong with that request. Please try again.