/tests/cases/helpers/comment_widget.test.php

<?php
/**
 * Copyright 2009-2010, Cake Development Corporation (http://cakedc.com)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright 2009-2010, Cake Development Corporation (http://cakedc.com)
 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
 */

App::import('Core', array('ClassRegistry', 'Controller', 'View', 'Model', 'Security'));
App::import('Helper', array('Comments.CommentWidget', 'Html', 'Form', 'Session'));
App::import('Component', array('Comments.Comments'));

Mock::generatePartial('AppHelper', 'JsHelper', array('link', 'get', 'effect'));

if (!class_exists('Article')) {
	class Article extends CakeTestModel {
	/**
	 * 
	 */
		public $name = 'Article';
	}
}

if (!class_exists('ArticlesTestController')) {
	class ArticlesTestController extends Controller {

	/**
	 * @var string
	 */
		public $name = 'ArticlesTest';

	/**
	 * @var array
	 */
		public $uses = array('Article');

	/**
	 * @var array
	 */
		public $components = array('Comments.Comments');

	/**
	 * Overrides Controller::redirect() to log the redirected url
	 * (non-PHPdoc)
	 * @see cake/libs/controller/Controller#redirect($url, $status, $exit)
	 */
		public function redirect($url, $status = NULL, $exit = true) {
			$this->redirectUrl = $url;
		}

	}
}

/**
 * Comment Widget Helper Test
 *
 * @package comments
 * @subpackage comment.tests.cases.helpers
 */
