/cake/tests/cases/console/libs/tasks/view.test.php

<?php
/**
 * ViewTask Test file
 *
 * Test Case for view generation shell task
 *
 * PHP Version 5.x
 *
 * CakePHP : Rapid Development Framework (http://cakephp.org)
 * Copyright 2006-2009, Cake Software Foundation, Inc.
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright 2006-2009, Cake Software Foundation, Inc.
 * @link          http://cakephp.org CakePHP Project
 * @package       cake
 * @subpackage    cake.tests.cases.console.libs.tasks
 * @since         CakePHP v 1.2.0.7726
 * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
 */
App::import('Shell', 'Shell', false);

if (!defined('DISABLE_AUTO_DISPATCH')) {
	define('DISABLE_AUTO_DISPATCH', true);
}

if (!class_exists('ShellDispatcher')) {
	ob_start();
	$argv = false;
	require CAKE . 'console' .  DS . 'cake.php';
	ob_end_clean();
}

require_once CAKE . 'console' .  DS . 'libs' . DS . 'tasks' . DS . 'view.php';
require_once CAKE . 'console' .  DS . 'libs' . DS . 'tasks' . DS . 'controller.php';
require_once CAKE . 'console' .  DS . 'libs' . DS . 'tasks' . DS . 'template.php';
require_once CAKE . 'console' .  DS . 'libs' . DS . 'tasks' . DS . 'project.php';

Mock::generatePartial(
	'ShellDispatcher', 'TestViewTaskMockShellDispatcher',
	array('getInput', 'stdout', 'stderr', '_stop', '_initEnvironment')
);
Mock::generatePartial(
	'ViewTask', 'MockViewTask',
	array('in', '_stop', 'err', 'out', 'createFile')
);

Mock::generate('ControllerTask', 'ViewTaskMockControllerTask');
Mock::generate('ProjectTask', 'ViewTaskMockProjectTask');

/**
 * Test View Task Comment Model
 *
 * @package cake
 * @subpackage cake.tests.cases.console.libs.tasks
 */
class ViewTaskComment extends Model {

/**
 * Model name
 *
 * @var string
 * @access public
 */
	var $name = 'ViewTaskComment';

/**
 * Table name
 *
 * @var string
 * @access public
 */
	var $useTable = 'comments';

/**
 * Belongs To Associations
 *
 * @var array
 * @access public
 */
	var $belongsTo = array(
		'Article' => array(
			'className' => 'ViewTaskArticle',
			'foreignKey' => 'article_id'
		)
	);
}

/**
 * Test View Task Article Model
 *
 * @package cake
 * @subpackage cake.tests.cases.console.libs.tasks
 */
class ViewTaskArticle extends Model {

/**
 * Model name
 *
 * @var string
 * @access public
 */
	var $name = 'ViewTaskArticle';

/**
 * Table name
 *
 * @var string
 * @access public
 */
	var $useTable = 'articles';
}

/**
 * Test View Task Comments Controller 
 *
 * @package cake
 * @subpackage cake.tests.cases.console.libs.tasks
 */
class ViewTaskCommentsController extends Controller {

/**
 * Controller name
 *
 * @var string
 * @access public
 */
	var $name = 'ViewTaskComments';

/**
 * Testing public controller action
 *
 * @return void
 * @access public
 */
	function index() {
	}

/**
 * Testing public controller action
 *
 * @return void
 * @access public
 */
	function add() {
	}
}

/**
 * Test View Task Articles Controller
 *
 * @package cake
 * @subpackage cake.tests.cases.console.libs.tasks
 */
class ViewTaskArticlesController extends Controller {

/**
 * Controller name
 *
 * @var string
 * @access public
 */
	var $name = 'ViewTaskArticles';

/**
 * Test public controller action
 *
 * @return void
 * @access public
 */
	function index() {
	}

/**
 * Test public controller action
 *
 * @return void
 * @access public
 */
	function add() {
	}

/**
 * Test admin prefixed controller action
 *
 * @return void
 * @access public
 */
	function admin_index() {
	}

/**
 * Test admin prefixed controller action
 *
 * @return void
 * @access public
 */
	function admin_add() {
	}

/**
 * Test admin prefixed controller action
 *
 * @return void
 * @access public
 */
	function admin_view() {
	}

/**
 * Test admin prefixed controller action
 *
 * @return void
 * @access public
 */
	function admin_edit() {
	}

/**
 * Test admin prefixed controller action
 *
 * @return void
 * @access public
 */
	function admin_delete() {
	}
}

