Allow providing manual signature hint to commands

src/Command.php

@@ -2,6 +2,8 @@
 
 namespace NoccyLabs\React\CommandBus;
 
+use ReflectionFunction;
+use ReflectionNamedType;
 use React\Promise\Deferred;
 use React\Promise\Promise;
 use React\Promise\PromiseInterface;
@@ -17,10 +19,13 @@ class Command
     /** @var callable $handler The handler */
     private $handler;
 
-    public function __construct(string $name, callable $handler)
+    private ?array $signature;
+
+    public function __construct(string $name, callable $handler, ?array $signature = null)
     {
         $this->name = $name;
         $this->handler = $handler;
+        $this->signature = $signature;
     }
 
     public function getName(): string
@@ -38,5 +43,36 @@ class Command
         });
     }
 
+    public function parameters(): array
+    {
+        $refl = new ReflectionFunction($this->handler);
+        $args = [];
+
+        foreach ($refl->getParameters() as $parameter) {
+            $name = $parameter->getName();
+            $type = null;
+            if (!$parameter->hasType()) {
+                $type = 'any';
+            } else {
+                $type = $parameter->getType();
+                if ($type instanceof ReflectionNamedType && $type->isBuiltin()) {
+                    $type = ($type->allowsNull() ? "?" : "") . $type->getName();
+                } else {
+                    $type = null;
+                }
+            }
+            
+            if ($parameter->isDefaultValueAvailable()) $type = "{$type}=".\json_encode($parameter->getDefaultValue(),\JSON_UNESCAPED_SLASHES);
+            if ($type !== null) $args[$name] = $type;
+        }
+
+        return $args;
+    }
+
+    public function getSignature(): array
+    {
+        return $this->signature ?? $this->parameters();
+    }
+
 }
 

src/CommandBus.php

@@ -51,6 +51,11 @@ class CommandBus implements CommandBusInterface
         $this->resolvers[] = $resolver;
     }
 
+    public function removeResolver(CommandResolverInterface $resolver): void
+    {
+        // FIXME implement
+    }
+
     /**
      * Get the names of defined commands
      *
@@ -60,7 +65,7 @@ class CommandBus implements CommandBusInterface
     {
         $commands = [];
         foreach ($this->resolvers as $resolver) {
-            $commands = array_merge($commands, $resolver->getNames());
+            $commands = array_merge($commands, $resolver->getCommandNames());
         }
         sort($commands);
         return array_unique($commands);
@@ -75,7 +80,7 @@ class CommandBus implements CommandBusInterface
     public function findCommand(string $command): ?Command
     {
         foreach ($this->resolvers as $resolver) {
-            if ($found = $resolver->find($command))
+            if ($found = $resolver->findCommand($command))
                 return $found;
         }
         return null;

src/CommandRegistry.php

@@ -40,12 +40,12 @@ class CommandRegistry implements CommandResolverInterface, EventEmitterInterface
         $this->emit(self::EVENT_UNREGISTERED, [ $command ]);
     }
 
-    public function find(string $command): ?Command
+    public function findCommand(string $command): ?Command
     {
         return $this->commands[$command] ?? null;
     }
 
-    public function getNames(): array
+    public function getCommandNames(): array
     {
         return array_keys($this->commands);
     }

src/CommandResolverInterface.php

@@ -11,9 +11,9 @@ use Evenement\EventEmitterTrait;
 interface CommandResolverInterface
 {
     
-    public function find(string $command): ?Command;
+    public function findCommand(string $command): ?Command;
 
-    public function getNames(): array;
+    public function getCommandNames(): array;
 
 }
 

src/CommandResolverTrait.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace NoccyLabs\React\CommandBus;
+use Evenement\EventEmitterInterface;
+use Evenement\EventEmitterTrait;
+
+/**
+ * A collection of commands that can be executed via CommandBusInterface
+ *
+ */
+trait CommandResolverTrait
+{
+
+    const EVENT_REGISTERED = 'registered';
+    const EVENT_UNREGISTERED = 'unregistered';
+
+    /** @var array<string,Command> */
+    private array $commands = [];
+
+    public function registerCommand(string $command, callable $handler): void
+    {
+        $isNew = !array_key_exists($command, $this->commands);
+
+        $this->commands[$command] = new Command($command, $handler);
+
+        if ($isNew) {
+            $this->emit(self::EVENT_REGISTERED, [ $command ]);
+        }
+    }
+
+    public function unregisterCommand(string $command): void
+    {
+        if (!array_key_exists($command, $this->commands)) {
+            return;
+        }
+
+        unset($this->commands[$command]);
+
+        $this->emit(self::EVENT_UNREGISTERED, [ $command ]);
+    }
+
+    public function findCommand(string $command): ?Command
+    {
+        return $this->commands[$command] ?? null;
+    }
+
+    public function getCommandNames(): array
+    {
+        return array_keys($this->commands);
+    }
+}
+

tests/CommandRegistryTest.php

@@ -48,8 +48,8 @@ class CommandRegistryTest extends \PHPUnit\Framework\TestCase
         $reg->register('a', $cmda);
         $reg->register('b', $cmdb);
 
-        $this->assertEquals('a', $reg->find('a')?->getName());
-        $this->assertEquals('b', $reg->find('b')?->getName());
+        $this->assertEquals('a', $reg->findCommand('a')?->getName());
+        $this->assertEquals('b', $reg->findCommand('b')?->getName());
     }
 
     public function testGettingCommandNames()
@@ -61,7 +61,7 @@ class CommandRegistryTest extends \PHPUnit\Framework\TestCase
         $reg->register('a', $cmda);
         $reg->register('b', $cmdb);
 
-        $this->assertEquals(['a','b'], $reg->getNames());
+        $this->assertEquals(['a','b'], $reg->getCommandNames());
     }
 
 }

tests/CommandTest.php

@@ -26,4 +26,14 @@ class CommandTest extends \PHPUnit\Framework\TestCase
         $this->assertEquals(true, $hit);
     }
 
+    public function testCommandReflection()
+    {
+        $command = new Command("test", function (string $a, ?int $b, bool $c = false) { });
+        $expect = [
+            'a' => 'string',
+            'b' => '?int',
+            'c' => 'bool=false'
+        ];
+        $this->assertEquals($expect, $command->parameters());
+    }
 }