feat: ✨ create Campaign entity and associated VOs
This commit is contained in:
parent
c0801988fc
commit
9c5c3eaf64
10 changed files with 547 additions and 0 deletions
103
src/Domain/Models/Entities/Campaign.php
Normal file
103
src/Domain/Models/Entities/Campaign.php
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Domain\Models\Entities;
|
||||
use Domain\Enums\Country;
|
||||
use Domain\Models\Entities\Tag;
|
||||
use Domain\Models\ValueObjects\Brand\BrandCode;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignCode;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignCoupon;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignId;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignName;
|
||||
use Shared\DDD\Models\AggregateRoot;
|
||||
use Shared\DDD\Models\HasTimestampIdentifier;
|
||||
|
||||
/**
|
||||
* @implements \Shared\DDD\Models\AggregateRoot<\Domain\Models\ValueObjects\Campaign\CampaignId>
|
||||
*/
|
||||
final readonly class Campaign implements AggregateRoot, HasTimestampIdentifier
|
||||
{
|
||||
private function __construct(
|
||||
public CampaignId $id,
|
||||
public CampaignCode $code,
|
||||
public Tag $tag,
|
||||
public CampaignName $name,
|
||||
public bool $publication,
|
||||
public bool $printAllAtOnce,
|
||||
public Country $availableIn,
|
||||
/** @var CampaignCoupon[] */
|
||||
public array $coupons,
|
||||
public BrandCode $brand,
|
||||
public ?\DateTimeInterface $updatedAt = null,
|
||||
) {
|
||||
}
|
||||
|
||||
public function id(): CampaignId
|
||||
{
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
public function createdAt(): \DateTimeInterface
|
||||
{
|
||||
return $this->id->toDateTime();
|
||||
}
|
||||
|
||||
public function updatedAt(): ?\DateTimeInterface
|
||||
{
|
||||
return $this->updatedAt;
|
||||
}
|
||||
|
||||
public static function create(
|
||||
CampaignCode $code,
|
||||
Tag $tag,
|
||||
CampaignName $name,
|
||||
bool $publication,
|
||||
bool $printAllAtOnce,
|
||||
Country $availableIn,
|
||||
/** @var CampaignCoupon[] */
|
||||
array $coupons,
|
||||
BrandCode $brand,
|
||||
?\DateTimeInterface $updatedAt = null,
|
||||
): Campaign {
|
||||
return new self(
|
||||
id: CampaignId::generate(),
|
||||
code: $code,
|
||||
tag: $tag,
|
||||
name: $name,
|
||||
publication: $publication,
|
||||
printAllAtOnce: $printAllAtOnce,
|
||||
availableIn: $availableIn,
|
||||
coupons: $coupons,
|
||||
brand: $brand,
|
||||
updatedAt: $updatedAt,
|
||||
);
|
||||
}
|
||||
|
||||
public static function hydrate(
|
||||
CampaignId $id,
|
||||
CampaignCode $code,
|
||||
Tag $tag,
|
||||
CampaignName $name,
|
||||
bool $publication,
|
||||
bool $printAllAtOnce,
|
||||
Country $availableIn,
|
||||
/** @var CampaignCoupon[] */
|
||||
array $coupons,
|
||||
BrandCode $brand,
|
||||
?\DateTimeInterface $updatedAt = null,
|
||||
): self {
|
||||
return new self(
|
||||
id: $id,
|
||||
code: $code,
|
||||
tag: $tag,
|
||||
name: $name,
|
||||
publication: $publication,
|
||||
printAllAtOnce: $printAllAtOnce,
|
||||
availableIn: $availableIn,
|
||||
coupons: $coupons,
|
||||
brand: $brand,
|
||||
updatedAt: $updatedAt,
|
||||
);
|
||||
}
|
||||
}
|
||||
18
src/Domain/Models/ValueObjects/Campaign/CampaignCode.php
Normal file
18
src/Domain/Models/ValueObjects/Campaign/CampaignCode.php
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
final readonly class CampaignCode
|
||||
{
|
||||
public function __construct(
|
||||
public string $code,
|
||||
) {
|
||||
$trimmed = trim($code);
|
||||
|
||||
if ($trimmed === '') {
|
||||
throw new \DomainException('Campaign code cannot be empty.');
|
||||
}
|
||||
}
|
||||
}
|
||||
22
src/Domain/Models/ValueObjects/Campaign/CampaignCoupon.php
Normal file
22
src/Domain/Models/ValueObjects/Campaign/CampaignCoupon.php
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
use Domain\Models\ValueObjects\PrintRules;
|
||||
use Domain\Models\ValueObjects\ProcessingCode;
|
||||
|
||||
final readonly class CampaignCoupon
|
||||
{
|
||||
public function __construct(
|
||||
public ProcessingCode $code,
|
||||
public StockId $qty,
|
||||
public ?PrintRules $printRules,
|
||||
public int $warningThresholdQty
|
||||
) {
|
||||
if ($this->warningThresholdQty <= 0) {
|
||||
throw new \DomainException('Campaign Coupon warningThresholdQty must be positive.');
|
||||
}
|
||||
}
|
||||
}
|
||||
16
src/Domain/Models/ValueObjects/Campaign/CampaignId.php
Normal file
16
src/Domain/Models/ValueObjects/Campaign/CampaignId.php
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
use Ramsey\Uuid\Uuid;
|
||||
use Shared\DDD\Models\Uuidv7EntityId;
|
||||
|
||||
final readonly class CampaignId extends Uuidv7EntityId
|
||||
{
|
||||
public static function generate(): self
|
||||
{
|
||||
return new self(Uuid::uuid7());
|
||||
}
|
||||
}
|
||||
18
src/Domain/Models/ValueObjects/Campaign/CampaignName.php
Normal file
18
src/Domain/Models/ValueObjects/Campaign/CampaignName.php
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
final readonly class CampaignName
|
||||
{
|
||||
public function __construct(
|
||||
public string $value,
|
||||
) {
|
||||
$trimmed = trim($value);
|
||||
|
||||
if ($trimmed === '') {
|
||||
throw new \DomainException('Campaign name cannot be empty.');
|
||||
}
|
||||
}
|
||||
}
|
||||
216
tests/Unit/Domain/Models/Entities/CampaignTest.php
Normal file
216
tests/Unit/Domain/Models/Entities/CampaignTest.php
Normal file
|
|
@ -0,0 +1,216 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests\Unit\Domain\Models\Entities;
|
||||
|
||||
use Carbon\CarbonImmutable;
|
||||
use Domain\Enums\BarcodeFormat;
|
||||
use Domain\Enums\Country;
|
||||
use Domain\Models\Entities\Campaign;
|
||||
use Domain\Models\Entities\Tag;
|
||||
use Domain\Models\ValueObjects\Brand\BrandCode;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignCode;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignCoupon;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignId;
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignName;
|
||||
use Domain\Models\ValueObjects\Coupon\CouponAvailabilityCalendar;
|
||||
use Domain\Models\ValueObjects\Coupon\CouponDiffusion;
|
||||
use Domain\Models\ValueObjects\Coupon\CouponId;
|
||||
use Domain\Models\ValueObjects\Coupon\CouponLegalInformation;
|
||||
use Domain\Models\ValueObjects\Coupon\CouponProduct;
|
||||
use Domain\Models\ValueObjects\Coupon\CouponValidity;
|
||||
use Domain\Models\ValueObjects\CouponName;
|
||||
use Domain\Models\ValueObjects\CouponPicture;
|
||||
use Domain\Models\ValueObjects\CouponProductName;
|
||||
use Domain\Models\ValueObjects\GS1;
|
||||
use Domain\Models\ValueObjects\MoneyAmount;
|
||||
use Domain\Models\ValueObjects\PicturePath;
|
||||
use Domain\Models\ValueObjects\PrintRules;
|
||||
use Domain\Models\ValueObjects\ProcessingCode;
|
||||
use Domain\Models\ValueObjects\Tag\TagId;
|
||||
use Domain\Models\ValueObjects\Tag\TagName;
|
||||
use Ramsey\Uuid\Uuid;
|
||||
use Shared\Enums\Currency;
|
||||
use Shared\ValueObjects\DateTime;
|
||||
use Shared\ValueObjects\Money;
|
||||
|
||||
covers(Campaign::class);
|
||||
|
||||
describe('campaign', function (): void {
|
||||
beforeEach(function (): void {
|
||||
$this->tag = Tag::hydrate(
|
||||
TagId::generate(),
|
||||
new TagName('Tag A'),
|
||||
);
|
||||
});
|
||||
|
||||
afterEach(function (): void {
|
||||
CarbonImmutable::setTestNow();
|
||||
});
|
||||
|
||||
it('creates a campaign', function (): void {
|
||||
// GIVEN
|
||||
$id = CampaignId::generate();
|
||||
$code = new CampaignCode('Camp100');
|
||||
$name = new CampaignName('Name');
|
||||
$publication = \boolval(0);
|
||||
$printAllAtOnce = \boolval(1);
|
||||
$availableIn = Country::FR;
|
||||
$coupons = [new CampaignCoupon(new ProcessingCode('PC1'), new StockId(1), new PrintRules(maxPerCustomer: 3), 100)];
|
||||
$brand = new BrandCode('AAA01');
|
||||
|
||||
// WHEN
|
||||
$campaign = Campaign::hydrate(
|
||||
$id,
|
||||
$code,
|
||||
$this->tag,
|
||||
$name,
|
||||
$publication,
|
||||
$printAllAtOnce,
|
||||
$availableIn,
|
||||
$coupons,
|
||||
$brand,
|
||||
);
|
||||
|
||||
// THEN
|
||||
expect($campaign->id())->toBe($id)
|
||||
->and($campaign->code)->toBe($code)
|
||||
->and($campaign->tag)->toBe($this->tag)
|
||||
->and($campaign->name)->toBe($name)
|
||||
->and($campaign->publication)->toBe($publication)
|
||||
->and($campaign->printAllAtOnce)->toBe($printAllAtOnce)
|
||||
->and($campaign->availableIn)->toBe($availableIn)
|
||||
->and($campaign->coupons)->toBe($coupons)
|
||||
->and($campaign->brand)->toBe($brand)
|
||||
->and($campaign->updatedAt)->toBeNull()
|
||||
->and($campaign->updatedAt())->toBeNull();
|
||||
});
|
||||
|
||||
it('creates a coupon with an explicit updatedAt date', function (): void {
|
||||
// GIVEN
|
||||
$id = CampaignId::generate();
|
||||
$code = new CampaignCode('Camp100');
|
||||
$name = new CampaignName('Name');
|
||||
$publication = \boolval(0);
|
||||
$printAllAtOnce = \boolval(1);
|
||||
$availableIn = Country::FR;
|
||||
$coupons = [new CampaignCoupon(new ProcessingCode('PC1'), new StockId(1), new PrintRules(maxPerCustomer: 3), 100)];
|
||||
$brand = new BrandCode('AAA01');
|
||||
$updatedAt = new \DateTimeImmutable('2026-09-22 10:00:00', new \DateTimeZone('UTC'));
|
||||
|
||||
// WHEN
|
||||
$campaign = Campaign::hydrate(
|
||||
$id,
|
||||
$code,
|
||||
$this->tag,
|
||||
$name,
|
||||
$publication,
|
||||
$printAllAtOnce,
|
||||
$availableIn,
|
||||
$coupons,
|
||||
$brand,
|
||||
$updatedAt
|
||||
);
|
||||
|
||||
// THEN
|
||||
expect($campaign->updatedAt)->toBe($updatedAt)
|
||||
->and($campaign->updatedAt())->toBe($updatedAt);
|
||||
});
|
||||
|
||||
it('creates a new campaign with a freshly generated id', function (): void {
|
||||
// GIVEN
|
||||
$code = new CampaignCode('Camp100');
|
||||
$name = new CampaignName('Name');
|
||||
$publication = \boolval(0);
|
||||
$printAllAtOnce = \boolval(1);
|
||||
$availableIn = Country::FR;
|
||||
$coupons = [new CampaignCoupon(new ProcessingCode('PC1'), new StockId(1), new PrintRules(maxPerCustomer: 3), 100)];
|
||||
$brand = new BrandCode('AAA01');
|
||||
|
||||
// WHEN
|
||||
$campaign = Campaign::create(
|
||||
$code,
|
||||
$this->tag,
|
||||
$name,
|
||||
$publication,
|
||||
$printAllAtOnce,
|
||||
$availableIn,
|
||||
$coupons,
|
||||
$brand
|
||||
);
|
||||
|
||||
// THEN
|
||||
expect($campaign->id())->toBeInstanceOf(CampaignId::class)
|
||||
->and($campaign->code)->toBe($code)
|
||||
->and($campaign->tag)->toBe($this->tag)
|
||||
->and($campaign->name)->toBe($name)
|
||||
->and($campaign->publication)->toBe($publication)
|
||||
->and($campaign->printAllAtOnce)->toBe($printAllAtOnce)
|
||||
->and($campaign->availableIn)->toBe($availableIn)
|
||||
->and($campaign->coupons)->toBe($coupons)
|
||||
->and($campaign->brand)->toBe($brand)
|
||||
->and($campaign->updatedAt)->toBeNull()
|
||||
->and($campaign->updatedAt())->toBeNull();
|
||||
});
|
||||
|
||||
it('generates a different id for each created campaign', function (): void {
|
||||
// GIVEN
|
||||
$code = new CampaignCode('Camp100');
|
||||
$name = new CampaignName('Name');
|
||||
$publication = \boolval(0);
|
||||
$printAllAtOnce = \boolval(1);
|
||||
$availableIn = Country::FR;
|
||||
$coupons = [new CampaignCoupon(new ProcessingCode('PC1'), new StockId(1), new PrintRules(maxPerCustomer: 3), 100)];
|
||||
$brand = new BrandCode('AAA01');
|
||||
|
||||
// WHEN
|
||||
$firstCampaign = Campaign::create(
|
||||
$code,
|
||||
$this->tag,
|
||||
$name,
|
||||
$publication,
|
||||
$printAllAtOnce,
|
||||
$availableIn,
|
||||
$coupons,
|
||||
$brand
|
||||
);
|
||||
$secondCampaign = Campaign::create(
|
||||
$code,
|
||||
$this->tag,
|
||||
$name,
|
||||
$publication,
|
||||
$printAllAtOnce,
|
||||
$availableIn,
|
||||
$coupons,
|
||||
$brand
|
||||
);
|
||||
|
||||
// THEN
|
||||
expect($firstCampaign->id()->equals($secondCampaign->id()))->toBeFalse();
|
||||
});
|
||||
|
||||
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 CampaignId(Uuid::uuid7($expected));
|
||||
$campaign = Campaign::hydrate(
|
||||
$id,
|
||||
new CampaignCode('Camp100'),
|
||||
$this->tag,
|
||||
new CampaignName('Name'),
|
||||
\boolval(0),
|
||||
\boolval(1),
|
||||
Country::FR,
|
||||
new GS1('110101010', BarcodeFormat::EAN13),
|
||||
[new CampaignCoupon(new ProcessingCode('PC1'), new StockId(1), new PrintRules(maxPerCustomer: 3), 100)],
|
||||
new BrandCode('AAA01')
|
||||
);
|
||||
|
||||
// WHEN
|
||||
$result = $campaign->createdAt();
|
||||
|
||||
// THEN
|
||||
expect($result->format('Y-m-d H:i:s.v'))->toBe($expected->format('Y-m-d H:i:s.v'));
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests\Unit\Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignCode;
|
||||
|
||||
covers(CampaignCode::class);
|
||||
|
||||
describe('campaign code', function (): void {
|
||||
it('creates a valid campaign code', function (): void {
|
||||
// GIVEN
|
||||
$code = 'Name';
|
||||
|
||||
// WHEN
|
||||
$name = new CampaignCode($code);
|
||||
|
||||
// THEN
|
||||
expect($name->code)->toBe($code);
|
||||
});
|
||||
|
||||
it('rejects invalid campaign code', function (): void {
|
||||
// GIVEN
|
||||
$code = '';
|
||||
|
||||
// GIVEN / THEN
|
||||
expect(fn (): CampaignCode => new CampaignCode($code))->toThrow(\DomainException::class);
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests\Unit\Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignCoupon;
|
||||
use Domain\Models\ValueObjects\PrintRules;
|
||||
use Domain\Models\ValueObjects\ProcessingCode;
|
||||
|
||||
covers(CampaignCoupon::class);
|
||||
|
||||
describe('campaign coupon', function (): void {
|
||||
it('creates a valid campaign coupon', function (): void {
|
||||
// GIVEN
|
||||
$code = new ProcessingCode('PC1');
|
||||
$qty = new StockId();
|
||||
$printRules = new PrintRules(maxPerCustomer: 3);
|
||||
$warningThresholdQty = 100;
|
||||
|
||||
// WHEN
|
||||
$campaignCoupon = new CampaignCoupon(code: $code, qty: $qty, printRules: $printRules, warningThresholdQty: $warningThresholdQty);
|
||||
|
||||
// THEN
|
||||
expect($campaignCoupon->code)->toBe($code)
|
||||
->and($campaignCoupon->qty)->toBe($qty)
|
||||
->and($campaignCoupon->printRules)->toBe($printRules)
|
||||
->and($campaignCoupon->warningThresholdQty)->toBe($warningThresholdQty);
|
||||
});
|
||||
|
||||
it('creates a valid campaign coupon whitout print rules', function (): void {
|
||||
// GIVEN
|
||||
$code = new ProcessingCode('PC1');
|
||||
$qty = new StockId();
|
||||
$warningThresholdQty = 100;
|
||||
|
||||
// WHEN
|
||||
$campaignCoupon = new CampaignCoupon(code: $code, qty: $qty, warningThresholdQty: $warningThresholdQty);
|
||||
|
||||
// THEN
|
||||
expect($campaignCoupon->code)->toBe($code)
|
||||
->and($campaignCoupon->qty)->toBe($qty)
|
||||
->and($campaignCoupon->warningThresholdQty)->toBe($warningThresholdQty);
|
||||
});
|
||||
|
||||
it('rejects invalid campaign coupon', function (): void {
|
||||
// GIVEN
|
||||
$code = new ProcessingCode('PC1');
|
||||
$qty = new StockId();
|
||||
$printRules = new PrintRules(maxPerCustomer: 3);
|
||||
$warningThresholdQty = -100;
|
||||
|
||||
// GIVEN / THEN
|
||||
expect(fn (): CampaignCoupon => new CampaignCoupon(code: $code, qty: $qty, printRules: $printRules, warningThresholdQty: $warningThresholdQty))->toThrow(\DomainException::class);
|
||||
});
|
||||
|
||||
it('rejects invalid campaign coupon whitout print rules', function (): void {
|
||||
// GIVEN
|
||||
$code = new ProcessingCode('PC1');
|
||||
$qty = new StockId();
|
||||
$warningThresholdQty = -100;
|
||||
|
||||
// GIVEN / THEN
|
||||
expect(fn (): CampaignCoupon => new CampaignCoupon(code: $code, qty: $qty, warningThresholdQty: $warningThresholdQty))->toThrow(\DomainException::class);
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests\Unit\Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignId;
|
||||
|
||||
covers(CampaignId::class);
|
||||
|
||||
describe('campaign', function (): void {
|
||||
it('generates a unique campaign id', function (): void {
|
||||
// WHEN
|
||||
$id = CampaignId::generate();
|
||||
|
||||
// THEN
|
||||
expect($id)->toBeInstanceOf(CampaignId::class);
|
||||
});
|
||||
|
||||
it('generates different ids on each call', function (): void {
|
||||
// WHEN
|
||||
$first = CampaignId::generate();
|
||||
$second = CampaignId::generate();
|
||||
|
||||
// THEN
|
||||
expect((string) $first)->not->toBe((string) $second);
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests\Unit\Domain\Models\ValueObjects\Campaign;
|
||||
|
||||
use Domain\Models\ValueObjects\Campaign\CampaignName;
|
||||
|
||||
covers(CampaignName::class);
|
||||
|
||||
describe('campaign name', function (): void {
|
||||
it('creates a valid campaign name', function (): void {
|
||||
// GIVEN
|
||||
$value = 'Name';
|
||||
|
||||
// WHEN
|
||||
$name = new CampaignName($value);
|
||||
|
||||
// THEN
|
||||
expect($name->value)->toBe($value);
|
||||
});
|
||||
|
||||
it('rejects invalid campaign name', function (): void {
|
||||
// GIVEN
|
||||
$value = '';
|
||||
|
||||
// GIVEN / THEN
|
||||
expect(fn (): CampaignName => new CampaignName($value))->toThrow(\DomainException::class);
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Reference in a new issue