From 689368109bbb40ff42e80a0acee732515162360c Mon Sep 17 00:00:00 2001 From: Noah Lancien Date: Tue, 27 Oct 2026 14:51:43 +0100 Subject: [PATCH] fix: US2.2 - Review feedbacks - Remove useless tests, rename UpdateCampaign, rewrite failed outputs, rewrite auto unpublish, move campaign availability checker --- .../Campaign/Update/AutoUnpublishCampaign.php | 56 ++++++ .../Update/AutoUnpublishCampaignInput.php | 16 ++ ...nUpdated.php => CampaignStatusUpdated.php} | 2 +- .../Outputs/CampaignUnpublicationSkipped.php | 11 ++ .../Update/Outputs/CampaignUpdateFailed.php | 15 -- .../Outputs/NotEnoughCouponAvailable.php | 11 ++ .../Update/Outputs/UpdateCampaignError.php | 11 -- ...UpdateCampaign.php => PublishCampaign.php} | 29 ++- src/Domain/Models/Entities/Campaign.php | 31 +--- src/Domain/Models/Entities/Coupon.php | 11 ++ .../Campaign/CampaignCouponArray.php | 2 + .../Campaign/CampaignAvailabilityChecker.php | 24 +++ tests/Fixtures/Campaign/CampaignFactory.php | 103 +++++++++++ tests/Fixtures/Coupon/CouponFactory.php | 96 ++++++++++ .../Update/AutoUnpublishCampaignTest.php | 166 ++++++++++++++++++ ...mpaignTest.php => PublishCampaignTest.php} | 141 ++++++++------- .../Domain/Models/Entities/CampaignTest.php | 119 ++----------- .../CampaignAvailabilityCheckerTest.php | 87 +++++++++ 18 files changed, 698 insertions(+), 233 deletions(-) create mode 100644 src/Application/UseCases/Campaign/Update/AutoUnpublishCampaign.php create mode 100644 src/Application/UseCases/Campaign/Update/AutoUnpublishCampaignInput.php rename src/Application/UseCases/Campaign/Update/Outputs/{CampaignUpdated.php => CampaignStatusUpdated.php} (91%) create mode 100644 src/Application/UseCases/Campaign/Update/Outputs/CampaignUnpublicationSkipped.php delete mode 100644 src/Application/UseCases/Campaign/Update/Outputs/CampaignUpdateFailed.php create mode 100644 src/Application/UseCases/Campaign/Update/Outputs/NotEnoughCouponAvailable.php delete mode 100644 src/Application/UseCases/Campaign/Update/Outputs/UpdateCampaignError.php rename src/Application/UseCases/Campaign/Update/{UpdateCampaign.php => PublishCampaign.php} (58%) create mode 100644 src/Domain/Services/Campaign/CampaignAvailabilityChecker.php create mode 100644 tests/Fixtures/Campaign/CampaignFactory.php create mode 100644 tests/Fixtures/Coupon/CouponFactory.php create mode 100644 tests/Unit/Application/UseCases/Campaign/Update/AutoUnpublishCampaignTest.php rename tests/Unit/Application/UseCases/Campaign/Update/{UpdateCampaignTest.php => PublishCampaignTest.php} (57%) create mode 100644 tests/Unit/Domain/Services/CampaignAvailabilityCheckerTest.php diff --git a/src/Application/UseCases/Campaign/Update/AutoUnpublishCampaign.php b/src/Application/UseCases/Campaign/Update/AutoUnpublishCampaign.php new file mode 100644 index 0000000..3dea0fd --- /dev/null +++ b/src/Application/UseCases/Campaign/Update/AutoUnpublishCampaign.php @@ -0,0 +1,56 @@ + */ +final readonly class AutoUnpublishCampaign implements UseCase, Transactional +{ + public function __construct( + private CampaignRepository $repository, + private CampaignAvailabilityChecker $availabilityChecker + ) { + } + + #[\Override] + public function execute(BaseInput $input): Output + { + Assert::isInstanceOf($input, AutoUnpublishCampaignInput::class); + + $campaign = $this->repository->findByCode($input->code); + + if (! $campaign instanceof Campaign) { + return new CampaignNotFound(); + } + + if (! $campaign->publication || $this->availabilityChecker->hasActiveCoupon($campaign)) { + return new CampaignUnpublicationSkipped(); + } + + $campaign = $campaign->unpublish(); + $this->repository->save($campaign); + + return new CampaignStatusUpdated( + name: $campaign->name, + code: $campaign->code, + publication: $campaign->publication, + printAllAtOnce: $campaign->printAllAtOnce, + coupons: $campaign->coupons, + brandCode: $campaign->brandCode, + actorId: $campaign->actorId + ); + } +} diff --git a/src/Application/UseCases/Campaign/Update/AutoUnpublishCampaignInput.php b/src/Application/UseCases/Campaign/Update/AutoUnpublishCampaignInput.php new file mode 100644 index 0000000..236fc76 --- /dev/null +++ b/src/Application/UseCases/Campaign/Update/AutoUnpublishCampaignInput.php @@ -0,0 +1,16 @@ + */ -final readonly class UpdateCampaign implements UseCase, Transactional +final readonly class PublishCampaign implements UseCase, Transactional { public function __construct( private CampaignRepository $repository, - private CouponRepository $couponRepository + private CampaignAvailabilityChecker $availabilityChecker ) { } @@ -37,21 +36,19 @@ final readonly class UpdateCampaign implements UseCase, Transactional return new CampaignNotFound(); } - if ($campaign->publication && $input->publication) { - return new CampaignUpdateFailed(UpdateCampaignError::CampaignAlreadyPublished); - } + if ($input->publication) { + if (! $this->availabilityChecker->hasActiveCoupon($campaign)) { + return new NotEnoughCouponAvailable(); + } - if (! $campaign->publication && ! $input->publication) { - return new CampaignUpdateFailed(UpdateCampaignError::CampaignAlreadyUnpublished); + $campaign = $campaign->publish(); + } else { + $campaign = $campaign->unpublish(); } - $campaign = $input->publication ? - $campaign->publish($this->couponRepository->findByCodes($campaign->coupons->getCouponCodes())) : - $campaign->unpublish(); - $this->repository->save($campaign); - return new CampaignUpdated( + return new CampaignStatusUpdated( name: $campaign->name, code: $campaign->code, publication: $campaign->publication, diff --git a/src/Domain/Models/Entities/Campaign.php b/src/Domain/Models/Entities/Campaign.php index 0b8a06e..9d3e464 100644 --- a/src/Domain/Models/Entities/Campaign.php +++ b/src/Domain/Models/Entities/Campaign.php @@ -10,6 +10,7 @@ use Domain\Models\ValueObjects\Campaign\CampaignCode; use Domain\Models\ValueObjects\Campaign\CampaignCouponArray; use Domain\Models\ValueObjects\Campaign\CampaignId; use Domain\Models\ValueObjects\Campaign\CampaignName; +use Domain\Models\ValueObjects\Coupon\CouponCode; use Shared\DDD\Models\AggregateRoot; use Shared\DDD\Models\HasTimestampIdentifier; use Shared\Helpers\DatesHelper; @@ -89,35 +90,13 @@ final readonly class Campaign implements AggregateRoot, HasTimestampIdentifier ); } - /** @param array $coupons Coupons available in the Campaign (with CampaignCoupon) */ - public function publish(array $coupons): self + public function publish(): self { - if ($this->publication) { - throw new \DomainException('Campaign is already published.'); - } - - $hasAvailableCoupon = true; - foreach ($coupons as $coupon) { - try { - $coupon->getActivePeriod(); - } catch (\DomainException) { - $hasAvailableCoupon = false; - } - } - - if (! $hasAvailableCoupon) { - throw new \DomainException('At least 1 available coupon should be provided to activate a campaign.'); - } - return $this->changePublication(true); } public function unpublish(): self { - if (! $this->publication) { - throw new \DomainException('Campaign is already unpublished.'); - } - return $this->changePublication(false); } @@ -154,4 +133,10 @@ final readonly class Campaign implements AggregateRoot, HasTimestampIdentifier return $this; } + + /** @return array */ + public function couponCodes(): array + { + return $this->coupons->getCouponCodes(); + } } diff --git a/src/Domain/Models/Entities/Coupon.php b/src/Domain/Models/Entities/Coupon.php index ca23ff2..c4181a8 100644 --- a/src/Domain/Models/Entities/Coupon.php +++ b/src/Domain/Models/Entities/Coupon.php @@ -215,4 +215,15 @@ final readonly class Coupon implements AggregateRoot, HasTimestampIdentifier } } } + + public function isActive(): bool + { + try { + $this->getActivePeriod(); + + return true; + } catch (\DomainException) { + return false; + } + } } diff --git a/src/Domain/Models/ValueObjects/Campaign/CampaignCouponArray.php b/src/Domain/Models/ValueObjects/Campaign/CampaignCouponArray.php index a7627cf..4e633e5 100644 --- a/src/Domain/Models/ValueObjects/Campaign/CampaignCouponArray.php +++ b/src/Domain/Models/ValueObjects/Campaign/CampaignCouponArray.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Domain\Models\ValueObjects\Campaign; +use Domain\Models\ValueObjects\Coupon\CouponCode; + final readonly class CampaignCouponArray { public function __construct( diff --git a/src/Domain/Services/Campaign/CampaignAvailabilityChecker.php b/src/Domain/Services/Campaign/CampaignAvailabilityChecker.php new file mode 100644 index 0000000..4e77c2f --- /dev/null +++ b/src/Domain/Services/Campaign/CampaignAvailabilityChecker.php @@ -0,0 +1,24 @@ +couponRepository->findByCodes($campaign->couponCodes()), + static fn (Coupon $coupon): bool => $coupon->isActive(), + ); + } +} diff --git a/tests/Fixtures/Campaign/CampaignFactory.php b/tests/Fixtures/Campaign/CampaignFactory.php new file mode 100644 index 0000000..b9f4800 --- /dev/null +++ b/tests/Fixtures/Campaign/CampaignFactory.php @@ -0,0 +1,103 @@ +|null $couponCodes ignoré si $coupons est fourni + * @param list|null $coupons prioritaire sur $couponCodes + */ + public static function make( + string $name = 'Campaign name', + bool $printAllAtOnce = false, + ?array $couponCodes = null, + ?array $coupons = null, + ?PrintRules $printRules = null, + string $brandCode = 'AAA01', + ?ActorId $actorId = null, + ): Campaign { + return Campaign::create( + name: new CampaignName($name), + printAllAtOnce: $printAllAtOnce, + coupons: self::coupons($coupons, $couponCodes, $printRules), + brandCode: new BrandCode($brandCode), + actorId: $actorId ?? ActorId::generate(), + ); + } + + /** + * Campagne reconstruite comme depuis la base : permet de fixer id, code et updatedAt. + * Nécessite que hydrate() accepte $updatedAt en dernier paramètre. + * + * @param list|null $couponCodes + * @param list|null $coupons + */ + public static function hydrated( + ?CampaignId $id = null, + ?CampaignCode $code = null, + bool $published = true, + string $name = 'Campaign name', + bool $printAllAtOnce = false, + ?array $couponCodes = null, + ?array $coupons = null, + ?PrintRules $printRules = null, + string $brandCode = 'AAA01', + ?ActorId $actorId = null, + ): Campaign { + return Campaign::hydrate( + id: $id ?? CampaignId::generate(), + code: $code ?? CampaignCode::generate(), + name: new CampaignName($name), + publication: $published, + printAllAtOnce: $printAllAtOnce, + coupons: self::coupons($coupons, $couponCodes, $printRules), + brandCode: new BrandCode($brandCode), + actorId: $actorId ?? ActorId::generate(), + ); + } + + public static function published(string ...$couponCodes): Campaign + { + return self::hydrated(published: true, couponCodes: $couponCodes ?: null); + } + + public static function unpublished(string ...$couponCodes): Campaign + { + return self::hydrated(published: false, couponCodes: $couponCodes ?: null); + } + + /** + * @param list|null $coupons + * @param list|null $couponCodes + */ + private static function coupons(?array $coupons, ?array $couponCodes, ?PrintRules $printRules): CampaignCouponArray + { + if ($coupons !== null) { + return new CampaignCouponArray($coupons); + } + + return new CampaignCouponArray(array_map( + static fn (string | CouponCode $code): CampaignCoupon => new CampaignCoupon( + $code instanceof CouponCode ? $code : new CouponCode($code), + $printRules, + ), + $couponCodes ?? ['COU01'], + )); + } +} diff --git a/tests/Fixtures/Coupon/CouponFactory.php b/tests/Fixtures/Coupon/CouponFactory.php new file mode 100644 index 0000000..d2c8560 --- /dev/null +++ b/tests/Fixtures/Coupon/CouponFactory.php @@ -0,0 +1,96 @@ +modify('-1 month'), + end: $diffusionEnd ?? new \DateTime()->modify('+1 month'), + ), + ), + validityInformations: new CouponValidityInformationArray([ + new CouponValidityInformation('Lorem ipsum dolor sit amet consectetur adipiscing elit.', Country::FRANCE), + new CouponValidityInformation('Lorem ipsum dolor sit amet consectetur adipiscing elit.', Country::BENELUX) + ]), + legalInformations: new CouponLegalInformationArray([ + new CouponLegalInformation('Lorem ipsum dolor sit amet consectetur adipiscing elit.', Country::FRANCE), + new CouponLegalInformation('Lorem ipsum dolor sit amet consectetur adipiscing elit.', Country::BENELUX) + ]), + processingCode: new ProcessingCodeArray([ + new ProcessingCode('5425003944130', Country::FRANCE), + new ProcessingCode('4006381333931', Country::BENELUX), + ]), + brandCode: new BrandCode($brandCode), + createdBy: ActorId::generate(), + products: new CouponProductArray([new IncoCode(35784), new IncoCode(15522)]), + movements: new CouponMovementArray([new CouponMovement(1000)]), + availabilityCalendar: $availabilityCalendar, + ); + } + + /** Coupon dont la diffusion est terminée. */ + public static function expired(string | CouponCode $code = 'COU01'): Coupon + { + return self::make( + code: $code, + diffusionStart: new \DateTime()->modify('-2 months'), + diffusionEnd: new \DateTime()->modify('-1 day'), + ); + } + + /** Coupon dont la diffusion n'a pas commencé. */ + public static function upcoming(string | CouponCode $code = 'COU01'): Coupon + { + return self::make( + code: $code, + diffusionStart: new \DateTime()->modify('+1 day'), + diffusionEnd: new \DateTime()->modify('+2 months'), + ); + } +} diff --git a/tests/Unit/Application/UseCases/Campaign/Update/AutoUnpublishCampaignTest.php b/tests/Unit/Application/UseCases/Campaign/Update/AutoUnpublishCampaignTest.php new file mode 100644 index 0000000..9f34170 --- /dev/null +++ b/tests/Unit/Application/UseCases/Campaign/Update/AutoUnpublishCampaignTest.php @@ -0,0 +1,166 @@ +shouldReceive('findByCode')->once()->with($code)->andReturn(null); + $repository->shouldNotReceive('save'); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldNotReceive('findByCodes'); + + $useCase = new AutoUnpublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute(new AutoUnpublishCampaignInput($code)); + + // THEN + expect($result)->toBeInstanceOf(CampaignNotFound::class); + }); + + it('skips an already unpublished campaign without querying coupons', function (): void { + // GIVEN + $campaign = CampaignFactory::hydrated(published: false); + + $repository = \Mockery::mock(CampaignRepository::class); + $repository->shouldReceive('findByCode')->once()->with($campaign->code)->andReturn($campaign); + $repository->shouldNotReceive('save'); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldNotReceive('findByCodes'); + + $useCase = new AutoUnpublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute(new AutoUnpublishCampaignInput($campaign->code)); + + // THEN + expect($result)->toBeInstanceOf(CampaignUnpublicationSkipped::class); + }); + + it('skips a published campaign that still has an active coupon', function (): void { + // GIVEN + $campaign = CampaignFactory::hydrated(published: true, couponCodes: ['COU01']); + + $repository = \Mockery::mock(CampaignRepository::class); + $repository->shouldReceive('findByCode')->once()->with($campaign->code)->andReturn($campaign); + $repository->shouldNotReceive('save'); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldReceive('findByCodes')->once()->andReturn([CouponFactory::make('COU01')]); + + $useCase = new AutoUnpublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute(new AutoUnpublishCampaignInput($campaign->code)); + + // THEN + expect($result)->toBeInstanceOf(CampaignUnpublicationSkipped::class); + }); + + it('skips a published campaign with one active and one expired coupon', function (): void { + // GIVEN + $campaign = CampaignFactory::hydrated(published: true, couponCodes: ['COU01', 'COU02']); + + $repository = \Mockery::mock(CampaignRepository::class); + $repository->shouldReceive('findByCode')->once()->with($campaign->code)->andReturn($campaign); + $repository->shouldNotReceive('save'); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldReceive('findByCodes')->once()->andReturn([ + CouponFactory::expired('COU01'), + CouponFactory::make('COU02'), + ]); + + $useCase = new AutoUnpublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute(new AutoUnpublishCampaignInput($campaign->code)); + + // THEN + expect($result)->toBeInstanceOf(CampaignUnpublicationSkipped::class); + }); + + it('unpublishes a published campaign when every coupon is not available', function (): void { + // GIVEN + $campaign = CampaignFactory::hydrated(published: true, couponCodes: ['COU01', 'COU02']); + + $repository = \Mockery::mock(CampaignRepository::class); + $repository->shouldReceive('findByCode')->once()->with($campaign->code)->andReturn($campaign); + $repository->shouldReceive('save')->once()->with(\Mockery::on( + static fn (Campaign $saved): bool => $saved->publication === false + && $saved->code === $campaign->code + && $saved->updatedAt() instanceof \DateTimeInterface, + )); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldReceive('findByCodes')->once()->andReturn([ + CouponFactory::expired('COU01'), + CouponFactory::upcoming('COU02'), + ]); + + $useCase = new AutoUnpublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute(new AutoUnpublishCampaignInput($campaign->code)); + + // THEN + expect($result)->toBeInstanceOf(CampaignStatusUpdated::class) + ->and($result->publication)->toBeFalse() + ->and($result->code)->toBe($campaign->code) + ->and($result->name)->toBe($campaign->name) + ->and($result->brandCode)->toBe($campaign->brandCode) + ->and($result->coupons)->toBe($campaign->coupons); + }); + + it('unpublishes a published campaign when no coupon is found', function (): void { + // GIVEN + $campaign = CampaignFactory::hydrated(published: true, couponCodes: ['COU01']); + + $repository = \Mockery::mock(CampaignRepository::class); + $repository->shouldReceive('findByCode')->once()->with($campaign->code)->andReturn($campaign); + $repository->shouldReceive('save')->once()->with(\Mockery::on( + static fn (Campaign $saved): bool => $saved->publication === false, + )); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldReceive('findByCodes')->once()->andReturn([]); + + $useCase = new AutoUnpublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute(new AutoUnpublishCampaignInput($campaign->code)); + + // THEN + expect($result)->toBeInstanceOf(CampaignStatusUpdated::class) + ->and($result->publication)->toBeFalse(); + }); +}); diff --git a/tests/Unit/Application/UseCases/Campaign/Update/UpdateCampaignTest.php b/tests/Unit/Application/UseCases/Campaign/Update/PublishCampaignTest.php similarity index 57% rename from tests/Unit/Application/UseCases/Campaign/Update/UpdateCampaignTest.php rename to tests/Unit/Application/UseCases/Campaign/Update/PublishCampaignTest.php index 8e5fe9c..b48d8e2 100644 --- a/tests/Unit/Application/UseCases/Campaign/Update/UpdateCampaignTest.php +++ b/tests/Unit/Application/UseCases/Campaign/Update/PublishCampaignTest.php @@ -6,10 +6,9 @@ namespace Tests\Unit\Application\UseCases\Campaign\Update; use Application\UseCases\Campaign\Update\Input; use Application\UseCases\Campaign\Update\Outputs\CampaignNotFound; -use Application\UseCases\Campaign\Update\Outputs\CampaignUpdated; -use Application\UseCases\Campaign\Update\Outputs\CampaignUpdateFailed; -use Application\UseCases\Campaign\Update\Outputs\UpdateCampaignError; -use Application\UseCases\Campaign\Update\UpdateCampaign; +use Application\UseCases\Campaign\Update\Outputs\CampaignStatusUpdated; +use Application\UseCases\Campaign\Update\Outputs\NotEnoughCouponAvailable; +use Application\UseCases\Campaign\Update\PublishCampaign; use Domain\Models\Entities\Campaign; use Domain\Models\ValueObjects\Actor\ActorId; use Domain\Models\ValueObjects\Brand\BrandCode; @@ -22,10 +21,14 @@ use Domain\Models\ValueObjects\Coupon\CouponCode; use Domain\Models\ValueObjects\PrintRules; use Domain\Ports\Repositories\CampaignRepository; use Domain\Ports\Repositories\CouponRepository; +use Domain\Services\Campaign\CampaignAvailabilityChecker; +use Tests\Fixtures\Coupon\CouponFactory; -covers(UpdateCampaign::class, Input::class, CampaignUpdateFailed::class, CampaignUpdated::class, CampaignNotFound::class); +covers(PublishCampaign::class, Input::class, CampaignStatusUpdated::class, CampaignNotFound::class); describe('update campaign publication use case', function (): void { + $campaignCoupon1 = new CampaignCoupon(new CouponCode('COU01'), new PrintRules(maxPerCustomer: 1)); + $campaignCoupon2 = new CampaignCoupon(new CouponCode('COU02'), new PrintRules(maxPerCustomer: 1)); $existingCampaign = static fn (CampaignCode $code, bool $basePublicationStatus): Campaign => Campaign::hydrate( CampaignId::generate(), $code, @@ -33,8 +36,8 @@ describe('update campaign publication use case', function (): void { $basePublicationStatus, false, new CampaignCouponArray([ - new CampaignCoupon(new CouponCode('AAA01'), new PrintRules(maxPerCustomer: 1)), - new CampaignCoupon(new CouponCode('AAA02'), new PrintRules(maxPerCustomer: 1)) + $campaignCoupon1, + $campaignCoupon2 ]), new BrandCode('AAA01'), ActorId::generate() @@ -57,45 +60,27 @@ describe('update campaign publication use case', function (): void { $couponRepository = \Mockery::mock(CouponRepository::class); - $useCase = new UpdateCampaign($repository, $couponRepository); + $useCase = new PublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); // WHEN $result = $useCase->execute($input); // THEN - expect($result)->toBeInstanceOf(CampaignUpdated::class) + expect($result)->toBeInstanceOf(CampaignStatusUpdated::class) ->and($result->publication)->toBeFalse(); }); - it('throws when unpublish an already unpublished campaign', function () use ($existingCampaign): void { - // GIVEN - $code = CampaignCode::generate(); - $campaign = $existingCampaign($code, false); - $publication = false; - $input = new Input(code: $campaign->code, publication: $publication); - - $repository = \Mockery::mock(CampaignRepository::class); - $repository->shouldReceive('findByCode')->once()->with($code)->andReturn($campaign); - $repository->shouldNotReceive('save'); - - $couponRepository = \Mockery::mock(CouponRepository::class); - - $useCase = new UpdateCampaign($repository, $couponRepository); - - // WHEN - $result = $useCase->execute($input); - - // THEN - expect($result)->toBeInstanceOf(CampaignUpdateFailed::class) - ->and($result->error)->toBe(UpdateCampaignError::CampaignAlreadyUnpublished); - }); - it('publish an unpublished campaign', function () use ($existingCampaign): void { // GIVEN - $code = CampaignCode::generate(); - $campaign = $existingCampaign($code, false); - $publication = true; - $input = new Input(code: $campaign->code, publication: $publication); + $code = CampaignCode::generate(); + $campaign = $existingCampaign($code, false); + $publication = true; + $input = new Input(code: $campaign->code, publication: $publication); + $expectedCoupons = [ + CouponFactory::make('COU01'), + CouponFactory::make('COU02'), + CouponFactory::expired('COU03'), + ]; $repository = \Mockery::mock(CampaignRepository::class); $repository->shouldReceive('findByCode')->once()->with($code)->andReturn($campaign); @@ -106,42 +91,19 @@ describe('update campaign publication use case', function (): void { )); $couponRepository = \Mockery::mock(CouponRepository::class); - $couponRepository->shouldReceive('findByCodes')->once()->with($campaign->coupons->getCouponCodes()); + $couponRepository->shouldReceive('findByCodes')->once()->with($campaign->coupons->getCouponCodes())->andReturn($expectedCoupons); - $useCase = new UpdateCampaign($repository, $couponRepository); + $useCase = new PublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); // WHEN $result = $useCase->execute($input); // THEN - expect($result)->toBeInstanceOf(CampaignUpdated::class) + expect($result)->toBeInstanceOf(CampaignStatusUpdated::class) ->and($result->publication)->toBeTrue(); }); - it('throws when publish an already published campaign', function () use ($existingCampaign): void { - // GIVEN - $code = CampaignCode::generate(); - $campaign = $existingCampaign($code, true); - $publication = true; - $input = new Input(code: $campaign->code, publication: $publication); - - $repository = \Mockery::mock(CampaignRepository::class); - $repository->shouldReceive('findByCode')->once()->with($code)->andReturn($campaign); - $repository->shouldNotReceive('save'); - - $couponRepository = \Mockery::mock(CouponRepository::class); - - $useCase = new UpdateCampaign($repository, $couponRepository); - - // WHEN - $result = $useCase->execute($input); - - // THEN - expect($result)->toBeInstanceOf(CampaignUpdateFailed::class) - ->and($result->error)->toBe(UpdateCampaignError::CampaignAlreadyPublished); - }); - - it('throws when the campaign is not found', function (): void { + it('returns a CampaignNotFound output when the campaign is not found', function (): void { // GIVEN $code = CampaignCode::generate(); $publication = true; @@ -152,7 +114,7 @@ describe('update campaign publication use case', function (): void { $couponRepository = \Mockery::mock(CouponRepository::class); - $useCase = new UpdateCampaign($repository, $couponRepository); + $useCase = new PublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); // WHEN $result = $useCase->execute($input); @@ -160,4 +122,55 @@ describe('update campaign publication use case', function (): void { // THEN expect($result)->toBeInstanceOf(CampaignNotFound::class); }); + + it('returns a specific output when there is no available coupons in the campaign', function () use ($existingCampaign): void { + // GIVEN + $code = CampaignCode::generate(); + $campaign = $existingCampaign($code, false); + $publication = true; + $input = new Input(code: $campaign->code, publication: $publication); + $expectedCoupons = [ + CouponFactory::expired('COU01'), + CouponFactory::upcoming('COU02'), + ]; + + $repository = \Mockery::mock(CampaignRepository::class); + $repository->shouldReceive('findByCode')->once()->with($code)->andReturn($campaign); + $repository->shouldNotReceive('save'); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldReceive('findByCodes')->once()->with($campaign->coupons->getCouponCodes())->andReturn($expectedCoupons); + + $useCase = new PublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute($input); + + // THEN + expect($result)->toBeInstanceOf(NotEnoughCouponAvailable::class); + }); + + it('returns a NotEnoughCouponAvailable output when there is no available coupons in the campaign', function () use ($existingCampaign): void { + // GIVEN + $code = CampaignCode::generate(); + $campaign = $existingCampaign($code, false); + $publication = true; + $input = new Input(code: $campaign->code, publication: $publication); + $expectedCoupons = []; + + $repository = \Mockery::mock(CampaignRepository::class); + $repository->shouldReceive('findByCode')->once()->with($code)->andReturn($campaign); + $repository->shouldNotReceive('save'); + + $couponRepository = \Mockery::mock(CouponRepository::class); + $couponRepository->shouldReceive('findByCodes')->once()->with($campaign->coupons->getCouponCodes())->andReturn($expectedCoupons); + + $useCase = new PublishCampaign($repository, new CampaignAvailabilityChecker($couponRepository)); + + // WHEN + $result = $useCase->execute($input); + + // THEN + expect($result)->toBeInstanceOf(NotEnoughCouponAvailable::class); + }); }); diff --git a/tests/Unit/Domain/Models/Entities/CampaignTest.php b/tests/Unit/Domain/Models/Entities/CampaignTest.php index 2b01bc0..931df34 100644 --- a/tests/Unit/Domain/Models/Entities/CampaignTest.php +++ b/tests/Unit/Domain/Models/Entities/CampaignTest.php @@ -33,16 +33,17 @@ use Domain\Models\ValueObjects\PicturePath; use Domain\Models\ValueObjects\PrintRules; use Domain\Models\ValueObjects\ProcessingCode; use Domain\Models\ValueObjects\ProcessingCodeArray; -use Ramsey\Uuid\Uuid; use Shared\Enums\Country; use Shared\Enums\Currency; -use Shared\Helpers\DatesHelper; use Shared\ValueObjects\Money; +use Tests\Fixtures\Campaign\CampaignFactory; covers(Campaign::class); describe('campaign', function (): void { + $code = CampaignCode::generate(); $name = new CampaignName('Name'); + $publication = \boolval(1); $printAllAtOnce = \boolval(1); $coupons = new CampaignCouponArray([ new CampaignCoupon( @@ -238,36 +239,6 @@ describe('campaign', function (): void { ->and($campaign->updatedAt()->format('Y-m-d H:i:s'))->toBe('2026-06-15 16:45:00'); }); - it('throws when unpublish an already unpublished campaign', function () use ( - $code, - $name, - $printAllAtOnce, - $coupons, - $brandCode, - $actorId - ): void { - // GIVEN - CarbonImmutable::setTestNow('2026-06-15 16:45:00 UTC'); - $id = CampaignId::generate(); - $oldPublicationStatus = false; - $campaign = Campaign::hydrate( - $id, - $code, - $name, - $oldPublicationStatus, - $printAllAtOnce, - $coupons, - $brandCode, - $actorId - ); - - // WHEN - $action = fn () => $campaign = $campaign->unpublish(); - - // THEN - expect($action)->toThrow(\DomainException::class, 'Campaign is already unpublished.'); - }); - it('publishes a campaign and sets updatedAt timestamp', function () use ( $code, $name, @@ -275,11 +246,9 @@ describe('campaign', function (): void { $coupons, $brandCode, $actorId, - $makeCoupon ): void { // GIVEN CarbonImmutable::setTestNow('2026-06-15 16:45:00 UTC'); - $now = DatesHelper::now(); $id = CampaignId::generate(); $oldPublicationStatus = false; $newPublicationStatus = true; @@ -294,14 +263,8 @@ describe('campaign', function (): void { $actorId ); - // Coupons valides - $printableCoupon = $makeCoupon([ - 'diffusionStart' => $now->modify('-1 month')->toDateTime(), - 'diffusionEnd' => $now->modify('+1 month')->toDateTime(), - ]); - // WHEN - $campaign = $campaign->publish([$printableCoupon]); + $campaign = $campaign->publish(); // THEN expect($campaign->id())->toBe($id) @@ -315,68 +278,6 @@ describe('campaign', function (): void { ->and($campaign->updatedAt()->format('Y-m-d H:i:s'))->toBe('2026-06-15 16:45:00'); }); - it('throws when publish an already published campaign', function () use ($code, $name, $printAllAtOnce, $coupons, $brandCode, $actorId): void { - // GIVEN - CarbonImmutable::setTestNow('2026-06-15 16:45:00 UTC'); - $id = CampaignId::generate(); - $oldPublicationStatus = true; - $campaign = Campaign::hydrate( - $id, - $code, - $name, - $oldPublicationStatus, - $printAllAtOnce, - $coupons, - $brandCode, - $actorId - ); - - // WHEN - $action = fn () => $campaign = $campaign->publish([]); - - // THEN - expect($action)->toThrow(\DomainException::class, 'Campaign is already published.'); - }); - - it('throws when publish a campaign with no active coupons', function () use ( - $code, - $name, - $printAllAtOnce, - $brandCode, - $actorId, - $makeCoupon - ): void { - // GIVEN - CarbonImmutable::setTestNow('2026-06-15 16:45:00 UTC'); - $now = DatesHelper::now(); - $id = CampaignId::generate(); - $oldPublicationStatus = false; - - $printableCoupon = $makeCoupon([ - 'diffusionStart' => $now->modify('+1 month')->toDateTime(), - 'diffusionEnd' => $now->modify('+2 month')->toDateTime(), - ]); - $coupons = new CampaignCouponArray([ - new CampaignCoupon($printableCoupon->code) - ]); - $campaign = Campaign::hydrate( - $id, - $code, - $name, - $oldPublicationStatus, - $printAllAtOnce, - $coupons, - $brandCode, - $actorId - ); - - // WHEN - $action = fn () => $campaign = $campaign->publish([$printableCoupon]); - - // THEN - expect($action)->toThrow(\DomainException::class, 'At least 1 available coupon should be provided to activate a campaign.'); - }); - it('unpublishes a campaign when there are no available coupons in it', function () use ( $code, $name, @@ -464,4 +365,16 @@ describe('campaign', function (): void { ->and($campaign->createdAt())->toBeInstanceOf(DateTimeInterface::class) ->and($campaign->updatedAt())->toBeInstanceOf(DateTimeInterface::class); }); + + it('gets the codes of the associated coupons', function (): void { + // GIVEN + $expectedCoupons = ['COU01', 'COU02']; + $campaign = CampaignFactory::hydrated(couponCodes: $expectedCoupons); + + // WHEN + $coupons = array_map(static fn (CouponCode $c): string => $c->value, $campaign->couponCodes()); + + // THEN + expect($coupons)->toBe($expectedCoupons); + }); }); diff --git a/tests/Unit/Domain/Services/CampaignAvailabilityCheckerTest.php b/tests/Unit/Domain/Services/CampaignAvailabilityCheckerTest.php new file mode 100644 index 0000000..7ed1db4 --- /dev/null +++ b/tests/Unit/Domain/Services/CampaignAvailabilityCheckerTest.php @@ -0,0 +1,87 @@ +shouldReceive('findByCodes') + ->once() + ->with(\Mockery::on( + static fn (array $codes): bool => array_map( + static fn ($code): string => $code->value, + $codes, + ) === $campaignCodes, + )) + ->andReturn($coupons); + + return $repository; + }; + + it('is available with an active coupon', function () use ($makeRepository): void { + // GIVEN + $campaign = CampaignFactory::hydrated(couponCodes: ['COU01']); + $repository = $makeRepository(['COU01'], [CouponFactory::make('COU01')]); + $service = new CampaignAvailabilityChecker($repository); + + // WHEN + $result = $service->hasActiveCoupon($campaign); + + // THEN + expect($result)->toBeTrue(); + }); + + it('is available with one active and one expired coupon', function () use ($makeRepository): void { + // GIVEN + $campaign = CampaignFactory::hydrated(couponCodes: ['COU01', 'COU02']); + $repository = $makeRepository(['COU01', 'COU02'], [ + CouponFactory::expired('COU01'), + CouponFactory::make('COU02'), + ]); + $service = new CampaignAvailabilityChecker($repository); + + // WHEN + $result = $service->hasActiveCoupon($campaign); + + // THEN + expect($result)->toBeTrue(); + }); + + it('is not available when every coupon is expired or upcoming', function () use ($makeRepository): void { + // GIVEN + $campaign = CampaignFactory::hydrated(couponCodes: ['COU01', 'COU02']); + $repository = $makeRepository(['COU01', 'COU02'], [ + CouponFactory::expired('COU01'), + CouponFactory::upcoming('COU02'), + ]); + $service = new CampaignAvailabilityChecker($repository); + + // WHEN + $result = $service->hasActiveCoupon($campaign); + + // THEN + expect($result)->toBeFalse(); + }); + + it('is not available when no coupon is found', function () use ($makeRepository): void { + // GIVEN + $campaign = CampaignFactory::hydrated(couponCodes: ['COU01']); + $repository = $makeRepository(['COU01'], []); + $service = new CampaignAvailabilityChecker($repository); + + // WHEN + $result = $service->hasActiveCoupon($campaign); + + // THEN + expect($result)->toBeFalse(); + }); +});