/**
 * ViewTaskTest class
 *
 * @package       cake
 * @subpackage    cake.tests.cases.console.libs.tasks
 */
class ViewTaskTest extends CakeTestCase {

/**
 * Fixtures
 *
 * @var array
 * @access public
 */
	var $fixtures = array('core.article', 'core.comment', 'core.articles_tag', 'core.tag');

/**
 * startTest method
 *
 * Ensure that the default theme is used
 *
 * @return void
 * @access public
 */
	function startTest() {
		$this->Dispatcher =& new TestViewTaskMockShellDispatcher();
		$this->Dispatcher->shellPaths = App::path('shells');
		$this->Task =& new MockViewTask($this->Dispatcher);
		$this->Task->Dispatch =& $this->Dispatcher;
		$this->Task->Template =& new TemplateTask($this->Dispatcher);
		$this->Task->Controller =& new ViewTaskMockControllerTask();
		$this->Task->Project =& new ViewTaskMockProjectTask();
		$this->Task->path = TMP;
		$this->Task->Template->params['theme'] = 'default';
	}

/**
 * endTest method
 *
 * @return void
 * @access public
 */
	function endTest() {
		ClassRegistry::flush();
	}

/**
 * Test getContent and parsing of Templates.
 *
 * @return void
 * @access public
 */
	function testGetContent() {
		$vars = array(
			'modelClass' => 'TestViewModel',
			'schema' => array(),
			'primaryKey' => 'id',
			'displayField' => 'name',
			'singularVar' => 'testViewModel',
			'pluralVar' => 'testViewModels',
			'singularHumanName' => 'Test View Model',
			'pluralHumanName' => 'Test View Models',
			'fields' => array('id', 'name', 'body'),
			'associations' => array()
		);
		$result = $this->Task->getContent('view', $vars);

		$this->assertPattern('/Delete .+Test View Model/', $result);
		$this->assertPattern('/Edit .+Test View Model/', $result);
		$this->assertPattern('/List .+Test View Models/', $result);
		$this->assertPattern('/New .+Test View Model/', $result);

		$this->assertPattern('/testViewModel\[\'TestViewModel\'\]\[\'id\'\]/', $result);
		$this->assertPattern('/testViewModel\[\'TestViewModel\'\]\[\'name\'\]/', $result);
		$this->assertPattern('/testViewModel\[\'TestViewModel\'\]\[\'body\'\]/', $result);
	}

/**
 * test getContent() using an admin_prefixed action.
 *
 * @return void
 * @access public
 */
	function testGetContentWithAdminAction() {
		$_back = Configure::read('Routing');
		Configure::write('Routing.prefixes', array('admin'));
		$vars = array(
			'modelClass' => 'TestViewModel',
			'schema' => array(),
			'primaryKey' => 'id',
			'displayField' => 'name',
			'singularVar' => 'testViewModel',
			'pluralVar' => 'testViewModels',
			'singularHumanName' => 'Test View Model',
			'pluralHumanName' => 'Test View Models',
			'fields' => array('id', 'name', 'body'),
			'associations' => array()
		);
		$result = $this->Task->getContent('admin_view', $vars);

		$this->assertPattern('/Delete .+Test View Model/', $result);
		$this->assertPattern('/Edit .+Test View Model/', $result);
		$this->assertPattern('/List .+Test View Models/', $result);
		$this->assertPattern('/New .+Test View Model/', $result);

		$this->assertPattern('/testViewModel\[\'TestViewModel\'\]\[\'id\'\]/', $result);
		$this->assertPattern('/testViewModel\[\'TestViewModel\'\]\[\'name\'\]/', $result);
		$this->assertPattern('/testViewModel\[\'TestViewModel\'\]\[\'body\'\]/', $result);

		$result = $this->Task->getContent('admin_add', $vars);
		$this->assertPattern("/input\('name'\)/", $result);
		$this->assertPattern("/input\('body'\)/", $result);
		$this->assertPattern('/List .+Test View Models/', $result);

		Configure::write('Routing', $_back);
	}

/**
 * test Bake method
 *
 * @return void
 * @access public
 */
	function testBake() {
		$this->Task->controllerName = 'ViewTaskComments';
		$this->Task->controllerPath = 'view_task_comments';

		$this->Task->expectAt(0, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'view.ctp',
			new PatternExpectation('/View Task Articles/')
		));
		$this->Task->bake('view', true);

