Introduce psr to interop container decorator

Enables plugin managers to accept non-interop psr containers as creation
context and transparently wrap as interop for backward compatibility

Author: Xerkus

src/AbstractPluginManager.php

@@ -8,6 +8,7 @@
 namespace Zend\ServiceManager;
 
 use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface as PsrContainerInterface;
 use Zend\ServiceManager\Exception\InvalidServiceException;
 
 /**
@@ -52,6 +53,11 @@ abstract class AbstractPluginManager extends ServiceManager implements PluginMan
      */
     public function __construct($configInstanceOrParentLocator = null, array $config = [])
     {
+        if ($configInstanceOrParentLocator instanceof PsrContainerInterface
+            && ! $configInstanceOrParentLocator instanceof ContainerInterface
+        ) {
+            $configInstanceOrParentLocator = new PsrContainerDecorator($configInstanceOrParentLocator);
+        }
         if (null !== $configInstanceOrParentLocator
             && ! $configInstanceOrParentLocator instanceof ConfigInterface
             && ! $configInstanceOrParentLocator instanceof ContainerInterface

src/PsrContainerDecorator.php

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * @link      http://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\ServiceManager;
+
+use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\ContainerInterface as PsrContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
+
+/**
+ * @internal for use in abstract plugin manager
+ */
+final class PsrContainerDecorator implements ContainerInterface
+{
+    /**
+     * @var PsrContainerInterface
+     */
+    private $container;
+
+    public function __construct(PsrContainerInterface $container)
+    {
+        $this->container = $container;
+    }
+
+    /**
+     * Finds an entry of the container by its identifier and returns it.
+     *
+     * @param string $id Identifier of the entry to look for.
+     *
+     * @throws NotFoundExceptionInterface  No entry was found for **this** identifier.
+     * @throws ContainerExceptionInterface Error while retrieving the entry.
+     *
+     * @return mixed Entry.
+     */
+    public function get($id)
+    {
+        return $this->container->get($id);
+    }
+
+    /**
+     * Returns true if the container can return an entry for the given identifier.
+     * Returns false otherwise.
+     *
+     * `has($id)` returning true does not mean that `get($id)` will not throw an exception.
+     * It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`.
+     *
+     * @param string $id Identifier of the entry to look for.
+     *
+     * @return bool
+     */
+    public function has($id)
+    {
+        return $this->container->has($id);
+    }
+
+    /**
+     * @return PsrContainerInterface
+     */
+    public function getContainer()
+    {
+        return $this->container;
+    }
+}

test/AbstractPluginManagerTest.php

@@ -9,14 +9,17 @@
 
 use Interop\Container\ContainerInterface;
 use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerInterface as PsrContainerInterface;
 use stdClass;
+use Zend\ServiceManager\AbstractPluginManager;
 use Zend\ServiceManager\ConfigInterface;
 use Zend\ServiceManager\Exception\InvalidArgumentException;
 use Zend\ServiceManager\Exception\InvalidServiceException;
 use Zend\ServiceManager\Exception\ServiceNotFoundException;
 use Zend\ServiceManager\Factory\AbstractFactoryInterface;
 use Zend\ServiceManager\Factory\FactoryInterface;
 use Zend\ServiceManager\Factory\InvokableFactory;
+use Zend\ServiceManager\PsrContainerDecorator;
 use Zend\ServiceManager\ServiceManager;
 use ZendTest\ServiceManager\TestAsset\InvokableObject;
 use ZendTest\ServiceManager\TestAsset\SimplePluginManager;
@@ -60,6 +63,32 @@ public function testInjectCreationContextInFactories()
         $this->assertInstanceOf(InvokableObject::class, $object);
     }
 
+    public function testTransparentlyDecoratesNonInteropPsrContainerAsInteropContainer()
+    {
+        $invokableFactory = $this->getMockBuilder(FactoryInterface::class)
+            ->getMock();
+        $invokableFactory->method('__invoke')
+            ->will($this->returnArgument(0));
+
+        $config = [
+            'factories' => [
+                'creation context container' => $invokableFactory,
+            ],
+        ];
+
+        $container     = $this->getMockBuilder(PsrContainerInterface::class)
+            ->getMock();
+        $pluginManager = $this->getMockForAbstractClass(
+            AbstractPluginManager::class,
+            [$container, $config]
+        );
+
+        $object = $pluginManager->get('creation context container');
+
+        $this->assertInstanceOf(PsrContainerDecorator::class, $object);
+        $this->assertSame($container, $object->getContainer());
+    }
+
     public function testValidateInstance()
     {
         $config = [

test/PsrContainerDecoratorTest.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\ServiceManager;
+
+use Psr\Container\ContainerInterface;
+use stdClass;
+use Zend\ServiceManager\PsrContainerDecorator;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \Zend\ServiceManager\PsrContainerDecorator
+ */
+class PsrContainerDecoratorTest extends TestCase
+{
+    public function testProxiesHasToDecoratedContainer()
+    {
+        $psrContainer = $this->getMockBuilder(ContainerInterface::class)
+            ->getMock();
+        $psrContainer->expects($this->exactly(2))
+            ->method('has')
+            ->with('string key')
+            ->willReturnOnConsecutiveCalls(true, false);
+        $decorator = new PsrContainerDecorator($psrContainer);
+        $this->assertTrue($decorator->has('string key'));
+        $this->assertFalse($decorator->has('string key'));
+    }
+
+    public function testProxiesGetToDecoratedContainer()
+    {
+        $service = new stdClass();
+        $psrContainer = $this->getMockBuilder(ContainerInterface::class)
+            ->getMock();
+        $psrContainer->expects($this->once())
+            ->method('get')
+            ->with('string key')
+            ->willReturn($service);
+        $decorator = new PsrContainerDecorator($psrContainer);
+        $this->assertSame($service, $decorator->get('string key'));
+    }
+
+    public function testGetterReturnsDecoratedContainer()
+    {
+        $psrContainer = $this->getMockBuilder(ContainerInterface::class)
+            ->getMock();
+        $decorator = new PsrContainerDecorator($psrContainer);
+        $this->assertSame($psrContainer, $decorator->getContainer());
+    }
+}