Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding ComponentCollection and a test case.
- Loading branch information
Showing
2 changed files
with
259 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <?php | ||
| /** | ||
| * Components collection is used as a registry for loaded components and handles loading | ||
| * and constructing component class objects. | ||
| * | ||
| * CakePHP(tm) : Rapid Development Framework (http://cakephp.org) | ||
| * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org) | ||
| * | ||
| * Licensed under The MIT License | ||
| * Redistributions of files must retain the above copyright notice. | ||
| * | ||
| * @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org) | ||
| * @link http://cakephp.org CakePHP(tm) Project | ||
| * @package cake | ||
| * @subpackage cake.libs.controller | ||
| * @since CakePHP(tm) v 2.0 | ||
| * @license MIT License (http://www.opensource.org/licenses/mit-license.php) | ||
| */ | ||
| App::import('Core', 'ObjectCollection'); | ||
|
|
||
| class ComponentCollection extends ObjectCollection { | ||
|
|
||
| /** | ||
| * Loads/constructs a component. Will return the instance in the registry if it already exists. | ||
| * | ||
| * @param string $component Component name to load | ||
| * @param array $settings Settings for the component. | ||
| * @param boolean $enable Whether or not this component should be enabled by default | ||
| * @return Component A component object, Either the existing loaded component or a new one. | ||
| * @throws MissingComponentFileException, MissingComponentClassException when the component could not be found | ||
| */ | ||
| public function load($component, $settings = array(), $enable = true) { | ||
| list($plugin, $name) = pluginSplit($component); | ||
| if (isset($this->_loaded[$name])) { | ||
| return $this->_loaded[$name]; | ||
| } | ||
| $componentClass = $name . 'Component'; | ||
| if (!class_exists($componentClass)) { | ||
| if (!App::import('Component', $component)) { | ||
| throw new MissingComponentFileException(Inflector::underscore($component) . '.php'); | ||
| } | ||
| if (!class_exists($componentClass)) { | ||
| throw new MissingComponentFileException($component); | ||
| } | ||
| } | ||
| $this->_loaded[$name] = new $componentClass($this, $settings); | ||
| if ($enable === true) { | ||
| $this->_enabled[] = $name; | ||
| } | ||
| return $this->_loaded[$name]; | ||
| } | ||
|
|
||
| /** | ||
| * Name of the component to remove from the collection | ||
| * | ||
| * @param string $name Name of component to delete. | ||
| * @return void | ||
| */ | ||
| public function unload($name) { | ||
| list($plugin, $name) = pluginSplit($name); | ||
| unset($this->_loaded[$name]); | ||
| $this->_enabled = array_values(array_diff($this->_enabled, (array)$name)); | ||
| } | ||
|
|
||
| } | ||
| /** | ||
| * Exceptions used by the ComponentCollection. | ||
| */ | ||
| class MissingComponentFileException extends RuntimeException { } | ||
|
|
||
| class MissingComponentClassException extends RuntimeException { } |
188 changes: 188 additions & 0 deletions
188
cake/tests/cases/libs/controller/component_collection.test.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| <?php | ||
| /** | ||
| * ComponentCollectionTest file | ||
| * | ||
| * PHP 5 | ||
| * | ||
| * CakePHP(tm) : Rapid Development Framework (http://cakephp.org) | ||
| * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org) | ||
| * | ||
| * Licensed under The MIT License | ||
| * Redistributions of files must retain the above copyright notice. | ||
| * | ||
| * @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org) | ||
| * @link http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests | ||
| * @package cake | ||
| * @subpackage cake.tests.cases.libs | ||
| * @since CakePHP(tm) v 2.0 | ||
| * @license MIT License (http://www.opensource.org/licenses/mit-license.php) | ||
| */ | ||
|
|
||
| App::import('Core', 'ComponentCollection'); | ||
|
|
||
| class ComponentCollectionTest extends CakeTestCase { | ||
| /** | ||
| * setup | ||
| * | ||
| * @return void | ||
| */ | ||
| function setup() { | ||
| $this->Components = new ComponentCollection(); | ||
| } | ||
|
|
||
| /** | ||
| * teardown | ||
| * | ||
| * @return void | ||
| */ | ||
| function teardown() { | ||
| unset($this->Components); | ||
| } | ||
|
|
||
| /** | ||
| * test triggering callbacks on loaded helpers | ||
| * | ||
| * @return void | ||
| */ | ||
| function testLoad() { | ||
| $result = $this->Components->load('Cookie'); | ||
| $this->assertType('CookieComponent', $result); | ||
| $this->assertType('CookieComponent', $this->Components->Cookie); | ||
|
|
||
| $result = $this->Components->attached(); | ||
| $this->assertEquals(array('Cookie'), $result, 'attached() results are wrong.'); | ||
|
|
||
| $this->assertTrue($this->Components->enabled('Cookie')); | ||
|
|
||
| $result = $this->Components->load('Cookie'); | ||
| $this->assertSame($result, $this->Components->Cookie); | ||
| } | ||
|
|
||
| /** | ||
| * test load and enable = false | ||
| * | ||
| * @return void | ||
| */ | ||
| function testLoadWithEnableFalse() { | ||
| $result = $this->Components->load('Cookie', array(), false); | ||
| $this->assertType('CookieComponent', $result); | ||
| $this->assertType('CookieComponent', $this->Components->Cookie); | ||
|
|
||
| $this->assertFalse($this->Components->enabled('Cookie'), 'Cookie should be disabled'); | ||
| } | ||
| /** | ||
| * test missingcomponent exception | ||
| * | ||
| * @expectedException MissingComponentFileException | ||
| * @return void | ||
| */ | ||
| function testLoadMissingComponentFile() { | ||
| $this->Components->load('ThisComponentShouldAlwaysBeMissing'); | ||
| } | ||
|
|
||
| /** | ||
| * test loading a plugin component. | ||
| * | ||
| * @return void | ||
| */ | ||
| function testLoadPluginComponent() { | ||
| App::build(array( | ||
| 'plugins' => array(TEST_CAKE_CORE_INCLUDE_PATH . 'tests' . DS . 'test_app' . DS . 'plugins' . DS), | ||
| )); | ||
| $result = $this->Components->load('TestPlugin.OtherComponent'); | ||
| $this->assertType('OtherComponentComponent', $result, 'Component class is wrong.'); | ||
| $this->assertType('OtherComponentComponent', $this->Components->OtherComponent, 'Class is wrong'); | ||
| App::build(); | ||
| } | ||
|
|
||
| /** | ||
| * test unload() | ||
| * | ||
| * @return void | ||
| */ | ||
| function testUnload() { | ||
| $this->Components->load('Cookie'); | ||
| $this->Components->load('Security'); | ||
|
|
||
| $result = $this->Components->attached(); | ||
| $this->assertEquals(array('Cookie', 'Security'), $result, 'loaded components is wrong'); | ||
|
|
||
| $this->Components->unload('Cookie'); | ||
| $this->assertFalse(isset($this->Components->Cookie)); | ||
| $this->assertTrue(isset($this->Components->Security)); | ||
|
|
||
| $result = $this->Components->attached(); | ||
| $this->assertEquals(array('Security'), $result, 'loaded components is wrong'); | ||
|
|
||
| $result = $this->Components->enabled(); | ||
| $this->assertEquals(array('Security'), $result, 'enabled components is wrong'); | ||
| } | ||
|
|
||
| /** | ||
| * test triggering callbacks. | ||
| * | ||
| * @return void | ||
| */ | ||
| function testTrigger() { | ||
| $controller = null; | ||
| if (!class_exists('TriggerMockCookieComponent')) { | ||
| $this->getMock('CookieComponent', array(), array(), 'TriggerMockCookieComponent'); | ||
| $this->getMock('SecurityComponent', array(), array(), 'TriggerMockSecurityComponent'); | ||
| } | ||
| $this->Components->load('TriggerMockCookie'); | ||
| $this->Components->load('TriggerMockSecurity'); | ||
|
|
||
| $this->Components->TriggerMockCookie->expects($this->once())->method('startup') | ||
| ->with(null); | ||
| $this->Components->TriggerMockSecurity->expects($this->once())->method('startup') | ||
| ->with(null); | ||
|
|
||
| $this->Components->trigger('startup', array(&$controller)); | ||
| } | ||
|
|
||
| /** | ||
| * test trigger and disabled helpers. | ||
| * | ||
| * @return void | ||
| */ | ||
| function testTriggerWithDisabledComponents() { | ||
| $controller = null; | ||
| if (!class_exists('TriggerMockCookieComponent')) { | ||
| $this->getMock('CookieComponent', array(), array(), 'TriggerMockCookieComponent'); | ||
| $this->getMock('SecurityComponent', array(), array(), 'TriggerMockSecurityComponent'); | ||
| } | ||
| $this->Components->load('TriggerMockCookie'); | ||
| $this->Components->load('TriggerMockSecurity'); | ||
|
|
||
| $this->Components->TriggerMockCookie->expects($this->once())->method('startup') | ||
| ->with(null); | ||
| $this->Components->TriggerMockSecurity->expects($this->never())->method('startup') | ||
| ->with(null); | ||
|
|
||
| $this->Components->disable('TriggerMockSecurity'); | ||
|
|
||
| $this->Components->trigger('startup', array(&$controller)); | ||
| } | ||
|
|
||
| /** | ||
| * test normalizeObjectArray | ||
| * | ||
| * @return void | ||
| */ | ||
| function testnormalizeObjectArray() { | ||
| $components = array( | ||
| 'Html', | ||
| 'Foo.Bar' => array('one', 'two'), | ||
| 'Something', | ||
| 'Banana.Apple' => array('foo' => 'bar') | ||
| ); | ||
| $result = ComponentCollection::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); | ||
| } | ||
| } |