feat: introduce ArticleViewer and ViewerGateway for article visibility management

Author: aspirantzhang

contexts/ArticlePublishing/Application/Coordinators/ArticlePublishingCoordinator.php

@@ -12,11 +12,14 @@
 use Contexts\ArticlePublishing\Application\DTOs\UpdateArticleDTO;
 use Contexts\ArticlePublishing\Domain\Gateway\CategoryGateway;
 use Contexts\ArticlePublishing\Domain\Gateway\CurrentUserGateway;
+use Contexts\ArticlePublishing\Domain\Gateway\ViewerGateway;
 use Contexts\ArticlePublishing\Domain\Models\Article;
 use Contexts\ArticlePublishing\Domain\Models\ArticleId;
 use Contexts\ArticlePublishing\Domain\Models\ArticleStatus;
+use Contexts\ArticlePublishing\Domain\Models\ArticleVisibility;
 use Contexts\ArticlePublishing\Domain\Models\AuthorId;
 use Contexts\ArticlePublishing\Domain\Policies\GlobalPermissionPolicy;
+use Contexts\ArticlePublishing\Domain\Policies\VisibilityPolicy;
 use Contexts\ArticlePublishing\Infrastructure\Repositories\ArticleRepository;
 use Contexts\Shared\Policies\CompositePolicy;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
@@ -26,10 +29,11 @@ class ArticlePublishingCoordinator extends BaseCoordinator
     public function __construct(
         private ArticleRepository $repository,
         private CategoryGateway $categoryGateway,
-        private CurrentUserGateway $currentUserGateway
+        private CurrentUserGateway $currentUserGateway,
+        private ViewerGateway $viewerGateway,
     ) {}
 
