ControllerTest.php

<?php
/**
 * Lithium: the most rad php framework
 *
 * @copyright     Copyright 2012, Union of RAD (http://union-of-rad.org)
 * @license       http://opensource.org/licenses/bsd-license.php The BSD License
 */

namespace lithium\tests\cases\action;

use lithium\action\Request;
use lithium\action\Controller;
use lithium\tests\mocks\action\MockPostsController;
use lithium\tests\mocks\action\MockRenderAltController;
use lithium\tests\mocks\action\MockControllerRequest;

class ControllerTest extends \lithium\test\Unit {

	/**
	 * Tests that controllers can be instantiated with custom request objects.
	 *
	 * @return void
	 */
	public function testConstructionWithCustomRequest() {
		$request = new MockControllerRequest();
		$postsController = new MockPostsController(compact('request'));
		$result = get_class($postsController->request);
		$this->assertEqual($result, 'lithium\tests\mocks\action\MockControllerRequest');
	}

	/**
	 * Tests the use of `Controller::__invoke()` for dispatching requests to action methods.  Also
	 * tests that using PHP's callable syntax yields the same result as calling `__invoke()`
	 * explicitly.
	 *
	 * @return void
	 */
	public function testMethodInvocation() {
		$postsController = new MockPostsController();
		$result = $postsController->__invoke(null, array('action' => 'index', 'args' => array()));

		$this->assertInstanceOf('lithium\action\Response', $result);
		$this->assertEqual('List of posts', $result->body());
		$this->assertEqual(array('Content-Type' => 'text/plain; charset=UTF-8'), $result->headers);

		$result2 = $postsController(null, array('action' => 'index', 'args' => array()));
		$this->assertEqual($result2, $result);

		$postsController = new MockPostsController();
		$this->expectException('/Unhandled media type/');
		$result = $postsController(null, array('action' => 'index', 'args' => array(true)));

		$this->assertInstanceOf('lithium\action\Response', $result);
		$this->assertEqual($result->body, '');

		$headers = array('Content-Type' => 'text/html; charset=UTF-8');
		$this->assertEqual($result->headers, $headers);

		$result = $postsController->access('_render');
		$this->assertEqual($result['data'], array('foo' => 'bar'));

		$postsController = new MockPostsController();
		$result = $postsController(null, array('action' => 'view', 'args' => array('2')));

		$this->assertInstanceOf('lithium\action\Response', $result);
		$this->assertEqual($result->body, "Array\n(\n    [0] => This is a post\n)\n");

		$headers = array('status' => 200, 'Content-Type' => 'text/plain; charset=UTF-8');
		$this->assertEqual($result->headers(), $headers);

		$result = $postsController->access('_render');
		$this->assertEqual($result['data'], array('This is a post'));
	}

	/**
	 * Tests that calls to `Controller::redirect()` correctly write redirect headers to the
	 * response object.
	 *
	 * @return void
	 */
	public function testRedirectResponse() {
		$postsController = new MockPostsController();

		$result = $postsController(null, array('action' => 'delete'));
		$this->assertEqual($result->body(), '');

		$headers = array('Location' => '/posts', 'Content-Type' => 'text/html');
		$this->assertEqual($result->headers, $headers);

		$postsController = new MockPostsController();
		$result = $postsController(null, array('action' => 'delete', 'args' => array('5')));

		$this->assertEqual($result->body(), 'Deleted 5');
		$this->assertFalse($postsController->stopped);

		$postsController = new MockPostsController(array('classes' => array(
			'response' => 'lithium\tests\mocks\action\MockControllerResponse'
		)));
		$this->assertFalse($postsController->stopped);

		$postsController->__invoke(null, array('action' => 'send'));
		$this->assertTrue($postsController->stopped);

		$result = $postsController->access('_render');
		$this->assertTrue($result['hasRendered']);

		$this->assertEqual($postsController->response->body(), null);
		$this->assertEqual(
			$postsController->response->headers,
			array('Location' => '/posts', 'Content-Type' => 'text/html')
		);
	}

	/**
	 * Tests calling `Controller::render()` with parameters to render an alternate template from
	 * the default.
	 *
	 * @return void
	 */
	public function testRenderWithAlternateTemplate() {
		$postsController = new MockPostsController(array('classes' => array(
			'media' => 'lithium\tests\mocks\action\MockMediaClass'
		)));

		$result = $postsController(null, array('action' => 'view2'));
		$this->assertEqual('view', $result->options['template']);
		$this->assertEqual('default', $result->options['layout']);

		$result = $postsController(null, array('action' => 'view3'));
		$this->assertEqual('view', $result->options['template']);
		$this->assertFalse($result->options['layout']);
	}

