Merge pull request #28 from mtymek/container_aware_dispatcher_2

Allow pulling commands from container

README.md

@@ -358,6 +358,31 @@ The `Route` instance contains several methods of interest:
 - `getName()` will return the name of the route (which may be useful if you use the same callable
   for multiple routes).
 
+Pulling commands from container
+-------------------------------
+
+You can keep your commands in service container, compatible with `container-interop`. In order 
+to do so, inject your container into `Dispatcher` object upon creation:
+
+```php
+$serviceManager = new ServiceManager(/* ... */);
+
+// use `zend-servicemanager` as container
+$dispatcher = new Dispatcher($serviceManager);
+
+$routes = [
+    [
+        'name' => 'hello',        
+        'handler' => HelloCommand::class,
+    ]
+];
+
+$application = new Application('App', 1.0, $routes, null, $dispatcher);
+```
+
+In this example, when `hello` route is matched, `Dispatcher` will try to pull `HelloCommand` from 
+container and then execute it.
+
 Exception Handling
 ------------------
 

composer.json

@@ -26,11 +26,13 @@
         "phpunit/phpunit": "~4.7",
         "squizlabs/php_codesniffer": "^2.3.1",
         "zendframework/zend-filter": "~2.3",
-        "zendframework/zend-validator": "~2.3"
+        "zendframework/zend-validator": "~2.3",
+        "container-interop/container-interop": "^1.1"
     },
     "suggest": {
         "zendframework/zend-filter": "~2.3; Useful for filtering/normalizing argument values",
-        "zendframework/zend-validator": "~2.3; Useful for providing more thorough argument validation logic"
+        "zendframework/zend-validator": "~2.3; Useful for providing more thorough argument validation logic",
+        "container-interop/container-interop": "^1.1; For ability to pull dispatched commands from container"
     },
     "autoload": {
         "psr-4": {

src/Dispatcher.php

@@ -6,6 +6,7 @@
 
 namespace ZF\Console;
 
+use Interop\Container\ContainerInterface;
 use InvalidArgumentException;
 use RuntimeException;
 use Zend\Console\Adapter\AdapterInterface as ConsoleAdapter;
@@ -15,6 +16,19 @@ class Dispatcher
 {
     protected $commandMap = [];
 
+    /**
+     * @var ContainerInterface
+     */
+    protected $container;
+
+    /**
+     * @param ContainerInterface $container
+     */
+    public function __construct(ContainerInterface $container = null)
+    {
+        $this->container = $container;
+    }
+
     public function map($command, $callable)
     {
         if (! is_string($command) || empty($command)) {
@@ -56,12 +70,16 @@ public function dispatch(Route $route, ConsoleAdapter $console)
         $callable = $this->commandMap[$name];
 
         if (! is_callable($callable) && is_string($callable)) {
-            $callable = new $callable();
+            if ($this->container && $this->container->has($callable)) {
+                $callable = $this->container->get($callable);
+            } else {
+                $callable = new $callable();
+            }
+
             if (! is_callable($callable)) {
-                throw new RuntimeException(sprintf(
-                    'Invalid command class specified for "%s"; class must be invokable',
-                    $name
-                ));
+                throw new RuntimeException(
+                    sprintf('Invalid command class specified for "%s"; class must be invokable', $name)
+                );
             }
             $this->commandMap[$name] = $callable;
         }

test/DispatcherTest.php

@@ -6,13 +6,20 @@
 
 namespace ZFTest\Console;
 
+use Interop\Container\ContainerInterface;
 use PHPUnit_Framework_TestCase as TestCase;
 use Zend\Console\Adapter\AdapterInterface;
 use ZF\Console\Dispatcher;
 use ZF\Console\Route;
+use ZFTest\Console\TestAsset\FooCommand;
 
 class DispatcherTest extends TestCase
 {
+    /**
+     * @var Dispatcher
+     */
+    private $dispatcher;
+
     public function setUp()
     {
         $this->route = $this->getMockBuilder('ZF\Console\Route')
@@ -91,4 +98,20 @@ public function testDispatchReturnsCallableReturnIntegerOnSuccess()
             ->will($this->returnValue('test'));
         $this->assertEquals(2, $this->dispatcher->dispatch($this->route, $this->console));
     }
+
+    public function testDispatchCanPullCommandFromContainer()
+    {
+        $container = $this->prophesize(ContainerInterface::class);
+        $container->has(FooCommand::class)->willReturn(true);
+        $container->get(FooCommand::class)->willReturn(new FooCommand());
+
+        $route = $this->prophesize(Route::class);
+        $route->getName()->willReturn('foobar');
+
+        $console = $this->prophesize(AdapterInterface::class);
+
+        $dispatcher = new Dispatcher($container->reveal());
+        $dispatcher->map('foobar', FooCommand::class);
+        $dispatcher->dispatch($route->reveal(), $console->reveal());
+    }
 }

test/TestAsset/FooCommand.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace ZFTest\Console\TestAsset;
+
+class FooCommand
+{
+    public function __invoke()
+    {
+    }
+}