feat: route enum binding support (#668)

Author: brendt

src/Tempest/Http/src/Exceptions/NotFoundException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Http\Exceptions;
+
+use Exception;
+
+final class NotFoundException extends Exception
+{
+}

src/Tempest/Http/src/GenericRouter.php

@@ -4,6 +4,7 @@
 
 namespace Tempest\Http;
 
+use BackedEnum;
 use Closure;
 use Psr\Http\Message\ServerRequestInterface as PsrRequest;
 use ReflectionException;
@@ -12,6 +13,7 @@
 use Tempest\Http\Exceptions\ControllerActionHasNoReturn;
 use Tempest\Http\Exceptions\InvalidRouteException;
 use Tempest\Http\Exceptions\MissingControllerOutputException;
+use Tempest\Http\Exceptions\NotFoundException;
 use Tempest\Http\Mappers\RequestToPsrRequestMapper;
 use Tempest\Http\Responses\Invalid;
 use Tempest\Http\Responses\NotFound;
@@ -59,8 +61,9 @@ public function dispatch(Request|PsrRequest $request): Response
         try {
             $request = $this->resolveRequest($request, $matchedRoute);
             $response = $callable($request);
+        } catch (NotFoundException) {
+            return new NotFound();
         } catch (ValidationException $validationException) {
-            // TODO: refactor to middleware
             return new Invalid($request, $validationException->failingRules);
         }
 
@@ -141,6 +144,10 @@ public function toUri(array|string $action, ...$params): string
                 continue;
             }
 
+            if ($value instanceof BackedEnum) {
+                $value = $value->value;
+            }
+
             $pattern = '#\{' . $key . Route::ROUTE_PARAM_CUSTOM_REGEX . '\}#';
             $uri = preg_replace($pattern, (string)$value, $uri);
         }

src/Tempest/Http/src/RouteBindingInitializer.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Http;
+
+use BackedEnum;
+use Tempest\Container\Container;
+use Tempest\Container\DynamicInitializer;
+use Tempest\Http\Exceptions\NotFoundException;
+use Tempest\Reflection\ClassReflector;
+
+final class RouteEnumBindingInitializer implements DynamicInitializer
+{
+    public function canInitialize(ClassReflector $class): bool
+    {
+        return $class->getType()->matches(BackedEnum::class);
+    }
+
+    public function initialize(ClassReflector $class, Container $container): object
+    {
+        $matchedRoute = $container->get(MatchedRoute::class);
+
+        $parameter = null;
+
+        foreach ($matchedRoute->route->handler->getParameters() as $searchParameter) {
+            if ($searchParameter->getType()->equals($class->getType())) {
+                $parameter = $searchParameter;
+
+                break;
+            }
+        }
+
+        $enum = $class->callStatic('tryFrom', $matchedRoute->params[$parameter->getName()]);
+
+        if ($enum === null) {
+            throw new NotFoundException();
+        }
+
+        return $enum;
+    }
+}

src/Tempest/Http/src/RouteEnumBindingInitializer.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Http;
+
+use Tempest\Container\Container;
+use Tempest\Container\DynamicInitializer;
+use Tempest\Database\DatabaseModel;
+use Tempest\Database\Id;
+use Tempest\Http\Exceptions\NotFoundException;
+use Tempest\Reflection\ClassReflector;
+
+final class RouteModelBindingInitializer implements DynamicInitializer
+{
+    public function canInitialize(ClassReflector $class): bool
+    {
+        return $class->getType()->matches(DatabaseModel::class);
+    }
+
+    public function initialize(ClassReflector $class, Container $container): object
+    {
+        $matchedRoute = $container->get(MatchedRoute::class);
+
+        $parameter = null;
+
+        foreach ($matchedRoute->route->handler->getParameters() as $searchParameter) {
+            if ($searchParameter->getType()->equals($class->getType())) {
+                $parameter = $searchParameter;
+
+                break;
+            }
+        }
+
+        $model = $class->callStatic('find', new Id($matchedRoute->params[$parameter->getName()]));
+
+        if ($model === null) {
+            throw new NotFoundException();
+        }
+
+        return $model;
+    }
+}

src/Tempest/Http/src/RouteModelBindingInitializer.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Fixtures\Controllers;
+
+use Tempest\Http\Get;
+use Tempest\Http\Response;
+use Tempest\Http\Responses\Ok;
+
+final readonly class ControllerWithEnumBinding
+{
+    #[Get('/with-enum/{input}')]
+    public function __invoke(EnumForController $input): Response
+    {
+        return new Ok();
+    }
+}

tests/Fixtures/Controllers/ControllerWithEnumBinding.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Fixtures\Controllers;
+
+enum EnumForController: string
+{
+    case FOO = 'foo';
+    case BAR = 'bar';
+    case BAZ = 'baz';
+}

tests/Fixtures/Controllers/EnumForController.php

@@ -10,6 +10,9 @@
 use Tempest\Http\Responses\Ok;
 use Tempest\Http\Router;
 use Tempest\Http\Status;
+use function Tempest\uri;
+use Tests\Tempest\Fixtures\Controllers\ControllerWithEnumBinding;
+use Tests\Tempest\Fixtures\Controllers\EnumForController;
 use Tests\Tempest\Fixtures\Controllers\TestController;
 use Tests\Tempest\Fixtures\Controllers\TestGlobalMiddleware;
 use Tests\Tempest\Fixtures\Migrations\CreateAuthorTable;
@@ -147,4 +150,24 @@ public function test_repeated_routes(): void
         $this->http->post('/repeated/e')->assertOk();
         $this->http->post('/repeated/f')->assertOk();
     }
+
+    public function test_enum_route_binding(): void
+    {
+        $this->http->get('/with-enum/foo')->assertOk();
+        $this->http->get('/with-enum/bar')->assertOk();
+        $this->http->get('/with-enum/unknown')->assertNotFound();
+    }
+
+    public function test_generate_uri_with_enum(): void
+    {
+        $this->assertSame(
+            '/with-enum/foo',
+            uri(ControllerWithEnumBinding::class, input: EnumForController::FOO),
+        );
+
+        $this->assertSame(
+            '/with-enum/bar',
+            uri(ControllerWithEnumBinding::class, input: EnumForController::BAR),
+        );
+    }
 }