refactor(pages): implement CQS action, query, DTO, and SeoMetadata VO for pages

This commit is contained in:
Jérémy Munsch 2026-09-29 15:10:29 +02:00
parent 8f6006e209
commit 1fd2a3a1d8
No known key found for this signature in database
GPG key ID: 2AAECDA6B7330F91
17 changed files with 676 additions and 22 deletions

View file

@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
namespace App\Actions\Pages;
use App\Contracts\Action;
use App\Contracts\ActionInput;
use App\Models\Page;
use Webmozart\Assert\Assert;
/**
* @implements \App\Contracts\Action<\App\Actions\Pages\UpdatePageInput, \App\Models\Page>
*/
final class UpdatePage implements Action
{
/**
* @param \App\Actions\Pages\UpdatePageInput $input
*/
#[\Override]
public function __invoke(ActionInput $input): Page
{
Assert::isInstanceOf($input, UpdatePageInput::class);
$page = $input->page;
$page->fill([
'seo_title' => $input->seo->title,
'seo_description' => $input->seo->description,
'title' => $input->title,
'content' => $input->content,
]);
$page->saveOrFail();
return $page;
}
}

View file

@ -0,0 +1,27 @@
<?php
declare(strict_types=1);
namespace App\Actions\Pages;
use App\Contracts\ActionInput;
use App\Models\Page;
use Domain\Models\ValueObjects\SeoMetadata;
use Webmozart\Assert\Assert;
final readonly class UpdatePageInput implements ActionInput
{
public function __construct(
public Page $page,
public SeoMetadata $seo,
public ?string $title,
public string $content,
) {
Assert::stringNotEmpty(trim($this->content));
if ($this->title !== null) {
Assert::stringNotEmpty(trim($this->title));
Assert::maxLength($this->title, 255);
}
}
}

78
app/Dto/PageDto.php Normal file
View file

@ -0,0 +1,78 @@
<?php
declare(strict_types=1);
namespace App\Dto;
use App\Models\Page;
use Domain\Enums\StaticPageSlug;
use Illuminate\Contracts\Routing\UrlRoutable;
use Illuminate\Contracts\Support\Arrayable;
/**
* @implements Arrayable<string, mixed>
*/
final readonly class PageDto implements Arrayable, UrlRoutable
{
public function __construct(
public int $id,
public StaticPageSlug $slug,
public string $seo_title,
public string $seo_description,
public ?string $title,
public string $content,
) {
}
public static function fromModel(Page $page): self
{
return new self(
id: $page->id,
slug: $page->slug,
seo_title: $page->seo_title,
seo_description: $page->seo_description,
title: $page->title,
content: $page->content,
);
}
#[\Override]
public function getRouteKey(): mixed
{
return $this->slug->value;
}
#[\Override]
public function getRouteKeyName(): string
{
return 'slug';
}
#[\Override]
public function resolveRouteBinding($value, $field = null): mixed
{
return null;
}
#[\Override]
public function resolveChildRouteBinding($childType, $value, $field): mixed
{
return null;
}
/**
* @return array{id: int, slug: StaticPageSlug, seo_title: string, seo_description: string, title: string|null, content: string}
*/
#[\Override]
public function toArray(): array
{
return [
'id' => $this->id,
'slug' => $this->slug,
'seo_title' => $this->seo_title,
'seo_description' => $this->seo_description,
'title' => $this->title,
'content' => $this->content,
];
}
}

View file