	/**
	 * Tests that requests where the controller class is specified manually continue to route to
	 * the correct template path.
	 *
	 * @return void
	 */
	public function testRenderWithNamespacedController() {
		$request = new Request();
		$request->params['controller'] = 'lithium\tests\mocks\action\MockPostsController';

		$controller = new MockPostsController(compact('request') + array('classes' => array(
			'media' => 'lithium\tests\mocks\action\MockMediaClass'
		)));

		$controller->render();
		$this->assertEqual('mock_posts', $controller->response->options['controller']);
	}

	/**
	 * Verifies that data array is passed on to controller's response.
	 *
	 * @return void
	 */
	public function testRenderWithDataArray() {
		$request = new Request();
		$request->params['controller'] = 'lithium\tests\mocks\action\MockPostsController';

		$controller = new MockPostsController(compact('request') + array('classes' => array(
			'media' => 'lithium\tests\mocks\action\MockMediaClass'
		)));

		$controller->set(array('set' => 'data'));
		$controller->render(array('data' => array('render' => 'data')));

		$expected = array(
			'set' => 'data',
			'render' => 'data'
		);
		$this->assertEqual($expected, $controller->response->data);
	}

	/**
	 * Verifies that the Controller does not modify data when passed an array (or RecordSet)
	 * with a single element.
	 *
	 * @return void
	 */
	public function testRenderWithDataSingleIndexedArray() {
		$request = new Request();
		$request->params['controller'] = 'lithium\tests\mocks\action\MockPostsController';

		$controller = new MockPostsController(compact('request') + array('classes' => array(
			'media' => 'lithium\tests\mocks\action\MockMediaClass'
		)));

		$expected = array(array('id' => 1));
		$controller->render(array('data' => $expected));

		$this->assertEqual($expected, $controller->response->data);
	}

	/**
	 * Verifies that protected methods (i.e. prefixed with '_'), and methods declared in the
	 * Controller base class cannot be accessed.
	 *
	 * @return void
	 */
	public function testProtectedMethodAccessAttempt() {
		$postsController = new MockPostsController();
		$this->expectException('/^Attempted to invoke a private method/');
		$result = $postsController->__invoke(null, array('action' => 'redirect'));

		$this->assertEqual($result->body, null);
		$this->assertEqual($result->headers(), array());

		$postsController = new MockPostsController();
		$this->expectException('/^Private/');
		$result = $postsController->invoke('_safe');

		$this->assertEqual($result->body, null);
		$this->assertEqual($result->headers(), array());
	}

	public function testResponseStatus() {
		$postsController = new MockPostsController(array('classes' => array(
			'response' => 'lithium\tests\mocks\action\MockControllerResponse'
		)));
		$this->assertFalse($postsController->stopped);

		$postsController(null, array('action' => 'notFound'));

		$result = $postsController->access('_render');
		$this->assertTrue($result['hasRendered']);

		$expected = array('code' => 404, 'message' => 'Not Found');
		$result = $postsController->response->status;
		$this->assertEqual($expected, $result);
		$result = $postsController->response->body();
		$this->assertEqual($expected, $result);
	}

	public function testResponseTypeBasedOnRequestType() {
		$request = new MockControllerRequest();
		$request->params['type'] = 'json';

		$postsController = new MockPostsController(array(
			'request' => $request,
			'classes' => array(
				'response' => 'lithium\tests\mocks\action\MockControllerResponse'
			)
		));
		$this->assertFalse($postsController->stopped);

		$postsController($request, array('action' => 'type'));

		$expected = array(
			'type' => 'json', 'data' => array('data' => 'test'), 'auto' => true,
			'layout' => 'default', 'template' => 'type', 'hasRendered' => true, 'negotiate' => false
		);
		$result = $postsController->access('_render');
		$this->assertEqual($expected, $result);

		$result = $postsController->response->headers('Content-Type');
		$this->assertEqual('application/json; charset=UTF-8', $result);

		$result = $postsController->response->body();
		$this->assertEqual(array('data' => 'test'), $result);
	}

