feat: implement publishDraft functionality and related request validation for article publishing

Author: aspirantzhang

app/Http/Requests/BaseFormRequest.php

@@ -6,4 +6,11 @@
 
 use Illuminate\Foundation\Http\FormRequest;
 
-class BaseFormRequest extends FormRequest {}
+class BaseFormRequest extends FormRequest
+{
+    protected function prepareForValidation()
+    {
+        parent::prepareForValidation();
+        $this->route('id') && $this->merge(['id' => $this->route('id')]);
+    }
+}

contexts/ArticlePublishing/Application/Coordinators/ArticlePublishingCoordinator.php

@@ -53,11 +53,15 @@ private function createPublished(CreateArticleDTO $data): Article
         return $this->repository->create($article);
     }
 
-    // TODO
-    // public function publishDraft(ArticleId $id): void
-    // {
+    public function publishDraft(int $id): void
+    {
+        $article = $this->repository->getById(new ArticleId($id));
+        $article->publish();
+
+        $this->repository->update($article);
 
-    // }
+        $this->dispatchDomainEvents($article);
+    }
 
     private function dispatchDomainEvents(Article $article): void
     {

contexts/ArticlePublishing/Infrastructure/Records/ArticleRecord.php

@@ -48,7 +48,7 @@ public static function mapStatusToRecord(ArticleStatus $status): int
         return array_search($status->getValue(), self::STATUS_MAPPING);
     }
 
-    public function toDomain(array $events): Article
+    public function toDomain(array $events = []): Article
     {
         return Article::reconstitute(
             new ArticleId($this->id),

contexts/ArticlePublishing/Infrastructure/Repositories/ArticleRepository.php

@@ -5,6 +5,7 @@
 namespace Contexts\ArticlePublishing\Infrastructure\Repositories;
 
 use Contexts\ArticlePublishing\Domain\Models\Article;
+use Contexts\ArticlePublishing\Domain\Models\ArticleId;
 use Contexts\ArticlePublishing\Infrastructure\Records\ArticleRecord;
 
 class ArticleRepository
@@ -20,4 +21,25 @@ public function create(Article $article): Article
 
         return $record->toDomain($article->getDomainEvents());
     }
+
+    public function getById(ArticleId $articleId): Article
+    {
+        $record = ArticleRecord::findOrFail($articleId->value);
+
+        return $record->toDomain();
+    }
+
+    public function update(Article $article): Article
+    {
+        $record = ArticleRecord::findOrFail($article->id->value);
+
+        $record->update([
+            'title' => $article->getTitle(),
+            'body' => $article->getbody(),
+            'status' => ArticleRecord::mapStatusToRecord($article->getStatus()),
+            'created_at' => $article->getCreatedAt(),
+        ]);
+
+        return $record->toDomain($article->getDomainEvents());
+    }
 }

contexts/ArticlePublishing/Infrastructure/Routes.php

@@ -8,5 +8,6 @@
 Route::middleware([])->name('ArticlePublishing.')->group(function () {
     Route::controller(ArticlePublishingController::class)->prefix('articles')->name('ArticlePublishing.')->group(function () {
         Route::post('', 'createArticle')->name('createArticle');
+        Route::put('{id}/publish', 'publishDraft')->name('publishDraft');
     });
 });

contexts/ArticlePublishing/Presentation/Controllers/ArticlePublishingController.php

@@ -9,6 +9,7 @@
 use Contexts\ArticlePublishing\Application\Coordinators\ArticlePublishingCoordinator;
 use Contexts\ArticlePublishing\Presentation\Resources\ArticleResource;
 use Contexts\ArticlePublishing\Application\DTOs\CreateArticleDTO;
+use Contexts\ArticlePublishing\Presentation\Requests\PublishDraftRequest;
 
 class ArticlePublishingController extends BaseController
 {
@@ -18,6 +19,16 @@ public function createArticle(CreateArticleRequest $request)
             CreateArticleDTO::fromRequest($request->validated())
         );
 
