vid-2

Author: codereviewvideos

app/config/config.yml

@@ -3,6 +3,7 @@ imports:
     - { resource: security.yml }
     - { resource: services.yml }
     - { resource: services/doctrine_entity_repository.yml }
+    - { resource: services/listener.yml }
     - { resource: services/repository.yml }
 
 # Put parameters here that don't need to change on each machine where the app is deployed

app/config/config_acceptance.yml

@@ -1,5 +1,6 @@
 imports:
     - { resource: config.yml }
+    - { resource: services/clock_acceptance.yml }
 
 monolog:
     handlers:

app/config/config_dev.yml

@@ -1,5 +1,6 @@
 imports:
     - { resource: config.yml }
+    - { resource: services/clock_prod.yml }
 
 framework:
     router:

app/config/config_prod.yml

@@ -1,5 +1,6 @@
 imports:
     - { resource: config.yml }
+    - { resource: services/clock_prod.yml }
 
 #doctrine:
 #    orm:

app/config/services/clock_acceptance.yml

@@ -0,0 +1,6 @@
+services:
+
+    crv.clock:
+        class: AppBundle\Model\TestClock
+        arguments:
+            - "@filesystem"

app/config/services/clock_prod.yml

@@ -0,0 +1,4 @@
+services:
+
+    crv.clock:
+        class: AppBundle\Model\SystemClock

app/config/services/listener.yml

@@ -0,0 +1,9 @@
+services:
+
+    crv.listener.timestamp:
+        class: AppBundle\Listener\TimestampListener
+        arguments:
+            - "@crv.clock"
+        tags:
+            - { name: doctrine.event_listener, event: prePersist }
+            - { name: doctrine.event_listener, event: preUpdate }

behat.yml

@@ -15,6 +15,9 @@ default:
             client: "@guzzle.client.local_test_api"
         - AppBundle\Features\Context\WidgetSetupContext:
             em: "@doctrine.orm.entity_manager"
+            clock: "@crv.clock"
+        - AppBundle\Features\Context\TimeContext:
+            clock: "@crv.clock"
 
   extensions:
     Behat\Symfony2Extension:

src/AppBundle/Entity/Traits/TimestampableTrait.php

@@ -58,15 +58,6 @@ public function setCreatedAt(\DateTimeImmutable $dateTime = null)
         return $this;
     }
 
-    /**
-     * @ORM\PrePersist()
-     * @return $this
-     */
-    public function setCreatedAtViaPrePersist()
-    {
-        return $this->setCreatedAt();
-    }
-
     /**
      * Get updated at
      *

src/AppBundle/Features/Context/TimeContext.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace AppBundle\Features\Context;
+
+use AppBundle\Model\Clock;
+use AppBundle\Model\TestClock;
+use Behat\Behat\Context\Context;
+
+class TimeContext implements Context
+{
+    /**
+     * @var TestClock
+     */
+    private $clock;
+
+    public function __construct(
+        TestClock $clock
+    )
+    {
+        $this->clock = $clock;
+    }
+
+    /**
+     * @Given the system time at the start of this test is :strDate
+     */
+    public function theSystemTimeAtTheStartOfThisTestIs($strDate)
+    {
+        $this->clock->setTime(
+            $strDate
+        );
+    }
+}

src/AppBundle/Features/Context/WidgetSetupContext.php

@@ -3,6 +3,7 @@
 namespace AppBundle\Features\Context;
 
 use AppBundle\Entity\Widget;
+use AppBundle\Model\Clock;
 use Behat\Behat\Context\Context;
 use Behat\Gherkin\Node\TableNode;
 use Doctrine\Common\Collections\ArrayCollection;
@@ -14,17 +15,24 @@ class WidgetSetupContext implements Context
      * @var EntityManagerInterface
      */
     protected $em;
