comicpress-core/test/ComicPressTagBuilderTest.php

<?php

require_once('PHPUnit/Framework.php');
require_once('MockPress/mockpress.php');
require_once(dirname(__FILE__) . '/../classes/ComicPressTagBuilder.inc');
require_once(dirname(__FILE__) . '/../classes/ComicPressStoryline.inc');

class ComicPressTagBuilderTest extends PHPUnit_Framework_TestCase {
	function setUp() {
		_reset_wp();
	}

	function testNewFactory() {
		$core = new ComicPressTagBuilderFactory();
	}

	function providerTestBuilder() {
		$p = (object)array('ID' => 1);

		return array(
			array(
				array(
					array('next')
				),
				array('get_next_post', array(1), $p)
			),
			array(
				array(
					array('previous'),
				),
				array('get_previous_post', array(1), $p)
			),
			array(
				array(
					array('first'),
				),
				array('get_first_post', array(1), $p)
			),
			array(
				array(
					array('last'),
				),
				array('get_last_post', array(1), $p)
			),
			array(
				array(
					array('in', 'category-2'),
					array('last')
				),
				array('get_last_post', array(2,3,4), $p)
			),
			array(
				array(
					array('in', 2),
					array('first')
				),
				array('get_first_post', array(2,3,4), $p)
			),
			array(
				array(
					array('in', 2),
					array('first'),
					array('setup')
				),
				array('get_first_post', array(2,3,4), $p),
				true
			),
			array(
				array(
					array('from', (object)array('other-post' => 'post')),
					array('in', 2),
					array('first')
				),
				array('get_first_post', array(2,3,4), (object)array('other-post' => 'post')),
			),
			array(
				array(
					array('next', 3)
				),
				array('get_next_post', array(1), $p, 3),
				false,
				array('test')
			),
			array(
				array(
					array('next', 3)
				),
				array('get_next_post', array(1), $p, 3),
				false,
				(object)array('test' => 'test2')
			),
			array(
				array(
					array('next', 3)
				),
				array('get_next_post', array(1), $p, 3),
				false,
				"string"
			),
			array(
				array(
					array('in', 'all'),
					array('first')
				),
				array('get_first_post', array(1,2,3,4,5), $p)
			),
			array(
				array(
					array('in', 'all'),
					array('all')
				),
				array('get_all_posts', array(1,2,3,4,5))
			),
		);
	}

	/**
	 * @dataProvider providerTestBuilder
	 */
	function testStorylineBuilder($instructions, $expected_dbi_call, $expects_setup_postdata = false, $returns_override = null) {
		global $post, $wp_test_expectations;
		$post = (object)array('ID' => 1);

		wp_set_post_categories(1, array(1));

		$method = array_shift($expected_dbi_call);

		$dbi = $this->getMock('ComicPressDBInterface', array($method));
		$expectation = $dbi->expects($this->once())->method($method);
		call_user_func_array(array($expectation, 'with'), $expected_dbi_call);

		if ($expects_setup_postdata) {
			call_user_func(array($expectation, 'will'), $this->returnValue('new-post'));
		}

		if (!empty($returns_override)) {
			call_user_func(array($expectation, 'will'), $this->returnValue($returns_override));
		}

		$core = new ComicPressTagBuilderFactory($dbi);

		$storyline = new ComicPressStoryline();
		$storyline->set_flattened_storyline('0/1,0/2,0/2/3,0/2/4,0/5');

		foreach (array(
			1 => array('cat_name' => 'Test 1', 'category_nicename' => 'category-1', 'category_parent' => 0),
			2 => array('cat_name' => 'Test 2', 'category_nicename' => 'category-2', 'category_parent' => 0),
			3 => array('cat_name' => 'Test 3', 'category_nicename' => 'category-3', 'category_parent' => 2),
			4 => array('cat_name' => 'Test 4', 'category_nicename' => 'category-4', 'category_parent' => 2),
			5 => array('cat_name' => 'Test 5', 'category_nicename' => 'category-5', 'category_parent' => 0),
		) as $id => $category) {
			add_category($id, (object)$category);
		}

		foreach ($instructions as $instruction) {
			$method = array_shift($instruction);
			$core = call_user_func_array(array($core, $method), $instruction);
		}

		if ($expects_setup_postdata) {
			$this->assertEquals('new-post', $post);
		}
	}

