add ClockServiceInterface

Author: rez1dent3

config/config.php

@@ -12,6 +12,7 @@
 use Bavix\Wallet\Internal\Events\BalanceUpdatedEvent;
 use Bavix\Wallet\Internal\Repository\TransactionRepository;
 use Bavix\Wallet\Internal\Repository\TransferRepository;
+use Bavix\Wallet\Internal\Service\ClockService;
 use Bavix\Wallet\Internal\Service\DatabaseService;
 use Bavix\Wallet\Internal\Service\DispatcherService;
 use Bavix\Wallet\Internal\Service\JsonService;
@@ -64,6 +65,7 @@
      * Internal services that can be overloaded.
      */
     'internal' => [
+        'clock' => ClockService::class,
         'database' => DatabaseService::class,
         'dispatcher' => DispatcherService::class,
         'json' => JsonService::class,

src/Internal/Assembler/BalanceUpdatedEventAssembler.php

@@ -6,12 +6,25 @@
 
 use Bavix\Wallet\Internal\Events\BalanceUpdatedEvent;
 use Bavix\Wallet\Internal\Events\BalanceUpdatedEventInterface;
+use Bavix\Wallet\Internal\Service\ClockServiceInterface;
 use Bavix\Wallet\Models\Wallet;
 
 final class BalanceUpdatedEventAssembler implements BalanceUpdatedEventAssemblerInterface
 {
-    public function create(Wallet $wallet, string $balance): BalanceUpdatedEventInterface
+    private ClockServiceInterface $clockService;
+
+    public function __construct(ClockServiceInterface $clockService)
+    {
+        $this->clockService = $clockService;
+    }
+
+    public function create(Wallet $wallet): BalanceUpdatedEventInterface
     {
-        return new BalanceUpdatedEvent((int) $wallet->getKey(), $wallet->uuid, $balance);
+        return new BalanceUpdatedEvent(
+            (int) $wallet->getKey(),
+            $wallet->uuid,
+            $wallet->getOriginalBalanceAttribute(),
+            $this->clockService->now()
+        );
     }
 }

src/Internal/Assembler/BalanceUpdatedEventAssemblerInterface.php

@@ -9,5 +9,5 @@
 
 interface BalanceUpdatedEventAssemblerInterface
 {
-    public function create(Wallet $wallet, string $balance): BalanceUpdatedEventInterface;
+    public function create(Wallet $wallet): BalanceUpdatedEventInterface;
 }

src/Internal/Events/BalanceUpdatedEvent.php

@@ -4,20 +4,25 @@
 
 namespace Bavix\Wallet\Internal\Events;
 
+use DateTimeImmutable;
+
 final class BalanceUpdatedEvent implements BalanceUpdatedEventInterface
 {
     private int $walletId;
     private string $walletUuid;
     private string $balance;
+    private DateTimeImmutable $updatedAt;
 
     public function __construct(
         int $walletId,
         string $walletUuid,
-        string $balance
+        string $balance,
+        DateTimeImmutable $updatedAt
     ) {
         $this->walletId = $walletId;
         $this->walletUuid = $walletUuid;
         $this->balance = $balance;
+        $this->updatedAt = $updatedAt;
     }
 
     public function getWalletId(): int
@@ -34,4 +39,9 @@ public function getBalance(): string
     {
         return $this->balance;
     }
+
+    public function getUpdatedAt(): DateTimeImmutable
+    {
+        return $this->updatedAt;
+    }
 }

src/Internal/Events/BalanceUpdatedEventInterface.php

@@ -4,11 +4,15 @@
 
 namespace Bavix\Wallet\Internal\Events;
 
+use DateTimeImmutable;
+
 interface BalanceUpdatedEventInterface extends EventInterface
 {
     public function getWalletId(): int;
 
     public function getWalletUuid(): string;
 
     public function getBalance(): string;
+
+    public function getUpdatedAt(): DateTimeImmutable;
 }

src/Internal/Service/ClockService.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Internal\Service;
+
+use DateTimeImmutable;
+
+final class ClockService implements ClockServiceInterface
+{
+    public function now(): DateTimeImmutable
+    {
+        return new DateTimeImmutable();
+    }
+}

src/Internal/Service/ClockServiceInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Internal\Service;
+
+use DateTimeImmutable;
+
+/**
+ * @see https://github.com/php-fig/fig-standards/blob/master/proposed/clock.md
+ *
+ * @internal
+ */
+interface ClockServiceInterface
+{
+    public function now(): DateTimeImmutable;
+}

src/Services/RegulatorService.php

@@ -109,7 +109,7 @@ public function approve(): void
             $wallet->newQuery()->whereKey($wallet->getKey())->update(['balance' => $balance]); // ?qN
             $wallet->fill(['balance' => $balance])->syncOriginalAttribute('balance');
 
-            $event = $this->balanceUpdatedEventAssembler->create($wallet, $balance);
+            $event = $this->balanceUpdatedEventAssembler->create($wallet);
             $this->dispatcherService->dispatch($event);
         }
 

src/WalletServiceProvider.php

@@ -24,6 +24,8 @@
 use Bavix\Wallet\Internal\Repository\TransactionRepositoryInterface;
 use Bavix\Wallet\Internal\Repository\TransferRepository;
 use Bavix\Wallet\Internal\Repository\TransferRepositoryInterface;
+use Bavix\Wallet\Internal\Service\ClockService;
+use Bavix\Wallet\Internal\Service\ClockServiceInterface;
 use Bavix\Wallet\Internal\Service\DatabaseService;
 use Bavix\Wallet\Internal\Service\DatabaseServiceInterface;
 use Bavix\Wallet\Internal\Service\DispatcherService;
@@ -191,6 +193,7 @@ private function internal(array $configure): void
     {
         $this->app->bind(StorageServiceInterface::class, $configure['storage'] ?? StorageService::class);
 
+        $this->app->singleton(ClockServiceInterface::class, $configure['clock'] ?? ClockService::class);
         $this->app->singleton(DatabaseServiceInterface::class, $configure['database'] ?? DatabaseService::class);
         $this->app->singleton(DispatcherServiceInterface::class, $configure['dispatcher'] ?? DispatcherService::class);
         $this->app->singleton(JsonServiceInterface::class, $configure['json'] ?? JsonService::class);

tests/Infra/Listeners/BalanceUpdatedThrowDateListener.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Test\Infra\Listeners;
+
+use Bavix\Wallet\Internal\Events\BalanceUpdatedEventInterface;
+use Bavix\Wallet\Internal\Exceptions\UnknownEventException;
+use DateTimeInterface;
+
+final class BalanceUpdatedThrowDateListener
+{
+    public function handle(BalanceUpdatedEventInterface $balanceChangedEvent): void
+    {
+        throw new UnknownEventException(
+            $balanceChangedEvent->getUpdatedAt()->format(DateTimeInterface::ATOM),
+            (int) $balanceChangedEvent->getBalance()
+        );
+    }
+}