Add FleetJourney component

ecs.php

@@ -3,7 +3,8 @@
 declare(strict_types=1);
 
 use PhpCsFixer\Fixer\Import\NoUnusedImportsFixer;
-use \PhpCsFixer\Fixer\Phpdoc\PhpdocInlineTagNormalizerFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocInlineTagNormalizerFixer;
+use PhpCsFixer\Fixer\Whitespace\TypeDeclarationSpacesFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
 
@@ -20,6 +21,7 @@
     $ecsConfig->rules([
         NoUnusedImportsFixer::class,
         PhpdocInlineTagNormalizerFixer::class,
+        TypeDeclarationSpacesFixer::class,
     ]);
 
     // this way you can add sets - group of rules

phpstan.dist.neon

@@ -7,3 +7,4 @@ parameters:
         - src/
         - spec/
         - tests/
+    treatPhpDocTypesAsCertain: false

spec/TheGame/Application/Component/BuildingConstruction/CommandHandler/CancelConstructingCommandHandlerSpec.php

@@ -14,7 +14,7 @@
 use TheGame\Application\Component\BuildingConstruction\Domain\Event\BuildingConstructionHasBeenCancelledEvent;
 use TheGame\Application\SharedKernel\Domain\BuildingType;
 use TheGame\Application\SharedKernel\Domain\PlanetId;
-use TheGame\Application\SharedKernel\Domain\ResourceRequirementsInterface;
+use TheGame\Application\SharedKernel\Domain\ResourcesInterface;
 use TheGame\Application\SharedKernel\EventBusInterface;
 use TheGame\Application\SharedKernel\Exception\InconsistentModelException;
 
