Framework/Mustache
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'release/0.6.0'

Browse Source
This commit is contained in:
Justin Hileman
2011-06-12 23:08:26 -04:00
parent 27bed8f10a 49b500f789
commit 9c16a83e53
10 changed files with 139 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Mustache.php
+57 -55
View File
@@ -38,38 +38,6 @@ class Mustache {
* will change in the future. * 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}}} * 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 * Mustache tags. That is, once this pragma is activated the {{normal}} tag will not be
@@ -88,8 +56,8 @@ class Mustache {
const SECTION_TYPES = '\^#\/'; const SECTION_TYPES = '\^#\/';
const TAG_TYPES = '#\^\/=!<>\\{&'; const TAG_TYPES = '#\^\/=!<>\\{&';
public $_otag = '{{'; protected $_otag = '{{';
public $_ctag = '}}'; protected $_ctag = '}}';
protected $_tagRegEx; protected $_tagRegEx;
@@ -99,8 +67,6 @@ class Mustache {
protected $_pragmas = array(); protected $_pragmas = array();
protected $_pragmasImplemented = array( protected $_pragmasImplemented = array(
self::PRAGMA_DOT_NOTATION,
self::PRAGMA_IMPLICIT_ITERATOR,
self::PRAGMA_UNESCAPED self::PRAGMA_UNESCAPED
); );
@@ -112,16 +78,64 @@ class Mustache {
* This method accepts a $template string and a $view object. Optionally, pass an associative * This method accepts a $template string and a $view object. Optionally, pass an associative
* array of partials as well. * array of partials as well.
* *
* Passing an $options array allows overriding certain Mustache options during instantiation:
*
* $options = array(
* // `charset` -- must be supported by `htmlspecialentities()`. defaults to 'UTF-8'
* 'charset' => 'ISO-8859-1',
*
* // opening and closing delimiters, as an array or a space-separated string
* 'delimiters' => '<% %>',
*
* // an array of pragmas to enable
* 'pragmas' => array(
* Mustache::PRAGMA_UNESCAPED
* ),
* );
*
* @access public * @access public
* @param string $template (default: null) * @param string $template (default: null)
* @param mixed $view (default: null) * @param mixed $view (default: null)
* @param array $partials (default: null) * @param array $partials (default: null)
* @param array $options (default: array())
* @return void * @return void
*/ */
public function __construct($template = null, $view = null, $partials = null) { public function __construct($template = null, $view = null, $partials = null, array $options = null) {
if ($template !== null) $this->_template = $template; if ($template !== null) $this->_template = $template;
if ($partials !== null) $this->_partials = $partials; if ($partials !== null) $this->_partials = $partials;
if ($view !== null) $this->_context = array($view); if ($view !== null) $this->_context = array($view);
if ($options !== null) $this->_setOptions($options);
}
/**
* Helper function for setting options from constructor args.
*
* @access protected
* @param array $options
* @return void
*/
protected function _setOptions(array $options) {
if (isset($options['charset'])) {
$this->_charset = $options['charset'];
}
if (isset($options['delimiters'])) {
$delims = $options['delimiters'];
if (!is_array($delims)) {
$delims = array_map('trim', explode(' ', $delims, 2));
}
$this->_otag = $delims[0];
$this->_ctag = $delims[1];
}
if (isset($options['pragmas'])) {
foreach ($options['pragmas'] as $pragma_name) {
if (!in_array($pragma_name, $this->_pragmasImplemented)) {
throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA);
}
}
$this->_pragmas = $options['pragmas'];
}
} }
/** /**
@@ -225,24 +239,8 @@ class Mustache {
// regular section // regular section
case '#': case '#':
if ($this->_varIsIterable($val)) { 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) { foreach ($val as $local_context) {
if ($iterator) {
$iterator_context = array($iterator => $local_context);
$this->_pushContext($iterator_context);
} else {
$this->_pushContext($local_context); $this->_pushContext($local_context);
}
$replace .= $this->_renderTemplate($content); $replace .= $this->_renderTemplate($content);
$this->_popContext(); $this->_popContext();
} }
@@ -616,7 +614,9 @@ class Mustache {
protected function _renderPartial($tag_name, $whitespace = '') { protected function _renderPartial($tag_name, $whitespace = '') {
$view = clone($this); $view = clone($this);
return $whitespace . preg_replace('/\n(?!$)/s', "\n" . $whitespace, $view->render($this->_getPartial($tag_name))); $partial = $whitespace . preg_replace('/\n(?!$)/s', "\n" . $whitespace, $this->_getPartial($tag_name));
return $view->render($partial);
} }
/** /**
@@ -685,7 +685,9 @@ class Mustache {
* @return string * @return string
*/ */
protected function _getVariable($tag_name) { protected function _getVariable($tag_name) {
if ($tag_name != '.' && strpos($tag_name, '.') !== false && $this->_hasPragma(self::PRAGMA_DOT_NOTATION)) { if ($tag_name === '.') {
return $this->_context[0];
} else if (strpos($tag_name, '.') !== false) {
$chunks = explode('.', $tag_name); $chunks = explode('.', $tag_name);
$first = array_shift($chunks); $first = array_shift($chunks);
README.markdown
+2
View File
@@ -83,6 +83,8 @@ Known Issues
* Things get weird when you change delimiters inside a section -- `delimiters` example currently fails with an * Things get weird when you change delimiters inside a section -- `delimiters` example currently fails with an
"unclosed section" exception. "unclosed section" exception.
* The current spec test exposes several whitespace bugs (which are mostly instances of the exact same whitespace
bug) ... Despite these failing tests, this version is actually *closer* to correct than previous releases.
See Also See Also
examples/dot_notation/dot_notation.mustache
-1
View File
@@ -1,4 +1,3 @@
{{%DOT-NOTATION}}
* {{person.name.first}} {{person.name.last}} * {{person.name.first}} {{person.name.last}}
* {{person.age}} * {{person.age}}
* {{person.hometown.city}}, {{person.hometown.state}} * {{person.hometown.city}}, {{person.hometown.state}}
examples/implicit_iterator/implicit_iterator.mustache
-1
View File
@@ -1,4 +1,3 @@
{{%IMPLICIT-ITERATOR}}
{{#data}} {{#data}}
* {{.}} * {{.}}
{{/data}} {{/data}}
test/MustachePragmaDotNotationTest.php
-63
View File
@@ -1,63 +0,0 @@
<?php
require_once '../Mustache.php';
/**
* @group pragmas
*/
class MustachePragmaDotNotationTest extends PHPUnit_Framework_TestCase {
public function testDotTraversal() {
$m = new Mustache('', array('foo' => array('bar' => 'this worked')));
$this->assertEquals($m->render('{{foo.bar}}'), '',
'Dot notation not enabled, variable should have been replaced with nothing');
$this->assertEquals($m->render('{{%DOT-NOTATION}}{{foo.bar}}'), 'this worked',
'Dot notation enabled, variable should have been replaced by "this worked"');
}
public function testDeepTraversal() {
$data = array(
'foo' => array('bar' => array('baz' => array('qux' => array('quux' => 'WIN!')))),
'a' => array('b' => array('c' => array('d' => array('e' => 'abcs')))),
'one' => array(
'one' => 'one-one',
'two' => 'one-two',
'three' => 'one-three',
),
);
$m = new Mustache('', $data);
$this->assertEquals($m->render('{{%DOT-NOTATION}}{{foo.bar.baz.qux.quux}}'), 'WIN!');
$this->assertEquals($m->render('{{%DOT-NOTATION}}{{a.b.c.d.e}}'), 'abcs');
$this->assertEquals($m->render('{{%DOT-NOTATION}}{{one.one}}|{{one.two}}|{{one.three}}'), 'one-one|one-two|one-three');
}
public function testDotNotationContext() {
$data = array('parent' => array('items' => array(
array('item' => array('index' => 1)),
array('item' => array('index' => 2)),
array('item' => array('index' => 3)),
array('item' => array('index' => 4)),
array('item' => array('index' => 5)),
)));
$m = new Mustache('', $data);
$this->assertEquals('12345', $m->render('{{%DOT-NOTATION}}{{#parent}}{{#items}}{{item.index}}{{/items}}{{/parent}}'));
}
public function testDotNotationSectionNames() {
$data = array('parent' => array('items' => array(
array('item' => array('index' => 1)),
array('item' => array('index' => 2)),
array('item' => array('index' => 3)),
array('item' => array('index' => 4)),
array('item' => array('index' => 5)),
)));
$m = new Mustache('', $data);
$this->assertEquals('.....', $m->render('{{%DOT-NOTATION}}{{#parent.items}}.{{/parent.items}}'));
$this->assertEquals('12345', $m->render('{{%DOT-NOTATION}}{{#parent.items}}{{item.index}}{{/parent.items}}'));
$this->assertEquals('12345', $m->render('{{%DOT-NOTATION}}{{#parent.items}}{{#item}}{{index}}{{/item}}{{/parent.items}}'));
}
}
test/MustachePragmaImplicitIteratorTest.php
-87
View File
@@ -1,87 +0,0 @@
<?php
require_once '../Mustache.php';
/**
* @group pragmas
*/
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(
0 => '{{%IMPLICIT-ITERATOR}}',
1 => 'IMPLICIT-ITERATOR', 'pragma_name' => 'IMPLICIT-ITERATOR',
2 => null, 'options_string' => 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}}'));
}
/**
* @dataProvider recursiveSectionData
*/
public function testRecursiveSections($template, $view, $result) {
$m = new Mustache();
$this->assertEquals($result, $m->render($template, $view));
}
public function recursiveSectionData() {
return array(
array(
'{{%IMPLICIT-ITERATOR}}{{#items}}{{#.}}{{.}}{{/.}}{{/items}}',
array('items' => array(array('a', 'b', 'c'), array('d', 'e', 'f'))),
'abcdef'
),
array(
'{{%IMPLICIT-ITERATOR}}{{#items}}{{#.}}{{#.}}{{.}}{{/.}}{{/.}}{{/items}}',
array('items' => array(array(array('a', 'b'), array('c')), array(array('d'), array('e', 'f')))),
'abcdef'
),
array(
'{{%IMPLICIT-ITERATOR}}{{#items}}{{#.}}{{#items}}{{.}}{{/items}}{{/.}}{{/items}}',
array('items' => array(
array('items' => array('a', 'b', 'c')),
array('items' => array('d', 'e', 'f')),
)),
'abcdef'
),
);
}
}
test/MustachePragmaTest.php
+8 -8
View File
@@ -22,23 +22,23 @@ class MustachePragmaTest extends PHPUnit_Framework_TestCase {
public function testPragmaReplace() { public function testPragmaReplace() {
$m = new Mustache(); $m = new Mustache();
$this->assertEquals('', $m->render('{{%DOT-NOTATION}}'), 'Pragma tag not removed'); $this->assertEquals('', $m->render('{{%UNESCAPED}}'), 'Pragma tag not removed');
} }
public function testPragmaReplaceMultiple() { public function testPragmaReplaceMultiple() {
$m = new Mustache(); $m = new Mustache();
$this->assertEquals('', $m->render('{{% DOT-NOTATION }}'), 'Pragmas should allow whitespace'); $this->assertEquals('', $m->render('{{% UNESCAPED }}'), 'Pragmas should allow whitespace');
$this->assertEquals('', $m->render('{{% DOT-NOTATION foo=bar }}'), 'Pragmas should allow whitespace'); $this->assertEquals('', $m->render('{{% UNESCAPED foo=bar }}'), 'Pragmas should allow whitespace');
$this->assertEquals('', $m->render("{{%DOT-NOTATION}}\n{{%DOT-NOTATION}}"), 'Multiple pragma tags not removed'); $this->assertEquals('', $m->render("{{%UNESCAPED}}\n{{%UNESCAPED}}"), 'Multiple pragma tags not removed');
$this->assertEquals(' ', $m->render('{{%DOT-NOTATION}} {{%DOT-NOTATION}}'), 'Multiple pragma tags not removed'); $this->assertEquals(' ', $m->render('{{%UNESCAPED}} {{%UNESCAPED}}'), 'Multiple pragma tags not removed');
} }
public function testPragmaReplaceNewline() { public function testPragmaReplaceNewline() {
$m = new Mustache(); $m = new Mustache();
$this->assertEquals('', $m->render("{{%DOT-NOTATION}}\n"), 'Trailing newline after pragma tag not removed'); $this->assertEquals('', $m->render("{{%UNESCAPED}}\n"), 'Trailing newline after pragma tag not removed');
$this->assertEquals("\n", $m->render("\n{{%DOT-NOTATION}}\n"), 'Too many newlines removed with pragma tag'); $this->assertEquals("\n", $m->render("\n{{%UNESCAPED}}\n"), 'Too many newlines removed with pragma tag');
$this->assertEquals("1\n23", $m->render("1\n2{{%DOT-NOTATION}}\n3"), 'Wrong newline removed with pragma tag'); $this->assertEquals("1\n23", $m->render("1\n2{{%UNESCAPED}}\n3"), 'Wrong newline removed with pragma tag');
} }
public function testPragmaReset() { public function testPragmaReset() {
test/MustacheSpecTest.php
+8 -8
View File
@@ -25,7 +25,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
* @group comments * @group comments
* @dataProvider loadCommentSpec * @dataProvider loadCommentSpec
*/ */
public function testCommentSpec($template, $data, $partials, $expected, $desc) { public function testCommentSpec($desc, $template, $data, $partials, $expected) {
$m = new Mustache($template, $data, $partials); $m = new Mustache($template, $data, $partials);
$this->assertEquals($expected, $m->render(), $desc); $this->assertEquals($expected, $m->render(), $desc);
} }
@@ -34,7 +34,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
* @group delimiters * @group delimiters
* @dataProvider loadDelimitersSpec * @dataProvider loadDelimitersSpec
*/ */
public function testDelimitersSpec($template, $data, $partials, $expected, $desc) { public function testDelimitersSpec($desc, $template, $data, $partials, $expected) {
$m = new Mustache($template, $data, $partials); $m = new Mustache($template, $data, $partials);
$this->assertEquals($expected, $m->render(), $desc); $this->assertEquals($expected, $m->render(), $desc);
} }
@@ -43,7 +43,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
* @group interpolation * @group interpolation
* @dataProvider loadInterpolationSpec * @dataProvider loadInterpolationSpec
*/ */
public function testInterpolationSpec($template, $data, $partials, $expected, $desc) { public function testInterpolationSpec($desc, $template, $data, $partials, $expected) {
$m = new Mustache($template, $data, $partials); $m = new Mustache($template, $data, $partials);
$this->assertEquals($expected, $m->render(), $desc); $this->assertEquals($expected, $m->render(), $desc);
} }
@@ -52,7 +52,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
* @group inverted-sections * @group inverted-sections
* @dataProvider loadInvertedSpec * @dataProvider loadInvertedSpec
*/ */
public function testInvertedSpec($template, $data, $partials, $expected, $desc) { public function testInvertedSpec($desc, $template, $data, $partials, $expected) {
$m = new Mustache($template, $data, $partials); $m = new Mustache($template, $data, $partials);
$this->assertEquals($expected, $m->render(), $desc); $this->assertEquals($expected, $m->render(), $desc);
} }
@@ -61,7 +61,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
// * @group lambdas // * @group lambdas
// * @dataProvider loadLambdasSpec // * @dataProvider loadLambdasSpec
// */ // */
// public function testLambdasSpec($template, $data, $partials, $expected, $desc) { // public function testLambdasSpec($desc, $template, $data, $partials, $expected) {
// $this->markTestSkipped("Lambdas for PHP haven't made it into the spec yet, so we'll skip them to avoid a bajillion failed tests."); // $this->markTestSkipped("Lambdas for PHP haven't made it into the spec yet, so we'll skip them to avoid a bajillion failed tests.");
// //
// if (!version_compare(PHP_VERSION, '5.3.0', '>=')) { // if (!version_compare(PHP_VERSION, '5.3.0', '>=')) {
@@ -76,7 +76,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
* @group partials * @group partials
* @dataProvider loadPartialsSpec * @dataProvider loadPartialsSpec
*/ */
public function testPartialsSpec($template, $data, $partials, $expected, $desc) { public function testPartialsSpec($desc, $template, $data, $partials, $expected) {
$m = new Mustache($template, $data, $partials); $m = new Mustache($template, $data, $partials);
$this->assertEquals($expected, $m->render(), $desc); $this->assertEquals($expected, $m->render(), $desc);
} }
@@ -85,7 +85,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
* @group sections * @group sections
* @dataProvider loadSectionsSpec * @dataProvider loadSectionsSpec
*/ */
public function testSectionsSpec($template, $data, $partials, $expected, $desc) { public function testSectionsSpec($desc, $template, $data, $partials, $expected) {
$m = new Mustache($template, $data, $partials); $m = new Mustache($template, $data, $partials);
$this->assertEquals($expected, $m->render(), $desc); $this->assertEquals($expected, $m->render(), $desc);
} }
@@ -138,7 +138,7 @@ class MustacheSpecTest extends PHPUnit_Framework_TestCase {
$spec = $yaml->parse(file_get_contents($filename)); $spec = $yaml->parse(file_get_contents($filename));
foreach ($spec['tests'] as $test) { foreach ($spec['tests'] as $test) {
$data[] = array($test['template'], $test['data'], isset($test['partials']) ? $test['partials'] : array(), $test['expected'], $test['desc']); $data[] = array($test['name'] . ': ' . $test['desc'], $test['template'], $test['data'], isset($test['partials']) ? $test['partials'] : array(), $test['expected']);
} }
return $data; return $data;
} }
test/MustacheTest.php
+60
View File
@@ -72,6 +72,54 @@ class MustacheTest extends PHPUnit_Framework_TestCase {
$this->assertEquals($output, $m4->render($template)); $this->assertEquals($output, $m4->render($template));
} }
/**
* @dataProvider constructorOptions
*/
public function testConstructorOptions($options, $charset, $delimiters, $pragmas) {
$mustache = new MustacheExposedOptionsStub(null, null, null, $options);
$this->assertEquals($charset, $mustache->getCharset());
$this->assertEquals($delimiters, $mustache->getDelimiters());
$this->assertEquals($pragmas, $mustache->getPragmas());
}
public function constructorOptions() {
return array(
array(
array(),
'UTF-8',
array('{{', '}}'),
array(),
),
array(
array(
'charset' => 'UTF-8',
'delimiters' => '<< >>',
'pragmas' => array(Mustache::PRAGMA_UNESCAPED)
),
'UTF-8',
array('<<', '>>'),
array(Mustache::PRAGMA_UNESCAPED),
),
array(
array(
'charset' => 'cp866',
'delimiters' => array('[[[[', ']]]]'),
'pragmas' => array(Mustache::PRAGMA_UNESCAPED)
),
'cp866',
array('[[[[', ']]]]'),
array(Mustache::PRAGMA_UNESCAPED),
),
);
}
/**
* @expectedException MustacheException
*/
public function testConstructorInvalidPragmaOptionsThrowExceptions() {
$mustache = new Mustache(null, null, null, array('pragmas' => array('banana phone')));
}
/** /**
* Test __toString() function. * Test __toString() function.
* *
@@ -367,3 +415,15 @@ class MustacheTest extends PHPUnit_Framework_TestCase {
$this->assertEquals('{{win}}', $m->render()); $this->assertEquals('{{win}}', $m->render());
} }
} }
class MustacheExposedOptionsStub extends Mustache {
public function getPragmas() {
return $this->_pragmas;
}
public function getCharset() {
return $this->_charset;
}
public function getDelimiters() {
return array($this->_otag, $this->_ctag);
}
}
test/spec
+1 -1
Submodule test/spec updated: 2d9859f72c...3383fa66e8