Merge pull request #9 from Ali1/frozen

I18n\Time support

Author: softius

src/FrozenDateTimeParamConverter.php

@@ -5,6 +5,7 @@
 use Cake\Http\Exception\BadRequestException;
 use Cake\I18n\FrozenDate;
 use Cake\I18n\FrozenTime;
+use Cake\I18n\Time;
 
 /**
  * Class FrozenDateTimeParamConverter
@@ -18,25 +19,21 @@ class FrozenDateTimeParamConverter implements ParamConverterInterface
      */
     public function supports(string $class): bool
     {
-        return $class === FrozenDate::class || $class === FrozenTime::class;
+        return $class === FrozenDate::class || $class === FrozenTime::class || $class === Time::class;
     }
 
     /**
      * @inheritDoc
      *
-     * @param string $value from URL
+     * @param string $value from URL.
      * @param string $class FrozenDate or FrozenTime.
      *
      * @return FrozenTime|FrozenDate
      */
     public function convertTo(string $value, string $class)
     {
         try {
-            if ($class === FrozenDate::class) {
-                return new FrozenDate($value);
-            } else {
-                return new FrozenTime($value);
-            }
+            return new $class($value);
         } catch (\Exception $e) {
             throw new BadRequestException();
         }

tests/App/Controller/UsersController.php

@@ -5,6 +5,7 @@
 use Cake\Controller\Controller;
 use Cake\I18n\FrozenDate;
 use Cake\I18n\FrozenTime;
+use Cake\I18n\Time;
 use DateTime;
 use ParamConverter\Test\App\Model\Entity\User;
 
@@ -18,6 +19,10 @@ public function withEntity(User $entity): void
     {
     }
 
+    public function withTime(Time $time): void
+    {
+    }
+
     public function withDatetime(DateTime $dateTime): void
     {
     }

tests/TestCase/DispatchListenerTest.php

@@ -8,6 +8,7 @@
 use Cake\Http\ServerRequest;
 use Cake\I18n\FrozenDate;
 use Cake\I18n\FrozenTime;
+use Cake\I18n\Time;
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use DateTime;
@@ -70,6 +71,24 @@ public function testDatetime(): void
         $this->assertTrue($updatedRequest->getParam('pass.0') instanceof Datetime);
     }
 
+    public function testTime(): void
+    {
+        $event = new Event('beforeEvent');
+        $event->setData('controller', new UsersController());
+
+        $request = (new ServerRequest())
+            ->withParam('pass', ["2020-10-10"])
+            ->withParam('action', 'withTime');
+        $response = new Response();
+
+        $listener = new DispatchListener();
+        $listener->beforeDispatch($event, $request, $response);
+
+        /** @var ServerRequest $updatedRequest */
+        $updatedRequest = $event->getData('request');
+        $this->assertTrue($updatedRequest->getParam('pass.0') instanceof Time);
+    }
+
     public function testFrozenDate(): void
     {
         $event = new Event('beforeEvent');

tests/TestCase/TimeParamConverterTest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace ParamConverter\Test\TestCase;
+
+use Cake\Http\Exception\BadRequestException;
+use Cake\I18n\Time;
+use Cake\TestSuite\TestCase;
+use ParamConverter\FrozenDateTimeParamConverter;
+
+class TimeParamConverterTest extends TestCase
+{
+    public function testSupports(): void
+    {
+        $converter = new FrozenDateTimeParamConverter();
+        $this->assertTrue($converter->supports(Time::class));
+    }
+
+    /**
+     * @dataProvider conversionDataProvider
+     * @param string $rawValue Raw value
+     * @param string $expectedValue Expected value upon conversion
+     * @param string $format Date format
+     */
+    public function testConvertTo(string $rawValue, string $expectedValue, string $format): void
+    {
+        $converter = new FrozenDateTimeParamConverter();
+        /** @var \Cake\I18n\Time $convertedValue */
+        $convertedValue = $converter->convertTo($rawValue, Time::class);
+        $this->assertInstanceOf(Time::class, $convertedValue);
+        $this->assertEquals($expectedValue, $convertedValue->format($format));
+    }
+
+    public function testException(): void
+    {
+        $converter = new FrozenDateTimeParamConverter();
+        $this->expectException(BadRequestException::class);
+        $converter->convertTo("notvalid", Time::class);
+    }
+
+    /**
+     * @return array[]
+     */
+    public function conversionDataProvider(): array
+    {
+        return [
+            // raw value, converted value
+            ['now', date('Y-m-d'), 'Y-m-d'],
+            ['now', date('Y-m-d h:i'), 'Y-m-d h:i'],
+            ['2020-09-10', '2020-09-10', 'Y-m-d'],
+            ['2020-09-10 15:10:00', '2020-09-10 15:10:00', 'Y-m-d H:i:s'],
+        ];
+    }
+}