Merge branch 'release/0.2.6'

Mustache.php

@@ -33,8 +33,46 @@ class Mustache {
 	// Override charset passed to htmlentities() and htmlspecialchars(). Defaults to UTF-8.
 	protected $_charset = 'UTF-8';
 
+	/**
+	 * Pragmas are macro-like directives that, when invoked, change the behavior or
+	 * syntax of Mustache.
+	 *
+	 * They should be considered extremely experimental. Most likely their implementation
+	 * will change in the future.
+	 */
+
+	/**
+	 * The {{%DOT-NOTATION}} pragma allows context traversal via dots. Given the following context:
+	 *
+	 *     $context = array('foo' => array('bar' => array('baz' => 'qux')));
+	 *
+	 * One could access nested properties using dot notation:
+	 *
+	 *      {{%DOT-NOTATION}}{{foo.bar.baz}}
+	 *
+	 * Which would render as `qux`.
+	 */
 	const PRAGMA_DOT_NOTATION      = 'DOT-NOTATION';
 
+	/**
+	 * The {{%IMPLICIT-ITERATOR}} pragma allows access to non-associative array data in an
+	 * iterable section:
+	 *
+	 *     $context = array('items' => array('foo', 'bar', 'baz'));
+	 *
+	 * With this template:
+	 *
+	 *     {{%IMPLICIT-ITERATOR}}{{#items}}{{.}}{{/items}}
+	 *
+	 * Would render as `foobarbaz`.
+	 *
+	 * {{%IMPLICIT-ITERATOR}} accepts an optional 'iterator' argument which allows implicit
+	 * iterator tags other than {{.}} ...
+	 *
+	 *     {{%IMPLICIT-ITERATOR iterator=i}}{{#items}}{{i}}{{/items}}
+	 */
+	const PRAGMA_IMPLICIT_ITERATOR = 'IMPLICIT-ITERATOR';
+
 	/**
 	 * The {{%UNESCAPED}} pragma swaps the meaning of the {{normal}} and {{{unescaped}}}
 	 * Mustache tags. That is, once this pragma is activated the {{normal}} tag will not be
@@ -56,6 +94,7 @@ class Mustache {
 
 	protected $_pragmasImplemented = array(
 		self::PRAGMA_DOT_NOTATION,
+		self::PRAGMA_IMPLICIT_ITERATOR,
 		self::PRAGMA_UNESCAPED
 	);
 
@@ -189,8 +228,24 @@ class Mustache {
 				// regular section
 				case '#':
 					if ($this->_varIsIterable($val)) {
+						if ($this->_hasPragma(self::PRAGMA_IMPLICIT_ITERATOR)) {
+							if ($opt = $this->_getPragmaOptions(self::PRAGMA_IMPLICIT_ITERATOR)) {
+								$iterator = $opt['iterator'];
+							} else {
+								$iterator = '.';
+							}
+						} else {
+							$iterator = false;
+						}
+
 						foreach ($val as $local_context) {
+
+							if ($iterator) {
+								$iterator_context = array($iterator => $local_context);
+								$this->_pushContext($iterator_context);
+							} else {
 								$this->_pushContext($local_context);
+							}
 							$replace .= $this->_renderTemplate($content);
 							$this->_popContext();
 						}
@@ -291,11 +346,11 @@ class Mustache {
 	 * @throws MustacheException Unknown pragma
 	 */
 	protected function _getPragmaOptions($pragma_name) {
-		if (!$this->_hasPragma()) {
+		if (!$this->_hasPragma($pragma_name)) {
 			throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA);
 		}
 
-		return $this->_localPragmas[$pragma_name];
+		return (is_array($this->_localPragmas[$pragma_name])) ? $this->_localPragmas[$pragma_name] : array();
 	}
 
 
@@ -521,7 +576,7 @@ class Mustache {
 	 * @return string
 	 */
 	protected function _getVariable($tag_name) {
-		if ($this->_hasPragma(self::PRAGMA_DOT_NOTATION)) {
+		if ($this->_hasPragma(self::PRAGMA_DOT_NOTATION) && $tag_name != '.') {
 			$chunks = explode('.', $tag_name);
 			$first = array_shift($chunks);
 

examples/implicit_iterator/ImplicitIterator.php

@@ -0,0 +1,5 @@
+<?php
+
+class ImplicitIterator extends Mustache {
+	protected $data = array('Donkey Kong', 'Luigi', 'Mario', 'Peach', 'Yoshi');
+}

examples/implicit_iterator/implicit_iterator.mustache

@@ -0,0 +1,4 @@
+{{%IMPLICIT-ITERATOR}}
+{{#data}}
+* {{.}}
+{{/data}}

examples/implicit_iterator/implicit_iterator.txt

@@ -0,0 +1,5 @@
+* Donkey Kong
+* Luigi
+* Mario
+* Peach
+* Yoshi

examples/section_iterator_objects/SectionIteratorObjects.php

@@ -1,6 +1,6 @@
 <?php
 
-class SectionIteratorObject extends Mustache {
+class SectionIteratorObjects extends Mustache {
 	public $start = "It worked the first time.";
 
 	public function middle() {

examples/section_magic_objects/SectionMagicObjects.php

@@ -1,6 +1,6 @@
 <?php
 
-class SectionMagicObject extends Mustache {
+class SectionMagicObjects extends Mustache {
 	public $start = "It worked the first time.";
 
 	public function middle() {

test/MustachePragmaImplicitIteratorTest.php

@@ -0,0 +1,51 @@
+<?php
+
+require_once '../Mustache.php';
+require_once 'PHPUnit/Framework.php';
+
+class MustachePragmaImplicitIteratorTest extends PHPUnit_Framework_TestCase {
+
+	public function testEnablePragma() {
+		$m = $this->getMock('Mustache', array('_renderPragma'), array('{{%IMPLICIT-ITERATOR}}'));
+		$m->expects($this->exactly(1))
+			->method('_renderPragma')
+			->with(array('{{%IMPLICIT-ITERATOR}}', 'IMPLICIT-ITERATOR', null));
+		$m->render();
+	}
+
+	public function testImplicitIterator() {
+		$m1 = new Mustache('{{%IMPLICIT-ITERATOR}}{{#items}}{{.}}{{/items}}', array('items' => array('a', 'b', 'c')));
+		$this->assertEquals('abc', $m1->render());
+
+		$m2 = new Mustache('{{%IMPLICIT-ITERATOR}}{{#items}}{{.}}{{/items}}', array('items' => array(1, 2, 3)));
+		$this->assertEquals('123', $m2->render());
+	}
+
+	public function testDotNotationCollision() {
+		$m = new Mustache(null, array('items' => array('foo', 'bar', 'baz')));
+
+		$this->assertEquals('foobarbaz', $m->render('{{%IMPLICIT-ITERATOR}}{{%DOT-NOTATION}}{{#items}}{{.}}{{/items}}'));
+		$this->assertEquals('foobarbaz', $m->render('{{%DOT-NOTATION}}{{%IMPLICIT-ITERATOR}}{{#items}}{{.}}{{/items}}'));
+	}
+
+	public function testCustomIterator() {
+		$m = new Mustache(null, array('items' => array('foo', 'bar', 'baz')));
+
+		$this->assertEquals('foobarbaz', $m->render('{{%IMPLICIT-ITERATOR}}{{#items}}{{.}}{{/items}}'));
+		$this->assertEquals('foobarbaz', $m->render('{{%IMPLICIT-ITERATOR iterator=i}}{{#items}}{{i}}{{/items}}'));
+		$this->assertEquals('foobarbaz', $m->render('{{%IMPLICIT-ITERATOR iterator=items}}{{#items}}{{items}}{{/items}}'));
+	}
+
+	public function testDotNotationContext() {
+		$m = new Mustache(null, array('items' => array(
+			array('index' => 1, 'name' => 'foo'),
+			array('index' => 2, 'name' => 'bar'),
+			array('index' => 3, 'name' => 'baz'),
+		)));
+
+		$this->assertEquals('foobarbaz', $m->render('{{%IMPLICIT-ITERATOR}}{{#items}}{{#.}}{{name}}{{/.}}{{/items}}'));
+		$this->assertEquals('123', $m->render('{{%IMPLICIT-ITERATOR iterator=i}}{{%DOT-NOTATION}}{{#items}}{{i.index}}{{/items}}'));
+		$this->assertEquals('foobarbaz', $m->render('{{%IMPLICIT-ITERATOR iterator=i}}{{%DOT-NOTATION}}{{#items}}{{i.name}}{{/items}}'));
+	}
+
+}