Replace Chronos with PSR-20 Clock interface

README.md

@@ -38,10 +38,10 @@ This project is based on best practices and industry standards:
 * Autoloader (PSR-4)
 * Logger (PSR-3)
 * Code styles (PSR-12)
+* Clock interoperability (PSR-20)
 * Single action controllers
 * Input validation
 * Query Builder
-* Immutable date time ([Chronos](https://github.com/cakephp/chronos))
 * Unit- and integration tests
 * Console Commands
 * Tested with [Github Actions](https://github.com/odan/slim4-skeleton/actions) and [Scrutinizer CI](https://scrutinizer-ci.com/)

composer.json

@@ -14,16 +14,17 @@
         "php": "^8.1",
         "ext-json": "*",
         "ext-pdo": "*",
-        "cakephp/chronos": "^3",
         "cakephp/database": "^5",
         "cakephp/validation": "^5",
         "fig/http-message-util": "^1.1",
         "monolog/monolog": "^3",
-        "nyholm/psr7": "^1.4",
-        "nyholm/psr7-server": "^1.0",
+        "nyholm/psr7": "^1.8.1",
+        "nyholm/psr7-server": "^1.1",
         "php-di/php-di": "^7",
+        "psr/clock": "^1.0",
         "selective/basepath": "^2",
-        "slim/slim": "^4"
+        "slim/slim": "^4",
+        "symfony/clock": "^6.3"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3",

config/container.php

@@ -6,6 +6,7 @@
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Logger;
 use Nyholm\Psr7\Factory\Psr17Factory;
+use Psr\Clock\ClockInterface;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ServerRequestFactoryInterface;
@@ -18,6 +19,7 @@
 use Slim\Factory\AppFactory;
 use Slim\Interfaces\RouteParserInterface;
 use Slim\Middleware\ErrorMiddleware;
+use Symfony\Component\Clock\NativeClock;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\InputOption;
 
@@ -128,4 +130,8 @@
 
         return $application;
     },
+
+    ClockInterface::class => function () {
+        return new NativeClock();
+    },
 ];

docs/testing.md

@@ -199,42 +199,38 @@ $password = $this->getTableRowById('users', 1)['password'];
 ## Testing with Date and Time
 
 To change the date and time for testing purposes, invoke the 
-`Chronos::setTestNow` method within a test as follows:
+`setTestNow` method within a test as follows:
 
 ```php
-use Cake\Chronos\Chronos;
-
-Chronos::setTestNow('2022-02-01 00:00:00');
+$thia->setTestNow('2024-01-01 00:00:00');
 ```
 
-## Mocking
+To get the current date and time within the application, 
+declare the `Psr\Clock\ClockInterface $clock` as class dependency
+and invoke the `now()` method.
 
-When testing Slim applications, you may wish to "mock" certain aspects of your
-application, so they are not actually executed during a test.
-For example, when testing a service that needs a repository,
-you may wish to mock the repository so that it's not actually
-executed queries during the test.
+**Example**
 
-Note: Mocking is not a good testing method, because you may
-not test the code you actually deploy, and furthermore,
-if you change the code, you will have to change the test as well.
-The meaningfulness and maintainability of tests with a
-mock is thus significantly lower compared to a test
-that tests the entire code.
+````php
+<?php
 
-The `AppTestTrait` provides methods for mocking objects into the container.
+namespace Example;
 
-Mocking methods:
+use Psr\Clock\ClockInterface;
 
-```php
-$this->mock(UserCreator::class)->method('createUser')->willReturn(1);
-```
+final class MyClass
+{
+    public function __construct(private readonly ClockInterface $clock)
+    {
+    }
 
-For better IDE  support you may better use the `mockMethod` helper:
-
-```php
-$this->mockMethod([UserReaderRepository::class, 'getUserById'])
-    ->willReturn(['example' => 'data']);
+    public function insertCustomer(array $customer): int
+    {
+        $now = $this->clock->now();
+
+        // ...
+    }
+}
 ```
 
 ## Read more

src/Domain/Customer/Repository/CustomerFinderRepository.php

@@ -30,7 +30,7 @@ public function findCustomers(): array
             ]
         );
 
-        // Add more "use case specific" conditions to the query
+        // Add more conditions to the query
         // ...
 
         return $query->execute()->fetchAll('assoc') ?: [];

tests/TestCase/Action/Customer/CustomerCreatorActionTest.php

@@ -3,7 +3,6 @@
 namespace App\Test\TestCase\Action\Customer;
 
 use App\Test\Traits\AppTestTrait;
-use Cake\Chronos\Chronos;
 use Fig\Http\Message\StatusCodeInterface;
 use PHPUnit\Framework\TestCase;
 use Selective\TestTrait\Traits\DatabaseTestTrait;
@@ -20,7 +19,7 @@ class CustomerCreatorActionTest extends TestCase
 
     public function testCreateCustomer(): void
     {
-        Chronos::setTestNow('2021-01-01 00:00:00');
+        $this->setTestNow('2021-02-01 00:00:00');
 
         $request = $this->createJsonRequest(
             'POST',

tests/TestCase/Action/Customer/CustomerUpdaterActionTest.php

@@ -4,7 +4,6 @@
 
 use App\Test\Fixture\CustomerFixture;
 use App\Test\Traits\AppTestTrait;
-use Cake\Chronos\Chronos;
 use Fig\Http\Message\StatusCodeInterface;
 use PHPUnit\Framework\TestCase;
 use Selective\TestTrait\Traits\DatabaseTestTrait;
@@ -21,7 +20,7 @@ class CustomerUpdaterActionTest extends TestCase
 
     public function testUpdateCustomer(): void
     {
-        Chronos::setTestNow('2021-02-01 00:00:00');
+        $this->setTestNow('2024-01-31 00:00:00');
 
         $this->insertFixtures([CustomerFixture::class]);
 

tests/Traits/AppTestTrait.php

@@ -12,6 +12,7 @@
 trait AppTestTrait
 {
     use ArrayTestTrait;
+    use ClockTestTrait;
     use ContainerTestTrait;
     use HttpTestTrait;
     use HttpJsonTestTrait;

tests/Traits/ClockTestTrait.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Test\Traits;
+
+use DateTimeImmutable;
+use DateTimeZone;
+use Psr\Clock\ClockInterface;
+use Symfony\Component\Clock\MockClock;
+
+/**
+ * PSR-20 Test Clock.
+ */
+trait ClockTestTrait
+{
+    private function setTestNow(DateTimeImmutable|string $now = 'now', DateTimeZone|string $timezone = null): void
+    {
+        $this->container->set(ClockInterface::class, new MockClock($now, $timezone));
+    }
+}