Raise exception when creating HelperPluginManager if container is invalid

zend-servicemanager currently typehints against container-interop, which
means that if we have a container that does not implement
container-interop, we need to raise an exception when attempting to
create a `HelperPluginManager` instance.

Author: weierophinney

src/Exception/InvalidContainerException.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-expressive-zendviewrenderer for the canonical source repository
+ * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive-zendviewrenderer/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace Zend\Expressive\ZendView\Exception;
+
+use RuntimeException;
+
+class InvalidContainerException extends RuntimeException implements ExceptionInterface
+{
+}

src/ZendViewRendererFactory.php

@@ -9,6 +9,7 @@
 
 namespace Zend\Expressive\ZendView;
 
+use Interop\Container\ContainerInterface as InteropContainerInterface;
 use Psr\Container\ContainerInterface;
 use Zend\Expressive\Helper\ServerUrlHelper as BaseServerUrlHelper;
 use Zend\Expressive\Helper\UrlHelper as BaseUrlHelper;
@@ -92,14 +93,13 @@ public function __invoke(ContainerInterface $container) : ZendViewRenderer
      *
      * In each case, injects with the custom url/serverurl implementations.
      *
+     * @throws Exception\InvalidContainerException if the $container argument
+     *     does not implement InteropContainerInterface.
      * @throws Exception\MissingHelperException
      */
     private function injectHelpers(PhpRenderer $renderer, ContainerInterface $container) : void
     {
-        $helpers = $container->has(HelperPluginManager::class)
-            ? $container->get(HelperPluginManager::class)
-            : new HelperPluginManager($container);
-
+        $helpers = $this->retrieveHelperManager($container);
         $helpers->setAlias('url', BaseUrlHelper::class);
         $helpers->setAlias('Url', BaseUrlHelper::class);
         $helpers->setFactory(BaseUrlHelper::class, function () use ($container) {
@@ -127,4 +127,29 @@ private function injectHelpers(PhpRenderer $renderer, ContainerInterface $contai
 
         $renderer->setHelperPluginManager($helpers);
     }
+
+    /**
+     * @throws Exception\InvalidContainerException if the $container argument
+     *     does not implement InteropContainerInterface.
+     */
+    private function retrieveHelperManager(ContainerInterface $container) : HelperPluginManager
+    {
+        if ($container->has(HelperPluginManager::class)) {
+            return $container->get(HelperPluginManager::class);
+        }
+
+        if (! $container instanceof InteropContainerInterface) {
+            throw new Exception\InvalidContainerException(sprintf(
+                '%s expects a %s instance to its constructor; however, your service'
+                . ' container is an instance of %s, which does not implement that'
+                . ' interface. Consider switching to zend-servicemanager for your'
+                . ' container implementation if you wish to use the zend-view renderer.',
+                HelperPluginManager::class,
+                InteropContainerInterface::class,
+                get_class($container)
+            ));
+        }
+
+        return new HelperPluginManager($container);
+    }
 }

test/ZendViewRendererFactoryTest.php

@@ -13,9 +13,11 @@
 use PHPUnit\Framework\TestCase;
 use Prophecy\Prophecy\ObjectProphecy;
 use Prophecy\Prophecy\ProphecyInterface;
+use Psr\Container\ContainerInterface as PsrContainerInterface;
 use ReflectionProperty;
 use Zend\Expressive\Helper;
 use Zend\Expressive\Template\TemplatePath;
+use Zend\Expressive\ZendView\Exception\InvalidContainerException;
 use Zend\Expressive\ZendView\ServerUrlHelper;
 use Zend\Expressive\ZendView\UrlHelper;
 use Zend\Expressive\ZendView\ZendViewRenderer;
@@ -304,4 +306,19 @@ public function testWillUseRendererFromContainer()
         $composed = $this->fetchPhpRenderer($view);
         $this->assertSame($engine, $composed);
     }
+
+    public function testWillRaiseExceptionIfContainerDoesNotImplementInteropContainerInterface()
+    {
+        $container = $this->prophesize(PsrContainerInterface::class);
+        $container->has('config')->willReturn(false);
+        $container->get('config')->shouldNotBeCalled();
+        $container->has(PhpRenderer::class)->willReturn(false);
+        $container->get(PhpRenderer::class)->shouldNotBeCalled();
+        $container->has(HelperPluginManager::class)->willReturn(false);
+
+        $factory = new ZendViewRendererFactory();
+
+        $this->expectException(InvalidContainerException::class);
+        $factory($container->reveal());
+    }
 }