	function providerTestPostIn() {
		return array(
			array(null, false),
			array((object)array('ID' => 2), true)
		);
	}

	/**
	 * @dataProvider providerTestPostIn
	 */
	function testPostIn($post_to_use = null, $expected_result) {
		global $post;

		$post = (object)array('ID' => 1);
		wp_insert_post($post);

		$storyline = new ComicPressStoryline();
		$storyline->set_flattened_storyline('0/1,0/2,0/2/3,0/2/4,0/5');

		foreach (array(
			1 => array('cat_name' => 'Test 1', 'category_nicename' => 'category-1', 'category_parent' => 0),
			2 => array('cat_name' => 'Test 2', 'category_nicename' => 'category-2', 'category_parent' => 0),
			3 => array('cat_name' => 'Test 3', 'category_nicename' => 'category-3', 'category_parent' => 2),
			4 => array('cat_name' => 'Test 4', 'category_nicename' => 'category-4', 'category_parent' => 2),
			5 => array('cat_name' => 'Test 5', 'category_nicename' => 'category-5', 'category_parent' => 0),
		) as $id => $category) {
			add_category($id, (object)$category);
		}

		wp_set_post_categories(1, array(1));
		wp_set_post_categories(2, array(2));

		$dbi = $this->getMock('ComicPressDBInterface');
		$core = new ComicPressTagBuilderFactory($dbi);

		$post_to_use = empty($post_to_use) ? $post : $post_to_use;

		$this->assertEquals($expected_result, $core->post_in('category-2', $post_to_use));
	}

	private function setupStorylineBuilderTest($for_exceptions = false) {
		$target_post = (object)array(
			'ID' => 1,
			'post_title' => 'Post title',
			'post_date' => '2010-01-01',
			'guid' => 'the-slug',
		);

		wp_insert_post($target_post);

		$dbi = $this->getMock('ComicPressDBInterface', array('get_first_post'));
		$expectation = $dbi->expects($this->any())->method('get_first_post');
		if (!$for_exceptions) {
			$expectation->with(array('1'))->will($this->returnValue($target_post));
		}

		$storyline = new ComicPressStoryline();
		$storyline->set_flattened_storyline('0/1');

		return compact('target_post', 'dbi', 'storyline');
	}

	function providerTestStorylineBuilderHandlePost() {
		return array(
			array('id', 1),
			array('title', 'Post title'),
			array('timestamp', strtotime('2010-01-01')),
			array('permalink', 'the-slug'),
			array('post', (object)array(
				'ID' => 1,
				'post_title' => 'Post title',
				'post_date' => '2010-01-01',
				'guid' => 'the-slug',
			)),
			array(array('date', 'Ymd'), '20100101'),
		);
	}

	/**
	 * @dataProvider providerTestStorylineBuilderHandlePost
	 */
	function testStorylineBuilderHandlePost($info_method, $expected_result) {
		extract($this->setupStorylineBuilderTest());

		$core = new ComicPressTagBuilderFactory($dbi);
		$core = $core->first_in_1();

		if (is_array($info_method)) {
			$method = array_shift($info_method);
			$this->assertEquals($expected_result, call_user_func_array(array($core, $method), $info_method));
		} else {
			$this->assertEquals($expected_result, $core->{$info_method}());
		}
	}

	function providerTestStorylineBuilderExceptions() {
		return array(
			array(array('bad')),
			array(array(array('in', 1), 'bad')),
			array(array(array('in', 1), 'date')),
			array(array(array('from', 'test'))),
			array(array(array('in'))),
			array(array(array('from'))),
			array(array(array('current')))
		);
	}