-        return $this->success($result, ArticleResource::class)->send(201);
+        return $this->success($result, ArticleResource::class)
+                    ->message('Article created successfully')
+                    ->send(201);
+    }
+
+    public function publishDraft(PublishDraftRequest $request)
+    {
+        $id = (int)($request->validated()['id']);
+        app(ArticlePublishingCoordinator::class)->publishDraft($id);
+
+        return $this->success('Article published successfully')->send();
     }
 }

contexts/ArticlePublishing/Presentation/Requests/PublishDraftRequest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Contexts\ArticlePublishing\Presentation\Requests;
+
+use App\Http\Requests\BaseFormRequest;
+
+class PublishDraftRequest extends BaseFormRequest
+{
+    public function rules(): array
+    {
+        return [
+            'id' => ['required', 'integer', 'gt:0', 'exists:articles,id'],
+        ];
+    }
+}

contexts/ArticlePublishing/Tests/Feature/ArticlePublishingTest.php

@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Contexts\ArticlePublishing\Domain\Events\ArticlePublishedEvent;
-use Contexts\ArticlePublishing\Infrastructure\EventListeners\ConsoleOutputListener;
 
 it('can publish aritcle drafts via api', function () {
     $response = $this->postJson('articles', [
@@ -36,3 +35,19 @@
 
     Event::assertDispatched(ArticlePublishedEvent::class);
 });
+
+it('can publish a draft article', function () {
+    $response = $this->postJson('articles', [
+        'title' => 'My Article',
+        'body' => 'This is my article body',
+        'status' => 'draft',
+    ]);
+
+    $response->assertStatus(201);
+
+    $id = $response->json('data.id');
+
+    $response = $this->putJson("articles/{$id}/publish");
+
+    $response->assertStatus(200);
+});

contexts/ArticlePublishing/Tests/Feature/Infrastructure/Repositories/ArticleRepositoryTest.php

@@ -34,3 +34,51 @@
         'status' => ArticleRecord::mapStatusToRecord(ArticleStatus::published()),
     ]);
 });
+
+
+it('can retrieve an article by ID', function () {
+    // Create a test article in the database
+    $createdArticle = Article::createDraft(new ArticleId(0), 'Test Article', 'Test Content', new CarbonImmutable());
+    $articleRepository = new ArticleRepository();
+    $savedArticle = $articleRepository->create($createdArticle);
+
+    // Retrieve the article using getById
+    $retrievedArticle = $articleRepository->getById($savedArticle->id);
+
+    // Assert the retrieved article matches the created one
+    expect($retrievedArticle->id->value)->toBe($savedArticle->id->value);
+    expect($retrievedArticle->getTitle())->toBe('Test Article');
+    expect($retrievedArticle->getBody())->toBe('Test Content');
+    expect($retrievedArticle->getStatus()->equals(ArticleStatus::draft()))->toBeTrue();
+});
+
+it('can update an article', function () {
+    // Create a test article in the database
+    $createdArticle = Article::createDraft(new ArticleId(0), 'Original Title', 'Original Content', new CarbonImmutable());
+    $articleRepository = new ArticleRepository();
+    $savedArticle = $articleRepository->create($createdArticle);
+
+    // Create an updated version of the article
+    $updatedArticle = Article::createPublished(
+        $savedArticle->id,
+        'Updated Title',
+        'Updated Content',
+        new CarbonImmutable()
+    );
+
+    // Update the article
+    $result = $articleRepository->update($updatedArticle);
+
+    // Verify database was updated
+    $this->assertDatabaseHas('articles', [
+        'id' => $savedArticle->id->value,
+        'title' => 'Updated Title',
+        'body' => 'Updated Content',
+        'status' => ArticleRecord::mapStatusToRecord(ArticleStatus::published()),
+    ]);
+
+    // Verify returned object reflects updates
+    expect($result->getTitle())->toBe('Updated Title');
+    expect($result->getBody())->toBe('Updated Content');
+    expect($result->getStatus()->equals(ArticleStatus::published()))->toBeTrue();
+});

contexts/ArticlePublishing/Tests/Feature/Requests/PublishDraftRequestTest.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+it('[smoke test] id must greater than 0', function () {
+    $response = $this->putJson('articles/-1/publish');
+
+    $this->assertValidationError($response, 'id', 'greater than');
+});