Merge pull request #7 from jeckel/add-clock-module

Add clock module

Author: jeckel

composer.json

@@ -21,17 +21,19 @@
         }
     },
     "require": {
-        "php": ">=7.0",
+        "php": ">=7.1",
         "codeception/codeception": "^2.5",
         "behat/behat": "^3.5"
     },
     "require-dev": {
         "phpstan/phpstan": "^0.11.5",
         "squizlabs/php_codesniffer": "^3.4",
-        "phpmd/phpmd": "^2.6"
+        "phpmd/phpmd": "^2.6",
+        "mikey179/vfsStream": "^1.6"
     },
     "suggest": {
         "edno/codeception-gherkin-param": "The Codeception extension for supporting parameter notation in Gherkin scenario.",
-        "flow/jsonpath" : "Json path parser"
+        "flow/jsonpath": "Json path parser",
+        "jeckel/clock": "Clock service with mock capability"
     }
 }

composer.lock

@@ -0,0 +1,53 @@
+<?php
+namespace Jeckel\Gherkin;
+
+use Codeception\Lib\Interfaces\RequiresPackage;
+use Codeception\Configuration;
+
+/**
+ * Class Clock
+ * @package Jeckel\Gherkin
+ * @SuppressWarnings(PHPMD.LongVariable)
+ */
+class Clock extends ContextAbstract
+{
+    /** @var array */
+    protected $requiredFields = ['clock_path'];
+
+    // disable all inherited actions
+    public static $includeInheritedActions = false;
+
+    /** @var string */
+    protected $projectDir = null;
+
+    /**
+     * @return string
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
+    public function getProjectDir(): string
+    {
+        if (empty($this->projectDir)) {
+            return Configuration::projectDir();
+        }
+        return $this->projectDir;
+    }
+
+    /**
+     * @param string $projectDir
+     * @return Clock
+     */
+    public function setProjectDir(string $projectDir): Clock
+    {
+        $this->projectDir = $projectDir;
+        return $this;
+    }
+
+    /**
+     * @Given I set fake clock to :clock
+     * @param string $clock
+     */
+    public function setFakeClockTo(string $clock)
+    {
+        file_put_contents($this->projectDir . $this->config['clock_path'], $clock);
+    }
+}

src/Clock.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * User: jeckel
+ * Date: 21/04/19
+ * Time: 15:45
+ */
+
+namespace Test\Jeckel\Gherkin;
+
+use Codeception\Lib\ModuleContainer;
+use Jeckel\Gherkin\Clock;
+use org\bovigo\vfs\vfsStream;
+use org\bovigo\vfs\vfsStreamDirectory;
+use org\bovigo\vfs\vfsStreamWrapper;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class ClockTest extends \Codeception\Test\Unit
+{
+    /** @var Clock */
+    protected $helper;
+
+    public function setUp()
+    {
+        /** @var MockObject | ModuleContainer $moduleContainer */
+        $moduleContainer = $this->createMock(ModuleContainer::class);
+
+        $this->helper = new Clock($moduleContainer);
+
+        vfsStreamWrapper::register();
+        vfsStreamWrapper::setRoot(new vfsStreamDirectory('clockDir'));
+        $this->helper->setProjectDir(vfsStream::url('clockDir'));
+
+        return parent::setUp(); // TODO: Change the autogenerated stub
+    }
+
+    public function testSetFakeClockTo()
+    {
+        $clock =  '2018-01-01 10:10:00';
+        $clockFile = '/clock';
+
+        $this->helper->_setConfig(['clock_path' => $clockFile]);
+
+        $this->helper->setFakeClockTo($clock);
+        $this->assertTrue(vfsStreamWrapper::getRoot()->hasChild('clock'));
+        $this->assertEquals($clock, file_get_contents(vfsStream::url('clockDir') . $clockFile));
+    }
+}