feat: Updates PHP version, refactor models, add event emission and ot…

…her adjustments.

infection.json.dist

@@ -19,11 +19,8 @@
         "BCMath": false,
         "CastInt": false,
         "CastFloat": false,
-        "ArrayItem": false,
+        "CastArray": false,
         "CastString": false,
-        "InstanceOf_": false,
-        "MatchArmRemoval": false,
-        "ArrayItemRemoval": false,
         "PublicVisibility": false,
         "MethodCallRemoval": false,
         "NullSafePropertyCall": false

phpstan.neon.dist

@@ -3,10 +3,9 @@ parameters:
     - src
   level: 9
   tmpDir: report/phpstan
-  excludePaths:
-    - src/Application/Domain/Models/Commons/Utc.php
   ignoreErrors:
-    - '#No value type specified in iterable type#'
+    - '#expects string\|null, mixed given#'
     - '#with no value type specified in iterable type array#'
-    - '#expects array, mixed given#'
+    - '#expects class-string<T of object>\|T of object, string given#'
+    - '#return type has no value type specified in iterable type array#'
   reportUnmatchedIgnoredErrors: false

phpunit.xml

@@ -33,6 +33,8 @@
     </source>
 
     <php>
+        <env name="CHEAP_DELIVERY_HOST" value="cheap-delivery.localhost"/>
+
         <env name="MYSQL_DATABASE_HOST" value="cheap-delivery-adm"/>
         <env name="MYSQL_DATABASE_PORT" value="3306"/>
         <env name="MYSQL_DATABASE_NAME" value="cheap_delivery_adm_test"/>

src/Application/Domain/Models/Commons/Collection.php

@@ -4,7 +4,6 @@
 
 use Closure;
 use Generator;
-use Traversable;
 
 /**
  * @implements Collectible<mixed, mixed>
@@ -21,7 +20,7 @@ class Collection implements Collectible
      */
     public function __construct(iterable $elements = [])
     {
-        $this->elements = $this->normalize(elements: $elements);
+        $this->elements = iterator_to_array($elements);
     }
 
     public function add(mixed $element): Collectible
@@ -81,16 +80,4 @@ public function getIterator(): Generator
             yield $element;
         }
     }
-
-    /**
-     * @param mixed[] $elements
-     * @return mixed[]
-     */
-    private function normalize(iterable $elements): array
-    {
-        return match (true) {
-            $elements instanceof Traversable => iterator_to_array($elements),
-            default => $elements
-        };
-    }
 }

src/Application/Domain/Models/Commons/Utc.php

@@ -20,6 +20,7 @@ public static function now(): Utc
         $dateTime = new DateTimeImmutable(datetime: 'now', timezone: $timezone);
         $formattedDate = $dateTime->format(format: self::FORMAT_RFC3339);
 