-    public function create(CreateArticleDTO $data): Article
+    public function create(CreateArticleDTO $data): ArticleVisibility
     {
         CompositePolicy::allOf([
             new GlobalPermissionPolicy('publish_article'),
@@ -48,7 +52,9 @@ public function create(CreateArticleDTO $data): Article
 
         $this->dispatchDomainEvents($article);
 
-        return $article;
+        $viewer = $this->viewerGateway->getCurrentViewer();
+
+        return (new VisibilityPolicy($viewer))->fromArticle($article);
     }
 
     private function createDraft(CreateArticleDTO $data, AuthorId $authorId): Article
@@ -93,17 +99,29 @@ public function publishDraft(int $id): void
         $this->dispatchDomainEvents($article);
     }
 
-    public function getArticle(int $id): Article
+    public function getArticle(int $id): ArticleVisibility
     {
-        return $this->repository->getById(ArticleId::fromInt($id));
+        $article = $this->repository->getById(ArticleId::fromInt($id));
+
+        $viewer = $this->viewerGateway->getCurrentViewer();
+
+        return (new VisibilityPolicy($viewer))->fromArticle($article);
     }
 
     public function getArticleList(GetArticleListDTO $data): LengthAwarePaginator
     {
-        return $this->repository->paginate($data->page, $data->perPage, $data->toCriteria());
+        $viewer = $this->viewerGateway->getCurrentViewer();
+
+        $paginator = $this->repository->paginate($data->page, $data->perPage, $data->toCriteria());
+
+        $paginator->getCollection()->transform(function (Article $article) use ($viewer) {
+            return (new VisibilityPolicy($viewer))->fromArticle($article);
+        });
+
+        return $paginator;
     }
 
-    public function updateArticle(int $id, UpdateArticleDTO $data): Article
+    public function updateArticle(int $id, UpdateArticleDTO $data): ArticleVisibility
     {
         CompositePolicy::allOf([
             new GlobalPermissionPolicy('publish_article'),
@@ -123,10 +141,12 @@ public function updateArticle(int $id, UpdateArticleDTO $data): Article
 
         $this->dispatchDomainEvents($article);
 
-        return $article;
+        $viewer = $this->viewerGateway->getCurrentViewer();
+
+        return (new VisibilityPolicy($viewer))->fromArticle($article);
     }
 
-    public function archiveArticle(int $id)
+    public function archiveArticle(int $id): ArticleVisibility
     {
         CompositePolicy::allOf([
             new GlobalPermissionPolicy('publish_article'),
@@ -137,10 +157,12 @@ public function archiveArticle(int $id)
         $article->archive();
         $this->repository->update($article);
 
-        return $article;
+        $viewer = $this->viewerGateway->getCurrentViewer();
+
+        return (new VisibilityPolicy($viewer))->fromArticle($article);
     }
 
-    public function deleteArticle(int $id)
+    public function deleteArticle(int $id): ArticleVisibility
     {
         CompositePolicy::allOf([
             new GlobalPermissionPolicy('publish_article'),
@@ -151,6 +173,8 @@ public function deleteArticle(int $id)
 
         $this->repository->delete($article);
 
-        return $article;
+        $viewer = $this->viewerGateway->getCurrentViewer();
+
+        return (new VisibilityPolicy($viewer))->fromArticle($article);
     }
 }

contexts/ArticlePublishing/Domain/Gateway/ViewerGateway.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Contexts\ArticlePublishing\Domain\Gateway;
+
+use Contexts\ArticlePublishing\Domain\Models\ArticleViewer;
+
+interface ViewerGateway
+{
+    public function getCurrentViewer(): ArticleViewer;
+}

contexts/ArticlePublishing/Domain/Models/ArticleViewer.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Contexts\ArticlePublishing\Domain\Models;
+
+use Contexts\Shared\ValueObjects\Viewer;
+
+class ArticleViewer extends Viewer {}

contexts/ArticlePublishing/Domain/Models/ArticleVisibility.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Contexts\ArticlePublishing\Domain\Models;
+
+use Carbon\CarbonImmutable;
+
+class ArticleVisibility
+{
+    public function __construct(
+        private int $id,
+        private string $title,
+        private string $body,
+        private string $status,
+        private array $categories,
+        private int $authorId,
+        private ?CarbonImmutable $created_at = null,
+        private ?CarbonImmutable $updated_at = null
+    ) {}
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    public function getBody(): string
+    {
+        return $this->body;
+    }
+
+    public function getStatus(): string
+    {
+        return $this->status;
+    }
+
+    public function getCategories(): array
+    {
+        return $this->categories;
+    }
+
+    public function getAuthorId(): int
+    {
+        return $this->authorId;
+    }
+
+    public function getCreatedAt(): ?CarbonImmutable
+    {
+        return $this->created_at;
+    }
+
+    public function getUpdatedAt(): ?CarbonImmutable
+    {
+        return $this->updated_at;
+    }
+}

contexts/ArticlePublishing/Infrastructure/Adapters/ViewerAdapter.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Contexts\ArticlePublishing\Infrastructure\Adapters;
+
+use Contexts\ArticlePublishing\Domain\Gateway\ViewerGateway;
+use Contexts\ArticlePublishing\Domain\Models\ArticleViewer;
+use Contexts\Authorization\Contracts\V1\Services\CurrentUserService;
+use Contexts\Shared\ValueObjects\ViewerId;
+use Contexts\Shared\ValueObjects\ViewerRoleCollection;
+
+class ViewerAdapter implements ViewerGateway
+{
+    public function __construct(
+        private CurrentUserService $currentUserService
+    ) {}
+
+    public function getCurrentViewer(): ArticleViewer
+    {
+        $currentUser = $this->currentUserService->getCurrentUser();
+        $roleCollection = ViewerRoleCollection::fromPlainArray($currentUser->roles);
+
+        return new ArticleViewer(
+            ViewerId::fromInt($currentUser->id),
+            $currentUser->displayName,
+            $currentUser->email,
+            $roleCollection
+        );
+    }
+}

contexts/ArticlePublishing/Infrastructure/Repositories/ArticleRepository.php

@@ -10,8 +10,8 @@
 use Contexts\ArticlePublishing\Domain\Models\ArticleId;
 use Contexts\ArticlePublishing\Domain\Models\ArticleStatus;
 use Contexts\ArticlePublishing\Infrastructure\Records\ArticleRecord;
-use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Facades\DB;
 
 class ArticleRepository

contexts/ArticlePublishing/Infrastructure/ServiceProvider.php

@@ -8,9 +8,11 @@
 use Contexts\ArticlePublishing\Domain\Gateway\AuthorizationGateway;
 use Contexts\ArticlePublishing\Domain\Gateway\CategoryGateway;
 use Contexts\ArticlePublishing\Domain\Gateway\CurrentUserGateway;
+use Contexts\ArticlePublishing\Domain\Gateway\ViewerGateway;
 use Contexts\ArticlePublishing\Infrastructure\Adapters\AuthorizationAdapter;
 use Contexts\ArticlePublishing\Infrastructure\Adapters\CategoryAdapter;
 use Contexts\ArticlePublishing\Infrastructure\Adapters\CurrentUserAdapter;
+use Contexts\ArticlePublishing\Infrastructure\Adapters\ViewerAdapter;
 use Contexts\ArticlePublishing\Infrastructure\EventListeners\ConsoleOutputListener;
 use Contexts\CategoryManagement\Application\Coordinators\CategoryManagementCoordinator;
 use Illuminate\Foundation\Support\Providers\RouteServiceProvider;
@@ -52,6 +54,7 @@ public function map(): void
 
         $this->app->bind(AuthorizationGateway::class, AuthorizationAdapter::class);
         $this->app->bind(CurrentUserGateway::class, CurrentUserAdapter::class);
+        $this->app->bind(ViewerGateway::class, ViewerAdapter::class);
     }
 
     public function provides(): array

contexts/ArticlePublishing/Presentation/Controllers/ArticlePublishingController.php

@@ -71,7 +71,7 @@ public function archiveArticle(ArticleIdRequest $request)
         $id = (int) ($request->validated()['id']);
         $result = app(ArticlePublishingCoordinator::class)->archiveArticle($id);
 
-        return $this->success(['id' => $result->getId()->getValue()])
+        return $this->success(['id' => $result->getId()])
             ->message('Article archived successfully')
             ->send();
     }
@@ -81,7 +81,7 @@ public function deleteArticle(ArticleIdRequest $request)
         $id = (int) ($request->validated()['id']);
         $result = app(ArticlePublishingCoordinator::class)->deleteArticle($id);
 
-        return $this->success(['id' => $result->getId()->getValue()])
+        return $this->success(['id' => $result->getId()])
             ->message('Article deleted successfully')
             ->send();
     }

contexts/ArticlePublishing/Presentation/Resources/ArticleResource.php

@@ -12,23 +12,23 @@ class ArticleResource extends JsonResource
     public function toArray(Request $request): array
     {
         /**
-         * @var \Contexts\ArticlePublishing\Domain\Models\Article $article
+         * @var \Contexts\ArticlePublishing\Domain\Models\ArticleVisibility $article
          */
         $article = $this->resource;
 
         return [
-            'id' => (int) $article->getId()->getValue(),
+            'id' => (int) $article->getId(),
 
             'title' => (string) $article->getTitle(),
             'body' => (string) $article->getbody(),
-            'status' => (string) $article->getStatus()->getValue(),
-            'categories' => $article->getCategories()->map(fn ($category) => [
-                'id' => $category->getId(),
-                'label' => $category->getLabel(),
-            ])->toArray(),
-            'author_id' => (int) $article->getAuthorId()->getValue(),
+            'status' => (string) $article->getStatus(),
+            'categories' => $article->getCategories(),
+            'author_id' => (int) $article->getAuthorId(),
             'created_at' => $article->getCreatedAt()->format('Y-m-d H:i:s'),
-            'updated_at' => $article->getUpdatedAt()?->format('Y-m-d H:i:s'),
+            'updated_at' => $this->when(
+                (bool) $article->getUpdatedAt(),
+                $article->getUpdatedAt()?->format('Y-m-d H:i:s')
+            ),
         ];
     }
 }