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

Merge branch 'release/0.2.2'

Browse Source
This commit is contained in:
Justin Hileman
2010-05-24 10:46:28 -04:00
parent 4b53c0d8e4 fd3dc292a3
commit 4f5d3fffaa
16 changed files with 273 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Mustache.php
+83 -93
View File
@@ -43,7 +43,7 @@ class Mustache {
* Pragmas apply only to the current template. Partials, even those included after the
* {{%UNESCAPED}} call, will need their own pragma declaration.
*
* his may be useful in non-HTML Mustache situations.
* This may be useful in non-HTML Mustache situations.
*/
const PRAGMA_UNESCAPED = 'UNESCAPED';
@@ -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,6 +123,7 @@ class Mustache {
$this->_context = array($this);
}
$template = $this->_renderPragmas($template);
return $this->_renderTemplate($template, $this->_context);
}
@@ -124,13 +149,11 @@ class Mustache {
*
* @access protected
* @param string $template
* @param array &$context
* @return string Rendered Mustache template.
*/
protected function _renderTemplate($template, &$context) {
$template = $this->_renderPragmas($template, $context);
$template = $this->_renderSection($template, $context);
return $this->_renderTags($template, $context);
protected function _renderTemplate($template) {
$template = $this->_renderSection($template);
return $this->_renderTags($template);
}
/**
@@ -138,13 +161,12 @@ 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 . '(\\^|\\#)(.+?)' . $ctag . '\\s*([\\s\\S]+?)' . $otag . '\\/\\2' . $ctag . '\\s*/m';
$regex = '/' . $otag . '(\\^|\\#)\\s*(.+?)\\s*' . $ctag . '\\s*([\\s\\S]+?)' . $otag . '\\/\\s*\\2\\s*' . $ctag . '\\s*/m';
$matches = array();
while (preg_match($regex, $template, $matches, PREG_OFFSET_CAPTURE)) {
@@ -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);
$replace .= $this->_renderTemplate($content, $c);
$this->_pushContext($local_context);
$replace .= $this->_renderTemplate($content);
$this->_popContext();
}
} else if ($val) {
if (is_array($val) || is_object($val)) {
$c = $this->_getContext($context, $val);
$replace .= $this->_renderTemplate($content, $c);
$this->_pushContext($val);
$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) {
return htmlentities($this->_getVariable($tag_name, $context), null, $this->_charset);
protected function _renderEscaped($tag_name) {
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) {
return $this->_getVariable($tag_name, $context);
protected function _renderUnescaped($tag_name) {
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) {
$view = new self($this->_getPartial($tag_name), $this->_flattenContext($context), $this->_partials);
$view->_otag = $this->_otag;
$view->_ctag = $this->_ctag;
return $view->render();
protected function _renderPartial($tag_name) {
$view = clone($this);
return $view->render($this->_getPartial($tag_name));
}
/**
@@ -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.
*
* This is used to create context arrays for iterable blocks.
* Push a local context onto the stack.
*
* @access protected
* @param array $context
* @param array $local_context
* @return array
*/
protected function _getContext(&$context, &$local_context) {
$ret = array();
$ret[] =& $local_context;
foreach ($context as $view) {
$ret[] =& $view;
protected function _pushContext(&$local_context) {
$new = array();
$new[] =& $local_context;
foreach (array_keys($this->_context) as $key) {
$new[] =& $this->_context[$key];
}
return $ret;
$this->_context = $new;
}
/**
* Prepare a new (flattened) context.
*
* This is used to create a view object or array for rendering partials.
* Remove the latest context from the stack.
*
* @access protected
* @param array &$context
* @return array
* @throws MustacheException
* @return void
*/
protected function _flattenContext(&$context) {
$keys = array_keys($context);
$first = $context[$keys[0]];
protected function _popContext() {
$new = array();
if ($first instanceof Mustache) {
$ret = clone $first;
unset($keys[0]);
foreach ($keys as $name) {
foreach ($context[$name] as $key => $val) {
$ret->$key =& $val;
}
}
} 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.');
$keys = array_keys($this->_context);
array_shift($keys);
foreach ($keys as $key) {
$new[] =& $this->_context[$key];
}
return $ret;
$this->_context = $new;
}
/**
@@ -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
-2
View File
@@ -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
+19
View File
@@ -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
+2
View File
@@ -0,0 +1,2 @@
Children of {{name}}:
{{>children}}
examples/partials_with_view_class/partials_with_view_class.txt
+3
View File
@@ -0,0 +1,3 @@
Children of ilmich:
federica - 27 - female
marco - 32 - male
examples/pragmas_in_partials/PragmasInPartials.php
+8
View File
@@ -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
+3
View File
@@ -0,0 +1,3 @@
{{%UNESCAPED}}
{{say}}
{{>dinosaur}}
examples/pragmas_in_partials/pragmas_in_partials.txt
+2
View File
@@ -0,0 +1,2 @@
< RAWR!! >
&lt; RAWR!! &gt;
examples/recursive_partials/RecursivePartials.php
+16
View File
@@ -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
+1
View File
@@ -0,0 +1 @@
{{name}}{{#child}}{{>child}}{{/child}}
examples/recursive_partials/recursive_partials.txt
+1
View File
@@ -0,0 +1 @@
George > Dan > Justin
examples/whitespace/Whitespace.php
+37
View File
@@ -0,0 +1,37 @@
<?php
/**
* Whitespace test for tag names.
*
* Per http://github.com/janl/mustache.js/issues/issue/34/#comment_244396
* tags should strip leading and trailing whitespace in key names.
*
* `{{> tag }}` and `{{> tag}}` and `{{>tag}}` should all be equivalent.
*
* @extends Mustache
*/
class Whitespace extends Mustache {
public $foo = 'alpha';
public $bar = 'beta';
public function baz() {
return 'gamma';
}
public function qux() {
return array(
array('key with space' => 'A'),
array('key with space' => 'B'),
array('key with space' => 'C'),
array('key with space' => 'D'),
array('key with space' => 'E'),
array('key with space' => 'F'),
array('key with space' => 'G'),
);
}
protected $_partials = array(
'alphabet' => " * {{.}}\n",
);
}
examples/whitespace/whitespace.mustache
+10
View File
@@ -0,0 +1,10 @@
{{^ inverted section test }}
These are some things:
{{/inverted section test }}
* {{ foo }}
* {{ bar}}
* {{ baz }}
{{# qux }}
* {{ key with space }}
{{/ qux }}
{{#qux}}.{{/qux}}
examples/whitespace/whitespace.txt
+12
View File
@@ -0,0 +1,12 @@
These are some things:
* alpha
* beta
* gamma
* A
* B
* C
* D
* E
* F
* G
.......
test/MustachePragmaTest.php
+6
View File
@@ -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
+70
View File
@@ -137,6 +137,76 @@ class MustacheTest extends PHPUnit_Framework_TestCase {
$this->assertEquals('Zappa, Frank', $m->render('{{last_name}}, {{first_name}}', array('first_name' => 'Frank', 'last_name' => 'Zappa')));
}
/**
* Mustache should return the same thing when invoked multiple times.
*
* @access public
* @return void
*/
public function testMultipleInvocations() {
$m = new Mustache('x');
$first = $m->render();
$second = $m->render();
$this->assertEquals('x', $first);
$this->assertEquals($first, $second);
}
/**
* Mustache should return the same thing when invoked multiple times.
*
* @access public
* @return void
*/
public function testMultipleInvocationsWithTags() {
$m = new Mustache('{{one}} {{two}}', array('one' => 'foo', 'two' => 'bar'));
$first = $m->render();
$second = $m->render();
$this->assertEquals('foo bar', $first);
$this->assertEquals($first, $second);
}
/**
* Mustache should not use templates passed to the render() method for subsequent invocations.
*
* @access public
* @return void
*/
public function testResetTemplateForMultipleInvocations() {
$m = new Mustache('Sirve.');
$m->render('No sirve.');
$this->assertEquals('Sirve.', $m->render());
$m2 = new Mustache();
$m2->render('No sirve.');
$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.
*