Merge pull request #17 from Jeckel-Lab/feature/codeception-helper

Add helper for codeception

composer.json

@@ -31,6 +31,10 @@
         "squizlabs/php_codesniffer": "^3.5",
         "mikey179/vfsstream": "^1.6",
         "vimeo/psalm": "^4.3",
-        "phpro/grumphp": "^0.19 || ^1.2.0"
+        "phpro/grumphp": "^0.19 || ^1.2.0",
+        "codeception/codeception": "^4.1"
+    },
+    "suggest": {
+        "codeception/codeception": "Use helper to handle clock with your codeception tests"
     }
 }

phpunit.xml

@@ -5,6 +5,9 @@
     <include>
       <directory suffix=".php">src</directory>
     </include>
+    <exclude>
+      <directory suffix=".php">src/CodeceptionHelper</directory>
+    </exclude>
   </coverage>
   <testsuites>
     <testsuite name="Project Test Suite">

src/CodeceptionHelper/Clock.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * @author: Julien Mercier-Rojas <[email protected]>
+ * Created at: 25/03/2021
+ */
+
+declare(strict_types=1);
+
+namespace JeckelLab\Clock\CodeceptionHelper;
+
+use Codeception\Configuration;
+use Codeception\Module;
+use RuntimeException;
+
+/**
+ * Class Clock
+ * @package JeckelLab\Clock\CodeceptionHelper
+ */
+class Clock extends Module
+{
+    /**
+     * @var array
+     */
+    protected $requiredFields = ['fake_time_path'];
+
+    /**
+     * Expected format 'Y-m-d H:i:s'
+     * @Given current date and time is :currentDate
+     * @param string $currentDate
+     */
+    public function currentDateAndTimeIs(string $currentDate): void
+    {
+        /** @psalm-suppress MixedArrayAccess */
+        $fullPath = Configuration::projectDir() . ((string) $this->config['fake_time_path']);
+
+        $dir = dirname($fullPath);
+        if (!is_dir($dir) && !mkdir($dir) && !is_dir($dir)) {
+            throw new RuntimeException(sprintf('Directory "%s" was not created', $dir));
+        }
+        file_put_contents($fullPath, $currentDate);
+    }
+}