@@ -53,7 +53,7 @@ public function it_cancels_constructing(
         BuildingContextInterface $buildingBalanceContext,
         EventBusInterface $eventBus,
         Building $building,
-        ResourceRequirementsInterface $resourceRequirements,
+        ResourcesInterface $resourceRequirements,
     ): void {
         $planetId = "1D632422-951F-4181-A48D-5AD654260B2B";
         $buildingId = "d6949ca7-157d-4019-9267-c7a61af33b01";

spec/TheGame/Application/Component/BuildingConstruction/CommandHandler/StartConstructingNewBuildingCommandHandlerSpec.php

@@ -20,7 +20,7 @@
 use TheGame\Application\SharedKernel\Domain\BuildingType;
 use TheGame\Application\SharedKernel\Domain\PlanetId;
 use TheGame\Application\SharedKernel\Domain\ResourceId;
-use TheGame\Application\SharedKernel\Domain\ResourceRequirementsInterface;
+use TheGame\Application\SharedKernel\Domain\ResourcesInterface;
 use TheGame\Application\SharedKernel\EventBusInterface;
 
 final class StartConstructingNewBuildingCommandHandlerSpec extends ObjectBehavior
@@ -47,7 +47,7 @@ public function it_creates_building_when_building_for_the_specified_type_is_not_
         Building $building,
         BuildingContextInterface $buildingBalanceContext,
         ResourceAvailabilityCheckerInterface $resourceAvailabilityChecker,
-        ResourceRequirementsInterface $resourceRequirements,
+        ResourcesInterface $resourceRequirements,
         EventBusInterface $eventBus,
     ): void {
         $planetId = "E7AF94C7-488C-46E4-8C44-DCD8F62B2A45";
@@ -101,7 +101,7 @@ public function it_throws_exception_when_storage_hasnt_enough_resources(
         Building $building,
         BuildingContextInterface $buildingBalanceContext,
         ResourceAvailabilityCheckerInterface $resourceAvailabilityChecker,
-        ResourceRequirementsInterface $resourceRequirements,
+        ResourcesInterface $resourceRequirements,
     ): void {
         $planetId = "E7AF94C7-488C-46E4-8C44-DCD8F62B2A45";
         $resourceContextId = "52B4E60C-5CCE-4483-968E-D23D9240A18A";

spec/TheGame/Application/Component/BuildingConstruction/CommandHandler/StartUpgradingBuildingCommandHandlerSpec.php

@@ -17,7 +17,7 @@
 use TheGame\Application\Component\ResourceStorage\Bridge\ResourceAvailabilityCheckerInterface;
 use TheGame\Application\SharedKernel\Domain\BuildingType;
 use TheGame\Application\SharedKernel\Domain\PlanetId;
-use TheGame\Application\SharedKernel\Domain\ResourceRequirementsInterface;
+use TheGame\Application\SharedKernel\Domain\ResourcesInterface;
 use TheGame\Application\SharedKernel\EventBusInterface;
 use TheGame\Application\SharedKernel\Exception\InconsistentModelException;
 
@@ -58,7 +58,7 @@ public function it_throws_exception_when_storage_hasnt_enough_resources(
         Building $building,
         BuildingContextInterface $buildingBalanceContext,
         ResourceAvailabilityCheckerInterface $resourceAvailabilityChecker,
-        ResourceRequirementsInterface $resourceRequirements,
+        ResourcesInterface $resourceRequirements,
     ): void {
         $planetId = "E7AF94C7-488C-46E4-8C44-DCD8F62B2A45";
         $buildingId = "52B4E60C-5CCE-4483-968E-D23D9240A18A";
@@ -89,7 +89,7 @@ public function it_starts_upgrading_the_building(
         Building $building,
         BuildingContextInterface $buildingBalanceContext,
         ResourceAvailabilityCheckerInterface $resourceAvailabilityChecker,
-        ResourceRequirementsInterface $resourceRequirements,
+        ResourcesInterface $resourceRequirements,
         EventBusInterface $eventBus,
     ): void {
         $planetId = "E7AF94C7-488C-46E4-8C44-DCD8F62B2A45";

spec/TheGame/Application/Component/FleetJourney/Command/CancelJourneyCommandSpec.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\TheGame\Application\Component\FleetJourney\Command;
+
+use PhpSpec\ObjectBehavior;
+
+final class CancelJourneyCommandSpec extends ObjectBehavior
+{
+    public function let(): void
+    {
+        $fleetId = "06d98267-6399-426f-be86-b79ea570046b";
+        $this->beConstructedWith($fleetId);
+    }
+
+    public function it_has_fleet_id(): void
+    {
+        $this->getFleetId()->shouldReturn("06d98267-6399-426f-be86-b79ea570046b");
+    }
+}

spec/TheGame/Application/Component/FleetJourney/Command/ReturnJourneysCommandSpec.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\TheGame\Application\Component\FleetJourney\Command;
+
+use PhpSpec\ObjectBehavior;
+
+final class ReturnJourneysCommandSpec extends ObjectBehavior
+{
+    public function let(): void
+    {
+        $userId = "0cfe1c65-2cac-4138-92bd-fac68027c39b";
+        $this->beConstructedWith($userId);
+    }
+
+    public function it_has_user_id(): void
+    {
+        $this->getUserId()->shouldReturn("0cfe1c65-2cac-4138-92bd-fac68027c39b");
+    }
+}

spec/TheGame/Application/Component/FleetJourney/Command/StartJourneyCommandSpec.php

@@ -0,0 +1,161 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\TheGame\Application\Component\FleetJourney\Command;
+
+use InvalidArgumentException;
+use PhpSpec\ObjectBehavior;
+
+final class StartJourneyCommandSpec extends ObjectBehavior
+{
+    public function let(): void
+    {
+        $planetId = "e5835dba-aef6-4b15-9d7c-cfb177959f6d";
+        $targetGalaxyPoint = "[1:2:3]";
+        $mission = "transport";
+        $shipsTakingJourney = [
+            "light-fighter" => 25,
+        ];
+        $resourcesLoad = [
+            "5966f38b-2add-43e7-884b-64cf6569666f" => 500,
+        ];
+
+        $this->beConstructedWith(
+            $planetId,
+            $targetGalaxyPoint,
+            $mission,
+            $shipsTakingJourney,
+            $resourcesLoad
+        );
+    }
+
+    public function it_has_planet_id(): void
+    {
+        $this->getPlanetId()->shouldReturn("e5835dba-aef6-4b15-9d7c-cfb177959f6d");
+    }
+
+    public function it_has_target_galaxy_point(): void
+    {
+        $this->getTargetGalaxyPoint()->shouldReturn("[1:2:3]");
+    }
+
+    public function it_has_mission_type(): void
+    {
+        $this->getMissionType()->shouldReturn("transport");
+    }
+
+    public function it_has_ships_taking_journey(): void
+    {
+        $this->getShipsTakingJourney()->shouldReturn([
+            "light-fighter" => 25,
+        ]);
+    }
+
+    public function it_throws_exception_when_initializing_with_ships_taking_journey_containing_invalid_array_key(): void
+    {
+        $planetId = "e5835dba-aef6-4b15-9d7c-cfb177959f6d";
+        $targetGalaxyPoint = "[1:2:3]";
+        $mission = "transport";
+        $shipsTakingJourney = [
+            500 => 25,
+        ];
+        $resourcesLoad = [
+            "5966f38b-2add-43e7-884b-64cf6569666f" => 500,
+        ];
+
+        $this->beConstructedWith(
+            $planetId,
+            $targetGalaxyPoint,
+            $mission,
+            $shipsTakingJourney,
+            $resourcesLoad
+        );
+
+        $this->shouldThrow(InvalidArgumentException::class)->during('__construct', [
+            $planetId, $targetGalaxyPoint, $mission, $shipsTakingJourney, $resourcesLoad,
+        ]);
+    }
+
+    public function it_throws_exception_when_initializing_with_ships_taking_journey_containing_invalid_array_value(): void
+    {
+        $planetId = "e5835dba-aef6-4b15-9d7c-cfb177959f6d";
+        $targetGalaxyPoint = "[1:2:3]";
+        $mission = "transport";
+        $shipsTakingJourney = [
+            "light-fighter" => 25,
+        ];
+        $resourcesLoad = [
+            "5966f38b-2add-43e7-884b-64cf6569666f" => "8bd4aaac-2d64-4b3e-be30-56be1096d9e9",
+        ];
+
+        $this->beConstructedWith(
+            $planetId,
+            $targetGalaxyPoint,
+            $mission,
+            $shipsTakingJourney,
+            $resourcesLoad
+        );
+
+        $this->shouldThrow(InvalidArgumentException::class)->during('__construct', [
+            $planetId, $targetGalaxyPoint, $mission, $shipsTakingJourney, $resourcesLoad,
+        ]);
+    }
+
+    public function it_has_resources_load(): void
+    {
+        $this->getResourcesLoad()->shouldReturn([
+            "5966f38b-2add-43e7-884b-64cf6569666f" => 500,
+        ]);
+    }
+
+    public function it_throws_exception_when_initializing_with_resources_load_containing_invalid_array_key(): void
+    {
+        $planetId = "e5835dba-aef6-4b15-9d7c-cfb177959f6d";
+        $targetGalaxyPoint = "[1:2:3]";
+        $mission = "transport";
+        $shipsTakingJourney = [
+            "light-fighter" => 25,
+        ];
+        $resourcesLoad = [
+            350 => 500,
+        ];
+
+        $this->beConstructedWith(
+            $planetId,
+            $targetGalaxyPoint,
+            $mission,
+            $shipsTakingJourney,
+            $resourcesLoad
+        );
+
+        $this->shouldThrow(InvalidArgumentException::class)->during('__construct', [
+            $planetId, $targetGalaxyPoint, $mission, $shipsTakingJourney, $resourcesLoad,
+        ]);
+    }
+
+    public function it_throws_exception_when_initializing_with_resources_load_containing_invalid_array_value(): void
+    {
+        $planetId = "e5835dba-aef6-4b15-9d7c-cfb177959f6d";
+        $targetGalaxyPoint = "[1:2:3]";
+        $mission = "transport";
+        $shipsTakingJourney = [
+            "light-fighter" => 25,
+        ];
+        $resourcesLoad = [
+            "5966f38b-2add-43e7-884b-64cf6569666f" => "1d9a563e-ed8a-4c5a-a918-903873f2adff",
+        ];
+
+        $this->beConstructedWith(
+            $planetId,
+            $targetGalaxyPoint,
+            $mission,
+            $shipsTakingJourney,
+            $resourcesLoad
+        );
+
+        $this->shouldThrow(InvalidArgumentException::class)->during('__construct', [
+            $planetId, $targetGalaxyPoint, $mission, $shipsTakingJourney, $resourcesLoad,
+        ]);
+    }
+}

spec/TheGame/Application/Component/FleetJourney/Command/TargetJourneysCommandSpec.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\TheGame\Application\Component\FleetJourney\Command;
+
+use PhpSpec\ObjectBehavior;
+
+final class TargetJourneysCommandSpec extends ObjectBehavior
+{
+    public function let(): void
+    {
+        $userId = "c20f9c5c-09eb-4eba-bf7a-899507264f6a";
+        $this->beConstructedWith($userId);
+    }
+
+    public function it_has_user_id(): void
+    {
+        $this->getUserId()->shouldReturn("c20f9c5c-09eb-4eba-bf7a-899507264f6a");
+    }
+}

spec/TheGame/Application/Component/FleetJourney/CommandHandler/CancelJourneyCommandHandlerSpec.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\TheGame\Application\Component\FleetJourney\CommandHandler;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use TheGame\Application\Component\FleetJourney\Command\CancelJourneyCommand;
+use TheGame\Application\Component\FleetJourney\Domain\Entity\Fleet;
+use TheGame\Application\Component\FleetJourney\Domain\Event\FleetHasCancelledJourneyEvent;
+use TheGame\Application\Component\FleetJourney\Domain\FleetId;
+use TheGame\Application\Component\FleetJourney\FleetRepositoryInterface;
+use TheGame\Application\SharedKernel\Domain\GalaxyPointInterface;
+use TheGame\Application\SharedKernel\EventBusInterface;
+use TheGame\Application\SharedKernel\Exception\InconsistentModelException;
+
+final class CancelJourneyCommandHandlerSpec extends ObjectBehavior
+{
+    public function let(
+        FleetRepositoryInterface $fleetRepository,
+        EventBusInterface $eventBus,
+    ): void {
+        $this->beConstructedWith($fleetRepository, $eventBus);
+    }
+
+    public function it_cancels_journey(
+        FleetRepositoryInterface $fleetRepository,
+        EventBusInterface $eventBus,
+        Fleet $fleet,
+        GalaxyPointInterface $fleetTargetPoint,
+    ): void {
+        $fleetId = "f164e51d-2398-44fb-9c9d-7744681de1fe";
+        $fleetRepository->find(new FleetId($fleetId))->willReturn($fleet);
+
+        $fleet->cancelJourney()->shouldBeCalledOnce();
+
+        $fleet->getJourneyTargetPoint()->willReturn($fleetTargetPoint);
+        $fleetTargetPoint->format()->willReturn("[1:2:3]");
+
+        $eventBus->dispatch(Argument::type(FleetHasCancelledJourneyEvent::class))
+            ->shouldBeCalledOnce();
+        $fleet->getResourcesLoad()->willReturn([
+            "3cacc092-af4a-45ca-846e-0c7060a60c43" => 500,
+        ]);
+
+        $this->__invoke(
+            new CancelJourneyCommand($fleetId),
+        );
+    }
+
+    public function it_throws_exception_when_fleet_has_not_been_found(
+        FleetRepositoryInterface $fleetRepository,
+    ): void {
+        $fleetId = "f164e51d-2398-44fb-9c9d-7744681de1fe";
+
+        $fleetRepository->find(new FleetId($fleetId))->willReturn(null);
+
+        $this->shouldThrow(InconsistentModelException::class)
+            ->during('__invoke', [
+                new CancelJourneyCommand($fleetId),
+            ]);
+    }
+}