Merge branch 'feature/275'

Close #257

Author: Xerkus

CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 3.4.0 - TBD
+
+### Added
+
+- [#275](https://github.com/zendframework/zend-servicemanager/pull/275) Enables plugin managers to accept as a creation context PSR Containers not implementing Interop interface
+
+### Changed
+
+- Nothing.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 3.3.2 - 2018-01-29
 
 ### Added
@@ -61,7 +83,7 @@ All notable changes to this project will be documented in this file, in reverse
   container-interop at a minimum version of 1.2.0, and adding a requirement on
   psr/container 1.0. `Zend\ServiceManager\ServiceLocatorInterface` now
   explicitly extends the `ContainerInterface` from both projects.
-  
+
   Factory interfaces still typehint against the container-interop variant, as
   changing the typehint would break backwards compatibility. Users can
   duck-type most of these interfaces, however, by creating callables or
@@ -339,7 +361,7 @@ Documentation is now available at http://zend-servicemanager.rtfd.org
   (previously, it was the third).
 
   Example:
-  
+
   ```php
   $sm = new \Zend\ServiceManager\ServiceManager([
       'factories'  => [
@@ -348,7 +370,7 @@ Documentation is now available at http://zend-servicemanager.rtfd.org
           'MyClassC'      => 'MyFactory' // This is equivalent as using ::class
       ],
   ]);
-  
+
   $sm->get(MyClassA::class); // MyFactory will receive MyClassA::class as second parameter
   ```
 
@@ -367,7 +389,7 @@ Documentation is now available at http://zend-servicemanager.rtfd.org
         if ($instance instanceof \Zend\Validator\ValidatorInterface) {
             return;
         }
-    
+
         throw new InvalidServiceException(sprintf(
             'Plugin manager "%s" expected an instance of type "%s", but "%s" was received',
              __CLASS__,
@@ -377,19 +399,19 @@ Documentation is now available at http://zend-servicemanager.rtfd.org
     }
   }
   ```
-  
+
   In version 3, this becomes:
-  
+
   ```php
   use Zend\ServiceManager\AbstractPluginManager;
   use Zend\Validator\ValidatorInterface;
-  
+
   class MyPluginManager extends AbstractPluginManager
   {
       protected $instanceOf = ValidatorInterface::class;
   }
   ```
-  
+
   Of course, you can still override the `validate` method if your logic is more
   complex.
 
@@ -433,17 +455,17 @@ changes, outlined in this section.
   service manager; you can pass the configuration array directly instead.
 
   In version 2.x:
-  
+
   ```php
   $config = new \Zend\ServiceManager\Config([
       'factories'  => [...]
   ]);
-  
+
   $sm = new \Zend\ServiceManager\ServiceManager($config);
   ```
-  
+
   In ZF 3.x:
-  
+
   ```php
   $sm = new \Zend\ServiceManager\ServiceManager([
       'factories'  => [...]
@@ -472,7 +494,7 @@ changes, outlined in this section.
   argument if present.
 
   For instance, here is a simple version 2.x factory:
-  
+
   ```php
   class MyFactory implements FactoryInterface
   {
@@ -482,9 +504,9 @@ changes, outlined in this section.
       }
   }
   ```
-  
+
   The equivalent version 3 factory:
-  
+
   ```php
   class MyFactory implements FactoryInterface
   {
@@ -514,23 +536,23 @@ changes, outlined in this section.
   through the interface.
 
   In version 2.x, if a factory was set to a service name defined in a plugin manager:
-  
+
   ```php
   class MyFactory implements FactoryInterface
   {
       function createService(ServiceLocatorInterface $sl)
       {
           // $sl is actually a plugin manager
-        
+
           $parentLocator = $sl->getServiceLocator();
-        
+
           // ...
       }
   }
   ```
-  
+
   In version 3:
-  
+
   ```php
   class MyFactory implements FactoryInterface
   {

src/AbstractPluginManager.php

@@ -1,13 +1,14 @@
 <?php
 /**
- * @link      http://github.com/zendframework/zend-servicemanager for the canonical source repository
- * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-servicemanager/blob/master/LICENSE.md New BSD License
  */
 
 namespace Zend\ServiceManager;
 
 use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface as PsrContainerInterface;
 use Zend\ServiceManager\Exception\InvalidServiceException;
 
 /**
@@ -47,11 +48,21 @@ abstract class AbstractPluginManager extends ServiceManager implements PluginMan
      * factories; for $config, {@see \Zend\ServiceManager\ServiceManager::configure()}
      * for details on its accepted structure.
      *
-     * @param null|ConfigInterface|ContainerInterface $configInstanceOrParentLocator
+     * @param null|ConfigInterface|ContainerInterface|PsrContainerInterface $configInstanceOrParentLocator
      * @param array $config
      */
     public function __construct($configInstanceOrParentLocator = null, array $config = [])
     {
+        if ($configInstanceOrParentLocator instanceof PsrContainerInterface
+            && ! $configInstanceOrParentLocator instanceof ContainerInterface
+        ) {
+            /**
+             * {@see \Zend\ServiceManager\Factory\FactoryInterface} typehints
+             * against interop container and as such cannot accept non-interop
+             * psr container. Decorate it as interop.
+             */
+            $configInstanceOrParentLocator = new PsrContainerDecorator($configInstanceOrParentLocator);
+        }
         if (null !== $configInstanceOrParentLocator
             && ! $configInstanceOrParentLocator instanceof ConfigInterface
             && ! $configInstanceOrParentLocator instanceof ContainerInterface

src/PsrContainerDecorator.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-servicemanager/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\ServiceManager;
+
+use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface as PsrContainerInterface;
+
+/**
+ * @internal for use in abstract plugin manager
+ */
+final class PsrContainerDecorator implements ContainerInterface
+{
+    /**
+     * @var PsrContainerInterface
+     */
+    private $container;
+
+    public function __construct(PsrContainerInterface $container)
+    {
+        $this->container = $container;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get($id)
+    {
+        return $this->container->get($id);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function has($id)
+    {
+        return $this->container->has($id);
+    }
+
+    /**
+     * @return PsrContainerInterface
+     */
+    public function getContainer()
+    {
+        return $this->container;
+    }
+}

test/AbstractPluginManagerTest.php

@@ -1,22 +1,25 @@
 <?php
 /**
- * @link      http://github.com/zendframework/zend-servicemanager for the canonical source repository
- * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-servicemanager/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendTest\ServiceManager;
 
 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
+/**
+ * @see       https://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-servicemanager/blob/master/LICENSE.md 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());
+    }
+}