Merge branch 'feature/fix-partials' into dev

Mustache.php

@@ -59,6 +59,8 @@ class Mustache {
 		self::PRAGMA_UNESCAPED
 	);
 
+	protected $_localPragmas;
+
 	/**
 	 * Mustache class constructor.
 	 *
@@ -77,6 +79,28 @@ class Mustache {
 		if ($view !== null)     $this->_context = array($view);
 	}
 
+	/**
+	 * Mustache class clone method.
+	 *
+	 * A cloned Mustache instance should have pragmas, delimeters and root context
+	 * reset to default values.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function __clone() {
+		$this->_otag = '{{';
+		$this->_ctag = '}}';
+		$this->_localPragmas = null;
+
+		if ($keys = array_keys($this->_context)) {
+			$last = array_pop($keys);
+			if ($this->_context[$last] instanceof Mustache) {
+				$this->_context[$last] =& $this;
+			}
+		}
+	}
+
 	/**
 	 * Render the given template and view object.
 	 *
@@ -99,7 +123,7 @@ class Mustache {
 			$this->_context = array($this);
 		}
 
-		$template = $this->_renderPragmas($template, $context);
+		$template = $this->_renderPragmas($template);
 		return $this->_renderTemplate($template, $this->_context);
 	}
 
@@ -125,12 +149,11 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $template
-	 * @param array &$context
 	 * @return string Rendered Mustache template.
 	 */
