Merge pull request #19 from Jeckel-Lab/feature/fallback-to-realclock-if-fake-failed

Allow to fallback to realclock if fake clock intialization…

Author: jeckel

README.md

@@ -46,7 +46,7 @@ Configure default parameters in `config/packages/parameters.yaml`:
 parameters:
     clock:
         mode: real
-        timezone: Europe/Paris
+        timezone: Europe/Paris  # Optional
 ```
 
 And then configure parameters for **tests** environment in `config/packages/test/parameters.yaml`:
@@ -64,6 +64,7 @@ parameters:
     clock:
         mode: frozen
         fake_time_path: '%kernel.project_dir%/var/fake_time.txt'
+        fallback_to_current_date: true # Default: false, if true and file is not found or has invalid valid, then fallback to RealClock
 ```
 
 ## Test with Codeception

src/CodeceptionHelper/Clock.php

@@ -28,6 +28,7 @@ class Clock extends Module
 
     /**
      * @var string[]
+     * @psalm-suppress NonInvariantDocblockPropertyType
      */
     protected $config = [
         'date_format' => 'Y/m/d',
@@ -36,6 +37,7 @@ class Clock extends Module
 
     /**
      * @var array
+     * @psalm-suppress NonInvariantDocblockPropertyType
      */
     protected $requiredFields = ['fake_time_path', 'date_format', 'time_format'];
 

src/Exception/InvalidFakeClockInitialValueException.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @author: Julien Mercier-Rojas <julien@jeckel-lab.fr>
+ * Created at: 07/04/2021
+ */
+
+declare(strict_types=1);
+
+namespace JeckelLab\Clock\Exception;
+
+/**
+ * Class InvalidFakeClockInitialValueException
+ * @package JeckelLab\Clock\Exception
+ * @psalm-immutable
+ */
+class InvalidFakeClockInitialValueException extends RuntimeException
+{
+
+}

src/Factory/ClockFactory.php

@@ -9,6 +9,7 @@
 use JeckelLab\Clock\Clock\FakedClock;
 use JeckelLab\Clock\Clock\FrozenClock;
 use JeckelLab\Clock\Clock\RealClock;
+use JeckelLab\Clock\Exception\InvalidFakeClockInitialValueException;
 use JeckelLab\Clock\Exception\RuntimeException;
 use JeckelLab\Contract\Infrastructure\System\Clock as ClockInterface;
 
@@ -37,14 +38,21 @@ public static function getClock(array $config = []): ClockInterface
             );
         }
 
-        switch ($config['mode'] ?? '') {
-            case 'frozen':
-                return new FrozenClock(self::getInitialTimeFromConfig($config));
-            case 'faked':
-                return new FakedClock(self::getInitialTimeFromConfig($config), $timezone);
-            case 'real':
-            default:
+        try {
+            switch ($config['mode'] ?? '') {
+                case 'frozen':
+                    return new FrozenClock(self::getInitialTimeFromConfig($config));
+                case 'faked':
+                    return new FakedClock(self::getInitialTimeFromConfig($config), $timezone);
+                case 'real':
+                default:
+                    return new RealClock($timezone);
+            }
+        } catch (InvalidFakeClockInitialValueException $e) {
+            if (isset($config['fallback_to_current_date']) && $config['fallback_to_current_date'] === true) {
                 return new RealClock($timezone);
+            }
+            throw $e;
         }
     }
 
@@ -62,12 +70,12 @@ protected static function getInitialTimeFromConfig(array $config): DateTimeImmut
             if (isset($config['fake_time_path'])) {
                 $filePath = (string) $config['fake_time_path'];
                 if (! is_readable($filePath)) {
-                    throw new Exception('Impossible to read fake time file: ' . $filePath);
+                    throw new InvalidFakeClockInitialValueException('Impossible to read fake time file: ' . $filePath);
                 }
                 return new DateTimeImmutable(file_get_contents($filePath));
             }
         } catch (Exception $e) {
-            throw new RuntimeException(
+            throw new InvalidFakeClockInitialValueException(
                 'Invalid fake time provided: ' . $e->getMessage(),
                 (int) $e->getCode(),
                 $e

tests/Factory/ClockFactoryTest.php

@@ -100,6 +100,20 @@ public function testGetFakeClockWithUnreadableFile(): void
         ClockFactory::getClock(['mode' => 'frozen', 'fake_time_path' => '/foo/bar/baz']);
     }
 
+    public function testGetFakeClockWithUnreadableFileAndFallbackToCurrentDate(): void
+    {
+        self::assertInstanceOf(
+            RealClock::class,
+            ClockFactory::getClock(
+                [
+                    'mode' => 'frozen',
+                    'fake_time_path' => '/foo/bar/baz',
+                    'fallback_to_current_date' => true
+                ]
+            )
+        );
+    }
+
     public function testGetFakeClockWithInvalidInitFileContent(): void
     {
         $root = vfsStream::setup('root', 444, ['clock' => 'foobarbaz']);