	/**
	 * @expectedException ComicPressException
	 * @dataProvider providerTestStorylineBuilderExceptions
	 */
	function testStorylineBuilderExceptions($calls) {
		extract($this->setupStorylineBuilderTest(true));

		$core = new ComicPressTagBuilderFactory($dbi);

		foreach ($calls as $call) {
			if (is_array($call)) {
				$method = array_shift($call);
				$core = call_user_func_array(array($core, $method), $call);
			} else {
				$core = $core->{$call}();
			}
		}
	}

	function providerTestMethodParser() {
		return array(
			array(
				'last',
				array(
					array('last')
				)
			),
			array(
				'first_in_3',
				array(
					array('in', 3),
					array('first')
				)
			),
			array(
				'first_in_category_1',
				array(
					array('in', 'category-1'),
					array('first')
				)
			),
			array(
				'first_permalink_in_category_1',
				array(
					array('in', 'category-1'),
					array('first'),
					array('permalink'),
				)
			),
			array(
				'setup_first_post_in_category_1',
				array(
					array('in', 'category-1'),
					array('first'),
					array('setup')
				)
			),
			array(
				'media_for_first_post_in_category_1',
				array(
					array('in', 'category-1'),
					array('first'),
					array('media')
				)
			)
		);
	}

	/**
	 * @dataProvider providerTestMethodParser
	 */
	function testMethodParser($method_name, $expected_pieces) {
		$this->assertEquals($expected_pieces, ComicPressTagBuilder::parse_method($method_name));
	}

	function providerTestMethodParserExceptions() {
		return array(
			array('first_in_'),
			array('first_post_id'),
			array('setup_setup'),
			array('setup_first_permalink'),
			array('setup_media'),
			array('media_setup'),
			array('setup_for')
		);
	}

	/**
	 * @dataProvider providerTestMethodParserExceptions
	 * @expectedException ComicPressException
	 */
	function testMethodParserExceptions($method_name) {
		ComicPressTagBuilder::parse_method($method_name);
	}

	function testMethodParserWithParam() {
		extract($this->setupStorylineBuilderTest());

		$core = new ComicPressTagBuilderFactory($dbi);

		$this->assertEquals('2010-01-01', $core->first_date_in_1('Y-m-d'));
	}

	function testMedia() {
		$core = $this->getMock('ComicPressTagBuilder', array('_new_comicpresscomicpost'), array(), 'ComicPressTagBuilder_Mock', false);
		$core->post = 'this-post';

		$comicpresscomicpost = $this->getMock('ComicPressComicPost', array('get_attachments_with_children'));
		$comicpresscomicpost->expects($this->once())
												->method('get_attachments_with_children')
												->with(true)
												->will($this->returnValue(array('post-media')));

		$core->expects($this->once())
				 ->method('_new_comicpresscomicpost')
				 ->with('this-post')
				 ->will($this->returnValue($comicpresscomicpost));

		$this->assertEquals(new ComicPressMediaWrapper(array('post-media')), $core->media());
	}

	function testMediaForCurrentPost() {
		global $post;
		$post = 'this-post';

		$core = $this->getMock(
			'ComicPressTagBuilderFactory',
			array('_new_comicpresstagbuilder'),
			array(),
			'ComicPressTagBuilderFactory_' . md5(rand()),
			false
		);

		$core->dbi = 'dbi';
		$core->storyline = 'storyline';

		$tag_builder = $this->getMock('ComicPressTagBuilder', array('media'), array($post, 'storyline', 'dbi'));

		$tag_builder->expects($this->once())
								->method('media')
								->will($this->returnValue(array('post-media')));

		$core->expects($this->once())
				 ->method('_new_comicpresstagbuilder')
				 ->with($post, 'storyline', 'dbi')
				 ->will($this->returnValue($tag_builder));

		$this->assertEquals(array('post-media'), $core->media());
	}

