Merge branch 'hotfix/console-usage' into develop

Close #81

Author: weierophinney

CHANGELOG.md

@@ -53,15 +53,21 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Removed
 
-- Nothing.
+- `Zend\Mvc\Controller\AbstractController` no longer directly implements
+  `Zend\ServiceManager\ServiceLocatorAwareInterface`, but still implements the
+  methods defined in that interface. This was done to provide
+  forwards-compatibility, as zend-servicemanager v3 no longer defines the
+  interface. All initializers that do `ServiceLocatorInterface` injection were
+  updated to also inject when just the methods are present.
 
 ### Fixed
 
 - [#31](https://github.com/zendframework/zend-mvc/pull/31) and
   [#76](https://github.com/zendframework/zend-mvc/pull/76) update the component
   to be forwards-compatible with zend-eventmanager v3.
-- [#36](https://github.com/zendframework/zend-mvc/pull/36) and
-  [#76](https://github.com/zendframework/zend-mvc/pull/76) update the component
+- [#36](https://github.com/zendframework/zend-mvc/pull/36),
+  [#76](https://github.com/zendframework/zend-mvc/pull/76), and
+  [#81](https://github.com/zendframework/zend-mvc/pull/81) update the component
   to be forwards-compatible with zend-servicemanager v3. Several changes were
   introduced to support this effort:
   - Added a `RouteInvokableFactory`, which can act as either a

src/Controller/AbstractController.php

@@ -17,6 +17,7 @@
 use Zend\Http\Request as HttpRequest;
 use Zend\Mvc\InjectApplicationEventInterface;
 use Zend\Mvc\MvcEvent;
+use Zend\ServiceManager\ServiceLocatorInterface;
 use Zend\ServiceManager\ServiceManager;
 use Zend\Stdlib\DispatchableInterface as Dispatchable;
 use Zend\Stdlib\RequestInterface as Request;
@@ -62,6 +63,11 @@ abstract class AbstractController implements
      */
     protected $response;
 
+    /**
+     * @var ServiceLocatorInterface
+     */
+    protected $serviceLocator;
+
     /**
      * @var Event
      */
@@ -224,6 +230,27 @@ public function getEvent()
         return $this->event;
     }
 
+    /**
+     * Set serviceManager instance
+     *
+     * @param ServiceLocatorInterface $serviceLocator
+     * @return void
+     */
+    public function setServiceLocator(ServiceLocatorInterface $serviceLocator)
+    {
+        $this->serviceLocator = $serviceLocator;
+    }
+
+    /**
+     * Retrieve serviceManager instance
+     *
+     * @return ServiceLocatorInterface
+     */
+    public function getServiceLocator()
+    {
+        return $this->serviceLocator;
+    }
+
     /**
      * Get plugin manager
      *

src/Controller/ControllerManager.php

@@ -16,6 +16,7 @@
 use Zend\ServiceManager\AbstractPluginManager;
 use Zend\ServiceManager\ConfigInterface;
 use Zend\ServiceManager\Exception\InvalidServiceException;
+use Zend\ServiceManager\ServiceLocatorAwareInterface;
 use Zend\Stdlib\DispatchableInterface;
 
 /**
@@ -54,6 +55,10 @@ public function __construct($configOrContainerInstance, array $v3config = [])
         $this->addInitializer([$this, 'injectConsole']);
         $this->addInitializer([$this, 'injectPluginManager']);
         parent::__construct($configOrContainerInstance, $v3config);
+
+        // Added after parent construction, as v2 abstract plugin managers add
+        // one during construction.
+        $this->addInitializer([$this, 'injectServiceLocator']);
     }
 
     /**
@@ -191,4 +196,51 @@ public function injectPluginManager($first, $second)
 
         $controller->setPluginManager($container->get('ControllerPluginManager'));
     }
+
+    /**
+     * Initializer: inject service locator
+     *
+     * @param ContainerInterface|DispatchableInterface $first Container when
+     *     using zend-servicemanager v3; controller under v2.
+     * @param DispatchableInterface|ContainerInterface $second Controller when
+     *     using zend-servicemanager v3; container under v2.
+     */
+    public function injectServiceLocator($first, $second)
+    {
+        printf("In %s\n", __METHOD__);
+        if ($first instanceof ContainerInterface) {
+            $container = $first;
+            $controller = $second;
+        } else {
+            $container = $second;
+            $controller = $first;
+        }
+
+        // For v2, we need to pull the parent service locator
+        if (! method_exists($container, 'configure')) {
+            $container = $container->getServiceLocator() ?: $container;
+        }
+
+        if (! $controller instanceof ServiceLocatorAwareInterface
+            && method_exists($controller, 'setServiceLocator')
+        ) {
+            trigger_error(sprintf(
+                'ServiceLocatorAwareInterface is deprecated and will be removed in version 3.0, along '
+                . 'with the ServiceLocatorAwareInitializer. Please update your class %s to remove '
+                . 'the implementation, and start injecting your dependencies via factory instead.',
+                get_class($controller)
+            ), E_USER_DEPRECATED);
+            $controller->setServiceLocator($container);
+        }
+
+        if ($controller instanceof ServiceLocatorAwareInterface) {
+            trigger_error(sprintf(
+                'ServiceLocatorAwareInterface is deprecated and will be removed in version 3.0, along '
+                . 'with the ServiceLocatorAwareInitializer. Please update your class %s to remove '
+                . 'the implementation, and start injecting your dependencies via factory instead.',
+                get_class($controller)
+            ), E_USER_DEPRECATED);
+            $controller->setServiceLocator($container);
+        }
+    }
 }

src/Router/Console/SimpleRouteStack.php

@@ -42,8 +42,8 @@ protected function init()
                 Simple::class   => RouteInvokableFactory::class,
 
                 // v2 normalized names
-                'zendmvcrouterconsoleCatchall' => RouteInvokableFactory::class,
-                'zendmvcrouterconsoleSimple'   => RouteInvokableFactory::class,
+                'zendmvcrouterconsolecatchall' => RouteInvokableFactory::class,
+                'zendmvcrouterconsolesimple'   => RouteInvokableFactory::class,
             ],
         ]))->configureServiceManager($this->routePluginManager);
     }
