From 2065340fc2868b2610fffb321a04b994609fbc32 Mon Sep 17 00:00:00 2001 From: K Muller Date: Wed, 23 Sep 2026 15:05:27 +0200 Subject: [PATCH] feat: :hammer: working on Stock and associated VO/Entities --- src/Domain/Models/Entities/Actor.php | 48 +++++++++++++++ src/Domain/Models/Entities/Stock.php | 61 +++++++++++++++++++ .../Models/ValueObjects/Actor/ActorId.php | 16 +++++ .../ValueObjects/Stock/StockAdjustment.php | 21 +++++++ .../Models/ValueObjects/Stock/StockAmount.php | 16 +++++ .../Models/ValueObjects/Stock/StockId.php | 16 +++++ .../Unit/Domain/Models/Entities/ActorTest.php | 53 ++++++++++++++++ .../Models/ValueObjects/Actor/ActorIdTest.php | 28 +++++++++ .../Stock/StockAdjustmentTest.php | 56 +++++++++++++++++ .../ValueObjects/Stock/StockAmountTest.php | 39 ++++++++++++ .../Models/ValueObjects/Stock/StockIdTest.php | 28 +++++++++ 11 files changed, 382 insertions(+) create mode 100644 src/Domain/Models/Entities/Actor.php create mode 100644 src/Domain/Models/Entities/Stock.php create mode 100644 src/Domain/Models/ValueObjects/Actor/ActorId.php create mode 100644 src/Domain/Models/ValueObjects/Stock/StockAdjustment.php create mode 100644 src/Domain/Models/ValueObjects/Stock/StockAmount.php create mode 100644 src/Domain/Models/ValueObjects/Stock/StockId.php create mode 100644 tests/Unit/Domain/Models/Entities/ActorTest.php create mode 100644 tests/Unit/Domain/Models/ValueObjects/Actor/ActorIdTest.php create mode 100644 tests/Unit/Domain/Models/ValueObjects/Stock/StockAdjustmentTest.php create mode 100644 tests/Unit/Domain/Models/ValueObjects/Stock/StockAmountTest.php create mode 100644 tests/Unit/Domain/Models/ValueObjects/Stock/StockIdTest.php diff --git a/src/Domain/Models/Entities/Actor.php b/src/Domain/Models/Entities/Actor.php new file mode 100644 index 0000000..d5f2ec8 --- /dev/null +++ b/src/Domain/Models/Entities/Actor.php @@ -0,0 +1,48 @@ + + */ +final readonly class Actor implements AggregateRoot, HasTimestampIdentifier +{ + private function __construct( + public ActorId $id, + public string $displayName, + public ?\DateTimeInterface $updatedAt = null, + ) {} + + public function id(): ActorId + { + return $this->id; + } + + public function createdAt(): \DateTimeInterface + { + return $this->id->toDateTime(); + } + + public function updatedAt(): ?\DateTimeInterface + { + return $this->updatedAt; + } + + public static function hydrate( + ActorId $id, + string $displayName, + ?\DateTimeInterface $updatedAt = null, + ): self { + return new self( + id: $id, + displayName: $displayName, + updatedAt: $updatedAt, + ); + } +} diff --git a/src/Domain/Models/Entities/Stock.php b/src/Domain/Models/Entities/Stock.php new file mode 100644 index 0000000..c289d20 --- /dev/null +++ b/src/Domain/Models/Entities/Stock.php @@ -0,0 +1,61 @@ + + */ +final readonly class Stock implements AggregateRoot, HasTimestampIdentifier +{ + private function __construct( + public StockId $id, + public StockAmount $stockAmount, + public StockAdjustment $stockAdjustment, + public CampaignCode $campaignCode, + public ProcessingCode $processingCode, + public ?\DateTimeInterface $updatedAt = null, + ) { + } + + public function id(): StockId + { + return $this->id; + } + + public function createdAt(): \DateTimeInterface + { + return $this->id->toDateTime(); + } + + public function updatedAt(): ?\DateTimeInterface + { + return $this->updatedAt; + } + + public static function hydrate( + StockId $id, + StockAmount $stockAmount, + StockAdjustment $stockAdjustment, + CampaignCode $campaignCode, + ProcessingCode $processingCode, + ?\DateTimeInterface $updatedAt = null, + ): self { + return new self( + id: $id, + stockAmount: $stockAmount, + stockAdjustment: $stockAdjustment, + campaignCode: $campaignCode, + processingCode: $processingCode, + updatedAt: $updatedAt, + ); + } +} diff --git a/src/Domain/Models/ValueObjects/Actor/ActorId.php b/src/Domain/Models/ValueObjects/Actor/ActorId.php new file mode 100644 index 0000000..48e6ee1 --- /dev/null +++ b/src/Domain/Models/ValueObjects/Actor/ActorId.php @@ -0,0 +1,16 @@ +quantity <= 0 ) { + throw new \DomainException('Stock Amount should be more than 0.'); + } + } +} diff --git a/src/Domain/Models/ValueObjects/Stock/StockAmount.php b/src/Domain/Models/ValueObjects/Stock/StockAmount.php new file mode 100644 index 0000000..3195bbd --- /dev/null +++ b/src/Domain/Models/ValueObjects/Stock/StockAmount.php @@ -0,0 +1,16 @@ +value < 0 ) { + throw new \DomainException('Stock Amount should be positive.'); + } + } +} diff --git a/src/Domain/Models/ValueObjects/Stock/StockId.php b/src/Domain/Models/ValueObjects/Stock/StockId.php new file mode 100644 index 0000000..000e873 --- /dev/null +++ b/src/Domain/Models/ValueObjects/Stock/StockId.php @@ -0,0 +1,16 @@ +id())->toBe($id) + ->and($actor->displayName)->toBe($displayName) + ->and($actor->updatedAt)->toBeNull() + ->and($actor->updatedAt())->toBeNull(); + }); + + it('hydrates an actor with an explicit updatedAt date', function (): void { + // GIVEN + $updatedAt = new \DateTimeImmutable('2026-06-15 12:00:00', new \DateTimeZone('UTC')); + + // WHEN + $actor = Actor::hydrate(ActorId::generate(), 'John Doe', $updatedAt); + + // THEN + expect($actor->updatedAt)->toBe($updatedAt) + ->and($actor->updatedAt())->toBe($updatedAt); + }); + + it('returns the creation date extracted from the id', function (): void { + // GIVEN + $expected = new \DateTimeImmutable('2024-06-15 12:34:56.789000', new \DateTimeZone('UTC')); + $id = new ActorId(Uuid::uuid7($expected)); + $actor = Actor::hydrate($id, 'John Doe'); + + // WHEN + $result = $actor->createdAt(); + + // THEN + expect($result->format('Y-m-d H:i:s.v'))->toBe($expected->format('Y-m-d H:i:s.v')); + }); +}); diff --git a/tests/Unit/Domain/Models/ValueObjects/Actor/ActorIdTest.php b/tests/Unit/Domain/Models/ValueObjects/Actor/ActorIdTest.php new file mode 100644 index 0000000..166ba24 --- /dev/null +++ b/tests/Unit/Domain/Models/ValueObjects/Actor/ActorIdTest.php @@ -0,0 +1,28 @@ +toBeInstanceOf(ActorId::class); + }); + + it('generates different ids on each call', function (): void { + // WHEN + $first = ActorId::generate(); + $second = ActorId::generate(); + + // THEN + expect((string) $first)->not->toBe((string) $second); + }); +}); diff --git a/tests/Unit/Domain/Models/ValueObjects/Stock/StockAdjustmentTest.php b/tests/Unit/Domain/Models/ValueObjects/Stock/StockAdjustmentTest.php new file mode 100644 index 0000000..30d60d7 --- /dev/null +++ b/tests/Unit/Domain/Models/ValueObjects/Stock/StockAdjustmentTest.php @@ -0,0 +1,56 @@ +toBeInstanceOf(StockAdjustment::class) + ->and($adjustment->quantity)->toBe($quantity) + ->and($adjustment->reason)->toBe($reason) + ->and($adjustment->actorId)->toBe($actorId) + ->and($adjustment->updatedAt)->toBeNull(); + }); + + it('creates a stock adjustment with an explicit updatedAt date', function (): void { + // GIVEN + $updatedAt = new \DateTimeImmutable('2026-06-15 12:00:00', new \DateTimeZone('UTC')); + + // WHEN + $adjustment = new StockAdjustment(10, 'Inventory correction', ActorId::generate(), $updatedAt); + + // THEN + expect($adjustment->updatedAt)->toBe($updatedAt); + }); + + it('rejects a quantity of zero', function (): void { + // WHEN + $action = fn (): StockAdjustment => new StockAdjustment(0, 'Inventory correction', ActorId::generate()); + + // THEN + expect($action)->toThrow(\DomainException::class, 'Stock Amount should be more than 0.'); + }); + + it('rejects a negative quantity', function (): void { + // WHEN + $action = fn (): StockAdjustment => new StockAdjustment(-5, 'Inventory correction', ActorId::generate()); + + // THEN + expect($action)->toThrow(\DomainException::class, 'Stock Amount should be more than 0.'); + }); +}); diff --git a/tests/Unit/Domain/Models/ValueObjects/Stock/StockAmountTest.php b/tests/Unit/Domain/Models/ValueObjects/Stock/StockAmountTest.php new file mode 100644 index 0000000..ae988fb --- /dev/null +++ b/tests/Unit/Domain/Models/ValueObjects/Stock/StockAmountTest.php @@ -0,0 +1,39 @@ +toBeInstanceOf(StockAmount::class) + ->and($amount->value)->toBe($value); + }); + + it('accepts a zero value', function (): void { + // WHEN + $amount = new StockAmount(0); + + // THEN + expect($amount->value)->toBe(0); + }); + + it('rejects a negative value', function (): void { + // WHEN + $action = fn (): StockAmount => new StockAmount(-1); + + // THEN + expect($action)->toThrow(\DomainException::class, 'Stock Amount should be positive.'); + }); +}); diff --git a/tests/Unit/Domain/Models/ValueObjects/Stock/StockIdTest.php b/tests/Unit/Domain/Models/ValueObjects/Stock/StockIdTest.php new file mode 100644 index 0000000..65e6c85 --- /dev/null +++ b/tests/Unit/Domain/Models/ValueObjects/Stock/StockIdTest.php @@ -0,0 +1,28 @@ +toBeInstanceOf(StockId::class); + }); + + it('generates different ids on each call', function (): void { + // WHEN + $first = StockId::generate(); + $second = StockId::generate(); + + // THEN + expect((string) $first)->not->toBe((string) $second); + }); +});