	function testComicPressComicPost() {
		$a = ComicPressTagBuilder::_new_comicpresscomicpost('test');
		$this->assertTrue(is_a($a, 'ComicPressComicPost'));
	}

	function testCategoryStructure() {
		$storyline = new ComicPressStoryline();
		$storyline->set_flattened_storyline('0/1,0/2,0/3');

		$dbi = $this->getMock('ComicPressDBInterface');
		$core = new ComicPressTagBuilderFactory($dbi);

		$this->assertEquals(array(
			'1' => array('next' => 2, 'level' => 1),
			'2' => array('next' => 3, 'previous' => 1, 'level' => 1),
			'3' => array('previous' => 2, 'level' => 1),
		), $core->structure());
	}

	function providerTestCategoryTraversal() {
		return array(
			array(
				array(
					array('category'),
					array('current')
				),
				2
			),
			array(
				array(
					array('category'),
					array('current', true)
				),
				2
			),
			array(
				array(
					array('category'),
					array('next')
				),
				3
			),
			array(
				array(
					array('category'),
					array('previous')
				),
				1
			),
			array(
				array(
					array('category'),
					array('first')
				),
				1
			),
			array(
				array(
					array('category'),
					array('last')
				),
				5
			),
			array(
				array(
					array('category'),
					array('parent')
				),
				false
			),
			array(
				array(
					array('from', (object)array('ID' => 2)),
					array('category'),
					array('parent')
				),
				2
			),
			array(
				array(
					array('category', 4),
					array('parent')
				),
				2
			),
			array(
				array(
					array('category', 2),
					array('children')
				),
				array(2, 3, 4),
				true
			),
		);
	}

	/**
	 * @dataProvider providerTestCategoryTraversal
	 */
	function testCategoryTraversal($methods, $expected_result, $compare_ids = false) {
		global $post;

		$storyline = new ComicPressStoryline();
		$storyline->set_flattened_storyline('0/1,0/2,0/2/3,0/2/4,0/5');

		foreach (array(
			1 => array('cat_name' => 'Test 1', 'category_nicename' => 'category-1', 'category_parent' => 0),
			2 => array('cat_name' => 'Test 2', 'category_nicename' => 'category-2', 'category_parent' => 0),
			3 => array('cat_name' => 'Test 3', 'category_nicename' => 'category-3', 'category_parent' => 2),
			4 => array('cat_name' => 'Test 4', 'category_nicename' => 'category-4', 'category_parent' => 2),
			5 => array('cat_name' => 'Test 5', 'category_nicename' => 'category-5', 'category_parent' => 0),
		) as $id => $category) {
			add_category($id, (object)$category);
		}

		$post = (object)array('ID' => 1);

		$dbi = $this->getMock('ComicPressDBInterface');
		$core = new ComicPressTagBuilderFactory($dbi);

		wp_insert_post($post);
		wp_insert_post((object)array('ID' => 2));

		wp_set_post_categories(1, array(2));
		wp_set_post_categories(2, array(3));

		foreach ($methods as $method_info) {
			$method = array_shift($method_info);
			$core = call_user_func_array(array($core, $method), $method_info);
		}

		if (is_object($core)) {
			$this->assertEquals($expected_result, $core->cat_ID);
		} else {
			if (is_array($core) && $compare_ids) {
				foreach ($expected_result as $id) {
					$cat = array_shift($core);
					$this->assertEquals($id, $cat->cat_ID);
				}
			} else {
				$this->assertEquals($expected_result, $core);
			}
		}
	}

	function testFindFilePassthru() {
		$core = new ComicPressTagBuilderFactory();

		$comicpress = $this->getMock('ComicPress', array('find_file'));
		$comicpress->expects($this->once())
		           ->method('find_file')
		           ->with('name', 'path', 'categories')
		           ->will($this->returnValue('file'));

		ComicPress::get_instance($comicpress);

		$this->assertEquals('file', $core->find_file('name', 'path', 'categories'));

		ComicPress::get_instance(true);
	}