+        /** @var DateTimeImmutable $utc */
         $utc = DateTimeImmutable::createFromFormat(
             format: self::FORMAT_RFC3339,
             datetime: $formattedDate,

src/Application/Domain/Models/Commons/Uuid.php

@@ -2,15 +2,24 @@
 
 namespace CheapDelivery\Application\Domain\Models\Commons;
 
+use InvalidArgumentException;
+
 final readonly class Uuid
 {
+    private const UUID_PATTERN = '/^[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}$/i';
+    private const RANDOM_BYTES_SIZE = 16;
+
     public function __construct(private string $value)
     {
+        if (!self::isUuid($value)) {
+            $template = 'Invalid UUID <%s>.';
+            throw new InvalidArgumentException(message: sprintf($template, $this->value));
+        }
     }
 
     public static function generateV4(): Uuid
     {
-        $randomBytes = random_bytes(16);
+        $randomBytes = random_bytes(self::RANDOM_BYTES_SIZE);
 
         $randomBytes[6] = chr(ord($randomBytes[6]) & 0x0f | 0x40);
         $randomBytes[8] = chr(ord($randomBytes[8]) & 0x3f | 0x80);
@@ -24,4 +33,9 @@ public function toString(): string
     {
         return $this->value;
     }
+
+    public static function isUuid(string $value): bool
+    {
+        return preg_match(self::UUID_PATTERN, $value) === 1;
+    }
 }

src/Application/Handlers/DispatchWithLowestCostHandler.php

@@ -15,18 +15,18 @@ public function __construct(private Carriers $carriers, private Dispatches $disp
     {
     }
 
-    /**
-     * @param DispatchWithLowestCost $command
-     * @return void
-     */
-    public function handle(Command $command): void
+    public function handle(Command|DispatchWithLowestCost $command): void
     {
         $carriers = $this->carriers->findAll();
 
+        /** @var DispatchWithLowestCost $command */
+        $person = $command->person;
+        $product = $command->product;
+
         $dispatch = Dispatch::create();
         $dispatch->dispatchWithLowestCost(
-            weight: $command->product->weight,
-            distance: $command->person->distance,
+            weight: $product->weight,
+            distance: $person->distance,
             carriers: $carriers
         );
 

src/Driven/Carrier/Repository/Factories/Modalities/FixedCostFactory.php

@@ -20,6 +20,6 @@ public function __construct(private array $costModality)
 
     public function build(): CostModality
     {
-        return new FixedCost(fixedCost: new Cost(value: floatval($this->costModality['cost'])));
+        return new FixedCost(fixedCost: new Cost(value: (float)$this->costModality['cost']));
     }
 }

src/Driven/Carrier/Repository/Factories/Modalities/LinearCostFactory.php

@@ -20,6 +20,6 @@ public function __construct(private array $costModality)
 
     public function build(): CostModality
     {
-        return new LinearCost(variableCost: new Cost(value: floatval($this->costModality['cost'])));
+        return new LinearCost(variableCost: new Cost(value: (float)$this->costModality['cost']));
     }
 }

src/Driven/Carrier/Repository/Record.php

@@ -19,7 +19,7 @@ public static function from(array $value): Record
 
     public function toCarrier(): Carrier
     {
-        $costModality = json_decode($this->value['costModality'], true);
+        $costModality = (array)json_decode($this->value['costModality'], true);
 
         return new Carrier(
             name: new Name(value: $this->value['name']),

src/Driven/Dispatch/OutboxEvent/EventRecordFactory.php

@@ -12,11 +12,11 @@
 {
     public static function from(Event $event): EventRecord
     {
-        $record = match (get_class($event)) {
-            DispatchedWithLowestCost::class => new DispatchedWithLowestCostV1(event: $event),
-            default => throw new LogicException(message: 'Unsupported event type. Cannot convert event to EventRecord.')
-        };
+        if ($event::class === DispatchedWithLowestCost::class) {
+            return (new DispatchedWithLowestCostV1(event: $event))->build();
+        }
 
-        return $record->build();
+        $template = 'Event <%s> is not supported. Unable to create an EventRecord.';
+        throw new LogicException(message: sprintf($template, $event::class));
     }
 }

src/Driven/Shared/OutboxEvent/Commons/AggregateType.php

@@ -3,19 +3,13 @@
 namespace CheapDelivery\Driven\Shared\OutboxEvent\Commons;
 
 use ReflectionClass;
-use ReflectionException;
 
 final class AggregateType
 {
     private function __construct(public string $value)
     {
     }
 
-    /**
-     * @param class-string $class
-     * @return AggregateType
-     * @throws ReflectionException
-     */
     public static function from(string $class): AggregateType
     {
         return new AggregateType(value: (new ReflectionClass(objectOrClass: $class))->getShortName());

src/Driver/Http/Endpoints/Dispatch/DispatchWithLowestCost.php

@@ -17,7 +17,7 @@ public function __construct(private DispatchWithLowestCostHandler|CommandHandler
 
     public function handle(ServerRequestInterface $request): ResponseInterface
     {
-        $payload = json_decode($request->getBody()->__toString(), true);
+        $payload = (array)json_decode($request->getBody()->__toString(), true);
         $request = new Request(payload: $payload);
         $command = $request->toCommand();
 

src/Query/Dispatch/Database/Builder.php

@@ -4,10 +4,6 @@
 
 final class Builder
 {
-    /**
-     * @param array $dispatches
-     * @return mixed[]
-     */
     public static function from(array $dispatches): array
     {
         $mapper = fn(array $dispatch) => [

src/Query/Dispatch/Database/Facade.php

@@ -14,11 +14,6 @@ public function __construct(private QueryBuilder $queryBuilder)
     {
     }
 
-    /**
-     * @param DispatchFilters|Filters $filters
-     * @return mixed[]
-     * @throws QueryFailure
-     */
     public function findAll(DispatchFilters|Filters $filters): array
     {
         try {

src/Query/Filters.php

@@ -7,7 +7,7 @@ interface Filters
     /**
      * Creates a Filters instance from an array of data.
      *
-     * @param array $data The data to create the Filters instance from.
+     * @param mixed[] $data The data to create the Filters instance from.
      * @return Filters The created Filters instance.
      */
     public static function from(array $data): Filters;

tests/Integration/Application/Handlers/DispatchWithLowestCostHandlerTest.php

@@ -43,8 +43,8 @@ public function testDispatchWithLowestCost(): void
         /** @Then the dispatch should be persisted */
         $actual = $this->query->findLastDispatch();
 
-        self::assertEquals(96.4, $actual->shipment->cost->value);
-        self::assertEquals('DHL', $actual->shipment->carrierName->value);
+        self::assertEquals(96.4, $actual->shipment?->cost->value);
+        self::assertEquals('DHL', $actual->shipment?->carrierName->value);
 
         /** @And a new event will be inserted into the outbox table */
         $event = $this->query->findEventBy(aggregateId: $actual->id, eventType: 'DispatchedWithLowestCost');

tests/Integration/Query/Dispatch/Factories/Request.php

@@ -2,6 +2,7 @@
 
 namespace Test\Integration\Query\Dispatch\Factories;
 
+use CheapDelivery\Environment;
 use Psr\Http\Message\ServerRequestInterface;
 use Slim\Psr7\Headers;
 use Slim\Psr7\Request as SlimRequest;
@@ -12,12 +13,18 @@ final class Request
 {
     public static function getFrom(array $parameters): ServerRequestInterface
     {
-        $stream = fopen('php://memory', 'r+');
+        $uri = new Uri(
+            scheme: 'https',
+            host: Environment::get(variable: 'CHEAP_DELIVERY_HOST')->toString(),
+            port: null,
+            path: '/',
+            query: http_build_query($parameters)
+        );
+        /** @var resource $stream */
+        $stream = fopen(filename: 'php://memory', mode: 'r+');
+        $body = new Stream(stream: $stream);
+        $headers = new Headers(headers: ['Content-Type' => 'application/json']);
 
-        $uri = new Uri('https', 'cheap-delivery.localhost', null, '/', http_build_query($parameters));
-        $body = new Stream($stream);
-        $headers = new Headers(['Content-Type' => 'application/json']);
-
-        return new SlimRequest('GET', $uri, $headers, [], [], $body);
+        return new SlimRequest(method: 'GET', uri: $uri, headers: $headers, cookies: [], serverParams: [], body: $body);
     }
 }

tests/Unit/Application/Domain/Models/Commons/CollectionTest.php

@@ -11,7 +11,7 @@
 class CollectionTest extends TestCase
 {
     /**
-     * @param iterable $elements
+     * @param mixed[] $elements
      * @param array $expected
      * @return void
      * @dataProvider itemsProvider

tests/Unit/Application/Domain/Models/Commons/Factories/SomeThings.php

@@ -2,9 +2,8 @@
 
 namespace CheapDelivery\Application\Domain\Models\Commons\Factories;
 
-use CheapDelivery\Application\Domain\Models\Commons\Collectible;
 use CheapDelivery\Application\Domain\Models\Commons\Collection;
 
-final class SomeThings extends Collection implements Collectible
+final class SomeThings extends Collection
 {
 }

tests/Unit/Application/Domain/Models/Commons/UuidTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace CheapDelivery\Application\Domain\Models\Commons;
+
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+
+class UuidTest extends TestCase
+{
+    public function testInvalidUuid(): void
+    {
+        /** @Given a value that is not a valid UUID */
+        $value = 'not-a-valid-uuid';
+
+        /** @Then an exception indicating invalid UUID should be thrown */
+        $template = 'Invalid UUID <%s>.';
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage(sprintf($template, $value));
+
+        /** @When I try to construct a UUID with this value */
+        new Uuid(value: $value);
+    }
+
+    /**
+     * @param string $value
+     * @return void
+     * @dataProvider uuidProvider
+     */
+    public function testIsUuidValid(string $value): void
+    {
+        self::assertTrue(Uuid::isUuid(value: $value));
+    }
+
+    public static function uuidProvider(): array
+    {
+        return [
+            [Uuid::generateV4()->toString()],
+            ['550e8400-e29b-41d4-a716-446655440000'],
+            ['00000000-1111-2222-3333-444444444444']
+        ];
+    }
+}

tests/Unit/Application/Domain/Models/DispatchTest.php

@@ -28,8 +28,8 @@ public function testCalculateTheDispatchWithLowestCost(Weight $weight, Distance
         $actual = $dispatch->dispatchWithLowestCost(weight: $weight, distance: $distance, carriers: $carriers);
 
         /** @Then the value should be the same as expected */
-        self::assertEquals($expected->cost, $actual->shipment->cost);
-        self::assertEquals($expected->carrierName, $actual->shipment->carrierName);
+        self::assertEquals($expected->cost, $actual->shipment?->cost);
+        self::assertEquals($expected->carrierName, $actual->shipment?->carrierName);
         self::assertNotEmpty($actual->id->getValue());
     }
 

tests/Unit/Driven/Dispatch/OutboxEvent/EventRecordFactoryTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace CheapDelivery\Driven\Dispatch\OutboxEvent;
+
+use CheapDelivery\Driven\Dispatch\OutboxEvent\Mocks\RejectedDispatch;
+use LogicException;
+use PHPUnit\Framework\TestCase;
+
+class EventRecordFactoryTest extends TestCase
+{
+    public function testExceptionWhenUnsupportedEventType(): void
+    {
+        /** @Given I have an unmapped event */
+        $event = new RejectedDispatch();
+
+        /** @Then an exception indicating unsupported event type should be thrown */
+        $template = 'Event <%s> is not supported. Unable to create an EventRecord.';
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage(sprintf($template, $event::class));
+
+        /** @When I try to build an event record with this event */
+        EventRecordFactory::from(event: $event);
+    }
+}