@ -4,43 +4,54 @@ declare(strict_types=1);
namespace App\Http\Controllers\Bo;
use App\Actions\Pages\UpdatePage;
use App\Actions\Pages\UpdatePageInput;
use App\Contracts\ActionExecutor;
use App\Dto\PageDto;
use App\Http\Controllers\Controller;
use App\Http\Requests\Bo\Pages\UpdatePageRequest as PagesUpdatePageRequest;
use App\Models\Page;
use Domain\Models\ValueObjects\SeoMetadata;
use Illuminate\Contracts\View\View;
use Illuminate\Http\RedirectResponse;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Str;
class PageController extends Controller
{
public function __construct(
private readonly ActionExecutor $executor,
) {
}
public function edit(Page $page): View
{
$this->authorize('update', $page);
return view('bo.pages.edit', compact('page'));
return view('bo.pages.edit', [
'page' => PageDto::fromModel($page),
]);
}
public function update(PagesUpdatePageRequest $request, Page $page): RedirectResponse
public function update(PagesUpdatePageRequest $request, Page $page, UpdatePage $action): RedirectResponse
{
$this->authorize('update', $page);
return DB::transaction(function () use ($request, $page) {
$page->fill($request->only(
$page->getFillable()
));
$this->executor->execute(
$action,
new UpdatePageInput(
page: $page,
seo: new SeoMetadata(
title: $request->string('seo_title')->value(),
description: $request->string('seo_description')->value(),
),
title: $request->filled('title') ? $request->string('title')->value() : null,
content: $request->string('content')->value(),
),
);
if ($page->saveOrFail()) {
return to_route('bo.pages.edit', $page->slug->value())
->with('success', trans('crud.messages.has_been_updated', [
'model' => Str::ucfirst(trans_choice('models.classes.pages', 1)),
]));
}
return to_route('bo.pages.edit', $page->slug->value())
->with('error', trans('crud.messages.cannot_be_updated', [
'model' => Str::ucfirst(trans_choice('models.classes.pages', 1)),
]));
});
return to_route('bo.pages.edit', $page->slug->value())
->with('success', trans('crud.messages.has_been_updated', [
'model' => Str::ucfirst(trans_choice('models.classes.pages', 1)),
]));
}
}

View file

