Add RouteArgument attribute for Yii Hydrator

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Yii Router Change Log
 
-## 3.0.1 under development
+## 3.1.0 under development
 
-- no changes in this release.
+- New #203: Added `Route` attribute for Yii Hydrator (@vjik)
 
 ## 3.0.0 February 17, 2023
 

composer-require-checker.json

@@ -0,0 +1,9 @@
+{
+    "symbol-whitelist": [
+        "Yiisoft\\Hydrator\\Context",
+        "Yiisoft\\Hydrator\\NotResolvedException",
+        "Yiisoft\\Hydrator\\ParameterAttributeInterface",
+        "Yiisoft\\Hydrator\\ParameterAttributeResolverInterface",
+        "Yiisoft\\Hydrator\\UnexpectedAttributeException"
+    ]
+}

composer.json

@@ -39,6 +39,7 @@
         "vimeo/psalm": "^4.30|^5.6",
         "yiisoft/di": "^1.0",
         "yiisoft/dummy-provider": "^1.0.0",
+        "yiisoft/hydrator": "dev-master as 1.0",
         "yiisoft/test-support": "^3.0"
     },
     "autoload": {
@@ -52,7 +53,8 @@
         }
     },
     "suggest": {
-        "yiisoft/router-fastroute": "Router implementation based on nikic/FastRoute"
+        "yiisoft/router-fastroute": "Router implementation based on nikic/FastRoute",
+        "yiisoft/hydrator": "Need to use `Route` attribute"
     },
     "extra": {
         "config-plugin-options": {

src/HydratorAttribute/Route.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\HydratorAttribute;
+
+use Attribute;
+use Yiisoft\Hydrator\ParameterAttributeInterface;
+
+#[Attribute(Attribute::TARGET_PROPERTY | Attribute::TARGET_PARAMETER | Attribute::IS_REPEATABLE)]
+final class Route implements ParameterAttributeInterface
+{
+    public function __construct(
+        private ?string $name = null
+    ) {
+    }
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function getResolver(): string
+    {
+        return RouteResolver::class;
+    }
+}

src/HydratorAttribute/RouteResolver.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\HydratorAttribute;
+
+use Yiisoft\Hydrator\Context;
+use Yiisoft\Hydrator\NotResolvedException;
+use Yiisoft\Hydrator\ParameterAttributeInterface;
+use Yiisoft\Hydrator\ParameterAttributeResolverInterface;
+use Yiisoft\Hydrator\UnexpectedAttributeException;
+use Yiisoft\Router\CurrentRoute;
+
+final class RouteResolver implements ParameterAttributeResolverInterface
+{
+    public function __construct(
+        private CurrentRoute $currentRoute,
+    ) {
+    }
+
+    public function getParameterValue(ParameterAttributeInterface $attribute, Context $context): mixed
+    {
+        if (!$attribute instanceof Route) {
+            throw new UnexpectedAttributeException(Route::class, $attribute);
+        }
+
+        $arguments = $this->currentRoute->getArguments();
+
+        $name = $attribute->getName();
+        if ($name === null) {
+            return $arguments;
+        }
+
+        return $arguments[$name] ?? throw new NotResolvedException();
+    }
+}

tests/HydratorAttribute/RouteTest.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Tests\HydratorAttribute;
+
+use PHPUnit\Framework\TestCase;
+use ReflectionFunction;
+use Yiisoft\Hydrator\Attribute\Parameter\ToString;
+use Yiisoft\Hydrator\Context;
+use Yiisoft\Hydrator\Hydrator;
+use Yiisoft\Hydrator\UnexpectedAttributeException;
+use Yiisoft\Router\CurrentRoute;
+use Yiisoft\Router\HydratorAttribute\Route;
+use Yiisoft\Router\HydratorAttribute\RouteResolver;
+use Yiisoft\Router\Route as RouterRoute;
+use Yiisoft\Test\Support\Container\SimpleContainer;
+
+final class RouteTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $hydrator = $this->createHydrator([
+            'a' => 'one',
+            'b' => 'two',
+        ]);
+
+        $input = new class () {
+            #[Route('a')]
+            public string $a = '';
+            #[Route('b')]
+            public string $b = '';
+            #[Route]
+            public array $all = [];
+        };
+
+        $hydrator->hydrate($input);
+
+        $this->assertSame('one', $input->a);
+        $this->assertSame('two', $input->b);
+        $this->assertSame(['a' => 'one', 'b' => 'two'], $input->all);
+    }
+
+    public function testWithoutArguments(): void
+    {
+        $hydrator = $this->createHydrator([]);
+
+        $input = new class () {
+            #[Route('a')]
+            public string $a = '';
+            #[Route('b')]
+            public string $b = '';
+            #[Route]
+            public array $all = [];
+        };
+
+        $hydrator->hydrate($input);
+
+        $this->assertSame('', $input->a);
+        $this->assertSame('', $input->b);
+        $this->assertSame([], $input->all);
+    }
+
+    public function testUnexpectedAttributeException(): void
+    {
+        $resolver = new RouteResolver(new CurrentRoute());
+
+        $attribute = new ToString();
+        $context = $this->createContext();
+
+        $this->expectException(UnexpectedAttributeException::class);
+        $this->expectExceptionMessage('Expected "' . Route::class . '", but "' . ToString::class . '" given.');
+        $resolver->getParameterValue($attribute, $context);
+    }
+
+    private function createHydrator(array $arguments): Hydrator
+    {
+        $currentRoute = new CurrentRoute();
+        $currentRoute->setRouteWithArguments(RouterRoute::get('/'), $arguments);
+
+        return new Hydrator(
+            new SimpleContainer([
+                RouteResolver::class => new RouteResolver($currentRoute),
+            ]),
+        );
+    }
+
+    private function createContext(): Context
+    {
+        $reflection = new ReflectionFunction(static fn (int $a) => null);
+        return new Context($reflection->getParameters()[0], false, null, [], []);
+    }
+}