@@ -79,19 +79,21 @@ protected function routeFromArray($specs)
     {
         if ($specs instanceof Traversable) {
             $specs = ArrayUtils::iteratorToArray($specs);
-        } elseif (!is_array($specs)) {
+        }
+
+        if (! is_array($specs)) {
             throw new Exception\InvalidArgumentException('Route definition must be an array or Traversable object');
         }
 
         // default to 'simple' console route
-        if (!isset($specs['type'])) {
-            $specs['type'] = 'simple';
+        if (! isset($specs['type'])) {
+            $specs['type'] = Simple::class;
         }
 
         // build route object
         $route = parent::routeFromArray($specs);
 
-        if (!$route instanceof RouteInterface) {
+        if (! $route instanceof RouteInterface) {
             throw new Exception\RuntimeException('Given route does not implement Console route interface');
         }
 

src/Service/RouterFactory.php

@@ -46,10 +46,16 @@ public function __invoke(ContainerInterface $container, $name, array $options =
      * For use with zend-servicemanager v2; proxies to __invoke().
      *
      * @param ServiceLocatorInterface $container
+     * @param null|string $normalizedName
+     * @param null|string $requestedName
      * @return RouteStackInterface
      */
-    public function createService(ServiceLocatorInterface $container)
+    public function createService(ServiceLocatorInterface $container, $normalizedName = null, $requestedName = null)
     {
-        return $this($container, RouteStackInterface::class);
+        if ($normalizedName === 'router' && Console::isConsole()) {
+            $requestedName = 'ConsoleRouter';
+        }
+
+        return $this($container, $requestedName);
     }
 }

src/Service/ServiceListenerFactory.php

@@ -40,6 +40,7 @@ class ServiceListenerFactory implements FactoryInterface
         'aliases' => [
             'Configuration'                              => 'config',
             'configuration'                              => 'config',
+            'console'                                    => 'ConsoleAdapter',
             'Console'                                    => 'ConsoleAdapter',
             'ConsoleDefaultRenderingStrategy'            => View\Console\DefaultRenderingStrategy::class,
             'ControllerLoader'                           => 'ControllerManager',

src/Service/ServiceManagerConfig.php

@@ -141,6 +141,18 @@ public function __construct(array $config = [])
                     ), E_USER_DEPRECATED);
                     $instance->setServiceLocator($container);
                 }
+
+                if (! $instance instanceof ServiceLocatorAwareInterface
+                    && method_exists($instance, 'setServiceLocator')
+                ) {
+                    trigger_error(sprintf(
+                        'ServiceLocatorAwareInterface is deprecated and will be removed in version 3.0, along '
+                        . 'with the ServiceLocatorAwareInitializer. Please update your class %s to remove '
+                        . 'the implementation, and start injecting your dependencies via factory instead.',
+                        get_class($instance)
+                    ), E_USER_DEPRECATED);
+                    $instance->setServiceLocator($container);
+                }
             },
         ]);
 

test/Application/AllowsReturningEarlyFromRoutingTest.php

@@ -9,6 +9,7 @@
 
 namespace ZendTest\Mvc\Application;
 
+use PHPUnit_Framework_Error_Deprecated;
 use PHPUnit_Framework_TestCase as TestCase;
 use Zend\Http\PhpEnvironment\Response;
 use Zend\Mvc\MvcEvent;
@@ -17,6 +18,12 @@ class AllowsReturningEarlyFromRoutingTest extends TestCase
 {
     use PathControllerTrait;
 
+    public function setUp()
+    {
+        // Ignore deprecation errors
+        PHPUnit_Framework_Error_Deprecated::$enabled = false;
+    }
+
     public function testAllowsReturningEarlyFromRouting()
     {
         $application = $this->prepareApplication();

test/Application/ControllerIsDispatchedTest.php

@@ -9,13 +9,20 @@
 
 namespace ZendTest\Mvc\Application;
 
+use PHPUnit_Framework_Error_Deprecated;
 use PHPUnit_Framework_TestCase as TestCase;
 use Zend\Mvc\MvcEvent;
 
 class ControllerIsDispatchedTest extends TestCase
 {
     use PathControllerTrait;
 
+    public function setUp()
+    {
+        // Ignore deprecation errors
+        PHPUnit_Framework_Error_Deprecated::$enabled = false;
+    }
+
     public function testControllerIsDispatchedDuringRun()
     {
         $application = $this->prepareApplication();

test/Application/ExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEventTest.php

@@ -9,13 +9,20 @@
 
 namespace ZendTest\Mvc\Application;
 
+use PHPUnit_Framework_Error_Deprecated;
 use PHPUnit_Framework_TestCase as TestCase;
 use Zend\Mvc\MvcEvent;
 
 class ExceptionsRaisedInDispatchableShouldRaiseDispatchErrorEventTest extends TestCase
 {
     use BadControllerTrait;
 
+    public function setUp()
+    {
+        // Ignore deprecation errors
+        PHPUnit_Framework_Error_Deprecated::$enabled = false;
+    }
+
     /**
      * @group error-handling
      */