	/**
	 * @expectedException ComicPressException
	 */
	function testSetupEmptyPostException() {
		$core = new ComicPressTagBuilderFactory();
		unset($core->post);

		$this->assertTrue(false === $core->setup());

		$core->setup(true);
	}

	function providerTestProtect() {
		return array(
			array(null, 'test'),
			array('test3', 'test3')
		);
	}

	/**
	 * @dataProvider providerTestProtect
	 */
	function testProtect($post_to_use, $expected_post) {
		global $post, $wp_query;

		$post = "test";
		$wp_query = "test2";

		$core = new ComicPressTagBuilderFactory();

		$core->protect($post_to_use);

		$this->assertEquals($core->_post, 'test');
		$this->assertEquals($expected_post, $post);
		$this->assertEquals($wp_query, $core->_wp_query);
	}

	function testRestore() {
		global $post;

		$core = new ComicPressTagBuilderFactory();

		$post = 'not';
		$core->_post = 'test';

		$core->restore();

		$this->assertEquals($core->_post, $post);
	}

	function testUnprotect() {
		global $post, $wp_query;

		$core = new ComicPressTagBuilderFactory();

		$core->_post = $core->_wp_query = 'test';
		$post = $wp_query = 'not';

		$core->unprotect();

		$this->assertEquals('test', $post);
		$this->assertEquals('test', $wp_query);

		$this->assertTrue(!isset($core->_post));
		$this->assertTrue(!isset($core->_wp_query));
	}

	function providerTestComicPressMediaWrapper() {
		return array(
			array(
				array(), 'default-id-1default-id-2'
			),
			array(
				array('comic'), 'comic-id-1comic-id-2'
			),
			array(
				array('default', '<br />'), 'default-id-1<br />default-id-2'
			),
			array(
				array('default', 0), 'default-id-1'
			),
			array(
				array('default', 2), false
			),
			array(
				array('archive', 0), false
			),
			array(
				array('comic', 0), false, true
			),
		);
	}

	/**
	 * @dataProvider providerTestComicPressMediaWrapper
	 */
	function testComicPressMediaWrapper($arguments, $expected_return, $is_total_fail = false) {
		$backend = $this->getMock('ComicPressMockBackendFactory', array('embed', 'generate_from_id'));
		$backend->expects($this->any())
		        ->method('generate_from_id')
		        ->will($this->returnCallback(function($id) use ($backend) {
		        	if (in_array($id, array('comic-id-1', 'default-id-1', 'comic-id-2', 'default-id-2'))) {
			        	$backend->_id = $id;
			        	return $backend;
		        	} else {
		        		return false;
		        	}
		        }));

		$backend->expects($this->any())
					  ->method('embed')
					  ->will($this->returnCallback(function($which) use ($backend) {
					  	switch ($which) {
					  		case 'comic':
					  		case 'default':
					  			return $backend->_id;
					  			break;
					  		default:
					  			return false;
					  	}
					  }));

		$comicpress = ComicPress::get_instance(true);
		$comicpress->backends = array($backend);

		$media = new ComicPressMediaWrapper(array(
			array(
				'comic' => $is_total_fail ? 'total-fail' : 'comic-id-1',
				'default' => 'default-id-1'
			),
			array(
				'comic' => 'comic-id-2',
				'default' => 'default-id-2'
			),
		));

		$this->assertEquals($expected_return, call_user_func_array(array($media, 'embed'), $arguments));

		$comicpress = ComicPress::get_instance(true);
	}

	function providerTestSetPostExpectations() {
		return array(
			array('test'),
			array(123)
		);
	}

	/**
	 * @expectedException ComicPressException
	 * @dataProvider providerTestSetPostExpectations
	 */
	function testSetPostExceptions($input) {
		$core = new ComicPressTagBuilderFactory();
		$core->post($input);
	}

	function testSetPost() {
		$core = new ComicPressTagBuilderFactory();
		$core = $core->post((object)array('ID' => 1));

		$this->assertEquals((object)array('ID' => 1), $core->post);
	}
}