* Copyright 2005-2009, Cake Software Foundation, Inc. (http://www.cakefoundation.org) * * Licensed under The Open Group Test Suite License * Redistributions of files must retain the above copyright notice. * * @copyright Copyright 2005-2009, Cake Software Foundation, Inc. (http://www.cakefoundation.org) * @link https://trac.cakephp.org/wiki/Developement/TestSuite CakePHP(tm) Tests * @package cake * @subpackage cake.tests.cases.libs.view.helpers * @since CakePHP(tm) v 1.3 * @license http://www.opensource.org/licenses/opengroup.php The Open Group Test Suite License */ App::import('Helper', array('Js', 'Html', 'Form')); App::import('Core', array('View', 'ClassRegistry')); Mock::generate('JsBaseEngineHelper', 'TestJsEngineHelper', array('methodOne')); Mock::generate('View', 'JsHelperMockView'); class OptionEngineHelper extends JsBaseEngineHelper { var $_optionMap = array( 'request' => array( 'complete' => 'success', 'request' => 'beforeSend', 'type' => 'dataType' ) ); /** * test method for testing option mapping * * @return array **/ function testMap($options = array()) { return $this->_mapOptions('request', $options); } /** * test method for option parsing * * @return void **/ function testParseOptions($options, $safe = array()) { return $this->_parseOptions($options, $safe); } } /** * JsHelper TestCase. * * @package cake * @subpackage cake.tests.cases.libs.view.helpers */ class JsHelperTestCase extends CakeTestCase { /** * Regexp for CDATA start block * * @var string */ var $cDataStart = 'preg:/^\/\/[\s\r\n]*/'; /** * startTest method * * @access public * @return void */ function startTest() { $this->_asset = Configure::read('Asset.timestamp'); Configure::write('Asset.timestamp', false); $this->Js =& new JsHelper('JsBase'); $this->Js->Html =& new HtmlHelper(); $this->Js->Form =& new FormHelper(); $this->Js->Form->Html =& new HtmlHelper(); $this->Js->JsBaseEngine =& new JsBaseEngineHelper(); $view =& new JsHelperMockView(); ClassRegistry::addObject('view', $view); } /** * endTest method * * @access public * @return void */ function endTest() { Configure::write('Asset.timestamp', $this->_asset); ClassRegistry::removeObject('view'); unset($this->Js); } /** * Switches $this->Js to a mocked engine. * * @return void **/ function _useMock() { $this->Js =& new JsHelper(array('TestJs')); $this->Js->TestJsEngine =& new TestJsEngineHelper($this); $this->Js->Html =& new HtmlHelper(); $this->Js->Form =& new FormHelper(); $this->Js->Form->Html =& new HtmlHelper(); } /** * test object construction * * @return void **/ function testConstruction() { $js =& new JsHelper(); $this->assertEqual($js->helpers, array('Html', 'Form', 'JqueryEngine')); $js =& new JsHelper(array('mootools')); $this->assertEqual($js->helpers, array('Html', 'Form', 'mootoolsEngine')); $js =& new JsHelper('prototype'); $this->assertEqual($js->helpers, array('Html', 'Form', 'prototypeEngine')); $js =& new JsHelper('MyPlugin.Dojo'); $this->assertEqual($js->helpers, array('Html', 'Form', 'MyPlugin.DojoEngine')); } /** * test that methods dispatch internally and to the engine class * * @return void **/ function testMethodDispatching() { $this->_useMock(); $this->Js->TestJsEngine->expectOnce('dispatchMethod', array(new PatternExpectation('/methodOne/i'), array())); $this->Js->methodOne(); $this->Js->TestEngine =& new StdClass(); $this->expectError(); $this->Js->someMethodThatSurelyDoesntExist(); } /** * Test that method dispatching respects buffer parameters and bufferedMethods Lists. * * @return void **/ function testMethodDispatchWithBuffering() { $this->_useMock(); $this->Js->TestJsEngine->bufferedMethods = array('event', 'sortables'); $this->Js->TestJsEngine->setReturnValue('dispatchMethod', 'This is an event call', array('event', '*')); $this->Js->event('click', 'foo'); $result = $this->Js->getBuffer(); $this->assertEqual(count($result), 1); $this->assertEqual($result[0], 'This is an event call'); $result = $this->Js->event('click', 'foo', array('buffer' => false)); $buffer = $this->Js->getBuffer(); $this->assertTrue(empty($buffer)); $this->assertEqual($result, 'This is an event call'); $result = $this->Js->event('click', 'foo', false); $buffer = $this->Js->getBuffer(); $this->assertTrue(empty($buffer)); $this->assertEqual($result, 'This is an event call'); $this->Js->TestJsEngine->setReturnValue('dispatchMethod', 'I am not buffered.', array('effect', '*')); $result = $this->Js->effect('slideIn'); $buffer = $this->Js->getBuffer(); $this->assertTrue(empty($buffer)); $this->assertEqual($result, 'I am not buffered.'); $result = $this->Js->effect('slideIn', true); $buffer = $this->Js->getBuffer(); $this->assertNull($result); $this->assertEqual(count($buffer), 1); $this->assertEqual($buffer[0], 'I am not buffered.'); $result = $this->Js->effect('slideIn', array('speed' => 'slow'), true); $buffer = $this->Js->getBuffer(); $this->assertNull($result); $this->assertEqual(count($buffer), 1); $this->assertEqual($buffer[0], 'I am not buffered.'); $result = $this->Js->effect('slideIn', array('speed' => 'slow', 'buffer' => true)); $buffer = $this->Js->getBuffer(); $this->assertNull($result); $this->assertEqual(count($buffer), 1); $this->assertEqual($buffer[0], 'I am not buffered.'); } /** * test that writeScripts generates scripts inline. * * @return void **/ function testWriteScriptsNoFile() { $this->_useMock(); $this->Js->buffer('one = 1;'); $this->Js->buffer('two = 2;'); $result = $this->Js->writeBuffer(array('onDomReady' => false, 'cache' => false)); $expected = array( 'script' => array('type' => 'text/javascript'), $this->cDataStart, "one = 1;\ntwo = 2;", $this->cDataEnd, '/script', ); $this->assertTags($result, $expected, true); $this->Js->TestJsEngine->expectAtLeastOnce('domReady'); $result = $this->Js->writeBuffer(array('onDomReady' => true, 'cache' => false)); $view =& new JsHelperMockView(); $view->expectAt(0, 'addScript', array(new PatternExpectation('/one\s=\s1;\ntwo\=\2;/'))); $result = $this->Js->writeBuffer(array('onDomReady' => false, 'inline' => false, 'cache' => false)); } /** * test that writeScripts makes files, and puts the events into them. * * @return void **/ function testWriteScriptsInFile() { if ($this->skipIf(!is_writable(JS), 'webroot/js is not Writable, script caching test has been skipped')) { return; } $this->Js->JsBaseEngine = new TestJsEngineHelper(); $this->Js->buffer('one = 1;'); $this->Js->buffer('two = 2;'); $result = $this->Js->writeBuffer(array('onDomReady' => false, 'cache' => true)); $expected = array( 'script' => array('type' => 'text/javascript', 'src' => 'preg:/(.)*\.js/'), ); $this->assertTags($result, $expected); preg_match('/src="(.*\.js)"/', $result, $filename); $this->assertTrue(file_exists(WWW_ROOT . $filename[1])); $contents = file_get_contents(WWW_ROOT . $filename[1]); $this->assertPattern('/one\s=\s1;\ntwo\s=\s2;/', $contents); @unlink(WWW_ROOT . $filename[1]); } /** * test link() * * @return void **/ function testLinkWithMock() { $this->_useMock(); $options = array('update' => '#content'); $this->Js->TestJsEngine->setReturnValue('dispatchMethod', 'ajax code', array('request', '*')); $this->Js->TestJsEngine->expectAt(0, 'dispatchMethod', array('get', new AnythingExpectation())); $this->Js->TestJsEngine->expectAt(1, 'dispatchMethod', array( 'request', array('/posts/view/1', $options) )); $this->Js->TestJsEngine->expectAt(2, 'dispatchMethod', array( 'event', array('click', 'ajax code', $options) )); $result = $this->Js->link('test link', '/posts/view/1', $options); $expected = array( 'a' => array('id' => 'preg:/link-\d+/', 'href' => '/posts/view/1'), 'test link', '/a' ); $this->assertTags($result, $expected); $options = array( 'confirm' => 'Are you sure?', 'update' => '#content', 'class' => 'my-class', 'id' => 'custom-id', 'escape' => false ); $this->Js->TestJsEngine->expectAt(0, 'confirm', array($options['confirm'])); $this->Js->TestJsEngine->expectAt(1, 'request', array('/posts/view/1', '*')); $code = <<Js->TestJsEngine->expectAt(1, 'event', array('click', $code)); $result = $this->Js->link('test link »', '/posts/view/1', $options); $expected = array( 'a' => array('id' => $options['id'], 'class' => $options['class'], 'href' => '/posts/view/1'), 'test link »', '/a' ); $this->assertTags($result, $expected); $options = array('id' => 'something', 'htmlAttributes' => array('arbitrary' => 'value', 'batman' => 'robin')); $result = $this->Js->link('test link', '/posts/view/1', $options); $expected = array( 'a' => array('id' => $options['id'], 'href' => '/posts/view/1', 'arbitrary' => 'value', 'batman' => 'robin'), 'test link', '/a' ); $this->assertTags($result, $expected); } /** * test that link() and no buffering returns an and