	public function testResponseTypeBasedOnRequestParamsType() {
		$request = new MockControllerRequest();
		$request->params['type'] = 'json';

		$postsController = new MockPostsController(array(
			'request' => $request,
			'classes' => array(
				'response' => 'lithium\tests\mocks\action\MockControllerResponse'
			)
		));
		$this->assertFalse($postsController->stopped);

		$postsController->__invoke($request, array('action' => 'type'));

		$expected = array(
			'type' => 'json', 'data' => array('data' => 'test'), 'auto' => true,
			'layout' => 'default', 'template' => 'type', 'hasRendered' => true, 'negotiate' => false
		);
		$result = $postsController->access('_render');
		$this->assertEqual($expected, $result);

		$result = $postsController->response->headers('Content-Type');
		$this->assertEqual('application/json; charset=UTF-8', $result);

		$expected = array('data' => 'test');
		$result = $postsController->response->body();
		$this->assertEqual($expected, $result);
	}

	/**
	 * Tests that `$_render['template']` can be manually set in a controller action and will not be
	 * overwritten.
	 *
	 * @return void
	 */
	public function testManuallySettingTemplate() {
		$postsController = new MockPostsController(array('classes' => array(
			'media' => 'lithium\tests\mocks\action\MockMediaClass'
		)));
		$postsController(new Request(), array('action' => 'changeTemplate'));
		$result = $postsController->access('_render');
		$this->assertEqual('foo', $result['template']);
	}

	public function testRenderPropertyInheritance() {
		$controller = new MockRenderAltController();

		$expected = array(
			'data' => array('foo' => 'bar'), 'layout' => 'alternate', 'type' => null, 'auto' => true,
			'template' => null, 'hasRendered' => false, 'negotiate' => false
		);
		$result = $controller->access('_render');
		$this->assertEqual($expected, $result);
	}

	public function testSetData() {
		$postController = new MockPostsController();

		$setData = array('foo' => 'bar');
		$postController->set($setData);
		$_render = $postController->access('_render');
		$data = $_render['data'];
		$expected = $setData;
		$this->assertEqual($expected, $data);

		$setData = array('foo' => 'baz');
		$postController->set($setData);
		$_render = $postController->access('_render');
		$data = $_render['data'];
		$expected = $setData;
		$this->assertEqual($expected, $data);
	}

	public function testResponseTypeBasedOnRequestHeaderType() {
		$request = new MockControllerRequest(array(
			'env' => array('HTTP_ACCEPT' => 'application/json,*/*')
		));

		$postsController = new MockPostsController(array(
			'request' => $request,
			'classes' => array('response' => 'lithium\tests\mocks\action\MockControllerResponse'),
			'render' => array('negotiate' => true)
		));
		$this->assertFalse($postsController->stopped);

		$postsController($request, array('action' => 'type'));

		$expected = array(
			'type' => 'json', 'data' => array('data' => 'test'), 'auto' => true,
			'layout' => 'default', 'template' => 'type', 'hasRendered' => true, 'negotiate' => true
		);
		$result = $postsController->access('_render');
		$this->assertEqual($expected, $result);

		$result = $postsController->response->headers('Content-Type');
		$this->assertEqual('application/json; charset=UTF-8', $result);

		$result = $postsController->response->body();
		$this->assertEqual(array('data' => 'test'), $result);
	}

	/**
	 * Tests that requests which are dispotched with the controller route parameter specified as
	 * a fully-qualified class name are able to locate their templates correctly.
	 *
	 * @return void
	 */
	public function testDispatchingWithExplicitControllerName() {
		$request = new Request(array('url' => '/'));
		$request->params = array(
			'controller' => 'lithium\tests\mocks\action\MockPostsController',
			'action' => 'index'
		);

		$postsController = new MockPostsController(compact('request'));
		$postsController->__invoke($request, $request->params);
	}

	public function testNonExistentFunction() {
		$postsController = new MockPostsController();
		$this->expectException("Action `foo` not found.");
		$postsController(new Request(), array('action' => 'foo'));
	}

	/**
	 * Tests that the library of the controller is automatically added to the default rendering
	 * options.
	 */
	public function testLibraryScoping() {
		$request = new Request();
		$request->params['controller'] = 'lithium\tests\mocks\action\MockPostsController';

		$controller = new MockPostsController(compact('request') + array('classes' => array(
			'media' => 'lithium\tests\mocks\action\MockMediaClass'
		)));

		$controller->render();
		$this->assertEqual('lithium', $controller->response->options['library']);
	}
}

?>