		$this->Task->expectAt(1, 'createFile', array(TMP . 'view_task_comments' . DS . 'edit.ctp', '*'));
		$this->Task->bake('edit', true);

		$this->Task->expectAt(2, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'index.ctp',
			new PatternExpectation('/\$viewTaskComment\[\'Article\'\]\[\'title\'\]/')
		));
		$this->Task->bake('index', true);
	}

/**
 * test bake() with a -plugin param
 *
 * @return void
 * @access public
 */
	function testBakeWithPlugin() {
		$this->Task->controllerName = 'ViewTaskComments';
		$this->Task->controllerPath = 'view_task_comments';
		$this->Task->plugin = 'TestTest';

		$path = APP . 'plugins' . DS . 'test_test' . DS . 'views' . DS . 'view_task_comments' . DS  . 'view.ctp';
		$this->Task->expectAt(0, 'createFile', array($path, '*'));
		$this->Task->bake('view', true);
	}

/**
 * test bake actions baking multiple actions.
 *
 * @return void
 * @access public
 */
	function testBakeActions() {
		$this->Task->controllerName = 'ViewTaskComments';
		$this->Task->controllerPath = 'view_task_comments';

		$this->Task->expectAt(0, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'view.ctp',
			new PatternExpectation('/View Task Comments/')
		));
		$this->Task->expectAt(1, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'edit.ctp',
			new PatternExpectation('/Edit .+View Task Comment/')
		));
		$this->Task->expectAt(2, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'index.ctp',
			new PatternExpectation('/ViewTaskComment/')
		));

		$this->Task->bakeActions(array('view', 'edit', 'index'), array());
	}

/**
 * test baking a customAction (non crud)
 *
 * @return void
 * @access public
 */
	function testCustomAction() {
		$this->Task->controllerName = 'ViewTaskComments';
		$this->Task->controllerPath = 'view_task_comments';
		$this->Task->params['app'] = APP;

		$this->Task->setReturnValueAt(0, 'in', '');
		$this->Task->setReturnValueAt(1, 'in', 'my_action');
		$this->Task->setReturnValueAt(2, 'in', 'y');
		$this->Task->expectAt(0, 'createFile', array(TMP . 'view_task_comments' . DS . 'my_action.ctp', '*'));

		$this->Task->customAction();
	}

/**
 * Test all()
 *
 * @return void
 * @access public
 */
	function testExecuteIntoAll() {
		$this->Task->args[0] = 'all';

		$this->Task->Controller->setReturnValue('listAll', array('view_task_comments'));
		$this->Task->Controller->expectOnce('listAll');

		$this->Task->expectCallCount('createFile', 2);
		$this->Task->expectAt(0, 'createFile', array(TMP . 'view_task_comments' . DS . 'index.ctp', '*'));
		$this->Task->expectAt(1, 'createFile', array(TMP . 'view_task_comments' . DS . 'add.ctp', '*'));

		$this->Task->execute();
	}

/**
 * test `cake bake view $controller view`
 *
 * @return void
 * @access public
 */
	function testExecuteWithActionParam() {
		$this->Task->args[0] = 'ViewTaskComments';
		$this->Task->args[1] = 'view';

		$this->Task->expectCallCount('createFile', 1);
		$this->Task->expectAt(0, 'createFile', array(TMP . 'view_task_comments' . DS . 'view.ctp', '*'));
		$this->Task->execute();
	}

/**
 * test `cake bake view $controller`
 * Ensure that views are only baked for actions that exist in the controller.
 *
 * @return void
 * @access public
 */
	function testExecuteWithController() {
		$this->Task->args[0] = 'ViewTaskComments';

		$this->Task->expectCallCount('createFile', 2);
		$this->Task->expectAt(0, 'createFile', array(TMP . 'view_task_comments' . DS . 'index.ctp', '*'));
		$this->Task->expectAt(1, 'createFile', array(TMP . 'view_task_comments' . DS . 'add.ctp', '*'));

		$this->Task->execute();
	}