class CommentWidgetHelperTest extends CakeTestCase {

/**
 * fixtures property
 *
 * @var array
 */
	public $fixtures = array(
		'plugin.comments.comment',
		'plugin.comments.user',
		'plugin.comments.article');

/**
 * Helper being tested
 * @var CommentWidgetHelper
 */
	public $CommentWidget = null;
	
/**
 * Controller with commentable related actions for testing purpose
 * @var ArticlesTestController
 */
	public $Controller = null;
	
/**
 * Current view object
 * @var View
 */
	public $View = null;
	
/**
 * Mock object for Js helper
 * @var JsHelper
 */
	public $Js = null;
	
/**
 * Start test method
 *
 * @return void
 */
	public function startTest($method) {
		parent::startTest($method);

		$this->CommentWidget = new CommentWidgetHelper();
		$this->CommentWidget->Form = new FormHelper();
		$this->CommentWidget->Html = new HtmlHelper();
		$this->Js = new JsHelper();
		$this->CommentWidget->Js = $this->Js;
		$this->CommentWidget->params['action'] = 'view';
		
		$this->Controller = ClassRegistry::init('ArticlesTestController');
		$this->View = new View($this->Controller);
		ClassRegistry::addObject('view', $this->View);
		
		if (!in_array($method, array('testInitialize', 'testOptions'))) {
			$this->CommentWidget->initialize();
		}
	}
	
/**
 * Test helper instance
 * 
 * @return void
 */
	public function testInstance() {
		$this->assertTrue(is_a($this->CommentWidget, 'CommentWidgetHelper'));
	}
	
/**
 * Test initialize
 * 
 * @return void
 */
	public function testInitialize() {
		$this->assertTrue(empty($this->CommentWidget->globalParams));
		$this->CommentWidget->initialize();
		$this->assertFalse(empty($this->CommentWidget->globalParams));
	}

/**
 * Test beforeRender callback
 * 
 * @return void
 */
	public function testBeforeRender() {
		$this->assertTrue(empty($this->View->viewVars));
		$this->CommentWidget->beforeRender();
		$this->assertFalse($this->CommentWidget->enabled);
		
		$this->View->viewVars['commentParams'] = array(
			'displayType' => 'flat');
		$this->CommentWidget->beforeRender();
		$this->assertFalse($this->CommentWidget->enabled);
		
		$this->View->viewVars['commentParams'] = array(
			'displayType' => 'flat',
			'viewComments' => 'commentsData');
		$this->CommentWidget->beforeRender();
		$this->assertTrue($this->CommentWidget->enabled);
	}
	
/**
 * Test options method
 * 
 * @return void
 */
	public function testOptions() {
		$this->assertTrue(empty($this->CommentWidget->globalParams));
		$this->Js->setReturnValue('get', $this->Js);
		$this->Js->setReturnValue('effect', '');
		$options = array(
			'target' => 'test',
			'foo' => 'bar');

		$this->CommentWidget->options($options);
		$this->assertEqual(count($this->CommentWidget->globalParams), 9);
		$this->assertEqual($this->CommentWidget->globalParams['target'], 'test');
		$this->assertEqual($this->CommentWidget->globalParams['foo'], 'bar');
		
		$this->CommentWidget->options(array());
		$this->assertEqual(count($this->CommentWidget->globalParams), 9);
		$this->assertFalse($this->CommentWidget->globalParams['target']);
		$this->assertEqual($this->CommentWidget->globalParams['foo'], 'bar');
	}
	
/**
 * Test display method
 * 
 * @return void
 */
	public function testDisplay() {
		$this->CommentWidget->enabled = false;
		$this->assertEqual($this->CommentWidget->display(), '');

		$this->CommentWidget->enabled = true;
		$this->__mockView();
		$countElementCall = 0;
		$initialParams = $this->CommentWidget->globalParams; 
		$Article = ClassRegistry::init('Article');
		Configure::write('Routing.admin', 'admin');

		// Test a basic display call
		$currArticle = $Article->findById(1);
		$this->View->passedArgs = array(
			'foo' => 'bar',
			'article-slug');
		$this->View->viewVars = array(
			'article' => $currArticle,
			'commentParams' => array(
				'viewComments' => 'commentsData',
				'modelName' => 'Article',
				'userModel' => 'User'),
		);
		$expectedParams = array(
			'comments/flat/main', 
			array_merge(
				$initialParams,
				array(
					'viewRecord' => $currArticle['Article'],
					'viewRecordFull' => $currArticle),
				$this->View->viewVars['commentParams'],
				array(
					'url' => array('article-slug'),
					'allowAddByAuth' => false,
					'allowAddByModel' => 1,
					'adminRoute' => 'admin',
					'isAddMode' => false,
					'theme' => 'flat')
				)
		);

		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$expected = 'Here are your comments!';
		$this->View->setReturnValueAt($countElementCall++, 'element', $expected);
		$result = $this->CommentWidget->display();
		$this->assertEqual($result, $expected);


		// Test a display call with options
		$expectedParams[0] = 'comments/threaded_custom/main';
		$expectedParams[1] = array_merge($expectedParams[1], array(
			'theme' => 'threaded_custom',
			'displayType' => 'threaded', 
			'subtheme' => 'custom'));
		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$this->View->setReturnValueAt($countElementCall++, 'element', $expected);
		$options = array(
			'displayType' => 'threaded',
			'subtheme' => 'custom');
		$result = $this->CommentWidget->display($options);
		$this->assertEqual($result, $expected);


		// Test other cases
		$this->CommentWidget->initialize();
		$this->View->params['userslug'] = 'example-user';
		unset($this->View->viewVars['article']);
		$expectedParams[1] = array_merge($expectedParams[1], array(
			'url' => array('example-user', 'article-slug'),
			'viewRecord' => array(),
			'viewRecordFull' => array()));
		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$this->View->setReturnValueAt($countElementCall++, 'element', $expected);
		$result = $this->CommentWidget->display($options);
		$this->assertEqual($result, $expected);

		$this->View->expectCallCount('element', $countElementCall);
	}

/**
 * Test display method with a custom url
 * 
 * @return void
 */
	public function testDisplayCustomUrl() {
		$this->__mockView();
		$countElementCall = 0;
		$initialParams = $this->CommentWidget->globalParams; 
		$Article = ClassRegistry::init('Article');
		Configure::write('Routing.admin', 'admin');

		// Test a basic display call
		$currArticle = $Article->findById(1);
		$this->View->passedArgs = array(
			'foo' => 'bar',
			'article-slug');
		$this->View->viewVars = array(
			'article' => $currArticle,
			'commentParams' => array(
				'viewComments' => 'commentsData',
				'modelName' => 'Article',
				'userModel' => 'User'),
		);
		$expectedParams = array(
			'comments/flat/main', 
			array_merge(
				$initialParams,
				array(
					'viewRecord' => $currArticle['Article'],
					'viewRecordFull' => $currArticle),
				$this->View->viewVars['commentParams'],
				array(
					'url' => array('action' => 'other', 'param1'),
					'allowAddByAuth' => false,
					'allowAddByModel' => 1,
					'adminRoute' => 'admin',
					'isAddMode' => false,
					'theme' => 'flat')
				)
		);
		$this->CommentWidget->options(array('url' => array('action' => 'other', 'param1')));
		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$expected = 'Here are your comments!';
		$this->View->setReturnValueAt($countElementCall++, 'element', $expected);
		$result = $this->CommentWidget->display();
		$this->assertEqual($result, $expected);
	}

/**
 * Test link method
 * 
 * @return void
 */
	public function testLink() {
		$result = $this->CommentWidget->link('Foobar', '/foo', array('class' => 'bar'));
		$expected = array(
			'a' => array('href' => '/foo', 'class' => 'bar'), 
			'Foobar', 
			'/a');
		$this->assertTags($result, $expected);

		$this->Js->setReturnValue('get', $this->Js);
		$this->Js->setReturnValue('effect', '');
		
		$this->CommentWidget->options(array('target' => 'wrapper', 'ajaxOptions' => array('update' => 'wrapper'))); 
		$this->Js->expectOnce('link', array(
			'Foobar',
			'/foo',
			array(
			'update' => 'wrapper',
			'class' => 'bar'))
		);
		$this->Js->setReturnValueAt(0, 'link', '/ajaxFoo');
		$result = $this->CommentWidget->link('Foobar', '/foo', array('class' => 'bar'));
		$this->assertEqual($result, '/ajaxFoo');
	}
	
/**
 * Test prepareUrl method
 * 
 * @return void
 */
	public function testPrepareUrl() {
		$expected = $url = array(
			'controller' => 'articles',
			'action' => 'view',
			'my-first-article');
		$this->assertEqual($this->CommentWidget->prepareUrl($url), $expected);

		$this->Js->setReturnValue('get', $this->Js);
		$this->Js->setReturnValue('effect', '');
		
		$this->CommentWidget->options(array(
			'target' => 'placeholder',
			'ajaxAction' => 'add'));
		$expected['action'] = 'add';
		$this->assertEqual($this->CommentWidget->prepareUrl($url), $expected);
		
		$this->CommentWidget->options(array(
			'target' => 'placeholder',
			'ajaxAction' => array(
				'controller' => 'comments',
				'action' => 'add')));
		$expected = array(
			'controller' => 'comments',
			'action' => 'add',
			'my-first-article');
		$this->assertEqual($this->CommentWidget->prepareUrl($url), $expected);
	}
	
/**
 * Test allowAnonymousComment method
 * 
 * @return void
 */
	public function testAllowAnonymousComment() {
		$this->assertFalse($this->CommentWidget->globalParams['allowAnonymousComment']);
		$this->CommentWidget->options(array('allowAnonymousComment' => true));
		$this->assertTrue($this->CommentWidget->globalParams['allowAnonymousComment']);
	}
	
/**
 * Test element method
 * 
 * @return void
 */
	public function testElement() {
		$this->__mockView();
		$this->CommentWidget->options(array('theme' => 'flat'));
		$countElementCall = 0;
		
		$expectedParams = array(
			'comments/flat/view',
			array(
				'target' => false,
				'ajaxAction' => false,
				'displayUrlToComment' => false,
				'urlToComment' => '',
				'allowAnonymousComment'  => false,
				'url' => null,
				'ajaxOptions' => array(),
				'viewInstance' => null,
				'theme' => 'flat')
		);
		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$expected = 'Comment element content';
		$this->View->setReturnValueAt($countElementCall++, 'element', $expected);
		$this->assertEqual($this->CommentWidget->element('view'), $expected);
		
		// Test missing element in project elements path. The helper must try to search the element from the comments plugin
		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$this->View->setReturnValueAt($countElementCall++, 'element', 'Not Found: /path/to/project/views/elements/comments/flat/view.ctp');
		$expectedParams[1]['plugin'] = 'comments';
		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$this->View->setReturnValueAt($countElementCall++, 'element', $expected);
		$this->assertEqual($this->CommentWidget->element('view'), $expected);
		unset($expectedParams[1]['plugin']);
		
		// Test params: they must be passed to the element "as is". Note that the theme has not effect on the element being fetched
		$expectedParams[1]['target'] = 'wrapper'; 
		$expectedParams[1]['theme'] = 'threaded';
		$this->View->expectAt($countElementCall, 'element', $expectedParams);
		$this->View->setReturnValueAt($countElementCall++, 'element', $expected);
		$this->assertEqual($this->CommentWidget->element('view', array('target' => 'wrapper', 'theme' => 'threaded')), $expected);
		
		$this->View->expectCallCount('element', $countElementCall);
	}

/**
 * End test method
 *
 * @return void
 */
	public function endTest($method) {
		unset($this->CommentWidget, $this->Controller, $this->View);
		ClassRegistry::flush();
	}

/**
 * Mock the view object, update the CR and the testCase attribute with the mock object
 * 
 * @return void
 */
	private function __mockView() {
		if (!class_exists('MockView')) {
			Mock::generate('View');
		}
		$this->View = new MockView();
		ClassRegistry::removeObject('view');
		ClassRegistry::addObject('view', $this->View);
	}
}