+    /**
+     * @var Clock
+     */
+    private $clock;
 
     /**
      * WidgetSetupContext constructor.
      *
      * @param EntityManagerInterface $em
+     * @param Clock                  $clock
      */
     public function __construct(
-        EntityManagerInterface $em
+        EntityManagerInterface $em,
+        Clock $clock
     )
     {
         $this->em = $em;
+        $this->clock = $clock;
     }
 
     /**
@@ -48,13 +56,13 @@ public function thereAreWidgetsWithTheFollowingDetails(TableNode $widgets)
                 ->set(
                     'w.createdAt',
                     $qb->expr()->literal(
-                        (new \DateTimeImmutable($val['created_at']))->format('c')
+                        $this->clock->now()->modify($val['created_at'])->format('c')
                     )
                 )
                 ->set(
                     'w.updatedAt',
                     $qb->expr()->literal(
-                        (new \DateTimeImmutable($val['updated_at']))->format('c')
+                        $this->clock->now()->modify($val['updated_at'])->format('c')
                     )
                 )
                 ->where('w.id = :id')

src/AppBundle/Features/widget.feature

@@ -6,9 +6,10 @@ Feature: Manage Widget data via a JSON API
 
 
   Background:
-    Given there are Widgets with the following details:
+    Given the system time at the start of this test is "1 January 2020 00:00:00"
+    And there are Widgets with the following details:
       | id | name     | created_at | updated_at |
-      | 1  | Widget A | -4 days    | -5 minutes |
+      | 1  | Widget A | -7 days    | -5 minutes |
       | 2  | Widget B | -1 day     | -1 day     |
       | 3  | Widget C | -6 months  | -3 weeks   |
     And I set header "Content-Type" with value "application/json"
@@ -22,21 +23,7 @@ Feature: Manage Widget data via a JSON API
       {
           "id": 1,
           "name": "Widget A",
-          features: [
-            {
-              "id": 1,
-              "name": "some feature",
-              "created_at": "2015-01-01T00:00:00+0000",
-              "updated_at": "2015-01-01T00:00:00+0000",
-            },
-            {
-              "id": 1,
-              "name": "another feature",
-              "created_at": "2016-01-01T00:00:00+0000",
-              "updated_at": "2016-01-01T00:00:00+0000",
-            }
-          ]
+          "created_at": "2019-12-25T00:00:00+0000",
+          "updated_at": "2019-12-31T23:55:00+0000"
       }
-      """
-    And the "created_at" date should be approximately "-4 days"
-    And the "updated_at" date should be approximately "-5 minutes"
+      """

src/AppBundle/Listener/TimestampListener.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace AppBundle\Listener;
+
+use AppBundle\Model\Clock;
+use Doctrine\ORM\Event\LifecycleEventArgs;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
+
+class TimestampListener
+{
+    /**
+     * @var Clock
+     */
+    private $clock;
+
+    public function __construct(Clock $clock)
+    {
+        $this->clock = $clock;
+    }
+
+    public function prePersist(LifecycleEventArgs $lifecycleEventArgs)
+    {
+        $entity = $lifecycleEventArgs->getEntity();
+
+        if (method_exists($entity, 'setCreatedAt')) {
+            $entity->setCreatedAt(
+                $this->clock->now()
+            );
+        }
+    }
+
+    public function preUpdate(PreUpdateEventArgs $preUpdateEventArgs)
+    {
+        $entity = $preUpdateEventArgs->getEntity();
+
+        if (method_exists($entity, 'setUpdatedAt')) {
+            $entity->setCreatedAt(
+                $this->clock->now()
+            );
+        }
+    }
+}

src/AppBundle/Model/Clock.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace AppBundle\Model;
+
+interface Clock
+{
+    public function now() : \DateTimeImmutable;
+}

src/AppBundle/Model/SystemClock.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace AppBundle\Model;
+
+class SystemClock implements Clock
+{
+    public function now(): \DateTimeImmutable
+    {
+        return new \DateTimeImmutable('now');
+    }
+}

src/AppBundle/Model/TestClock.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace AppBundle\Model;
+
+use Symfony\Component\Filesystem\Filesystem;
+
+class TestClock implements Clock
+{
+    /**
+     * @var Filesystem
+     */
+    private $filesystem;
+
+    /**
+     * @var string
+     */
+    private $dir;
+
+    /**
+     * @var string
+     */
+    private $file;
+
+    public function __construct(Filesystem $filesystem)
+    {
+        $this->filesystem = $filesystem;
+
+        $this->dir = sys_get_temp_dir() . '/time';
+        $this->file = $this->dir . '/timefile';
+    }
+
+    public function setTime(string $time)
+    {
+        $this->filesystem->mkdir($this->dir);
+
+        if ($this->filesystem->exists($this->file)) {
+            $this->filesystem->remove($this->file);
+        }
+
+        $isoDateTime = (new \DateTimeImmutable($time))
+            ->format('c')
+        ;
+
+        $this->filesystem->dumpFile(
+            $this->file,
+            $isoDateTime
+        );
+    }    
+    
+    public function now(): \DateTimeImmutable
+    {
+        if (false === $this->filesystem->exists($this->file)) {
+            throw new \RuntimeException('Must set the time file before doing this.');
+        }
+
+        return new \DateTimeImmutable(
+            file_get_contents($this->file)
+        );
+    }
+}