From 9b8454f2ba0a0628af8d3ae1d39fb955856aa916 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Mon, 26 Apr 2010 22:38:33 -0400 Subject: [PATCH 01/13] Simplified tag RegEx. Fixed bug preventing section modifiers inside comments. --- Mustache.php | 5 +++-- examples/comments/comments.mustache | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Mustache.php b/Mustache.php index e1f69cd..48b4e1b 100644 --- a/Mustache.php +++ b/Mustache.php @@ -177,7 +177,7 @@ class Mustache { $otag = $this->prepareRegEx($this->otag); $ctag = $this->prepareRegEx($this->ctag); - $this->tagRegEx = '/' . $otag . "(#|\/|=|!|>|\\{|&)?([^\/#]+?)\\1?" . $ctag . "+/"; + $this->tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; $html = ''; $matches = array(); while (preg_match($this->tagRegEx, $template, $matches, PREG_OFFSET_CAPTURE)) { @@ -210,6 +210,7 @@ class Mustache { protected function renderTag($modifier, $tag_name, &$context) { switch ($modifier) { case '#': + case '^': if ($this->throwSectionExceptions) { throw new MustacheException('Unclosed section: ' . $tag_name, MustacheException::UNCLOSED_SECTION); } else { @@ -310,7 +311,7 @@ class Mustache { $otag = $this->prepareRegEx($this->otag); $ctag = $this->prepareRegEx($this->ctag); - $this->tagRegEx = '/' . $otag . "(#|\/|=|!|>|\\{|&)?([^\/#\^]+?)\\1?" . $ctag . "+/"; + $this->tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; return ''; } diff --git a/examples/comments/comments.mustache b/examples/comments/comments.mustache index b6feac8..846e449 100644 --- a/examples/comments/comments.mustache +++ b/examples/comments/comments.mustache @@ -1 +1 @@ -

{{title}}{{! just something interesting... or not... }}

\ No newline at end of file +

{{title}}{{! just something interesting... #or ^not... }}

\ No newline at end of file From 69a514916cc3b1f1780da633d4a2b749004913c5 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Mon, 26 Apr 2010 23:19:20 -0400 Subject: [PATCH 02/13] Updated section short-circuit logic to actually run when only inverted sections exist. --- Mustache.php | 2 +- examples/inverted_double_section/InvertedDoubleSection.php | 6 ++++++ .../inverted_double_section.mustache | 7 +++++++ .../inverted_double_section/inverted_double_section.txt | 3 +++ 4 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 examples/inverted_double_section/InvertedDoubleSection.php create mode 100644 examples/inverted_double_section/inverted_double_section.mustache create mode 100644 examples/inverted_double_section/inverted_double_section.txt diff --git a/Mustache.php b/Mustache.php index 48b4e1b..01f16ee 100644 --- a/Mustache.php +++ b/Mustache.php @@ -114,7 +114,7 @@ class Mustache { * @return string */ protected function renderSection($template, &$context) { - if (strpos($template, $this->otag . '#') === false) { + if (strpos($template, $this->otag . '#') === false && strpos($template, $this->otag . '^') === false) { return $template; } diff --git a/examples/inverted_double_section/InvertedDoubleSection.php b/examples/inverted_double_section/InvertedDoubleSection.php new file mode 100644 index 0000000..3dc2231 --- /dev/null +++ b/examples/inverted_double_section/InvertedDoubleSection.php @@ -0,0 +1,6 @@ + Date: Mon, 26 Apr 2010 23:27:21 -0400 Subject: [PATCH 03/13] Removing renderSection short-circuit, as it doesn't actually improve performance. --- Mustache.php | 4 ---- 1 file changed, 4 deletions(-) diff --git a/Mustache.php b/Mustache.php index 01f16ee..8754c68 100644 --- a/Mustache.php +++ b/Mustache.php @@ -114,10 +114,6 @@ class Mustache { * @return string */ protected function renderSection($template, &$context) { - if (strpos($template, $this->otag . '#') === false && strpos($template, $this->otag . '^') === false) { - return $template; - } - $otag = $this->prepareRegEx($this->otag); $ctag = $this->prepareRegEx($this->ctag); $regex = '/' . $otag . '(\\^|\\#)(.+?)' . $ctag . '\\s*([\\s\\S]+?)' . $otag . '\\/\\2' . $ctag . '\\s*/m'; From a9ea1db32284e53d537e52a7d679806afc878a56 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Thu, 29 Apr 2010 21:24:03 -0400 Subject: [PATCH 04/13] Added unit tests for constuctor and render() methods. --- test/MustacheTest.php | 69 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/test/MustacheTest.php b/test/MustacheTest.php index b6a6384..bf5c5c9 100644 --- a/test/MustacheTest.php +++ b/test/MustacheTest.php @@ -34,6 +34,40 @@ require_once 'PHPUnit/Framework.php'; */ class MustacheTest extends PHPUnit_Framework_TestCase { + + /** + * Test Mustache constructor. + * + * @access public + * @return void + */ + public function test__construct() { + $template = '{{#mustaches}}{{#last}}and {{/last}}{{type}}{{^last}}, {{/last}}{{/mustaches}}'; + $data = array( + 'mustaches' => array( + array('type' => 'Natural'), + array('type' => 'Hungarian'), + array('type' => 'Dali'), + array('type' => 'English'), + array('type' => 'Imperial'), + array('type' => 'Freestyle', 'last' => 'true'), + ) + ); + $output = 'Natural, Hungarian, Dali, English, Imperial, and Freestyle'; + + $m1 = new Mustache(); + $this->assertEquals($output, $m1->render($template, $data)); + + $m2 = new Mustache($template); + $this->assertEquals($output, $m2->render(null, $data)); + + $m3 = new Mustache($template, $data); + $this->assertEquals($output, $m3->render()); + + $m4 = new Mustache(null, $data); + $this->assertEquals($output, $m4->render($template)); + } + /** * Test everything in the `examples` directory. * @@ -50,6 +84,41 @@ class MustacheTest extends PHPUnit_Framework_TestCase { } + /** + * Test render(). + * + * @access public + * @return void + */ + public function testRender() { + $m = new Mustache(); + + $this->assertEquals('', $m->render('')); + $this->assertEquals('foo', $m->render('foo')); + $this->assertEquals('', $m->render(null)); + + $m2 = new Mustache('foo'); + $this->assertEquals('foo', $m2->render()); + + $m3 = new Mustache(''); + $this->assertEquals('', $m3->render()); + + $m3 = new Mustache(); + $this->assertEquals('', $m3->render(null)); + } + + /** + * Test render() with data. + * + * @access public + * @return void + */ + public function testRenderWithData() { + $m = new Mustache('{{first_name}} {{last_name}}'); + $this->assertEquals('Charlie Chaplin', $m->render(null, array('first_name' => 'Charlie', 'last_name' => 'Chaplin'))); + $this->assertEquals('Zappa, Frank', $m->render('{{last_name}}, {{first_name}}', array('first_name' => 'Frank', 'last_name' => 'Zappa'))); + } + /** * Data provider for testExamples method. * From 4d40070c6900ade3e57c4200fcb8cb162b5ca192 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Thu, 29 Apr 2010 21:35:41 -0400 Subject: [PATCH 05/13] Added __toString() test. --- test/MustacheTest.php | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/test/MustacheTest.php b/test/MustacheTest.php index bf5c5c9..f43a49a 100644 --- a/test/MustacheTest.php +++ b/test/MustacheTest.php @@ -68,21 +68,19 @@ class MustacheTest extends PHPUnit_Framework_TestCase { $this->assertEquals($output, $m4->render($template)); } + /** - * Test everything in the `examples` directory. + * Test __toString() function. * - * @dataProvider getExamples * @access public - * @param mixed $class - * @param mixed $template - * @param mixed $output * @return void */ - public function testExamples($class, $template, $output) { - $m = new $class; - $this->assertEquals($output, $m->render($template)); - } + public function test__toString() { + $m = new Mustache('{{first_name}} {{last_name}}', array('first_name' => 'Karl', 'last_name' => 'Marx')); + $this->assertEquals('Karl Marx', $m->__toString()); + $this->assertEquals('Karl Marx', (string) $m); + } /** * Test render(). @@ -119,6 +117,21 @@ class MustacheTest extends PHPUnit_Framework_TestCase { $this->assertEquals('Zappa, Frank', $m->render('{{last_name}}, {{first_name}}', array('first_name' => 'Frank', 'last_name' => 'Zappa'))); } + /** + * Test everything in the `examples` directory. + * + * @dataProvider getExamples + * @access public + * @param mixed $class + * @param mixed $template + * @param mixed $output + * @return void + */ + public function testExamples($class, $template, $output) { + $m = new $class; + $this->assertEquals($output, $m->render($template)); + } + /** * Data provider for testExamples method. * From f68335c845bac2bf46e99410db81ab27f5d78193 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Thu, 29 Apr 2010 21:39:50 -0400 Subject: [PATCH 06/13] Return false instead of null in hasPragma. Added documentation for pragma methods. --- Mustache.php | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/Mustache.php b/Mustache.php index 0d06f22..ee5dffb 100644 --- a/Mustache.php +++ b/Mustache.php @@ -98,7 +98,6 @@ class Mustache { } } - /** * Internal render function, used for recursive calls. * @@ -220,12 +219,29 @@ class Mustache { return ''; } + /** + * Check whether this Mustache has a specific pragma. + * + * @access protected + * @param string $pragma_name + * @return bool + */ protected function hasPragma($pragma_name) { if (array_key_exists($pragma_name, $this->pragmas) && $this->pragmas[$pragma_name]) { return true; + } else { + return false; } } + /** + * Return pragma options, if any. + * + * @access protected + * @param string $pragma_name + * @return mixed + * @throws MustacheException Unknown pragma + */ protected function getPragmaOptions($pragma_name) { if (!$this->hasPragma()) { throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA); From cbfef47de03ea3e178f4878f052a8e8650aba219 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Thu, 29 Apr 2010 23:50:41 -0400 Subject: [PATCH 07/13] Fixed assert param order in pragma test suite. --- test/MustachePragmaTest.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/test/MustachePragmaTest.php b/test/MustachePragmaTest.php index db21269..9ef8864 100644 --- a/test/MustachePragmaTest.php +++ b/test/MustachePragmaTest.php @@ -20,20 +20,20 @@ class MustachePragmaTest extends PHPUnit_Framework_TestCase { public function testPragmaReplace() { $m = new Mustache(); - $this->assertEquals($m->render('{{%DOT-NOTATION}}'), '', 'Pragma tag not removed'); + $this->assertEquals('', $m->render('{{%DOT-NOTATION}}'), 'Pragma tag not removed'); } public function testPragmaReplaceMultiple() { $m = new Mustache(); - $this->assertEquals($m->render("{{%DOT-NOTATION}}\n{{%DOT-NOTATION}}"), '', 'Multiple pragma tags not removed'); - $this->assertEquals($m->render('{{%DOT-NOTATION}} {{%DOT-NOTATION}}'), ' ', 'Multiple pragma tags not removed'); + $this->assertEquals('', $m->render("{{%DOT-NOTATION}}\n{{%DOT-NOTATION}}"), 'Multiple pragma tags not removed'); + $this->assertEquals(' ', $m->render('{{%DOT-NOTATION}} {{%DOT-NOTATION}}'), 'Multiple pragma tags not removed'); } public function testPragmaReplaceNewline() { $m = new Mustache(); - $this->assertEquals($m->render("{{%DOT-NOTATION}}\n"), '', 'Trailing newline after pragma tag not removed'); - $this->assertEquals($m->render("\n{{%DOT-NOTATION}}\n"), "\n", 'Too many newlines removed with pragma tag'); - $this->assertEquals($m->render("1\n2{{%DOT-NOTATION}}\n3"), "1\n23", 'Wrong newline removed with pragma tag'); + $this->assertEquals('', $m->render("{{%DOT-NOTATION}}\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("1\n23", $m->render("1\n2{{%DOT-NOTATION}}\n3"), 'Wrong newline removed with pragma tag'); } } \ No newline at end of file From fdcd284ed5b661ee4cea683ed0342ef300c049d4 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Fri, 30 Apr 2010 00:35:07 -0400 Subject: [PATCH 08/13] Updating known issues in readme. --- README.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 61cd5bb..1a029cc 100644 --- a/README.markdown +++ b/README.markdown @@ -81,8 +81,8 @@ And render it: Known Issues ------------ - * There's no way to toggle a pragma other than checking out the feature branch for each pragma... - Need a clean way to do this. + * 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. From ac365c052ea068edc9cd3b92ea933df4c43b75bb Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Fri, 30 Apr 2010 20:05:43 -0400 Subject: [PATCH 09/13] Further testing for Mustache constructor. --- test/MustacheTest.php | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/test/MustacheTest.php b/test/MustacheTest.php index f43a49a..f4d9672 100644 --- a/test/MustacheTest.php +++ b/test/MustacheTest.php @@ -34,6 +34,7 @@ require_once 'PHPUnit/Framework.php'; */ class MustacheTest extends PHPUnit_Framework_TestCase { + const TEST_CLASS = 'Mustache'; /** * Test Mustache constructor. @@ -68,7 +69,6 @@ class MustacheTest extends PHPUnit_Framework_TestCase { $this->assertEquals($output, $m4->render($template)); } - /** * Test __toString() function. * @@ -80,6 +80,26 @@ class MustacheTest extends PHPUnit_Framework_TestCase { $this->assertEquals('Karl Marx', $m->__toString()); $this->assertEquals('Karl Marx', (string) $m); + + $m2 = $this->getMock(self::TEST_CLASS, array('render'), array()); + $m2->expects($this->once()) + ->method('render') + ->will($this->returnValue('foo')); + + $this->assertEquals('foo', $m2->render()); + } + + public function test__toStringException() { + $m = $this->getMock(self::TEST_CLASS, array('render'), array()); + $m->expects($this->once()) + ->method('render') + ->will($this->throwException(new Exception)); + + try { + $out = (string) $m; + } catch (Exception $e) { + $this->fail('__toString should catch all exceptions'); + } } /** From 15324163069534cc936622aec067c2c3b94931e5 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Fri, 30 Apr 2010 20:12:37 -0400 Subject: [PATCH 10/13] Prefix Mustache reserved member variables with underscore to prevent namespace collisions with actual view values. --- Mustache.php | 88 ++++++++++++++++++++++++++-------------------------- 1 file changed, 44 insertions(+), 44 deletions(-) diff --git a/Mustache.php b/Mustache.php index ee5dffb..ae3668d 100644 --- a/Mustache.php +++ b/Mustache.php @@ -14,8 +14,8 @@ */ class Mustache { - public $otag = '{{'; - public $ctag = '}}'; + public $_otag = '{{'; + public $_ctag = '}}'; // Should this Mustache throw exceptions when it finds unexpected tags? protected $throwSectionExceptions = true; @@ -23,18 +23,18 @@ class Mustache { protected $throwVariableExceptions = false; // Override charset passed to htmlentities() and htmlspecialchars(). Defaults to UTF-8. - protected $charset = 'UTF-8'; + protected $_charset = 'UTF-8'; const PRAGMA_DOT_NOTATION = 'DOT-NOTATION'; - protected $tagRegEx; + protected $_tagRegEx; - protected $template = ''; - protected $context = array(); - protected $partials = array(); - protected $pragmas = array(); + protected $_template = ''; + protected $_context = array(); + protected $_partials = array(); + protected $_pragmas = array(); - protected $pragmasImplemented = array( + protected $_pragmasImplemented = array( self::PRAGMA_DOT_NOTATION ); @@ -51,9 +51,9 @@ class Mustache { * @return void */ public function __construct($template = null, $view = null, $partials = null) { - if ($template !== null) $this->template = $template; - if ($partials !== null) $this->partials = $partials; - if ($view !== null) $this->context = array($view); + if ($template !== null) $this->_template = $template; + if ($partials !== null) $this->_partials = $partials; + if ($view !== null) $this->_context = array($view); } /** @@ -69,16 +69,16 @@ class Mustache { * @return string Rendered Mustache template. */ public function render($template = null, $view = null, $partials = null) { - if ($template === null) $template = $this->template; - if ($partials !== null) $this->partials = $partials; + if ($template === null) $template = $this->_template; + if ($partials !== null) $this->_partials = $partials; if ($view) { - $this->context = array($view); - } else if (empty($this->context)) { - $this->context = array($this); + $this->_context = array($view); + } else if (empty($this->_context)) { + $this->_context = array($this); } - return $this->_render($template, $this->context); + return $this->_render($template, $this->_context); } /** @@ -121,8 +121,8 @@ class Mustache { * @return string */ protected function renderSection($template, &$context) { - $otag = $this->prepareRegEx($this->otag); - $ctag = $this->prepareRegEx($this->ctag); + $otag = $this->prepareRegEx($this->_otag); + $ctag = $this->prepareRegEx($this->_ctag); $regex = '/' . $otag . '(\\^|\\#)(.+?)' . $ctag . '\\s*([\\s\\S]+?)' . $otag . '\\/\\2' . $ctag . '\\s*/m'; $matches = array(); @@ -175,12 +175,12 @@ class Mustache { */ protected function renderPragmas($template, &$context) { // no pragmas - if (strpos($template, $this->otag . '%') === false) { + if (strpos($template, $this->_otag . '%') === false) { return $template; } - $otag = $this->prepareRegEx($this->otag); - $ctag = $this->prepareRegEx($this->ctag); + $otag = $this->prepareRegEx($this->_otag); + $ctag = $this->prepareRegEx($this->_ctag); $regex = '/' . $otag . '%([\\w_-]+)((?: [\\w]+=[\\w]+)*)' . $ctag . '\\n?/'; return preg_replace_callback($regex, array($this, 'renderPragma'), $template); } @@ -198,7 +198,7 @@ class Mustache { $pragma_name = $matches[1]; $options_string = $matches[2]; - if (!in_array($pragma_name, $this->pragmasImplemented)) { + if (!in_array($pragma_name, $this->_pragmasImplemented)) { throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA); } @@ -211,9 +211,9 @@ class Mustache { } if (empty($options)) { - $this->pragmas[$pragma_name] = true; + $this->_pragmas[$pragma_name] = true; } else { - $this->pragmas[$pragma_name] = $options; + $this->_pragmas[$pragma_name] = $options; } return ''; @@ -227,7 +227,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->_pragmas) && $this->_pragmas[$pragma_name]) { return true; } else { return false; @@ -247,7 +247,7 @@ class Mustache { throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA); } - return $this->pragmas[$pragma_name]; + return $this->_pragmas[$pragma_name]; } /** @@ -259,18 +259,18 @@ class Mustache { * @return void */ protected function renderTags($template, &$context) { - if (strpos($template, $this->otag) === false) { + if (strpos($template, $this->_otag) === false) { return $template; } - $otag = $this->prepareRegEx($this->otag); - $ctag = $this->prepareRegEx($this->ctag); + $otag = $this->prepareRegEx($this->_otag); + $ctag = $this->prepareRegEx($this->_ctag); - $this->tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; + $this->_tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; $html = ''; $matches = array(); - while (preg_match($this->tagRegEx, $template, $matches, PREG_OFFSET_CAPTURE)) { + while (preg_match($this->_tagRegEx, $template, $matches, PREG_OFFSET_CAPTURE)) { $tag = $matches[0][0]; $offset = $matches[0][1]; $modifier = $matches[1][0]; @@ -343,7 +343,7 @@ class Mustache { * @return string */ protected function renderEscaped($tag_name, &$context) { - return htmlentities($this->getVariable($tag_name, $context), null, $this->charset); + return htmlentities($this->getVariable($tag_name, $context), null, $this->_charset); } /** @@ -379,9 +379,9 @@ class Mustache { * @return string */ protected function renderPartial($tag_name, &$context) { - $view = new self($this->getPartial($tag_name), $context, $this->partials); - $view->otag = $this->otag; - $view->ctag = $this->ctag; + $view = new self($this->getPartial($tag_name), $context, $this->_partials); + $view->_otag = $this->_otag; + $view->_ctag = $this->_ctag; return $view->render(); } @@ -396,12 +396,12 @@ class Mustache { */ protected function changeDelimiter($tag_name, &$context) { $tags = explode(' ', $tag_name); - $this->otag = $tags[0]; - $this->ctag = $tags[1]; + $this->_otag = $tags[0]; + $this->_ctag = $tags[1]; - $otag = $this->prepareRegEx($this->otag); - $ctag = $this->prepareRegEx($this->ctag); - $this->tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; + $otag = $this->prepareRegEx($this->_otag); + $ctag = $this->prepareRegEx($this->_ctag); + $this->_tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; return ''; } @@ -498,8 +498,8 @@ class Mustache { * @return string */ protected function getPartial($tag_name) { - if (is_array($this->partials) && isset($this->partials[$tag_name])) { - return $this->partials[$tag_name]; + if (is_array($this->_partials) && isset($this->_partials[$tag_name])) { + return $this->_partials[$tag_name]; } if ($this->throwPartialExceptions) { From 5a1143efcef224cf821843fa0851da4b9ed3ac60 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Fri, 30 Apr 2010 20:23:25 -0400 Subject: [PATCH 11/13] Added _throwsException() check and refactored exception checks. --- Mustache.php | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/Mustache.php b/Mustache.php index bed4693..80e526f 100644 --- a/Mustache.php +++ b/Mustache.php @@ -17,10 +17,18 @@ class Mustache { public $_otag = '{{'; public $_ctag = '}}'; - // Should this Mustache throw exceptions when it finds unexpected tags? - protected $throwSectionExceptions = true; - protected $throwPartialExceptions = false; - protected $throwVariableExceptions = false; + /** + * Should this Mustache throw exceptions when it finds unexpected tags? + * + * @see self::_throwsException() + */ + protected $_throwsExceptions = array( + MustacheException::UNKNOWN_VARIABLE => false, + MustacheException::UNCLOSED_SECTION => true, + MustacheException::UNEXPECTED_CLOSE_SECTION => true, + MustacheException::UNKNOWN_PARTIAL => false, + MustacheException::UNKNOWN_PRAGMA => true, + ); // Override charset passed to htmlentities() and htmlspecialchars(). Defaults to UTF-8. protected $_charset = 'UTF-8'; @@ -265,6 +273,20 @@ class Mustache { return $this->_pragmas[$pragma_name]; } + + /** + * Check whether this Mustache instance throws a given exception. + * + * Expects exceptions to be MustacheException error codes (i.e. class constants). + * + * @access protected + * @param mixed $exception + * @return void + */ + protected function _throwsException($exception) { + return (isset($this->_throwsExceptions[$exception]) && $this->_throwsExceptions[$exception]); + } + /** * Loop through and render individual Mustache tags. * @@ -316,14 +338,14 @@ class Mustache { switch ($modifier) { case '#': case '^': - if ($this->throwSectionExceptions) { + if ($this->_throwsException(MustacheException::UNCLOSED_SECTION)) { throw new MustacheException('Unclosed section: ' . $tag_name, MustacheException::UNCLOSED_SECTION); } else { return ''; } break; case '/': - if ($this->throwSectionExceptions) { + if ($this->_throwsException(MustacheException::UNEXPECTED_CLOSE_SECTION)) { throw new MustacheException('Unexpected close section: ' . $tag_name, MustacheException::UNEXPECTED_CLOSE_SECTION); } else { return ''; @@ -503,7 +525,7 @@ class Mustache { } } - if ($this->throwVariableExceptions) { + if ($this->_throwsException(MustacheException::UNKNOWN_VARIABLE)) { throw new MustacheException("Unknown variable: " . $tag_name, MustacheException::UNKNOWN_VARIABLE); } else { return ''; @@ -525,7 +547,7 @@ class Mustache { return $this->_partials[$tag_name]; } - if ($this->throwPartialExceptions) { + if ($this->_throwsException(MustacheException::UNKNOWN_PARTIAL)) { throw new MustacheException('Unknown partial: ' . $tag_name, MustacheException::UNKNOWN_PARTIAL); } else { return ''; From 7304344c51298e61d5b424fcf829f9c154f22bc9 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Fri, 30 Apr 2010 20:34:31 -0400 Subject: [PATCH 12/13] Changing all protected functions to start with underscore, freeing up namespace for use in Mustache view classes. --- Mustache.php | 104 +++++++++++++++++++++++++-------------------------- 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/Mustache.php b/Mustache.php index 80e526f..e0dc769 100644 --- a/Mustache.php +++ b/Mustache.php @@ -128,9 +128,9 @@ class Mustache { * @return string Rendered Mustache template. */ protected function _render($template, &$context) { - $template = $this->renderPragmas($template, $context); - $template = $this->renderSection($template, $context); - return $this->renderTags($template, $context); + $template = $this->_renderPragmas($template, $context); + $template = $this->_renderSection($template, $context); + return $this->_renderTags($template, $context); } /** @@ -141,9 +141,9 @@ class Mustache { * @param array $context * @return string */ - protected function renderSection($template, &$context) { - $otag = $this->prepareRegEx($this->_otag); - $ctag = $this->prepareRegEx($this->_ctag); + protected function _renderSection($template, &$context) { + $otag = $this->_prepareRegEx($this->_otag); + $ctag = $this->_prepareRegEx($this->_ctag); $regex = '/' . $otag . '(\\^|\\#)(.+?)' . $ctag . '\\s*([\\s\\S]+?)' . $otag . '\\/\\2' . $ctag . '\\s*/m'; $matches = array(); @@ -155,7 +155,7 @@ class Mustache { $content = $matches[3][0]; $replace = ''; - $val = $this->getVariable($tag_name, $context); + $val = $this->_getVariable($tag_name, $context); switch($type) { // inverted section case '^': @@ -166,14 +166,14 @@ class Mustache { // regular section case '#': - if ($this->varIsIterable($val)) { + if ($this->_varIsIterable($val)) { foreach ($val as $local_context) { - $c = $this->getContext($context, $local_context); + $c = $this->_getContext($context, $local_context); $replace .= $this->_render($content, $c); } } else if ($val) { if (is_array($val) || is_object($val)) { - $c = $this->getContext($context, $val); + $c = $this->_getContext($context, $val); $replace .= $this->_render($content, $c); } else { $replace .= $content; @@ -196,16 +196,16 @@ class Mustache { * @param array &$context * @return string */ - protected function renderPragmas($template, &$context) { + protected function _renderPragmas($template, &$context) { // no pragmas if (strpos($template, $this->_otag . '%') === false) { return $template; } - $otag = $this->prepareRegEx($this->_otag); - $ctag = $this->prepareRegEx($this->_ctag); + $otag = $this->_prepareRegEx($this->_otag); + $ctag = $this->_prepareRegEx($this->_ctag); $regex = '/' . $otag . '%\\s*([\\w_-]+)((?: [\\w]+=[\\w]+)*)\\s*' . $ctag . '\\n?/'; - return preg_replace_callback($regex, array($this, 'renderPragma'), $template); + return preg_replace_callback($regex, array($this, '_renderPragma'), $template); } /** @@ -216,7 +216,7 @@ class Mustache { * @return void * @throws MustacheException unknown pragma */ - protected function renderPragma($matches) { + protected function _renderPragma($matches) { $pragma = $matches[0]; $pragma_name = $matches[1]; $options_string = $matches[2]; @@ -249,7 +249,7 @@ class Mustache { * @param string $pragma_name * @return bool */ - protected function hasPragma($pragma_name) { + protected function _hasPragma($pragma_name) { if (array_key_exists($pragma_name, $this->_pragmas) && $this->_pragmas[$pragma_name]) { return true; } else { @@ -265,8 +265,8 @@ class Mustache { * @return mixed * @throws MustacheException Unknown pragma */ - protected function getPragmaOptions($pragma_name) { - if (!$this->hasPragma()) { + protected function _getPragmaOptions($pragma_name) { + if (!$this->_hasPragma()) { throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA); } @@ -295,13 +295,13 @@ class Mustache { * @param array $context * @return void */ - protected function renderTags($template, &$context) { + protected function _renderTags($template, &$context) { if (strpos($template, $this->_otag) === false) { return $template; } - $otag = $this->prepareRegEx($this->_otag); - $ctag = $this->prepareRegEx($this->_ctag); + $otag = $this->_prepareRegEx($this->_otag); + $ctag = $this->_prepareRegEx($this->_ctag); $this->_tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; @@ -314,7 +314,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, $context); $template = substr($template, $offset + strlen($tag)); } @@ -334,7 +334,7 @@ class Mustache { * @throws MustacheException Unmatched section tag encountered. * @return string */ - protected function renderTag($modifier, $tag_name, &$context) { + protected function _renderTag($modifier, $tag_name, &$context) { switch ($modifier) { case '#': case '^': @@ -352,28 +352,28 @@ class Mustache { } break; case '=': - return $this->changeDelimiter($tag_name, $context); + return $this->_changeDelimiter($tag_name, $context); break; case '!': - return $this->renderComment($tag_name, $context); + return $this->_renderComment($tag_name, $context); break; case '>': - return $this->renderPartial($tag_name, $context); + return $this->_renderPartial($tag_name, $context); break; case '{': case '&': - if ($this->hasPragma(self::PRAGMA_UNESCAPED)) { - return $this->renderEscaped($tag_name, $context); + if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) { + return $this->_renderEscaped($tag_name, $context); } else { - return $this->renderUnescaped($tag_name, $context); + return $this->_renderUnescaped($tag_name, $context); } break; case '': default: - if ($this->hasPragma(self::PRAGMA_UNESCAPED)) { - return $this->renderUnescaped($tag_name, $context); + if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) { + return $this->_renderUnescaped($tag_name, $context); } else { - return $this->renderEscaped($tag_name, $context); + return $this->_renderEscaped($tag_name, $context); } break; } @@ -387,8 +387,8 @@ class Mustache { * @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, &$context) { + return htmlentities($this->_getVariable($tag_name, $context), null, $this->_charset); } /** @@ -399,7 +399,7 @@ class Mustache { * @param array $context * @return string */ - protected function renderComment($tag_name, &$context) { + protected function _renderComment($tag_name, &$context) { return ''; } @@ -411,8 +411,8 @@ class Mustache { * @param array $context * @return string */ - protected function renderUnescaped($tag_name, &$context) { - return $this->getVariable($tag_name, $context); + protected function _renderUnescaped($tag_name, &$context) { + return $this->_getVariable($tag_name, $context); } /** @@ -423,8 +423,8 @@ class Mustache { * @param array $context * @return string */ - protected function renderPartial($tag_name, &$context) { - $view = new self($this->getPartial($tag_name), $context, $this->_partials); + protected function _renderPartial($tag_name, &$context) { + $view = new self($this->_getPartial($tag_name), $context, $this->_partials); $view->_otag = $this->_otag; $view->_ctag = $this->_ctag; return $view->render(); @@ -439,13 +439,13 @@ class Mustache { * @param array $context * @return string */ - protected function changeDelimiter($tag_name, &$context) { + protected function _changeDelimiter($tag_name, &$context) { $tags = explode(' ', $tag_name); $this->_otag = $tags[0]; $this->_ctag = $tags[1]; - $otag = $this->prepareRegEx($this->_otag); - $ctag = $this->prepareRegEx($this->_ctag); + $otag = $this->_prepareRegEx($this->_otag); + $ctag = $this->_prepareRegEx($this->_ctag); $this->_tagRegEx = '/' . $otag . "([#\^\/=!>\\{&])?(.+?)\\1?" . $ctag . "+/"; return ''; } @@ -461,7 +461,7 @@ class Mustache { * @param mixed $local_context * @return void */ - protected function getContext(&$context, &$local_context) { + protected function _getContext(&$context, &$local_context) { $ret = array(); $ret[] =& $local_context; foreach ($context as $view) { @@ -485,20 +485,20 @@ class Mustache { * @throws MustacheException Unknown variable name. * @return string */ - protected function getVariable($tag_name, &$context) { - if ($this->hasPragma(self::PRAGMA_DOT_NOTATION)) { + protected function _getVariable($tag_name, &$context) { + if ($this->_hasPragma(self::PRAGMA_DOT_NOTATION)) { $chunks = explode('.', $tag_name); $first = array_shift($chunks); - $ret = $this->_getVariable($first, $context); + $ret = $this->_findVariableInContext($first, $context); while ($next = array_shift($chunks)) { // Slice off a chunk of context for dot notation traversal. $c = array($ret); - $ret = $this->_getVariable($next, $c); + $ret = $this->_findVariableInContext($next, $c); } return $ret; } else { - return $this->_getVariable($tag_name, $context); + return $this->_findVariableInContext($tag_name, $context); } } @@ -512,7 +512,7 @@ class Mustache { * @throws MustacheException Unknown variable name. * @return string */ - protected function _getVariable($tag_name, &$context) { + protected function _findVariableInContext($tag_name, &$context) { foreach ($context as $view) { if (is_object($view)) { if (isset($view->$tag_name)) { @@ -542,7 +542,7 @@ class Mustache { * @throws MustacheException Unknown partial name. * @return string */ - protected function getPartial($tag_name) { + protected function _getPartial($tag_name) { if (is_array($this->_partials) && isset($this->_partials[$tag_name])) { return $this->_partials[$tag_name]; } @@ -561,7 +561,7 @@ class Mustache { * @param mixed $var * @return bool */ - protected function varIsIterable($var) { + protected function _varIsIterable($var) { return is_object($var) || (is_array($var) && !array_diff_key($var, array_keys(array_keys($var)))); } @@ -572,7 +572,7 @@ class Mustache { * @param string $str * @return string */ - protected function prepareRegEx($str) { + protected function _prepareRegEx($str) { $replace = array( '\\' => '\\\\', '^' => '\^', '.' => '\.', '$' => '\$', '|' => '\|', '(' => '\(', ')' => '\)', '[' => '\[', ']' => '\]', '*' => '\*', '+' => '\+', '?' => '\?', From c6061baf49d2c2ff40c89fdfb0c181ec7616e441 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Fri, 30 Apr 2010 20:36:18 -0400 Subject: [PATCH 13/13] Changed protected _render function to _renderTemplate to avoid ambiguity. --- Mustache.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Mustache.php b/Mustache.php index e0dc769..6578862 100644 --- a/Mustache.php +++ b/Mustache.php @@ -99,7 +99,7 @@ class Mustache { $this->_context = array($this); } - return $this->_render($template, $this->_context); + return $this->_renderTemplate($template, $this->_context); } /** @@ -127,7 +127,7 @@ class Mustache { * @param array &$context * @return string Rendered Mustache template. */ - protected function _render($template, &$context) { + protected function _renderTemplate($template, &$context) { $template = $this->_renderPragmas($template, $context); $template = $this->_renderSection($template, $context); return $this->_renderTags($template, $context); @@ -169,12 +169,12 @@ class Mustache { if ($this->_varIsIterable($val)) { foreach ($val as $local_context) { $c = $this->_getContext($context, $local_context); - $replace .= $this->_render($content, $c); + $replace .= $this->_renderTemplate($content, $c); } } else if ($val) { if (is_array($val) || is_object($val)) { $c = $this->_getContext($context, $val); - $replace .= $this->_render($content, $c); + $replace .= $this->_renderTemplate($content, $c); } else { $replace .= $content; }