Test for ensuring, that the PhpRenderer doesnt use previous rendered output

.travis.yml

@@ -15,6 +15,7 @@ cache:
 
 env:
   global:
+    - COMPOSER_PROCESS_TIMEOUT=600
     - COMPOSER_ARGS="--no-interaction"
     - COVERAGE_DEPS="satooshi/php-coveralls"
     - LEGACY_DEPS="phpunit/phpunit"

CHANGELOG.md

@@ -6,7 +6,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#136](https://github.com/zendframework/zend-view/pull/136) updates the
+  `Navigation` helper class to document the various proxy methods it allows via
+  method overloading via `@method` annotations.
 
 ### Deprecated
 
@@ -18,7 +20,14 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#123](https://github.com/zendframework/zend-view/pull/123) updates the
+  `HelperPluginManager` such that it no longer injects a translator in a helper
+  if one is already present.
+
+- [#125](https://github.com/zendframework/zend-view/pull/125) provides an update
+  to the `PhpRenderer:render()` method such that it will now catch not only
+  `Exception` instances, but also PHP 7 `Throwable` instances, and properly
+  cleanup the output buffers when it does.
 
 ## 2.9.0 - 2017-03-21
 

composer.json

@@ -61,7 +61,7 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "config": {
-        "sort-packages": "true"
+        "sort-packages": true
     },
     "extra": {
         "branch-alias": {

doc/book/helpers/json.md

@@ -29,5 +29,5 @@ determine how to handle the content.
 > `enableJsonExprFinder` key of the options array:
 >
 > ```php
-> <?= $this-json($this-data, ['enableJsonExprFinder' = true]) ?>
+> <?= $this->json($this->data, ['enableJsonExprFinder' => true]) ?>
 > ```

doc/book/php-renderer.md

@@ -72,8 +72,8 @@ $stack = new Resolver\TemplatePathStack([
 $resolver
     ->attach($map)    // this will be consulted first, and is the fastest lookup
     ->attach($stack)  // filesystem-based lookup
-    ->attach(new Resolver\RelativeFallbackResolver($map) // allow short template names
-    ->attach(new Resolver\RelativeFallbackResolver($stack);
+    ->attach(new Resolver\RelativeFallbackResolver($map)) // allow short template names
+    ->attach(new Resolver\RelativeFallbackResolver($stack));
 ```
 
 You can also specify a specific priority value when registering resolvers, with

src/Helper/HeadMeta.php

@@ -322,7 +322,7 @@ protected function normalizeType($type)
     /**
      * Determine if item is valid
      *
-     * @param  mixed $item
+     * @param  stdClass $item
      * @return bool
      */
     protected function isValid($item)
@@ -334,22 +334,27 @@ protected function isValid($item)
             return false;
         }
 
+        $doctype = $this->view->plugin('doctype');
+        if ($item->type === 'charset' && $doctype->isXhtml()) {
+            return false;
+        }
+
         if (! isset($item->content)
-            && (! $this->view->plugin('doctype')->isHtml5()
-            || (! $this->view->plugin('doctype')->isHtml5() && $item->type !== 'charset'))
+            && (! $doctype->isHtml5()
+            || (! $doctype->isHtml5() && $item->type !== 'charset'))
         ) {
             return false;
         }
 
         // <meta itemprop= ... /> is only supported with doctype html
-        if (! $this->view->plugin('doctype')->isHtml5()
+        if (! $doctype->isHtml5()
             && $item->type === 'itemprop'
         ) {
             return false;
         }
 
         // <meta property= ... /> is only supported with doctype RDFa
-        if (! $this->view->plugin('doctype')->isRdfa()
+        if (! $doctype->isRdfa()
             && $item->type === 'property'
         ) {
             return false;
@@ -361,15 +366,15 @@ protected function isValid($item)
     /**
      * Append
      *
-     * @param  string $value
-     * @return void
+     * @param  stdClass $value
+     * @return View\Helper\Placeholder\Container\AbstractContainer
      * @throws Exception\InvalidArgumentException
      */
     public function append($value)
     {
         if (! $this->isValid($value)) {
             throw new Exception\InvalidArgumentException(
-                'Invalid value passed to append; please use appendMeta()'
+                'Invalid value passed to append'
             );
         }
 
@@ -382,7 +387,6 @@ public function append($value)
      * @param  string|int $index
      * @param  string     $value
      * @throws Exception\InvalidArgumentException
-     * @return void
      */
     public function offsetSet($index, $value)
     {
@@ -400,7 +404,6 @@ public function offsetSet($index, $value)
      *
      * @param  string|int $index
      * @throws Exception\InvalidArgumentException
-     * @return void
      */
     public function offsetUnset($index)
     {
@@ -414,15 +417,15 @@ public function offsetUnset($index)
     /**
      * Prepend
      *
-     * @param  string $value
+     * @param  stdClass $value
      * @throws Exception\InvalidArgumentException
-     * @return void
+     * @return View\Helper\Placeholder\Container\AbstractContainer
      */
     public function prepend($value)
     {
         if (! $this->isValid($value)) {
             throw new Exception\InvalidArgumentException(
-                'Invalid value passed to prepend; please use prependMeta()'
+                'Invalid value passed to prepend'
             );
         }
 
@@ -432,14 +435,14 @@ public function prepend($value)
     /**
      * Set
      *
-     * @param  string $value
+     * @param  stdClass $value
      * @throws Exception\InvalidArgumentException
-     * @return void
+     * @return View\Helper\Placeholder\Container\AbstractContainer
      */
     public function set($value)
     {
         if (! $this->isValid($value)) {
-            throw new Exception\InvalidArgumentException('Invalid value passed to set; please use setMeta()');
+            throw new Exception\InvalidArgumentException('Invalid value passed to set');
         }
 
         $container = $this->getContainer();
@@ -458,6 +461,7 @@ public function set($value)
      * Not valid in a non-HTML5 doctype
      *
      * @param  string $charset
+     * @param  Exception\InvalidArgumentException
      * @return HeadMeta Provides a fluent interface
      */
     public function setCharset($charset)
@@ -467,6 +471,11 @@ public function setCharset($charset)
         $item->charset = $charset;
         $item->content = null;
         $item->modifiers = [];
+
+        if (! $this->isValid($item)) {
+            throw new Exception\InvalidArgumentException('XHTML* doctype has no attribute charset; please use appendHttpEquiv()');
+        }
+
         $this->set($item);
 
         return $this;

src/Helper/Navigation.php

@@ -17,6 +17,11 @@
 
 /**
  * Proxy helper for retrieving navigational helpers and forwarding calls
+ *
+ * @method \Zend\View\Helper\Navigation\Breadcrumbs breadcrumbs($container = null)
+ * @method \Zend\View\Helper\Navigation\Links links($container = null)
+ * @method \Zend\View\Helper\Navigation\Menu menu($container = null)
+ * @method \Zend\View\Helper\Navigation\Sitemap sitemap($container = null)
  */
 class Navigation extends AbstractNavigationHelper
 {

src/HelperPluginManager.php

@@ -337,6 +337,10 @@ public function injectTranslator($first, $second)
             return;
         }
 
+        if (method_exists($helper, 'hasTranslator') && $helper->hasTranslator()) {
+            return;
+        }
+
         if ($container->has('MvcTranslator')) {
             $helper->setTranslator($container->get('MvcTranslator'));
             return;

src/Renderer/PhpRenderer.php

@@ -491,6 +491,7 @@ public function render($nameOrModel, $values = null)
         extract($__vars);
         unset($__vars); // remove $__vars from local scope
 
+        $this->__content = '';
         while ($this->__template = array_pop($this->__templates)) {
             $this->__file = $this->resolver($this->__template);
             if (! $this->__file) {
@@ -504,7 +505,10 @@ public function render($nameOrModel, $values = null)
                 ob_start();
                 $includeReturn = include $this->__file;
                 $this->__content = ob_get_clean();
-            } catch (\Exception $ex) {
+            } catch (\Throwable $ex) {
+                ob_end_clean();
+                throw $ex;
+            } catch (\Exception $ex) { // @TODO clean up once PHP 7 requirement is enforced
                 ob_end_clean();
                 throw $ex;
             }

test/Helper/DoctypeTest.php

@@ -137,7 +137,7 @@ public function testIsHtml5()
 
     public function testIsRdfa()
     {
-        // ensure default registerd Doctype is false
+        // ensure default registered Doctype is false
         $this->assertFalse($this->helper->isRdfa());
 
         $this->assertTrue($this->helper->__invoke(Helper\Doctype::XHTML1_RDFA)->isRdfa());

test/Helper/HeadMetaTest.php

@@ -440,6 +440,18 @@ public function testCharsetPosition()
         );
     }
 
+    public function testCarsetWithXhtmlDoctypeGotException()
+    {
+        $this->expectException(Exception\InvalidArgumentException::class);
+        $this->expectExceptionMessage('XHTML* doctype has no attribute charset; please use appendHttpEquiv()');
+
+        $view = new View();
+        $view->plugin('doctype')->__invoke('XHTML1_RDFA');
+
+        $view->plugin('headMeta')
+             ->setCharset('utf-8');
+    }
+
      /**
      * @group ZF-9743
      */

test/HelperPluginManagerTest.php

@@ -186,6 +186,28 @@ public function testInjectTranslatorWillReturnEarlyIfThePluginManagerDoesNotHave
         $this->assertNull($helper->getTranslator());
     }
 
+    public function testInjectTranslatorWillReturnEarlyIfTheHelperHasTranslatorAlready()
+    {
+        $translatorA = new Translator();
+        $translatorB = new Translator();
+        $config = new Config(['services' => [
+            'Translator' => $translatorB,
+        ]]);
+        $services = new ServiceManager();
+        $config->configureServiceManager($services);
+        $helpers = new HelperPluginManager($services);
+        $helpers->setFactory(
+            'TestHelper',
+            function () use ($translatorA) {
+                $helper = new HeadTitle();
+                $helper->setTranslator($translatorA);
+                return $helper;
+            }
+        );
+        $helperB = $helpers->get('TestHelper');
+        $this->assertSame($translatorA, $helperB->getTranslator());
+    }
+
     public function testCanOverrideAFactoryViaConfigurationPassedToConstructor()
     {
         $helper  = $this->prophesize(HelperInterface::class)->reveal();

test/PhpRendererTest.php

@@ -481,4 +481,34 @@ public function testDoesNotCallFilterChainIfNoFilterChainWasSet()
         $this->assertContains('Empty view', $result);
         $this->assertAttributeEmpty('__filterChain', $this->renderer);
     }
+
+    /**
+     * @group zend-view-120
+     * @see https://github.com/zendframework/zend-view/issues/120
+     */
+    public function testRendererDoesntUsePreviousRenderedOutputWhenInvokedWithEmptyString()
+    {
+        $this->renderer->resolver()->addPath(__DIR__ . '/_templates');
+
+        $previousOutput = $this->renderer->render('empty.phtml');
+
+        $actual = $this->renderer->render('');
+
+        $this->assertNotSame($previousOutput, $actual);
+    }
+
+    /**
+     * @group zend-view-120
+     * @see https://github.com/zendframework/zend-view/issues/120
+     */
+    public function testRendererDoesntUsePreviousRenderedOutputWhenInvokedWithFalse()
+    {
+        $this->renderer->resolver()->addPath(__DIR__ . '/_templates');
+
+        $previousOutput = $this->renderer->render('empty.phtml');
+
+        $actual = $this->renderer->render(false);
+
+        $this->assertNotSame($previousOutput, $actual);
+    }
 }