/**
 * test `cake bake view $controller -admin`
 * Which only bakes admin methods, not non-admin methods.
 *
 * @return void
 * @access public
 */
	function testExecuteWithControllerAndAdminFlag() {
		$_back = Configure::read('Routing');
		Configure::write('Routing.prefixes', array('admin'));
		$this->Task->args[0] = 'ViewTaskArticles';
		$this->Task->params['admin'] = 1;
		$this->Task->Project->setReturnValue('getPrefix', 'admin_');

		$this->Task->expectCallCount('createFile', 4);
		$this->Task->expectAt(0, 'createFile', array(TMP . 'view_task_articles' . DS . 'admin_index.ctp', '*'));
		$this->Task->expectAt(1, 'createFile', array(TMP . 'view_task_articles' . DS . 'admin_add.ctp', '*'));
		$this->Task->expectAt(2, 'createFile', array(TMP . 'view_task_articles' . DS . 'admin_view.ctp', '*'));
		$this->Task->expectAt(3, 'createFile', array(TMP . 'view_task_articles' . DS . 'admin_edit.ctp', '*'));

		$this->Task->execute();
		Configure::write('Routing', $_back);
	}

/**
 * test execute into interactive.
 *
 * @return void
 * @access public
 */
	function testExecuteInteractive() {
		$this->Task->connection = 'test_suite';
		$this->Task->args = array();
		$this->Task->params = array();

		$this->Task->Controller->setReturnValue('getName', 'ViewTaskComments');
		$this->Task->setReturnValue('in', 'y');
		$this->Task->setReturnValueAt(0, 'in', 'y');
		$this->Task->setReturnValueAt(1, 'in', 'y');
		$this->Task->setReturnValueAt(2, 'in', 'n');

		$this->Task->expectCallCount('createFile', 4);
		$this->Task->expectAt(0, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'index.ctp',
			new PatternExpectation('/ViewTaskComment/')
		));
		$this->Task->expectAt(1, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'view.ctp',
			new PatternExpectation('/ViewTaskComment/')
		));
		$this->Task->expectAt(2, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'add.ctp',
			new PatternExpectation('/Add .+View Task Comment/')
		));
		$this->Task->expectAt(3, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'edit.ctp',
			new PatternExpectation('/Edit .+View Task Comment/')
		));

		$this->Task->execute();
	}

/**
 * test `cake bake view posts index list`
 *
 * @return void
 * @access public
 */
	function testExecuteWithAlternateTemplates() {
		$this->Task->connection = 'test_suite';
		$this->Task->args = array('ViewTaskComments', 'index', 'list');
		$this->Task->params = array();
		
		$this->Task->expectCallCount('createFile', 1);
		$this->Task->expectAt(0, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'list.ctp',
			new PatternExpectation('/ViewTaskComment/')
		));
		$this->Task->execute();
	}

/**
 * test execute into interactive() with admin methods.
 *
 * @return void
 * @access public
 */
	function testExecuteInteractiveWithAdmin() {
		Configure::write('Routing.prefixes', array('admin'));
		$this->Task->connection = 'test_suite';
		$this->Task->args = array();

		$this->Task->Controller->setReturnValue('getName', 'ViewTaskComments');
		$this->Task->Project->setReturnValue('getPrefix', 'admin_');
		$this->Task->setReturnValueAt(0, 'in', 'y');
		$this->Task->setReturnValueAt(1, 'in', 'n');
		$this->Task->setReturnValueAt(2, 'in', 'y');

		$this->Task->expectCallCount('createFile', 4);
		$this->Task->expectAt(0, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'admin_index.ctp',
			new PatternExpectation('/ViewTaskComment/')
		));
		$this->Task->expectAt(1, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'admin_view.ctp',
			new PatternExpectation('/ViewTaskComment/')
		));
		$this->Task->expectAt(2, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'admin_add.ctp',
			new PatternExpectation('/Add .+View Task Comment/')
		));
		$this->Task->expectAt(3, 'createFile', array(
			TMP . 'view_task_comments' . DS . 'admin_edit.ctp',
			new PatternExpectation('/Edit .+View Task Comment/')
		));

		$this->Task->execute();
	}
}
?>