-	protected function _renderTemplate($template, &$context) {
+	protected function _renderTemplate($template) {
-		$template = $this->_renderSection($template, $context);
+		$template = $this->_renderSection($template);
-		return $this->_renderTags($template, $context);
+		return $this->_renderTags($template);
 	}
 
 	/**
@@ -138,10 +161,9 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $template
-	 * @param array $context
 	 * @return string
 	 */
-	protected function _renderSection($template, &$context) {
+	protected function _renderSection($template) {
 		$otag  = $this->_prepareRegEx($this->_otag);
 		$ctag  = $this->_prepareRegEx($this->_ctag);
 		$regex = '/' . $otag . '(\\^|\\#)\\s*(.+?)\\s*' . $ctag . '\\s*([\\s\\S]+?)' . $otag . '\\/\\s*\\2\\s*' . $ctag . '\\s*/m';
@@ -155,7 +177,7 @@ class Mustache {
 			$content  = $matches[3][0];
 
 			$replace = '';
-			$val = $this->_getVariable($tag_name, $context);
+			$val = $this->_getVariable($tag_name);
 			switch($type) {
 				// inverted section
 				case '^':
@@ -168,13 +190,15 @@ class Mustache {
 				case '#':
 					if ($this->_varIsIterable($val)) {
 						foreach ($val as $local_context) {
-							$c = $this->_getContext($context, $local_context);
+							$this->_pushContext($local_context);
-							$replace .= $this->_renderTemplate($content, $c);
+							$replace .= $this->_renderTemplate($content);
+							$this->_popContext();
 						}
 					} else if ($val) {
 						if (is_array($val) || is_object($val)) {
-							$c = $this->_getContext($context, $val);
+							$this->_pushContext($val);
-							$replace .= $this->_renderTemplate($content, $c);
+							$replace .= $this->_renderTemplate($content);
+							$this->_popContext();
 						} else {
 							$replace .= $content;
 						}
@@ -193,10 +217,11 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $template
-	 * @param array &$context
 	 * @return string
 	 */
-	protected function _renderPragmas($template, &$context) {
+	protected function _renderPragmas($template) {
+		$this->_localPragmas = $this->_pragmas;
+
 		// no pragmas
 		if (strpos($template, $this->_otag . '%') === false) {
 			return $template;
@@ -234,9 +259,9 @@ class Mustache {
 		}
 
 		if (empty($options)) {
-			$this->_pragmas[$pragma_name] = true;
+			$this->_localPragmas[$pragma_name] = true;
 		} else {
-			$this->_pragmas[$pragma_name] = $options;
+			$this->_localPragmas[$pragma_name] = $options;
 		}
 
 		return '';
@@ -250,7 +275,7 @@ class Mustache {
 	 * @return bool
 	 */
 	protected function _hasPragma($pragma_name) {
-		if (array_key_exists($pragma_name, $this->_pragmas) && $this->_pragmas[$pragma_name]) {
+		if (array_key_exists($pragma_name, $this->_localPragmas) && $this->_localPragmas[$pragma_name]) {
 			return true;
 		} else {
 			return false;
@@ -270,7 +295,7 @@ class Mustache {
 			throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA);
 		}
 
-		return $this->_pragmas[$pragma_name];
+		return $this->_localPragmas[$pragma_name];
 	}
 
 
@@ -292,10 +317,9 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $template
-	 * @param array $context
 	 * @return void
 	 */
-	protected function _renderTags($template, &$context) {
+	protected function _renderTags($template) {
 		if (strpos($template, $this->_otag) === false) {
 			return $template;
 		}
@@ -314,7 +338,7 @@ class Mustache {
 			$tag_name = trim($matches[2][0]);
 
 			$html .= substr($template, 0, $offset);
-			$html .= $this->_renderTag($modifier, $tag_name, $context);
+			$html .= $this->_renderTag($modifier, $tag_name);
 			$template = substr($template, $offset + strlen($tag));
 		}
 
@@ -330,11 +354,10 @@ class Mustache {
 	 * @access protected
 	 * @param string $modifier
 	 * @param string $tag_name
-	 * @param array $context
 	 * @throws MustacheException Unmatched section tag encountered.
 	 * @return string
 	 */
-	protected function _renderTag($modifier, $tag_name, &$context) {
+	protected function _renderTag($modifier, $tag_name) {
 		switch ($modifier) {
 			case '#':
 			case '^':
@@ -352,28 +375,28 @@ class Mustache {
 				}
 				break;
 			case '=':
-				return $this->_changeDelimiter($tag_name, $context);
+				return $this->_changeDelimiter($tag_name);
 				break;
 			case '!':
-				return $this->_renderComment($tag_name, $context);
+				return $this->_renderComment($tag_name);
 				break;
 			case '>':
-				return $this->_renderPartial($tag_name, $context);
+				return $this->_renderPartial($tag_name);
 				break;
 			case '{':
 			case '&':
 				if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) {
-					return $this->_renderEscaped($tag_name, $context);
+					return $this->_renderEscaped($tag_name);
 				} else {
-					return $this->_renderUnescaped($tag_name, $context);
+					return $this->_renderUnescaped($tag_name);
 				}
 				break;
 			case '':
 			default:
 				if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) {
-					return $this->_renderUnescaped($tag_name, $context);
+					return $this->_renderUnescaped($tag_name);
 				} else {
-					return $this->_renderEscaped($tag_name, $context);
+					return $this->_renderEscaped($tag_name);
 				}
 				break;
 		}
@@ -384,11 +407,10 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $tag_name
-	 * @param array $context
 	 * @return string
 	 */
-	protected function _renderEscaped($tag_name, &$context) {
+	protected function _renderEscaped($tag_name) {
-		return htmlentities($this->_getVariable($tag_name, $context), null, $this->_charset);
+		return htmlentities($this->_getVariable($tag_name), null, $this->_charset);
 	}
 
 	/**
@@ -396,10 +418,9 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $tag_name
-	 * @param array $context
 	 * @return string
 	 */
-	protected function _renderComment($tag_name, &$context) {
+	protected function _renderComment($tag_name) {
 		return '';
 	}
 
@@ -408,11 +429,10 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $tag_name
-	 * @param array $context
 	 * @return string
 	 */
-	protected function _renderUnescaped($tag_name, &$context) {
+	protected function _renderUnescaped($tag_name) {
-		return $this->_getVariable($tag_name, $context);
+		return $this->_getVariable($tag_name);
 	}
 
 	/**
@@ -420,14 +440,11 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $tag_name
-	 * @param array $context
 	 * @return string
 	 */
-	protected function _renderPartial($tag_name, &$context) {
+	protected function _renderPartial($tag_name) {
-		$view = new self($this->_getPartial($tag_name), $this->_flattenContext($context), $this->_partials);
+		$view = clone($this);
-		$view->_otag = $this->_otag;
+		return $view->render($this->_getPartial($tag_name));
-		$view->_ctag = $this->_ctag;
-		return $view->render();
 	}
 
 	/**
@@ -436,10 +453,9 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $tag_name
-	 * @param array $context
 	 * @return string
 	 */
-	protected function _changeDelimiter($tag_name, &$context) {
+	protected function _changeDelimiter($tag_name) {
 		$tags = explode(' ', $tag_name);
 		$this->_otag = $tags[0];
 		$this->_ctag = $tags[1];
@@ -450,63 +466,38 @@ class Mustache {
 		return '';
 	}
 
-
 	/**
-	 * Prepare a new context reference array.
+	 * Push a local context onto the stack.
-	 *
-	 * This is used to create context arrays for iterable blocks.
 	 *
 	 * @access protected
-	 * @param array $context
 	 * @param array $local_context
 	 * @return array
 	 */
-	protected function _getContext(&$context, &$local_context) {
+	protected function _pushContext(&$local_context) {
-		$ret = array();
+		$new = array();
-		$ret[] =& $local_context;
+		$new[] =& $local_context;
-		foreach ($context as $view) {
+		foreach (array_keys($this->_context) as $key) {
-			$ret[] =& $view;
+			$new[] =& $this->_context[$key];
 		}
-		return $ret;
+		$this->_context = $new;
 	}
 
 
 	/**
-	 * Prepare a new (flattened) context.
+	 * Remove the latest context from the stack.
-	 *
-	 * This is used to create a view object or array for rendering partials.
 	 *
 	 * @access protected
-	 * @param array &$context
+	 * @return void
-	 * @return array
-	 * @throws MustacheException
 	 */
-	protected function _flattenContext(&$context) {
+	protected function _popContext() {
-		$keys = array_keys($context);
+		$new = array();
-		$first = $context[$keys[0]];
 
-		if ($first instanceof Mustache) {
+		$keys = array_keys($this->_context);
-			$ret = clone $first;
+		array_shift($keys);
-			unset($keys[0]);
+		foreach ($keys as $key) {
-
+			$new[] =& $this->_context[$key];
-			foreach ($keys as $name) {
-				foreach ($context[$name] as $key => $val) {
-					$ret->$key =& $val;
 		}
-			}
+		$this->_context = $new;
-		} else if (is_array($first)) {
-			$ret = array();
-
-			foreach ($keys as $name) {
-				foreach ($context[$name] as $key => $val) {
-					$ret[$key] =& $val;
-				}
-			}
-		} else {
-			throw new MustacheException('Unknown root context type.');
-		}
-
-		return $ret;
 	}
 
 	/**
@@ -520,16 +511,15 @@ class Mustache {
 	 *
 	 * @access protected
 	 * @param string $tag_name
-	 * @param array $context
 	 * @throws MustacheException Unknown variable name.
 	 * @return string
 	 */
-	protected function _getVariable($tag_name, &$context) {
+	protected function _getVariable($tag_name) {
 		if ($this->_hasPragma(self::PRAGMA_DOT_NOTATION)) {
 			$chunks = explode('.', $tag_name);
 			$first = array_shift($chunks);
 
-			$ret = $this->_findVariableInContext($first, $context);
+			$ret = $this->_findVariableInContext($first, $this->_context);
 			while ($next = array_shift($chunks)) {
 				// Slice off a chunk of context for dot notation traversal.
 				$c = array($ret);
@@ -537,7 +527,7 @@ class Mustache {
 			}
 			return $ret;
 		} else {
-			return $this->_findVariableInContext($tag_name, $context);
+			return $this->_findVariableInContext($tag_name, $this->_context);
 		}
 	}
 

README.markdown

@@ -81,8 +81,6 @@ And render it:
 Known Issues
 ------------
 
- * Pragmas don't un-apply... Instead of applying only to a specific template, pragmas are applied
-   to all subsequent templates and partials rendered by this Mustache instance.
  * Sections don't respect delimiter changes -- `delimiters` example currently fails with an
    "unclosed section" exception.
  * Test coverage is incomplete.

examples/partials_with_view_class/PartialsWithViewClass.php

@@ -0,0 +1,19 @@
+<?php
+
+class PartialsWithViewClass extends Mustache {
+	public function __construct($template = null, $view = null, $partials = null) {
+		// Use an object of an arbitrary class as a View for this Mustache instance:
+		$view = new StdClass();
+		$view->name = 'ilmich';
+		$view->data = array(
+			array('name' => 'federica', 'age' => 27, 'gender' => 'female'),
+			array('name' => 'marco', 'age' => 32, 'gender' => 'male'),
+		);
+
+		$partials = array(
+			'children' => "{{#data}}{{name}} - {{age}} - {{gender}}\n{{/data}}",
+		);
+
+		parent::__construct($template, $view, $partials);
+	}
+}

examples/partials_with_view_class/partials_with_view_class.mustache

@@ -0,0 +1,2 @@
+Children of {{name}}:
+{{>children}}

examples/partials_with_view_class/partials_with_view_class.txt

@@ -0,0 +1,3 @@
+Children of ilmich:
+federica - 27 - female
+marco - 32 - male

examples/pragmas_in_partials/PragmasInPartials.php

@@ -0,0 +1,8 @@
+<?php
+
+class PragmasInPartials extends Mustache {
+	public $say = '< RAWR!! >';
+	protected $_partials = array(
+		'dinosaur' => '{{say}}'
+	);
+}

examples/pragmas_in_partials/pragmas_in_partials.mustache

@@ -0,0 +1,3 @@
+{{%UNESCAPED}}
+{{say}}
+{{>dinosaur}}

examples/pragmas_in_partials/pragmas_in_partials.txt

@@ -0,0 +1,2 @@
+< RAWR!! >
+&lt; RAWR!! &gt;

examples/recursive_partials/RecursivePartials.php

@@ -0,0 +1,16 @@
+<?php
+
+class RecursivePartials extends Mustache {
+	protected $_partials = array(
+		'child' => " > {{ name }}{{#child}}{{>child}}{{/child}}",
+	);
+
+	public $name  = 'George';
+	public $child = array(
+		'name'  => 'Dan',
+		'child' => array(
+			'name'  => 'Justin',
+			'child' => false,
+		)
+	);
+}

examples/recursive_partials/recursive_partials.mustache

@@ -0,0 +1 @@
+{{name}}{{#child}}{{>child}}{{/child}}

examples/recursive_partials/recursive_partials.txt

@@ -0,0 +1 @@
+George > Dan > Justin

test/MustachePragmaTest.php

@@ -39,4 +39,10 @@ class MustachePragmaTest extends PHPUnit_Framework_TestCase {
 		$this->assertEquals("1\n23", $m->render("1\n2{{%DOT-NOTATION}}\n3"), 'Wrong newline removed with pragma tag');
 	}
 
+	public function testPragmaReset() {
+		$m = new Mustache('', array('symbol' => '>>>'));
+		$this->assertEquals('>>>', $m->render('{{{symbol}}}'));
+		$this->assertEquals('>>>', $m->render('{{%UNESCAPED}}{{symbol}}'));
+		$this->assertEquals('>>>', $m->render('{{{symbol}}}'));
+	}
 }

test/MustacheTest.php

@@ -184,6 +184,29 @@ class MustacheTest extends PHPUnit_Framework_TestCase {
 		$this->assertEquals('', $m2->render());
 	}
 
+	/**
+	 * testClone function.
+	 *
+	 * @dataProvider getExamples
+	 * @access public
+	 * @return void
+	 */
+	public function test__clone($class, $template, $output) {
+		$m = new $class;
+		$n = clone $m;
+
+		$n_output = $n->render($template);
+
+		$o = clone $n;
+
+		$this->assertEquals($m->render($template), $n_output);
+		$this->assertEquals($n_output, $o->render($template));
+
+		$this->assertNotSame($m, $n);
+		$this->assertNotSame($n, $o);
+		$this->assertNotSame($m, $o);
+	}
+
 	/**
 	 * Test everything in the `examples` directory.
 	 *