Merge pull request #1618 from Kocal/feature/datepoint-support

Add support for Symfony's DatePoint in DateHandler, close #1617

Author: scyzoryck

.github/workflows/ci.yaml

@@ -45,6 +45,10 @@ jobs:
         if: ${{ matrix.composer-stability }}
         run: composer config minimum-stability ${{ matrix.composer-stability }}
 
+      - name: Install symfony/clock for PHP >= 8.1
+        if: ${{ matrix.php-version >= '8.1' }}
+        run: composer require --dev symfony/clock:"^6.4 || ^7.0 || ^8.0" --no-update
+
       - name: Install dependencies with Composer
         uses: ramsey/composer-install@v3
         with:

.github/workflows/static-analysis.yaml

@@ -34,6 +34,10 @@ jobs:
           tools: "cs2pr"
           extensions: pdo_sqlite
 
+      - name: Install symfony/clock for PHP >= 8.1
+        if: ${{ matrix.php-version >= '8.1' }}
+        run: composer require --dev symfony/clock:"^6.4 || ^7.0 || ^8.0" --no-update
+
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v3"
         with:

phpstan/ignore-by-php-version.neon.php

@@ -1,6 +1,7 @@
 <?php declare(strict_types = 1);
 
 use PHPUnit\Framework\Attributes\DataProvider;
+use Symfony\Component\Clock\DatePoint;
 use Symfony\Component\Uid\UuidV7;
 
 $includes = [];
@@ -28,7 +29,9 @@
 if(!class_exists(UuidV7::class)) {
     $includes[] = __DIR__ . '/no-uuid-7.neon';
 }
-
+if (!class_exists(DatePoint::class)) {
+    $includes[] = __DIR__ . '/no-datepoint.neon';
+}
 
 $config = [];
 $config['includes'] = $includes;

phpstan/no-datepoint.neon

@@ -0,0 +1,3 @@
+parameters:
+    ignoreErrors:
+        - '~Call to static method createFromInterface\(\) on an unknown class Symfony\\Component\\Clock\\DatePoint.~'

src/Handler/DateHandler.php

@@ -11,6 +11,7 @@
 use JMS\Serializer\Visitor\DeserializationVisitorInterface;
 use JMS\Serializer\Visitor\SerializationVisitorInterface;
 use JMS\Serializer\XmlSerializationVisitor;
+use Symfony\Component\Clock\DatePoint;
 
 /**
  * @phpstan-import-type TypeArray from Type
@@ -45,6 +46,11 @@ public static function getSubscribingMethods()
         $methods = [];
         $types = [\DateTime::class, \DateTimeImmutable::class, \DateInterval::class];
 
+        // Add Symfony's DatePoint if available (introduced in Symfony 6.4)
+        if (class_exists(DatePoint::class)) {
+            $types[] = DatePoint::class;
+        }
+
         foreach (['json', 'xml'] as $format) {
             foreach ($types as $type) {
                 $methods[] = [
@@ -156,6 +162,20 @@ public function serializeDateInterval(SerializationVisitorInterface $visitor, \D
         return $visitor->visitString($iso8601DateIntervalString, $type);
     }
 
+    /**
+     * @param TypeArray $type
+     *
+     * @return \DOMCdataSection|\DOMText|mixed
+     */
+    public function serializeSymfonyComponentClockDatePoint(
+        SerializationVisitorInterface $visitor,
+        \DateTimeImmutable $date,
+        array $type,
+        SerializationContext $context
+    ) {
+        return $this->serializeDateTimeInterface($visitor, $date, $type, $context);
+    }
+
     /**
      * @param mixed $data
      */
@@ -244,6 +264,32 @@ public function deserializeDateIntervalFromJson(DeserializationVisitorInterface
         return $this->parseDateInterval($data);
     }
 
