diff --git a/.gitignore b/.gitignore index 987e2a2..15977fb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ composer.lock vendor +mustache.php diff --git a/README.markdown b/README.markdown index d7ef259..1c49ae3 100644 --- a/README.markdown +++ b/README.markdown @@ -5,6 +5,7 @@ A [Mustache](http://mustache.github.com/) implementation in PHP. [![Build Status](https://secure.travis-ci.org/bobthecow/mustache.php.png?branch=dev)](http://travis-ci.org/bobthecow/mustache.php) + Usage ----- @@ -55,9 +56,14 @@ echo $m->render($template, $chris); ``` +And That's Not All! +------------------- + +Read [the Mustache.php documentation](https://github.com/bobthecow/mustache.php/wiki/Home) for more information. + + See Also -------- - * [Mustache.php wiki](https://github.com/bobthecow/mustache.php/wiki/Home). * [Readme for the Ruby Mustache implementation](http://github.com/defunkt/mustache/blob/master/README.md). * [mustache(5)](http://mustache.github.com/mustache.5.html) man page. diff --git a/bin/build_bootstrap.php b/bin/build_bootstrap.php new file mode 100755 index 0000000..2574a9f --- /dev/null +++ b/bin/build_bootstrap.php @@ -0,0 +1,175 @@ +#!/usr/bin/env php + + */ +class SymfonyClassCollectionLoader +{ + static private $loaded; + + const HEADER = <<\s*$/'), '', file_get_contents($r->getFileName())); + } + + $cache = $cacheDir.'/'.$name.$extension; + $header = sprintf(self::HEADER, strftime('%Y')); + self::writeCacheFile($cache, $header . substr(self::stripComments('lambdaHelper = new Mustache_LambdaHelper($this->mustache, $context); $buffer = \'\'; %s - if ($escape) { - return %s; - } else { - return $buffer; - } + return $buffer; } %s }'; + const KLASS_NO_LAMBDAS = 'walk($tree); $sections = implode("\n", $this->sections); + $klass = empty($this->sections) ? self::KLASS_NO_LAMBDAS : self::KLASS; + $callable = $this->strictCallables ? $this->prepare(self::STRICT_CALLABLE) : ''; - return sprintf($this->prepare(self::KLASS, 0, false), $name, $code, $this->getEscape('$buffer'), $sections); + return sprintf($this->prepare($klass, 0, false, true), $name, $callable, $code, $sections); } const SECTION_CALL = ' @@ -166,7 +179,8 @@ class Mustache_Compiler '; const SECTION = ' - private function section%s(Mustache_Context $context, $indent, $value) { + private function section%s(Mustache_Context $context, $indent, $value) + { $buffer = \'\'; if (%s) { $source = %s; @@ -268,12 +282,7 @@ class Mustache_Compiler } const VARIABLE = ' - $value = $context->%s(%s); - if (%s) { - $value = $this->mustache - ->loadLambda((string) call_user_func($value)) - ->renderInternal($context, $indent); - }%s + $value = $this->resolveValue($context->%s(%s), $context, $indent);%s $buffer .= %s%s; '; @@ -294,12 +303,11 @@ class Mustache_Compiler list($id, $filters) = $this->getFilters($id, $level); } - $method = $this->getFindMethod($id); - $id = ($method !== 'last') ? var_export($id, true) : ''; - $callable = $this->getCallable(); - $value = $escape ? $this->getEscape() : '$value'; + $method = $this->getFindMethod($id); + $id = ($method !== 'last') ? var_export($id, true) : ''; + $value = $escape ? $this->getEscape() : '$value'; - return sprintf($this->prepare(self::VARIABLE, $level), $method, $id, $callable, $filters, $this->flushIndent(), $value); + return sprintf($this->prepare(self::VARIABLE, $level), $method, $id, $filters, $this->flushIndent(), $value); } /** @@ -321,7 +329,7 @@ class Mustache_Compiler const FILTER = ' $filter = $context->%s(%s); if (!(%s)) { - throw new UnexpectedValueException(%s); + throw new Mustache_Exception_UnknownFilterException(%s); } $value = call_user_func($filter, $value);%s '; @@ -344,7 +352,7 @@ class Mustache_Compiler $method = $this->getFindMethod($name); $filter = ($method !== 'last') ? var_export($name, true) : ''; $callable = $this->getCallable('$filter'); - $msg = var_export(sprintf('Filter not found: %s', $name), true); + $msg = var_export($name, true); return sprintf($this->prepare(self::FILTER, $level), $method, $filter, $callable, $msg, $this->getFilter($filters, $level)); } @@ -377,15 +385,19 @@ class Mustache_Compiler * @param string $text * @param int $bonus Additional indent level (default: 0) * @param boolean $prependNewline Prepend a newline to the snippet? (default: true) + * @param boolean $appendNewline Append a newline to the snippet? (default: false) * * @return string PHP source code snippet */ - private function prepare($text, $bonus = 0, $prependNewline = true) + private function prepare($text, $bonus = 0, $prependNewline = true, $appendNewline = false) { $text = ($prependNewline ? "\n" : '').trim($text); if ($prependNewline) { $bonus++; } + if ($appendNewline) { + $text .= "\n"; + } return preg_replace("/\n( {8})?/", "\n".str_repeat(" ", $bonus * 4), $text); } diff --git a/src/Mustache/Engine.php b/src/Mustache/Engine.php index 8745e3e..adb0c0e 100644 --- a/src/Mustache/Engine.php +++ b/src/Mustache/Engine.php @@ -23,7 +23,7 @@ */ class Mustache_Engine { - const VERSION = '2.2.0'; + const VERSION = '2.3.0'; const SPEC_VERSION = '1.1.2'; const PRAGMA_FILTERS = 'FILTERS'; @@ -87,7 +87,7 @@ class Mustache_Engine * // A Mustache Logger instance. No logging will occur unless this is set. Using a PSR-3 compatible * // logging library -- such as Monolog -- is highly recommended. A simple stream logger implementation is * // available as well: - * 'logger' => new Mustache_StreamLogger('php://stderr'), + * 'logger' => new Mustache_Logger_StreamLogger('php://stderr'), * * // Only treat Closure instances and invokable classes as callable. If true, values like * // `array('ClassName', 'methodName')` and `array($classInstance, 'methodName')`, which are traditionally @@ -97,6 +97,8 @@ class Mustache_Engine * 'strict_callables' => true, * ); * + * @throws Mustache_Exception_InvalidArgumentException If `escape` option is not callable. + * * @param array $options (default: array()) */ public function __construct(array $options = array()) @@ -131,7 +133,7 @@ class Mustache_Engine if (isset($options['escape'])) { if (!is_callable($options['escape'])) { - throw new InvalidArgumentException('Mustache Constructor "escape" option must be callable'); + throw new Mustache_Exception_InvalidArgumentException('Mustache Constructor "escape" option must be callable'); } $this->escape = $options['escape']; @@ -245,18 +247,21 @@ class Mustache_Engine /** * Set partials for the current partials Loader instance. * - * @throws RuntimeException If the current Loader instance is immutable + * @throws Mustache_Exception_RuntimeException If the current Loader instance is immutable * * @param array $partials (default: array()) */ public function setPartials(array $partials = array()) { - $loader = $this->getPartialsLoader(); - if (!$loader instanceof Mustache_Loader_MutableLoader) { - throw new RuntimeException('Unable to set partials on an immutable Mustache Loader instance'); + if (!isset($this->partialsLoader)) { + $this->partialsLoader = new Mustache_Loader_ArrayLoader; } - $loader->setTemplates($partials); + if (!$this->partialsLoader instanceof Mustache_Loader_MutableLoader) { + throw new Mustache_Exception_RuntimeException('Unable to set partials on an immutable Mustache Loader instance'); + } + + $this->partialsLoader->setTemplates($partials); } /** @@ -266,14 +271,14 @@ class Mustache_Engine * any other valid Mustache context value. They will be prepended to the context stack, so they will be available in * any template loaded by this Mustache instance. * - * @throws InvalidArgumentException if $helpers is not an array or Traversable + * @throws Mustache_Exception_InvalidArgumentException if $helpers is not an array or Traversable * * @param array|Traversable $helpers */ public function setHelpers($helpers) { if (!is_array($helpers) && !$helpers instanceof Traversable) { - throw new InvalidArgumentException('setHelpers expects an array of helpers'); + throw new Mustache_Exception_InvalidArgumentException('setHelpers expects an array of helpers'); } $this->getHelpers()->clear(); @@ -355,12 +360,14 @@ class Mustache_Engine /** * Set the Mustache Logger instance. * + * @throws Mustache_Exception_InvalidArgumentException If logger is not an instance of Mustache_Logger or Psr\Log\LoggerInterface. + * * @param Mustache_Logger|Psr\Log\LoggerInterface $logger */ public function setLogger($logger = null) { if ($logger !== null && !($logger instanceof Mustache_Logger || is_a($logger, 'Psr\\Log\\LoggerInterface'))) { - throw new InvalidArgumentException('Expected an instance of Mustache_Logger or Psr\\Log\\LoggerInterface.'); + throw new Mustache_Exception_InvalidArgumentException('Expected an instance of Mustache_Logger or Psr\\Log\\LoggerInterface.'); } $this->logger = $logger; @@ -498,13 +505,21 @@ class Mustache_Engine public function loadPartial($name) { try { - return $this->loadSource($this->getPartialsLoader()->load($name)); - } catch (InvalidArgumentException $e) { + if (isset($this->partialsLoader)) { + $loader = $this->partialsLoader; + } elseif (isset($this->loader) && !$this->loader instanceof Mustache_Loader_StringLoader) { + $loader = $this->loader; + } else { + throw new Mustache_Exception_UnknownTemplateException($name); + } + + return $this->loadSource($loader->load($name)); + } catch (Mustache_Exception_UnknownTemplateException $e) { // If the named partial cannot be found, log then return null. $this->log( Mustache_Logger::WARNING, 'Partial not found: "{name}"', - array('name' => $name) + array('name' => $e->getTemplateName()) ); } } @@ -649,7 +664,7 @@ class Mustache_Engine /** * Helper method to dump a generated Mustache Template subclass to the file cache. * - * @throws RuntimeException if unable to create the cache directory or write to $fileName. + * @throws Mustache_Exception_RuntimeException if unable to create the cache directory or write to $fileName. * * @param string $fileName * @param string $source @@ -668,7 +683,7 @@ class Mustache_Engine @mkdir($dirName, 0777, true); if (!is_dir($dirName)) { - throw new RuntimeException(sprintf('Failed to create cache directory "%s".', $dirName)); + throw new Mustache_Exception_RuntimeException(sprintf('Failed to create cache directory "%s".', $dirName)); } } @@ -695,7 +710,7 @@ class Mustache_Engine ); } - throw new RuntimeException(sprintf('Failed to write cache file "%s".', $fileName)); + throw new Mustache_Exception_RuntimeException(sprintf('Failed to write cache file "%s".', $fileName)); } /** diff --git a/src/Mustache/Exception.php b/src/Mustache/Exception.php new file mode 100644 index 0000000..b4f8300 --- /dev/null +++ b/src/Mustache/Exception.php @@ -0,0 +1,18 @@ +token = $token; + parent::__construct($msg); + } + + public function getToken() + { + return $this->token; + } +} diff --git a/src/Mustache/Exception/UnknownFilterException.php b/src/Mustache/Exception/UnknownFilterException.php new file mode 100644 index 0000000..f5c0884 --- /dev/null +++ b/src/Mustache/Exception/UnknownFilterException.php @@ -0,0 +1,29 @@ +filterName = $filterName; + parent::__construct(sprintf('Unknown filter: %s', $filterName)); + } + + public function getFilterName() + { + return $this->filterName; + } +} diff --git a/src/Mustache/Exception/UnknownHelperException.php b/src/Mustache/Exception/UnknownHelperException.php new file mode 100644 index 0000000..98af13e --- /dev/null +++ b/src/Mustache/Exception/UnknownHelperException.php @@ -0,0 +1,29 @@ +helperName = $helperName; + parent::__construct(sprintf('Unknown helper: %s', $helperName)); + } + + public function getHelperName() + { + return $this->helperName; + } +} diff --git a/src/Mustache/Exception/UnknownTemplateException.php b/src/Mustache/Exception/UnknownTemplateException.php new file mode 100644 index 0000000..141d372 --- /dev/null +++ b/src/Mustache/Exception/UnknownTemplateException.php @@ -0,0 +1,29 @@ +templateName = $templateName; + parent::__construct(sprintf('Unknown template: %s', $templateName)); + } + + public function getTemplateName() + { + return $this->templateName; + } +} diff --git a/src/Mustache/HelperCollection.php b/src/Mustache/HelperCollection.php index f6354e6..e991137 100644 --- a/src/Mustache/HelperCollection.php +++ b/src/Mustache/HelperCollection.php @@ -21,7 +21,7 @@ class Mustache_HelperCollection * * Optionally accepts an array (or Traversable) of `$name => $helper` pairs. * - * @throws InvalidArgumentException if the $helpers argument isn't an array or Traversable + * @throws Mustache_Exception_InvalidArgumentException if the $helpers argument isn't an array or Traversable * * @param array|Traversable $helpers (default: null) */ @@ -29,7 +29,7 @@ class Mustache_HelperCollection { if ($helpers !== null) { if (!is_array($helpers) && !$helpers instanceof Traversable) { - throw new InvalidArgumentException('HelperCollection constructor expects an array of helpers'); + throw new Mustache_Exception_InvalidArgumentException('HelperCollection constructor expects an array of helpers'); } foreach ($helpers as $name => $helper) { @@ -79,6 +79,8 @@ class Mustache_HelperCollection /** * Get a helper by name. * + * @throws Mustache_Exception_UnknownHelperException If helper does not exist. + * * @param string $name * * @return mixed Helper @@ -86,7 +88,7 @@ class Mustache_HelperCollection public function get($name) { if (!$this->has($name)) { - throw new InvalidArgumentException('Unknown helper: '.$name); + throw new Mustache_Exception_UnknownHelperException($name); } return $this->helpers[$name]; @@ -133,14 +135,14 @@ class Mustache_HelperCollection /** * Check whether a given helper is present in the collection. * - * @throws InvalidArgumentException if the requested helper is not present. + * @throws Mustache_Exception_UnknownHelperException if the requested helper is not present. * * @param string $name */ public function remove($name) { if (!$this->has($name)) { - throw new InvalidArgumentException('Unknown helper: '.$name); + throw new Mustache_Exception_UnknownHelperException($name); } unset($this->helpers[$name]); diff --git a/src/Mustache/LambdaHelper.php b/src/Mustache/LambdaHelper.php index 6f226c5..dfd4659 100644 --- a/src/Mustache/LambdaHelper.php +++ b/src/Mustache/LambdaHelper.php @@ -12,8 +12,9 @@ /** * Mustache Lambda Helper. * - * Passed to section and interpolation lambdas, giving them access to a `render` - * method for rendering a string with the current context. + * Passed as the second argument to section lambdas (higher order sections), + * giving them access to a `render` method for rendering a string with the + * current context. */ class Mustache_LambdaHelper { diff --git a/src/Mustache/Loader.php b/src/Mustache/Loader.php index 21229d1..f659a1d 100644 --- a/src/Mustache/Loader.php +++ b/src/Mustache/Loader.php @@ -18,6 +18,8 @@ interface Mustache_Loader /** * Load a Template by name. * + * @throws Mustache_Exception_UnknownTemplateException If a template file is not found. + * * @param string $name * * @return string Mustache Template source diff --git a/src/Mustache/Loader/ArrayLoader.php b/src/Mustache/Loader/ArrayLoader.php index 1ce6e20..ec35774 100644 --- a/src/Mustache/Loader/ArrayLoader.php +++ b/src/Mustache/Loader/ArrayLoader.php @@ -23,9 +23,6 @@ * * The ArrayLoader is used internally as a partials loader by Mustache_Engine instance when an array of partials * is set. It can also be used as a quick-and-dirty Template loader. - * - * @implements Loader - * @implements MutableLoader */ class Mustache_Loader_ArrayLoader implements Mustache_Loader, Mustache_Loader_MutableLoader { @@ -43,6 +40,8 @@ class Mustache_Loader_ArrayLoader implements Mustache_Loader, Mustache_Loader_Mu /** * Load a Template. * + * @throws Mustache_Exception_UnknownTemplateException If a template file is not found. + * * @param string $name * * @return string Mustache Template source @@ -50,7 +49,7 @@ class Mustache_Loader_ArrayLoader implements Mustache_Loader, Mustache_Loader_Mu public function load($name) { if (!isset($this->templates[$name])) { - throw new InvalidArgumentException('Template '.$name.' not found.'); + throw new Mustache_Exception_UnknownTemplateException($name); } return $this->templates[$name]; diff --git a/src/Mustache/Loader/CascadingLoader.php b/src/Mustache/Loader/CascadingLoader.php new file mode 100644 index 0000000..192edb9 --- /dev/null +++ b/src/Mustache/Loader/CascadingLoader.php @@ -0,0 +1,69 @@ +loaders = array(); + foreach ($loaders as $loader) { + $this->addLoader($loader); + } + } + + /** + * Add a Loader instance. + * + * @param Mustache_Loader $loader A Mustache Loader instance + */ + public function addLoader(Mustache_Loader $loader) + { + $this->loaders[] = $loader; + } + + /** + * Load a Template by name. + * + * @throws Mustache_Exception_UnknownTemplateException If a template file is not found. + * + * @param string $name + * + * @return string Mustache Template source + */ + public function load($name) + { + foreach ($this->loaders as $loader) { + try { + return $loader->load($name); + } catch (Mustache_Exception_UnknownTemplateException $e) { + // do nothing, check the next loader. + } + } + + throw new Mustache_Exception_UnknownTemplateException($name); + } +} diff --git a/src/Mustache/Loader/FilesystemLoader.php b/src/Mustache/Loader/FilesystemLoader.php index bbd2a43..71d7f1c 100644 --- a/src/Mustache/Loader/FilesystemLoader.php +++ b/src/Mustache/Loader/FilesystemLoader.php @@ -23,8 +23,6 @@ * 'loader' => new Mustache_Loader_FilesystemLoader(dirname(__FILE__).'/views'), * 'partials_loader' => new Mustache_Loader_FilesystemLoader(dirname(__FILE__).'/views/partials'), * )); - * - * @implements Mustache_Loader */ class Mustache_Loader_FilesystemLoader implements Mustache_Loader { @@ -42,7 +40,7 @@ class Mustache_Loader_FilesystemLoader implements Mustache_Loader * 'extension' => '.ms', * ); * - * @throws RuntimeException if $baseDir does not exist. + * @throws Mustache_Exception_RuntimeException if $baseDir does not exist. * * @param string $baseDir Base directory containing Mustache template files. * @param array $options Array of Loader options (default: array()) @@ -52,7 +50,7 @@ class Mustache_Loader_FilesystemLoader implements Mustache_Loader $this->baseDir = rtrim(realpath($baseDir), '/'); if (!is_dir($this->baseDir)) { - throw new RuntimeException('FilesystemLoader baseDir must be a directory: '.$baseDir); + throw new Mustache_Exception_RuntimeException(sprintf('FilesystemLoader baseDir must be a directory: %s', $baseDir)); } if (array_key_exists('extension', $options)) { @@ -86,7 +84,7 @@ class Mustache_Loader_FilesystemLoader implements Mustache_Loader /** * Helper function for loading a Mustache file by name. * - * @throws InvalidArgumentException if a template file is not found. + * @throws Mustache_Exception_UnknownTemplateException If a template file is not found. * * @param string $name * @@ -97,7 +95,7 @@ class Mustache_Loader_FilesystemLoader implements Mustache_Loader $fileName = $this->getFileName($name); if (!file_exists($fileName)) { - throw new InvalidArgumentException('Template '.$name.' not found.'); + throw new Mustache_Exception_UnknownTemplateException($name); } return file_get_contents($fileName); diff --git a/src/Mustache/Loader/InlineLoader.php b/src/Mustache/Loader/InlineLoader.php new file mode 100644 index 0000000..1463bf8 --- /dev/null +++ b/src/Mustache/Loader/InlineLoader.php @@ -0,0 +1,121 @@ +load('hello'); + * $goodbye = $loader->load('goodbye'); + * + * __halt_compiler(); + * + * @@ hello + * Hello, {{ planet }}! + * + * @@ goodbye + * Goodbye, cruel {{ planet }} + * + * Templates are deliniated by lines containing only `@@ name`. + * + * The InlineLoader is well-suited to micro-frameworks such as Silex: + * + * $app->register(new MustacheServiceProvider, array( + * 'mustache.loader' => new Mustache_Loader_InlineLoader(__FILE__, __COMPILER_HALT_OFFSET__) + * )); + * + * $app->get('/{name}', function() use ($app) { + * return $app['mustache']->render('hello', compact('name')); + * }) + * ->value('name', 'world'); + * + * __halt_compiler(); + * + * @@ hello + * Hello, {{ name }}! + * + */ +class Mustache_Loader_InlineLoader implements Mustache_Loader +{ + protected $fileName; + protected $offset; + protected $templates; + + /** + * The InlineLoader requires a filename and offset to process templates. + * The magic constants `__FILE__` and `__COMPILER_HALT_OFFSET__` are usually + * perfectly suited to the job: + * + * $loader = new Mustache_Loader_InlineLoader(__FILE__, __COMPILER_HALT_OFFSET__); + * + * Note that this only works if the loader is instantiated inside the same + * file as the inline templates. If the templates are located in another + * file, it would be necessary to manually specify the filename and offset. + * + * @param string $fileName The file to parse for inline templates + * @param int $offset A string offset for the start of the templates. + * This usually coincides with the `__halt_compiler` + * call, and the `__COMPILER_HALT_OFFSET__`. + */ + public function __construct($fileName, $offset) + { + if (!is_file($fileName)) { + throw new Mustache_Exception_InvalidArgumentException('InlineLoader expects a valid filename.'); + } + + if (!is_int($offset) || $offset < 0) { + throw new Mustache_Exception_InvalidArgumentException('InlineLoader expects a valid file offset.'); + } + + $this->fileName = $fileName; + $this->offset = $offset; + } + + /** + * Load a Template by name. + * + * @throws Mustache_Exception_UnknownTemplateException If a template file is not found. + * + * @param string $name + * + * @return string Mustache Template source + */ + public function load($name) + { + $this->loadTemplates(); + + if (!array_key_exists($name, $this->templates)) { + throw new Mustache_Exception_UnknownTemplateException($name); + } + + return $this->templates[$name]; + } + + /** + * Parse and load templates from the end of a source file. + */ + protected function loadTemplates() + { + if ($this->templates === null) { + $this->templates = array(); + $data = file_get_contents($this->fileName, false, null, $this->offset); + foreach (preg_split("/^@@(?= [\w\d\.]+$)/m", $data, -1) as $chunk) { + if (trim($chunk)) { + list($name, $content) = explode("\n", $chunk, 2); + $this->templates[trim($name)] = trim($content); + } + } + } + } +} diff --git a/src/Mustache/Loader/StringLoader.php b/src/Mustache/Loader/StringLoader.php index aa8fcf7..e73b3cd 100644 --- a/src/Mustache/Loader/StringLoader.php +++ b/src/Mustache/Loader/StringLoader.php @@ -22,8 +22,6 @@ * $m = new Mustache; * $tpl = $m->loadTemplate('{{ foo }}'); * echo $tpl->render(array('foo' => 'bar')); // "bar" - * - * @implements Loader */ class Mustache_Loader_StringLoader implements Mustache_Loader { diff --git a/src/Mustache/Logger/StreamLogger.php b/src/Mustache/Logger/StreamLogger.php index 7f3fd50..da771f9 100644 --- a/src/Mustache/Logger/StreamLogger.php +++ b/src/Mustache/Logger/StreamLogger.php @@ -64,14 +64,14 @@ class Mustache_Logger_StreamLogger extends Mustache_Logger_AbstractLogger /** * Set the minimum logging level. * - * @throws InvalidArgumentException if the logging level is unknown. + * @throws Mustache_Exception_InvalidArgumentException if the logging level is unknown. * * @param integer $level The minimum logging level which will be written */ public function setLevel($level) { if (!array_key_exists($level, self::$levels)) { - throw new InvalidArgumentException('Unexpected logging level: ' . $level); + throw new Mustache_Exception_InvalidArgumentException(sprintf('Unexpected logging level: %s', $level)); } $this->level = $level; @@ -90,7 +90,7 @@ class Mustache_Logger_StreamLogger extends Mustache_Logger_AbstractLogger /** * Logs with an arbitrary level. * - * @throws InvalidArgumentException if the logging level is unknown. + * @throws Mustache_Exception_InvalidArgumentException if the logging level is unknown. * * @param mixed $level * @param string $message @@ -99,7 +99,7 @@ class Mustache_Logger_StreamLogger extends Mustache_Logger_AbstractLogger public function log($level, $message, array $context = array()) { if (!array_key_exists($level, self::$levels)) { - throw new InvalidArgumentException('Unexpected logging level: ' . $level); + throw new Mustache_Exception_InvalidArgumentException(sprintf('Unexpected logging level: %s', $level)); } if (self::$levels[$level] >= self::$levels[$this->level]) { @@ -110,6 +110,9 @@ class Mustache_Logger_StreamLogger extends Mustache_Logger_AbstractLogger /** * Write a record to the log. * + * @throws Mustache_Exception_LogicException If neither a stream resource nor url is present. + * @throws Mustache_Exception_RuntimeException If the stream url cannot be opened. + * * @param integer $level The logging level * @param string $message The log message * @param array $context The log context @@ -118,13 +121,13 @@ class Mustache_Logger_StreamLogger extends Mustache_Logger_AbstractLogger { if (!is_resource($this->stream)) { if (!isset($this->url)) { - throw new LogicException('Missing stream url, the stream can not be opened. This may be caused by a premature call to close().'); + throw new Mustache_Exception_LogicException('Missing stream url, the stream can not be opened. This may be caused by a premature call to close().'); } $this->stream = fopen($this->url, 'a'); if (!is_resource($this->stream)) { // @codeCoverageIgnoreStart - throw new UnexpectedValueException(sprintf('The stream or file "%s" could not be opened.', $this->url)); + throw new Mustache_Exception_RuntimeException(sprintf('The stream or file "%s" could not be opened.', $this->url)); // @codeCoverageIgnoreEnd } } @@ -174,7 +177,9 @@ class Mustache_Logger_StreamLogger extends Mustache_Logger_AbstractLogger */ protected static function interpolateMessage($message, array $context = array()) { - $message = (string) $message; + if (strpos($message, '{') === false) { + return $message; + } // build a replacement array with braces around the context keys $replace = array(); diff --git a/src/Mustache/Parser.php b/src/Mustache/Parser.php index 5766dde..ab7db84 100644 --- a/src/Mustache/Parser.php +++ b/src/Mustache/Parser.php @@ -32,12 +32,12 @@ class Mustache_Parser /** * Helper method for recursively building a parse tree. * + * @throws Mustache_Exception_SyntaxException when nesting errors or mismatched section tags are encountered. + * * @param ArrayIterator $tokens Stream of Mustache tokens * @param array $parent Parent token (default: null) * * @return array Mustache Token parse tree - * - * @throws LogicException when nesting errors or mismatched section tags are encountered. */ private function buildTree(ArrayIterator $tokens, array $parent = null) { @@ -58,11 +58,13 @@ class Mustache_Parser case Mustache_Tokenizer::T_END_SECTION: if (!isset($parent)) { - throw new LogicException('Unexpected closing tag: /'. $token[Mustache_Tokenizer::NAME]); + $msg = sprintf('Unexpected closing tag: /%s', $token[Mustache_Tokenizer::NAME]); + throw new Mustache_Exception_SyntaxException($msg, $token); } if ($token[Mustache_Tokenizer::NAME] !== $parent[Mustache_Tokenizer::NAME]) { - throw new LogicException('Nesting error: ' . $parent[Mustache_Tokenizer::NAME] . ' vs. ' . $token[Mustache_Tokenizer::NAME]); + $msg = sprintf('Nesting error: %s vs. %s', $parent[Mustache_Tokenizer::NAME], $token[Mustache_Tokenizer::NAME]); + throw new Mustache_Exception_SyntaxException($msg, $token); } $parent[Mustache_Tokenizer::END] = $token[Mustache_Tokenizer::INDEX]; @@ -80,7 +82,8 @@ class Mustache_Parser } while ($tokens->valid()); if (isset($parent)) { - throw new LogicException('Missing closing tag: ' . $parent[Mustache_Tokenizer::NAME]); + $msg = sprintf('Missing closing tag: %s', $parent[Mustache_Tokenizer::NAME]); + throw new Mustache_Exception_SyntaxException($msg, $parent); } return $nodes; diff --git a/src/Mustache/Template.php b/src/Mustache/Template.php index b9c81fd..aeee42d 100644 --- a/src/Mustache/Template.php +++ b/src/Mustache/Template.php @@ -22,6 +22,11 @@ abstract class Mustache_Template */ protected $mustache; + /** + * @var boolean + */ + protected $strictCallables = false; + /** * Mustache Template constructor. * @@ -67,13 +72,14 @@ abstract class Mustache_Template * * This is where the magic happens :) * + * NOTE: This method is not part of the Mustache.php public API. + * * @param Mustache_Context $context * @param string $indent (default: '') - * @param bool $escape (default: false) * * @return string Rendered template */ - abstract public function renderInternal(Mustache_Context $context, $indent = '', $escape = false); + abstract public function renderInternal(Mustache_Context $context, $indent = ''); /** * Tests whether a value should be iterated over (e.g. in a section context). @@ -146,4 +152,26 @@ abstract class Mustache_Template return $stack; } + + /** + * Resolve a context value. + * + * Invoke the value if it is callable, otherwise return the value. + * + * @param mixed $value + * @param Mustache_Context $context + * @param string $indent + * + * @return string + */ + protected function resolveValue($value, Mustache_Context $context, $indent = '') + { + if (($this->strictCallables ? is_object($value) : !is_string($value)) && is_callable($value)) { + return $this->mustache + ->loadLambda((string) call_user_func($value)) + ->renderInternal($context, $indent); + } + + return $value; + } } diff --git a/test/Mustache/Test/CompilerTest.php b/test/Mustache/Test/CompilerTest.php index 8b6f5be..bd94073 100644 --- a/test/Mustache/Test/CompilerTest.php +++ b/test/Mustache/Test/CompilerTest.php @@ -33,23 +33,52 @@ class Mustache_Test_CompilerTest extends PHPUnit_Framework_TestCase return array( array('', array(), 'Banana', false, 'ISO-8859-1', array( "\nclass Banana extends Mustache_Template", - 'return htmlspecialchars($buffer, ENT_COMPAT, \'ISO-8859-1\');', 'return $buffer;', )), array('', array($this->createTextToken('TEXT')), 'Monkey', false, 'UTF-8', array( "\nclass Monkey extends Mustache_Template", - 'return htmlspecialchars($buffer, ENT_COMPAT, \'UTF-8\');', '$buffer .= $indent . \'TEXT\';', 'return $buffer;', )), - array('', array($this->createTextToken('TEXT')), 'Monkey', true, 'ISO-8859-1', array( - "\nclass Monkey extends Mustache_Template", - '$buffer .= $indent . \'TEXT\';', - 'return call_user_func($this->mustache->getEscape(), $buffer);', - 'return $buffer;', - )), + array( + '', + array( + array( + Mustache_Tokenizer::TYPE => Mustache_Tokenizer::T_ESCAPED, + Mustache_Tokenizer::NAME => 'name', + ) + ), + 'Monkey', + true, + 'ISO-8859-1', + array( + "\nclass Monkey extends Mustache_Template", + '$value = $this->resolveValue($context->find(\'name\'), $context, $indent);', + '$buffer .= $indent . call_user_func($this->mustache->getEscape(), $value);', + 'return $buffer;', + ) + ), + + array( + '', + array( + array( + Mustache_Tokenizer::TYPE => Mustache_Tokenizer::T_ESCAPED, + Mustache_Tokenizer::NAME => 'name', + ) + ), + 'Monkey', + false, + 'ISO-8859-1', + array( + "\nclass Monkey extends Mustache_Template", + '$value = $this->resolveValue($context->find(\'name\'), $context, $indent);', + '$buffer .= $indent . htmlspecialchars($value, ENT_COMPAT, \'ISO-8859-1\');', + 'return $buffer;', + ) + ), array( '', @@ -73,11 +102,10 @@ class Mustache_Test_CompilerTest extends PHPUnit_Framework_TestCase "\nclass Monkey extends Mustache_Template", '$buffer .= $indent . \'foo\'', '$buffer .= "\n"', - '$value = $context->find(\'name\');', + '$value = $this->resolveValue($context->find(\'name\'), $context, $indent);', '$buffer .= htmlspecialchars($value, ENT_COMPAT, \'UTF-8\');', - '$value = $context->last();', + '$value = $this->resolveValue($context->last(), $context, $indent);', '$buffer .= \'\\\'bar\\\'\';', - 'return htmlspecialchars($buffer, ENT_COMPAT, \'UTF-8\');', 'return $buffer;', ) ), @@ -85,9 +113,9 @@ class Mustache_Test_CompilerTest extends PHPUnit_Framework_TestCase } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_SyntaxException */ - public function testCompilerThrowsUnknownNodeTypeException() + public function testCompilerThrowsSyntaxException() { $compiler = new Mustache_Compiler; $compiler->compile('', array(array(Mustache_Tokenizer::TYPE => 'invalid')), 'SomeClass'); diff --git a/test/Mustache/Test/EngineTest.php b/test/Mustache/Test/EngineTest.php index bf59d18..5c00821 100644 --- a/test/Mustache/Test/EngineTest.php +++ b/test/Mustache/Test/EngineTest.php @@ -141,7 +141,7 @@ class Mustache_Test_EngineTest extends PHPUnit_Framework_TestCase } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_InvalidArgumentException * @dataProvider getBadEscapers */ public function testNonCallableEscapeThrowsException($escape) @@ -158,7 +158,7 @@ class Mustache_Test_EngineTest extends PHPUnit_Framework_TestCase } /** - * @expectedException RuntimeException + * @expectedException Mustache_Exception_RuntimeException */ public function testImmutablePartialsLoadersThrowException() { @@ -223,7 +223,7 @@ class Mustache_Test_EngineTest extends PHPUnit_Framework_TestCase } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_InvalidArgumentException */ public function testSetHelpersThrowsExceptions() { @@ -232,7 +232,7 @@ class Mustache_Test_EngineTest extends PHPUnit_Framework_TestCase } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_InvalidArgumentException */ public function testSetLoggerThrowsExceptions() { @@ -240,6 +240,29 @@ class Mustache_Test_EngineTest extends PHPUnit_Framework_TestCase $mustache->setLogger(new StdClass); } + public function testLoadPartialCascading() + { + $loader = new Mustache_Loader_ArrayLoader(array( + 'foo' => 'FOO', + )); + + $mustache = new Mustache_Engine(array('loader' => $loader)); + + $tpl = $mustache->loadTemplate('foo'); + + $this->assertSame($tpl, $mustache->loadPartial('foo')); + + $mustache->setPartials(array( + 'foo' => 'f00', + )); + + // setting partials overrides the default template loading fallback. + $this->assertNotSame($tpl, $mustache->loadPartial('foo')); + + // but it didn't overwrite the original template loader templates. + $this->assertSame($tpl, $mustache->loadTemplate('foo')); + } + public function testPartialLoadFailLogging() { $name = tempnam(sys_get_temp_dir(), 'mustache-test'); diff --git a/test/Mustache/Test/Exception/SyntaxExceptionTest.php b/test/Mustache/Test/Exception/SyntaxExceptionTest.php new file mode 100644 index 0000000..8914fbd --- /dev/null +++ b/test/Mustache/Test/Exception/SyntaxExceptionTest.php @@ -0,0 +1,27 @@ + 'this')); + $this->assertTrue($e instanceof LogicException); + $this->assertTrue($e instanceof Mustache_Exception); + } + + public function testGetToken() + { + $token = array(Mustache_Tokenizer::TYPE => 'whatever'); + $e = new Mustache_Exception_SyntaxException('ignore this', $token); + $this->assertEquals($token, $e->getToken()); + } +} diff --git a/test/Mustache/Test/Exception/UnknownFilterExceptionTest.php b/test/Mustache/Test/Exception/UnknownFilterExceptionTest.php new file mode 100644 index 0000000..8ba2e4d --- /dev/null +++ b/test/Mustache/Test/Exception/UnknownFilterExceptionTest.php @@ -0,0 +1,32 @@ +assertTrue($e instanceof UnexpectedValueException); + $this->assertTrue($e instanceof Mustache_Exception); + } + + public function testMessage() + { + $e = new Mustache_Exception_UnknownFilterException('sausage'); + $this->assertEquals('Unknown filter: sausage', $e->getMessage()); + } + + public function testGetFilterName() + { + $e = new Mustache_Exception_UnknownFilterException('eggs'); + $this->assertEquals('eggs', $e->getFilterName()); + } +} diff --git a/test/Mustache/Test/Exception/UnknownHelperExceptionTest.php b/test/Mustache/Test/Exception/UnknownHelperExceptionTest.php new file mode 100644 index 0000000..60567f9 --- /dev/null +++ b/test/Mustache/Test/Exception/UnknownHelperExceptionTest.php @@ -0,0 +1,32 @@ +assertTrue($e instanceof InvalidArgumentException); + $this->assertTrue($e instanceof Mustache_Exception); + } + + public function testMessage() + { + $e = new Mustache_Exception_UnknownHelperException('beta'); + $this->assertEquals('Unknown helper: beta', $e->getMessage()); + } + + public function testGetHelperName() + { + $e = new Mustache_Exception_UnknownHelperException('gamma'); + $this->assertEquals('gamma', $e->getHelperName()); + } +} diff --git a/test/Mustache/Test/Exception/UnknownTemplateExceptionTest.php b/test/Mustache/Test/Exception/UnknownTemplateExceptionTest.php new file mode 100644 index 0000000..001bc63 --- /dev/null +++ b/test/Mustache/Test/Exception/UnknownTemplateExceptionTest.php @@ -0,0 +1,32 @@ +assertTrue($e instanceof InvalidArgumentException); + $this->assertTrue($e instanceof Mustache_Exception); + } + + public function testMessage() + { + $e = new Mustache_Exception_UnknownTemplateException('luigi'); + $this->assertEquals('Unknown template: luigi', $e->getMessage()); + } + + public function testGetTemplateName() + { + $e = new Mustache_Exception_UnknownTemplateException('yoshi'); + $this->assertEquals('yoshi', $e->getTemplateName()); + } +} diff --git a/test/Mustache/Test/FiveThree/Functional/FiltersTest.php b/test/Mustache/Test/FiveThree/Functional/FiltersTest.php index 8c51e37..bbd037e 100644 --- a/test/Mustache/Test/FiveThree/Functional/FiltersTest.php +++ b/test/Mustache/Test/FiveThree/Functional/FiltersTest.php @@ -67,7 +67,7 @@ class Mustache_Test_FiveThree_Functional_FiltersTest extends PHPUnit_Framework_T } /** - * @expectedException UnexpectedValueException + * @expectedException Mustache_Exception_UnknownFilterException * @dataProvider getBrokenPipes */ public function testThrowsExceptionForBrokenPipes($tpl, $data) diff --git a/test/Mustache/Test/Loader/ArrayLoaderTest.php b/test/Mustache/Test/Loader/ArrayLoaderTest.php index 63d1a96..b1da190 100644 --- a/test/Mustache/Test/Loader/ArrayLoaderTest.php +++ b/test/Mustache/Test/Loader/ArrayLoaderTest.php @@ -42,7 +42,7 @@ class Mustache_Test_Loader_ArrayLoaderTest extends PHPUnit_Framework_TestCase } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_UnknownTemplateException */ public function testMissingTemplatesThrowExceptions() { diff --git a/test/Mustache/Test/Loader/CascadingLoaderTest.php b/test/Mustache/Test/Loader/CascadingLoaderTest.php new file mode 100644 index 0000000..06e1725 --- /dev/null +++ b/test/Mustache/Test/Loader/CascadingLoaderTest.php @@ -0,0 +1,40 @@ + '{{ foo }}')), + new Mustache_Loader_ArrayLoader(array('bar' => '{{#bar}}BAR{{/bar}}')), + )); + + $this->assertEquals('{{ foo }}', $loader->load('foo')); + $this->assertEquals('{{#bar}}BAR{{/bar}}', $loader->load('bar')); + } + + /** + * @expectedException Mustache_Exception_UnknownTemplateException + */ + public function testMissingTemplatesThrowExceptions() + { + $loader = new Mustache_Loader_CascadingLoader(array( + new Mustache_Loader_ArrayLoader(array('foo' => '{{ foo }}')), + new Mustache_Loader_ArrayLoader(array('bar' => '{{#bar}}BAR{{/bar}}')), + )); + + $loader->load('not_a_real_template'); + } +} diff --git a/test/Mustache/Test/Loader/FilesystemLoaderTest.php b/test/Mustache/Test/Loader/FilesystemLoaderTest.php index d12a6ff..92b12f9 100644 --- a/test/Mustache/Test/Loader/FilesystemLoaderTest.php +++ b/test/Mustache/Test/Loader/FilesystemLoaderTest.php @@ -44,7 +44,7 @@ class Mustache_Test_Loader_FilesystemLoaderTest extends PHPUnit_Framework_TestCa } /** - * @expectedException RuntimeException + * @expectedException Mustache_Exception_RuntimeException */ public function testMissingBaseDirThrowsException() { @@ -52,7 +52,7 @@ class Mustache_Test_Loader_FilesystemLoaderTest extends PHPUnit_Framework_TestCa } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_UnknownTemplateException */ public function testMissingTemplateThrowsException() { diff --git a/test/Mustache/Test/Loader/InlineLoaderTest.php b/test/Mustache/Test/Loader/InlineLoaderTest.php new file mode 100644 index 0000000..52a24bd --- /dev/null +++ b/test/Mustache/Test/Loader/InlineLoaderTest.php @@ -0,0 +1,56 @@ +assertEquals('{{ foo }}', $loader->load('foo')); + $this->assertEquals('{{#bar}}BAR{{/bar}}', $loader->load('bar')); + } + + /** + * @expectedException Mustache_Exception_UnknownTemplateException + */ + public function testMissingTemplatesThrowExceptions() + { + $loader = new Mustache_Loader_InlineLoader(__FILE__, __COMPILER_HALT_OFFSET__); + $loader->load('not_a_real_template'); + } + + /** + * @expectedException Mustache_Exception_InvalidArgumentException + */ + public function testInvalidOffsetThrowsException() + { + $loader = new Mustache_Loader_InlineLoader(__FILE__, 'notanumber'); + } + + /** + * @expectedException Mustache_Exception_InvalidArgumentException + */ + public function testInvalidFileThrowsException() + { + $loader = new Mustache_Loader_InlineLoader('notarealfile', __COMPILER_HALT_OFFSET__); + } +} + +__halt_compiler(); + +@@ foo +{{ foo }} + +@@ bar +{{#bar}}BAR{{/bar}} diff --git a/test/Mustache/Test/Logger/StreamLoggerTest.php b/test/Mustache/Test/Logger/StreamLoggerTest.php index 9dfd4c2..4ddbcec 100644 --- a/test/Mustache/Test/Logger/StreamLoggerTest.php +++ b/test/Mustache/Test/Logger/StreamLoggerTest.php @@ -34,7 +34,7 @@ class Mustache_Test_Logger_StreamLoggerTest extends PHPUnit_Framework_TestCase } /** - * @expectedException LogicException + * @expectedException Mustache_Exception_LogicException */ public function testPrematurelyClosedStreamThrowsException() { @@ -187,7 +187,7 @@ class Mustache_Test_Logger_StreamLoggerTest extends PHPUnit_Framework_TestCase } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_InvalidArgumentException */ public function testThrowsInvalidArgumentExceptionWhenSettingUnknownLevels() { @@ -196,7 +196,7 @@ class Mustache_Test_Logger_StreamLoggerTest extends PHPUnit_Framework_TestCase } /** - * @expectedException InvalidArgumentException + * @expectedException Mustache_Exception_InvalidArgumentException */ public function testThrowsInvalidArgumentExceptionWhenLoggingUnknownLevels() { diff --git a/test/Mustache/Test/ParserTest.php b/test/Mustache/Test/ParserTest.php index 5f898d8..a99b848 100644 --- a/test/Mustache/Test/ParserTest.php +++ b/test/Mustache/Test/ParserTest.php @@ -108,7 +108,7 @@ class Mustache_Test_ParserTest extends PHPUnit_Framework_TestCase /** * @dataProvider getBadParseTrees - * @expectedException LogicException + * @expectedException Mustache_Exception_SyntaxException */ public function testParserThrowsExceptions($tokens) {