A few updates based on dogfooding

Author: jeremeamia

src/Commands/CommandRouter.php

@@ -22,10 +22,11 @@
  */
 class CommandRouter implements Listener
 {
-    /** @var array<string, Listener> */
-    private array $routes;
+    private Listener $default;
     private string $description;
     private int $maxLevels;
+    /** @var array<string, Listener> */
+    private array $routes;
 
     public static function new(): self
     {
@@ -37,21 +38,37 @@ public function __construct(array $routes = [])
         $this->routes = [];
         $this->description = '';
         $this->maxLevels = 1;
-        $this->add('list', Closure::fromCallable([$this, 'listSubCommands']));
+        $this->add('help', Closure::fromCallable([$this, 'showHelp']));
         foreach ($routes as $subCommand => $listener) {
             $this->add($subCommand, $listener);
         }
     }
 
     /**
      * @param string $subCommand
-     * @param Listener|callable|class-string $listener
+     * @param Listener|callable(Context): void|class-string $listener
      * @return $this
      */
     public function add(string $subCommand, $listener): self
     {
-        $this->routes[$subCommand] = Coerce::listener($listener);
-        $this->maxLevels = max($this->maxLevels, count(explode(' ', $subCommand)));
+        $listener = Coerce::listener($listener);
+        if ($subCommand === '*') {
+            $this->default = $listener;
+        } else {
+            $this->routes[$subCommand] = $listener;
+            $this->maxLevels = max($this->maxLevels, count(explode(' ', $subCommand)));
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param Listener|callable(Context): void|class-string $listener
+     * @return $this
+     */
+    public function withDefault($listener): self
+    {
+        $this->default = Coerce::listener($listener);
 
         return $this;
     }
@@ -60,7 +77,7 @@ public function add(string $subCommand, $listener): self
      * @param string $description
      * @return self
      */
-    public function description(string $description): self
+    public function withDescription(string $description): self
     {
         $this->description = $description;
 
@@ -85,31 +102,35 @@ public function handle(Context $context): void
             array_pop($nameArgs);
         }
 
-        $context->logger()->debug('CommandRouter could not find sub-command; routing to "list" instead');
-        $this->listSubCommands($context);
+        if ($this->default) {
+            $this->default->handle($context);
+        } else {
+            $this->showHelp($context);
+        }
     }
 
-    private function listSubCommands(Context $ctx): void
+    private function showHelp(Context $context): void
     {
-        $cmd = $ctx->payload()->get('command');
-        $fmt = $ctx->fmt();
-        $msg = $ctx->blocks()->message()->header("The {$cmd} Command");
+        $cmd = $context->payload()->get('command');
+        $fmt = $context->fmt();
+        $msg = $context->blocks()->message();
+
+        $msg->header("The {$cmd} Command");
         if ($this->description) {
             $msg->text($this->description);
         }
 
         $routes = array_keys($this->routes);
         natsort($routes);
-
         $msg->newSection()->mrkdwnText($fmt->lines([
-            '*Available commands*:',
+            '*Available sub-commands*:',
             $fmt->bulletedList(array_map(fn (string $subCommand) => $fmt->code("{$cmd} {$subCommand}"), $routes))
         ]));
 
-        if ($ctx->isAcknowledged()) {
-            $ctx->respond($msg);
+        if ($context->isAcknowledged()) {
+            $context->respond($msg);
         } else {
-            $ctx->ack($msg);
+            $context->ack($msg);
         }
     }
 }

src/Context.php

@@ -221,6 +221,28 @@ public function getAppId(): ?string
         return $this->appId;
     }
 
+    public function getAppConfig(): AppConfig
+    {
+        if (!isset($this->appConfig)) {
+            $this->appConfig = new AppConfig();
+        }
+
+        return $this->appConfig;
+    }
+
+    public function getApiClient(): ApiClient
+    {
+        if (!isset($this->apiClient)) {
+            $tokenStore = $this->getAppConfig()->getTokenStore();
+            $this->apiClient = new SimpleApiClient($tokenStore->get(
+                $this->payload->getTeamId(),
+                $this->payload->getEnterpriseId()
+            ));
+        }
+
+        return $this->apiClient;
+    }
+
     public function getAck(): ?string
     {
         return $this->ack;
@@ -258,14 +280,7 @@ public function logger(): SlackLogger
      */
     public function api(string $api, array $params): array
     {
-        if (!isset($this->apiClient)) {
-            $this->apiClient = new SimpleApiClient($this->getAppConfig()->getTokenStore()->get(
-                $this->payload->getTeamId(),
-                $this->payload->getEnterpriseId()
-            ));
-        }
-
-        return $this->apiClient->call($api, $params);
+        return $this->getApiClient()->call($api, $params);
     }
 
     public function blocks(): Blocks
@@ -457,15 +472,6 @@ public function offsetUnset($offset)
         $this->set($offset, null);
     }
 
-    private function getAppConfig(): AppConfig
-    {
-        if (!isset($this->appConfig)) {
-            $this->appConfig = new AppConfig();
-        }
-
-        return $this->appConfig;
-    }
-
     private function reconcileAppId(): void
     {
         $this->appId ??= $this->appConfig->getId();

src/Listeners/WIP.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\Framework\Listeners;
+
+use SlackPhp\Framework\{Context, Listener};
+use SlackPhp\Framework\Contexts\PayloadType;
+
+/**
+ * Simple listener that displays/logs a "Work in progress" message in whichever medium makes the most sense.
+ */
+class WIP implements Listener
+{
+    public function handle(Context $context): void
+    {
+        $message = 'Work in progress';
+        if ($context->payload()->isType(PayloadType::command())) {
+            $context->ack($message);
+        } elseif ($context->payload()->get('view')) {
+            $context->view()->push($message);
+        } elseif ($context->payload()->get('trigger_id')) {
+            $context->modals()->open($message);
+        } elseif ($context->payload()->getResponseUrl()) {
+            $context->respond($message);
+        } else {
+            $context->logger()->debug($message);
+        }
+    }
+}