@ -4,6 +4,7 @@ declare(strict_types=1);
namespace App\Policies\Backend;
use App\Dto\PageDto;
use App\Models\Customer;
use App\Models\Page;
use App\Models\User;
@ -11,7 +12,7 @@ use Domain\Enums\UserRole;
class PagePolicy
{
public function update(User | Customer $user, Page $_): bool
public function update(User | Customer $user, Page | PageDto $_): bool
{
if ($user instanceof Customer) {
return false;

View file

@ -5,9 +5,11 @@ declare(strict_types=1);
namespace App\Providers;
use App\Dto\FaqDto;
use App\Dto\PageDto;
use App\Dto\TagDto;
use App\Models\Customer;
use App\Policies\Backend\FaqPolicy;
use App\Policies\Backend\PagePolicy;
use App\Policies\Backend\TagPolicy;
use App\Policies\Frontend\BasketPolicy;
use App\Services\CrmService;
@ -33,6 +35,7 @@ class AuthServiceProvider extends ServiceProvider
// * Policies Exceptions
BasketProduct::class => BasketPolicy::class,
FaqDto::class => FaqPolicy::class,
PageDto::class => PagePolicy::class,
TagDto::class => TagPolicy::class,
];

View file

@ -0,0 +1,28 @@
<?php
declare(strict_types=1);
namespace App\Queries\Pages;
use App\Contracts\Query;
use App\Dto\PageDto;
use App\Models\Page;
use Domain\Enums\StaticPageSlug;
/**
* @implements \App\Contracts\Query<\App\Dto\PageDto>
*/
final readonly class GetPageBySlugQuery implements Query
{
public function execute(StaticPageSlug | string $slug): PageDto
{
$slugValue = $slug instanceof StaticPageSlug ? $slug->value : $slug;
/** @var \App\Models\Page $page */
$page = Page::query()
->where('slug', $slugValue)
->firstOrFail();
return PageDto::fromModel($page);
}
}

View file

@ -0,0 +1,20 @@
<?php
declare(strict_types=1);
namespace Domain\Models\ValueObjects;
use Webmozart\Assert\Assert;
final readonly class SeoMetadata
{
public function __construct(
public string $title,
public string $description,
) {
Assert::stringNotEmpty(trim($this->title));
Assert::maxLength($this->title, 255);
Assert::stringNotEmpty(trim($this->description));
Assert::maxLength($this->description, 500);
}
}

View file

@ -1,5 +1,6 @@
<nav class="navbar navbar-dark bg-dark flex-md-nowrap p-0 shadow">
<span class="navbar-brand col-12 col-md-3 col-lg-2 me-0 px-3">{{ config('app.name') }}</span>
<a class="navbar-brand col-12 col-md-3 col-lg-2 me-0 px-3" href="{{ route('fo.pages.home') }}"
title="{{ __('Go to page :page', ['page' => __('Home')]) }}" target="_blank">{{ config('app.name') }}</a>
<button class="navbar-toggler position-absolute d-md-none collapsed" data-bs-toggle="collapse" data-bs-target="#sidebar-menu" type="button"
aria-controls="sidebar-menu" aria-expanded="false" aria-label="Toggle navigation">

View file

@ -2,6 +2,7 @@
declare(strict_types=1);
use App\Dto\PageDto;
use App\Models\Discount;
use App\Models\Faq;
use App\Models\Page;
@ -75,7 +76,7 @@ Breadcrumbs::for('bo.pages.create', function (Generator $trail) use ($creationLa
$trail->parent('bo.pages.index');
$trail->push($creationLabel);
});
Breadcrumbs::for('bo.pages.edit', function (Generator $trail, Page $page) use ($editionLabel): void {
Breadcrumbs::for('bo.pages.edit', function (Generator $trail, Page | PageDto $page) use ($editionLabel): void {
$trail->parent('bo.pages.index');
$trail->push("{$editionLabel} {$page->slug->label()}", route('bo.pages.edit', $page->slug->value()));
});

View file

@ -0,0 +1,87 @@
<?php
declare(strict_types=1);
use App\Dto\PageDto;
use App\Models\Page;
use App\Models\User;
use Domain\Enums\StaticPageSlug;
use Domain\Enums\UserRole;
describe('Bo\PageController', function (): void {
beforeEach(function (): void {
/** @var \Tests\TestCase $this */
// GIVEN
$user = User::factory()->create(['role' => UserRole::SuperAdmin]);
$this->actingAs($user, 'backend');
});
it('can access edit', function (): void {
/** @var \Tests\TestCase $this */
// GIVEN
$page = new Page();
$page->slug = StaticPageSlug::LEGALS;
$page->seo_title = 'Mentions légales SEO Title Test';
$page->seo_description = 'Mentions légales SEO Description Test suffisamment longue';
$page->title = 'Mentions Légales';
$page->content = '<p>Contenu mentions légales</p>';
$page->saveOrFail();
// WHEN
$response = $this->get('/bo/pages/legals/edit');
// THEN
expect($response->status())->toBe(200);
$response->assertViewIs('bo.pages.edit');
$response->assertViewHas('page', fn ($pageData) => $pageData instanceof PageDto && $pageData->slug === StaticPageSlug::LEGALS);
});
it('can update a page', function (): void {
/** @var \Tests\TestCase $this */
// GIVEN
$page = new Page();
$page->slug = StaticPageSlug::TERMS;
$page->seo_title = 'Ancien Titre SEO suffisamment long pour la validation';
$page->seo_description = 'Ancienne Description SEO suffisamment longue pour la validation requise';
$page->title = 'Ancien Titre';
$page->content = '<p>Ancien contenu</p>';
$page->saveOrFail();
$data = [
'seo_title' => 'Conditions Générales de Ventes - Notre Boutique',
'seo_description' => 'Découvrez l\'ensemble de nos conditions générales de vente en ligne.',
'title' => 'Conditions Générales de Vente',
'content' => '<p>Nouveau contenu CGV avec <strong>HTML</strong>.</p>',
];
// WHEN
$response = $this->put('/bo/pages/cgv', $data);
// THEN
$page->refresh();
expect($page->seo_title)->toBe('Conditions Générales de Ventes - Notre Boutique')
->and($page->seo_description)->toBe('Découvrez l\'ensemble de nos conditions générales de vente en ligne.')
->and($page->title)->toBe('Conditions Générales de Vente')
->and($page->content)->toBe('<p>Nouveau contenu CGV avec <strong>HTML</strong>.</p>');
$response->assertRedirect('/bo/pages/cgv/edit');
});
it('fails validation when required fields are missing on update', function (): void {
/** @var \Tests\TestCase $this */
// GIVEN
$page = new Page();
$page->slug = StaticPageSlug::PRIVACY;
$page->seo_title = 'Politique de Confidentialité Titre SEO pour la validation';
$page->seo_description = 'Politique de Confidentialité Description SEO pour la validation requise';
$page->title = 'Confidentialité';
$page->content = '<p>Contenu</p>';
$page->saveOrFail();
// WHEN
$response = $this->put('/bo/pages/confidentialite', []);
// THEN
$response->assertSessionHasErrors(['seo_title', 'seo_description', 'content']);
});
});

View file

@ -0,0 +1,65 @@
<?php
declare(strict_types=1);
use App\Actions\Pages\UpdatePage;
use App\Actions\Pages\UpdatePageInput;
use App\Contracts\ActionInput;
use App\Models\Page;
use Domain\Enums\StaticPageSlug;
use Domain\Models\ValueObjects\SeoMetadata;
describe('UpdatePage action', function (): void {
it('updates an existing page in database', function (): void {
// GIVEN
$page = new Page();
$page->slug = StaticPageSlug::LEGALS;
$page->seo_title = 'Ancien SEO Title';
$page->seo_description = 'Ancienne SEO Description';
$page->title = 'Ancien titre';
$page->content = '<p>Ancien contenu</p>';
$page->saveOrFail();
$action = new UpdatePage();
$seo = new SeoMetadata('Nouveau SEO Title', 'Nouvelle SEO Description');
$input = new UpdatePageInput(
page: $page,
seo: $seo,
title: 'Nouveau titre',
content: '<p>Nouveau contenu</p>',
);
// WHEN
$updatedPage = $action($input);
// THEN
expect($updatedPage->id)->toBe($page->id)
->and($updatedPage->seo_title)->toBe('Nouveau SEO Title')
->and($updatedPage->seo_description)->toBe('Nouvelle SEO Description')
->and($updatedPage->title)->toBe('Nouveau titre')
->and($updatedPage->content)->toBe('<p>Nouveau contenu</p>');
$fresh = Page::query()->find($page->id);
expect($fresh)->not->toBeNull()
->and($fresh?->seo_title)->toBe('Nouveau SEO Title')
->and($fresh?->seo_description)->toBe('Nouvelle SEO Description')
->and($fresh?->title)->toBe('Nouveau titre')
->and($fresh?->content)->toBe('<p>Nouveau contenu</p>');
});
it('throws when an invalid input is passed', function (): void {
// GIVEN
$action = new UpdatePage();
$invalidInput = new class () implements ActionInput
{
};
// WHEN
expect(
/** @phpstan-ignore argument.type */
fn () => $action($invalidInput)
)
// THEN
->toThrow(\InvalidArgumentException::class);
});
});

View file

@ -0,0 +1,68 @@
<?php
declare(strict_types=1);
use App\Dto\PageDto;
use App\Models\Page;
use App\Queries\Pages\GetPageBySlugQuery;
use Domain\Enums\StaticPageSlug;
use Illuminate\Database\Eloquent\ModelNotFoundException;
describe('GetPageBySlugQuery', function (): void {
it('returns a PageDto when page exists by enum slug', function (): void {
// GIVEN
$page = new Page();
$page->slug = StaticPageSlug::LEGALS;
$page->seo_title = 'Mentions légales SEO';
$page->seo_description = 'Mentions légales description SEO';
$page->title = 'Mentions légales';
$page->content = '<p>Contenu des mentions légales</p>';
$page->save();
/** @var GetPageBySlugQuery $query */
$query = app(GetPageBySlugQuery::class);
// WHEN
$dto = $query->execute(StaticPageSlug::LEGALS);
// THEN
expect($dto)->toBeInstanceOf(PageDto::class)
->and($dto->id)->toBe($page->id)
->and($dto->slug)->toBe(StaticPageSlug::LEGALS)
->and($dto->seo_title)->toBe('Mentions légales SEO')
->and($dto->title)->toBe('Mentions légales');
});
it('returns a PageDto when page exists by string slug', function (): void {
// GIVEN
$page = new Page();
$page->slug = StaticPageSlug::TERMS;
$page->seo_title = 'CGV SEO Title';
$page->seo_description = 'CGV SEO Description';
$page->title = 'Conditions Générales de Vente';
$page->content = '<p>Contenu CGV</p>';
$page->save();
/** @var GetPageBySlugQuery $query */
$query = app(GetPageBySlugQuery::class);
// WHEN
$dto = $query->execute('cgv');
// THEN
expect($dto)->toBeInstanceOf(PageDto::class)
->and($dto->id)->toBe($page->id)
->and($dto->slug)->toBe(StaticPageSlug::TERMS);
});
it('throws ModelNotFoundException when page does not exist', function (): void {
// GIVEN
/** @var GetPageBySlugQuery $query */
$query = app(GetPageBySlugQuery::class);
// WHEN
expect(fn () => $query->execute('non-existent-slug'))
// THEN
->toThrow(ModelNotFoundException::class);
});
});

View file

@ -0,0 +1,98 @@
<?php
declare(strict_types=1);
use App\Actions\Pages\UpdatePageInput;
use App\Models\Page;
use Domain\Models\ValueObjects\SeoMetadata;
describe('UpdatePageInput', function (): void {
it('creates a valid UpdatePageInput instance', function (): void {
// GIVEN
$page = new Page();
$seo = new SeoMetadata('Titre SEO valide', 'Description SEO valide');
$title = 'Titre de page';
$content = '<p>Contenu HTML de la page</p>';
// WHEN
$input = new UpdatePageInput(
page: $page,
seo: $seo,
title: $title,
content: $content,
);
// THEN
expect($input->page)->toBe($page)
->and($input->seo)->toBe($seo)
->and($input->title)->toBe($title)
->and($input->content)->toBe($content);
});
it('allows null title', function (): void {
// GIVEN
$page = new Page();
$seo = new SeoMetadata('Titre SEO valide', 'Description SEO valide');
$content = '<p>Contenu HTML</p>';
// WHEN
$input = new UpdatePageInput(
page: $page,
seo: $seo,
title: null,
content: $content,
);
// THEN
expect($input->title)->toBeNull();
});
it('throws when title is empty string', function (): void {
// GIVEN
$page = new Page();
$seo = new SeoMetadata('Titre SEO valide', 'Description SEO valide');
// WHEN
expect(fn () => new UpdatePageInput(
page: $page,
seo: $seo,
title: ' ',
content: '<p>Contenu</p>',
))
// THEN
->toThrow(\InvalidArgumentException::class);
});
it('throws when title exceeds 255 characters', function (): void {
// GIVEN
$page = new Page();
$seo = new SeoMetadata('Titre SEO valide', 'Description SEO valide');
$longTitle = str_repeat('a', 256);
// WHEN
expect(fn () => new UpdatePageInput(
page: $page,
seo: $seo,
title: $longTitle,
content: '<p>Contenu</p>',
))
// THEN
->toThrow(\InvalidArgumentException::class);
});
it('throws when content is empty', function (): void {
// GIVEN
$page = new Page();
$seo = new SeoMetadata('Titre SEO valide', 'Description SEO valide');
// WHEN
expect(fn () => new UpdatePageInput(
page: $page,
seo: $seo,
title: 'Titre',
content: ' ',
))
// THEN
->toThrow(\InvalidArgumentException::class);
});
});

View file

@ -0,0 +1,43 @@
<?php
declare(strict_types=1);
use App\Dto\PageDto;
use App\Models\Page;
use Domain\Enums\StaticPageSlug;
describe('PageDto', function (): void {
it('creates a DTO from Page model', function (): void {
// GIVEN
$page = new Page();
$page->id = 1;
$page->slug = StaticPageSlug::FAQ;
$page->seo_title = 'FAQ SEO Title';
$page->seo_description = 'FAQ SEO Description';
$page->title = 'Foire aux questions';
$page->content = '<p>Questions et réponses</p>';
// WHEN
$dto = PageDto::fromModel($page);
// THEN
expect($dto->id)->toBe(1)
->and($dto->slug)->toBe(StaticPageSlug::FAQ)
->and($dto->seo_title)->toBe('FAQ SEO Title')
->and($dto->seo_description)->toBe('FAQ SEO Description')
->and($dto->title)->toBe('Foire aux questions')
->and($dto->content)->toBe('<p>Questions et réponses</p>')
->and($dto->getRouteKey())->toBe('faq')
->and($dto->getRouteKeyName())->toBe('slug')
->and($dto->resolveRouteBinding('faq'))->toBeNull()
->and($dto->resolveChildRouteBinding('child', 'val', 'field'))->toBeNull()
->and($dto->toArray())->toBe([
'id' => 1,
'slug' => StaticPageSlug::FAQ,
'seo_title' => 'FAQ SEO Title',
'seo_description' => 'FAQ SEO Description',
'title' => 'Foire aux questions',
'content' => '<p>Questions et réponses</p>',
]);
});
});

View file

@ -2,10 +2,12 @@
declare(strict_types=1);
use App\Dto\PageDto;
use App\Models\Customer;
use App\Models\Page;
use App\Models\User;
use App\Policies\Backend\PagePolicy;
use Domain\Enums\StaticPageSlug;
use Domain\Enums\UserRole;
describe('PagePolicy', function () {
@ -35,4 +37,25 @@ describe('PagePolicy', function () {
// THEN
expect($result)->toBeTrue();
});
test('update returns true for admin user with PageDto', function () {
// GIVEN
$user = new User();
$user->role = UserRole::Admin;
$policy = new PagePolicy();
$page = new Page();
$page->id = 1;
$page->slug = StaticPageSlug::FAQ;
$page->seo_title = 'SEO Title';
$page->seo_description = 'SEO Description';
$page->title = 'Title';
$page->content = 'Content';
$dto = PageDto::fromModel($page);
// WHEN
$result = $policy->update($user, $dto);
// THEN
expect($result)->toBeTrue();
});
});

View file

@ -0,0 +1,64 @@
<?php
declare(strict_types=1);
use Domain\Models\ValueObjects\SeoMetadata;
describe('SeoMetadata', function (): void {
it('creates a valid SeoMetadata instance', function (): void {
// GIVEN
$title = 'Titre Optimisé pour le Référencement Naturel';
$description = 'Description complète et détaillée expliquant la page pour le SEO.';
// WHEN
$seo = new SeoMetadata(title: $title, description: $description);
// THEN
expect($seo->title)->toBe($title)
->and($seo->description)->toBe($description);
});
it('throws when title is empty', function (): void {
// GIVEN
$emptyTitle = ' ';
$description = 'Description valide';
// WHEN
expect(fn () => new SeoMetadata(title: $emptyTitle, description: $description))
// THEN
->toThrow(\InvalidArgumentException::class);
});
it('throws when title exceeds 255 characters', function (): void {
// GIVEN
$tooLongTitle = str_repeat('a', 256);
$description = 'Description valide';
// WHEN
expect(fn () => new SeoMetadata(title: $tooLongTitle, description: $description))
// THEN
->toThrow(\InvalidArgumentException::class);
});
it('throws when description is empty', function (): void {
// GIVEN
$title = 'Titre valide';
$emptyDescription = ' ';
// WHEN
expect(fn () => new SeoMetadata(title: $title, description: $emptyDescription))
// THEN
->toThrow(\InvalidArgumentException::class);
});
it('throws when description exceeds 500 characters', function (): void {
// GIVEN
$title = 'Titre valide';
$tooLongDescription = str_repeat('a', 501);
// WHEN
expect(fn () => new SeoMetadata(title: $title, description: $tooLongDescription))
// THEN
->toThrow(\InvalidArgumentException::class);
});
});