Mustache/test/Mustache/Test/Functional/ExamplesTest.php

<?php

/*
 * This file is part of Mustache.php.
 *
 * (c) 2012 Justin Hileman
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Mustache\Test\Functional;

use Mustache\Mustache;

/**
 * @group examples
 * @group functional
 */
class ExamplesTest extends \PHPUnit_Framework_TestCase {

	/**
	 * Test everything in the `examples` directory.
	 *
	 * @dataProvider getExamples
	 *
	 * @param string $context
	 * @param string $source
	 * @param array  $partials
	 * @param string $expected
	 */
	public function testExamples($context, $source, $partials, $expected) {
		$mustache = new Mustache(array(
			'partials' => $partials
		));
		$this->assertEquals($expected, $mustache->loadTemplate($source)->render($context));
	}

	/**
	 * Data provider for testExamples method.
	 *
	 * Assumes that an `examples` directory exists inside parent directory.
	 * This examples directory should contain any number of subdirectories, each of which contains
	 * three files: one Mustache class (.php), one Mustache template (.mustache), and one output file
	 * (.txt).
	 *
	 * This whole mess will be refined later to be more intuitive and less prescriptive, but it'll
	 * do for now. Especially since it means we can have unit tests :)
	 *
	 * @return array
	 */
	public function getExamples() {
		$path     = realpath(__DIR__.'/../../../../examples');
		$examples = array();

		$handle   = opendir($path);
		while (($file = readdir($handle)) !== false) {
			if ($file == '.' || $file == '..') {
				continue;
			}

			$fullpath = $path.'/'.$file;
			if (is_dir($fullpath)) {
				$examples[$file] = $this->loadExample($fullpath);
			}
		}
		closedir($handle);

		return $examples;
	}

	/**
	 * Helper method to load an example given the full path.
	 *
	 * @param string $path
	 *
	 * @return array arguments for testExamples
	 */
	private function loadExample($path) {
		$context  = null;
		$source   = null;
		$partials = array();
		$expected = null;

		$handle = opendir($path);
		while (($file = readdir($handle)) !== false) {
			$fullpath = $path.'/'.$file;
			$info = pathinfo($fullpath);

			if (is_dir($fullpath) && $info['basename'] == 'partials') {
				// load partials
				$partials = $this->loadPartials($fullpath);
			} elseif (is_file($fullpath)) {
				// load other files
				switch ($info['extension']) {
					case 'php':
						require_once($fullpath);
						$context = new $info['filename'];
						break;

					case 'mustache':
						$source   = file_get_contents($fullpath);
						break;

					case 'txt':
						$expected = file_get_contents($fullpath);
						break;
				}
			}
		}
		closedir($handle);

		return array($context, $source, $partials, $expected);
	}

	/**
	 * Helper method to load partials given an example directory.
	 *
	 * @param string $path
	 *
	 * @return array  $partials
	 */
	private function loadPartials($path) {
		$partials = array();

		$handle = opendir($path);
		while (($file = readdir($handle)) !== false) {
			if ($file == '.' || $file == '..') {
				continue;
			}

			$fullpath = $path.'/'.$file;
			$info = pathinfo($fullpath);

			if ($info['extension'] === 'mustache') {
				$partials[$info['filename']] = file_get_contents($fullpath);
			}
		}
		closedir($handle);

		return $partials;
	}
}