Merge pull request #34 from assoconnect/romain_23685_move_absolute_date_value_resolver

CLEAN: AN-23685 - move AbsoluteDateValueResolver from the backend project

Author: noriam

composer.json

@@ -28,7 +28,7 @@
         "doctrine/dbal": "^2.10|^3.0",
         "symfony/serializer": "^6.0|^7.0",
         "twig/twig": "^3",
-        "symfony/clock": "^7.3"
+        "symfony/clock": "^6.4|^7.3"
     },
     "config": {
         "allow-plugins": {

config/services.yaml

@@ -21,3 +21,7 @@ services:
 
   AssoConnect\PHPDateBundle\Validator\:
     resource: "../src/Validator/*"
+
+  AssoConnect\PHPDateBundle\ThirdParty\Symfony\HttpKernel\Controller\ArgumentResolver\AbsoluteDateValueResolver:
+    tags:
+      - { name: 'controller.argument_value_resolver', priority: 150 }

src/ThirdParty/Symfony/HttpKernel/Controller/ArgumentResolver/AbsoluteDateValueResolver.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AssoConnect\PHPDateBundle\ThirdParty\Symfony\HttpKernel\Controller\ArgumentResolver;
+
+use AssoConnect\PHPDate\AbsoluteDate;
+use AssoConnect\PHPDate\Exception\ParsingException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+class AbsoluteDateValueResolver implements ValueResolverInterface
+{
+    /**
+     * @return array<AbsoluteDate>
+     */
+    public function resolve(Request $request, ArgumentMetadata $argument): iterable
+    {
+        $argumentType = $argument->getType();
+        if (AbsoluteDate::class !== $argumentType) {
+            return [];
+        }
+
+        // get the value from the request, based on the argument name
+        $value = $request->attributes->get($argument->getName());
+        if (!is_string($value)) {
+            return [];
+        }
+
+        try {
+            $date = new AbsoluteDate($value);
+        } catch (ParsingException $e) {
+            throw new BadRequestHttpException(
+                sprintf(
+                    'Invalid date given for parameter "%s" (expected format: %s).',
+                    $value,
+                    AbsoluteDate::DEFAULT_DATE_FORMAT
+                ),
+                $e
+            );
+        }
+
+        return [$date];
+    }
+}

tests/ThirdParty/Symfony/HttpKernel/Controller/ArgumentResolver/AbsoluteDateValueResolverTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AssoConnect\PHPDateBundle\Tests\ThirdParty\Symfony\HttpKernel\Controller\ArgumentResolver;
+
+use AssoConnect\PHPDate\AbsoluteDate;
+use AssoConnect\PHPDateBundle\ThirdParty\Symfony\HttpKernel\Controller\ArgumentResolver\AbsoluteDateValueResolver;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+class AbsoluteDateValueResolverTest extends TestCase
+{
+    private AbsoluteDateValueResolver $resolver;
+
+    protected function setUp(): void
+    {
+        $this->resolver = new AbsoluteDateValueResolver();
+    }
+
+    public function testResolve(): void
+    {
+        $request = new Request([], [], ['someArgument' => $date = '2024-06-02']);
+        $argument = new ArgumentMetadata('someArgument', AbsoluteDate::class, false, false, null);
+        $resolvedArgument = $this->resolver->resolve($request, $argument);
+
+        self::assertCount(1, $resolvedArgument);
+
+        foreach ($resolvedArgument as $arg) {
+            self::assertSame($date, $arg->format());
+        }
+    }
+
+    public function testResolveWithInvalidType(): void
+    {
+        $request = new Request([], [], ['someArgument' => '2024-06-02']);
+        $argument = new ArgumentMetadata('someArgument', \DateTime::class, false, false, null);
+        $resolvedArgument = $this->resolver->resolve($request, $argument);
+
+        self::assertSame([], $resolvedArgument);
+    }
+
+    public function testResolveWithNonStringValue(): void
+    {
+        $request = new Request([], [], ['someArgument' => 1]);
+        $argument = new ArgumentMetadata('someArgument', AbsoluteDate::class, false, false, null);
+        $resolvedArgument = $this->resolver->resolve($request, $argument);
+
+        self::assertSame([], $resolvedArgument);
+    }
+
+    public function testResolveWithInvalidValue(): void
+    {
+        $request = new Request([], [], ['someArgument' => 'somevalue']);
+        $argument = new ArgumentMetadata('someArgument', AbsoluteDate::class, false, false, null);
+
+        $this->expectException(BadRequestHttpException::class);
+        $this->expectExceptionMessage('Invalid date given for parameter "somevalue"');
+        $this->resolver->resolve($request, $argument);
+    }
+}