+    /**
+     * @param mixed $data
+     * @param TypeArray $type
+     */
+    public function deserializeSymfonyComponentClockDatePointFromXml(DeserializationVisitorInterface $visitor, $data, array $type): ?\DateTimeInterface
+    {
+        if ($this->isDataXmlNull($data)) {
+            return null;
+        }
+
+        return $this->parseDateTimeAsDatePoint($data, $type);
+    }
+
+    /**
+     * @param mixed $data
+     * @param TypeArray $type
+     */
+    public function deserializeSymfonyComponentClockDatePointFromJson(DeserializationVisitorInterface $visitor, $data, array $type): ?\DateTimeInterface
+    {
+        if (empty($data)) {
+            return null;
+        }
+
+        return $this->parseDateTimeAsDatePoint($data, $type);
+    }
+
     /**
      * @param mixed $data
      * @param TypeArray $type
@@ -279,6 +325,15 @@ private function parseDateTime($data, array $type, bool $immutable = false): \Da
         ));
     }
 
+    /**
+     * @param mixed $data
+     * @param TypeArray $type
+     */
+    private function parseDateTimeAsDatePoint($data, array $type): \DateTimeInterface
+    {
+        return DatePoint::createFromInterface($this->parseDateTime($data, $type));
+    }
+
     private function parseDateInterval(string $data): \DateInterval
     {
         $dateInterval = null;

tests/Handler/DateHandlerTest.php

@@ -12,6 +12,7 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Clock\DatePoint;
 
 class DateHandlerTest extends TestCase
 {
@@ -188,4 +189,65 @@ public function testDefaultFormat()
             $this->handler->deserializeDateTimeFromJson($visitor, '2017-06-18T17:32:11Z', $type),
         );
     }
+
+    public function testDatePointSerializationJson()
+    {
+        if (!class_exists(DatePoint::class)) {
+            self::markTestSkipped('Symfony Clock component is not available');
+        }
+
+        $context = $this->getMockBuilder(SerializationContext::class)->getMock();
+
+        $visitor = $this->getMockBuilder(SerializationVisitorInterface::class)->getMock();
+        $visitor->method('visitString')->with('2017-06-18');
+
+        $datePoint = new DatePoint('2017-06-18 14:30:59', $this->timezone);
+        $type = ['name' => DatePoint::class, 'params' => ['Y-m-d']];
+        $this->handler->serializeSymfonyComponentClockDatePoint($visitor, $datePoint, $type, $context);
+    }
+
+    public function testDatePointDeserializationJson()
+    {
+        if (!class_exists(DatePoint::class)) {
+            self::markTestSkipped('Symfony Clock component is not available');
+        }
+
+        $visitor = new JsonDeserializationVisitor();
+
+        $type = ['name' => DatePoint::class, 'params' => ['Y-m-d', '', 'Y-m-d|']];
+        $result = $this->handler->deserializeSymfonyComponentClockDatePointFromJson($visitor, '2017-06-18', $type);
+
+        self::assertInstanceOf(DatePoint::class, $result);
+        self::assertEquals('2017-06-18', $result->format('Y-m-d'));
+    }
+
+    public function testDatePointDeserializationReturnsNullForEmptyString()
+    {
+        if (!class_exists(DatePoint::class)) {
+            self::markTestSkipped('Symfony Clock component is not available');
+        }
+
+        $visitor = new JsonDeserializationVisitor();
+
+        $type = ['name' => DatePoint::class, 'params' => ['Y-m-d']];
+        self::assertNull($this->handler->deserializeSymfonyComponentClockDatePointFromJson($visitor, '', $type));
+    }
+
+    public function testDatePointWithTimezone()
+    {
+        if (!class_exists(DatePoint::class)) {
+            self::markTestSkipped('Symfony Clock component is not available');
+        }
+
+        $visitor = new JsonDeserializationVisitor();
+
+        $timestamp = (string) time();
+        $timezone = 'Europe/Brussels';
+        $type = ['name' => DatePoint::class, 'params' => ['U', $timezone]];
+
+        $result = $this->handler->deserializeSymfonyComponentClockDatePointFromJson($visitor, $timestamp, $type);
+
+        self::assertInstanceOf(DatePoint::class, $result);
+        self::assertEquals($timezone, $result->getTimezone()->getName());
+    }
 }