feat: add sorting functionality to article list retrieval

Author: aspirantzhang

contexts/ArticlePublishing/Application/Coordinators/ArticlePublishingCoordinator.php

@@ -120,7 +120,12 @@ public function getArticleList(GetArticleListDTO $data): LengthAwarePaginator
 
         $viewer = $this->viewerGateway->getCurrentViewer();
 
-        $paginator = $this->repository->paginate($data->currentPage, $data->perPage, $data->toCriteria());
+        $paginator = $this->repository->paginate(
+            $data->currentPage,
+            $data->perPage,
+            $data->toCriteria(),
+            $data->toSorting()
+        );
 
         $paginator->getCollection()->transform(function (Article $article) use ($viewer) {
             return (new VisibilityPolicy($viewer))->fromArticle($article);

contexts/ArticlePublishing/Application/DTOs/GetArticleListDTO.php

@@ -4,8 +4,12 @@
 
 namespace Contexts\ArticlePublishing\Application\DTOs;
 
-class GetArticleListDTO
+use Contexts\Shared\Application\BaseGetListDTO;
+
+class GetArticleListDTO extends BaseGetListDTO
 {
+    protected const ALLOWED_SORT_FIELDS = ['id', 'created_at'];
+
     public function __construct(
         public readonly ?string $id,
         public readonly ?string $title,
@@ -15,22 +19,31 @@ public function __construct(
         public readonly ?array $createdAtRange,
         public readonly int $currentPage,
         public readonly int $perPage,
+        public readonly ?array $sorting
     ) {}
 
     public static function fromRequest(array $data): self
     {
+        $merged = array_merge($data, self::convertFiltersToCriteria($data['filters'] ?? []));
+
         return new self(
-            $data['id'] ?? null,
-            $data['title'] ?? null,
-            $data['status'] ?? null,
-            $data['category_id'] ?? null,
-            $data['author_id'] ?? null,
-            $data['created_at_range'] ?? null,
-            $data['current_page'] ?? 1,
-            $data['per_page'] ?? 10,
+            $merged['id'] ?? null,
+            $merged['title'] ?? null,
+            $merged['status'] ?? null,
+            $merged['category_id'] ?? null,
+            $merged['author_id'] ?? null,
+            $merged['created_at_range'] ?? null,
+            $merged['current_page'] ?? 1,
+            $merged['per_page'] ?? 10,
+            self::normalizeAndFilterSorting($merged)
         );
     }
 
+    public function toSorting(): array
+    {
+        return $this->sorting;
+    }
+
     public function toCriteria(): array
     {
         return [

contexts/ArticlePublishing/Domain/Repositories/ArticleRepository.php

@@ -16,7 +16,7 @@ public function getById(ArticleId $articleId): Article;
 
     public function update(Article $article): Article;
 
-    public function paginate(int $currentPage = 1, int $perPage = 10, array $criteria = []): LengthAwarePaginator;
+    public function paginate(int $currentPage = 1, int $perPage = 10, array $criteria = [], array $sorting = []): LengthAwarePaginator;
 
     public function delete(Article $article): void;
 }

contexts/ArticlePublishing/Infrastructure/Factories/ArticleFactory.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Contexts\Authorization\Infrastructure\Factories;
+namespace Contexts\ArticlePublishing\Infrastructure\Factories;
 
 use Contexts\ArticlePublishing\Infrastructure\Records\ArticleRecord;
 use Illuminate\Database\Eloquent\Factories\Factory;

contexts/ArticlePublishing/Infrastructure/Persistence/ArticlePersistence.php

@@ -71,9 +71,12 @@ public function update(Article $article): Article
         return $record->toDomain($article->getEvents());
     }
 
-    public function paginate(int $currentPage = 1, int $perPage = 10, array $criteria = []): LengthAwarePaginator
+    public function paginate(int $currentPage = 1, int $perPage = 10, array $criteria = [], array $sorting = []): LengthAwarePaginator
     {
-        $paginator = ArticleRecord::query()->search($criteria)->paginate($perPage, ['*'], 'current_page', $currentPage);
+        $paginator = ArticleRecord::query()
+            ->search($criteria)
+            ->sorting($sorting)
+            ->paginate($perPage, ['*'], 'current_page', $currentPage);
 
         $paginator->getCollection()->transform(function ($record) {
             return $record->toDomain();

contexts/ArticlePublishing/Infrastructure/Records/ArticleRecord.php

@@ -11,11 +11,13 @@
 use Contexts\ArticlePublishing\Domain\Models\ArticleId;
 use Contexts\ArticlePublishing\Domain\Models\ArticleStatus;
 use Contexts\ArticlePublishing\Domain\Models\AuthorId;
-use Contexts\Authorization\Infrastructure\Factories\ArticleFactory;
+use Contexts\ArticlePublishing\Infrastructure\Factories\ArticleFactory;
 use Contexts\CategoryManagement\Infrastructure\Records\CategoryRecord;
 use Contexts\Shared\Infrastructure\BaseRecord;
+use Contexts\Shared\Infrastructure\Traits\HasSortingScopeTrait;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Carbon;
 
@@ -30,6 +32,8 @@
  */
 class ArticleRecord extends BaseRecord
 {
+    use HasFactory;
+    use HasSortingScopeTrait;
     use SoftDeletes;
 
     protected $table = 'articles';

contexts/ArticlePublishing/Presentation/Requests/GetArticleListRequest.php

@@ -4,9 +4,9 @@
 
 namespace Contexts\ArticlePublishing\Presentation\Requests;
 
-use Contexts\Shared\Presentation\Requests\BaseRequest;
+use Contexts\Shared\Presentation\Requests\BaseListRequest;
 
-class GetArticleListRequest extends BaseRequest
+class GetArticleListRequest extends BaseListRequest
 {
     public function rules(): array
     {
@@ -16,10 +16,11 @@ public function rules(): array
             'status' => ['string', 'in:draft,published'],
             'category_id' => ['integer', 'gt:0'],
             'author_id' => ['integer', 'gt:0'],
-            'created_at_range' => ['array', 'size:2'],
-            'created_at_range.*' => ['date'],
-            'current_page' => ['integer', 'gt:0'],
-            'per_page' => ['integer', 'gt:0'],
+            'created_at' => ['array', 'size:2'],
+            'created_at.*' => ['date_format:Y-m-d'],
+            ...$this->paginationRule(),
+            ...$this->filtersRule(),
+            ...$this->sortingRule(),
         ];
     }
 }

contexts/ArticlePublishing/Tests/Feature/ArticlePublishingTest.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Contexts\ArticlePublishing\Domain\Events\ArticlePublishedEvent;
+use Contexts\ArticlePublishing\Infrastructure\Records\ArticleRecord;
 use Contexts\Authorization\Domain\Policies\RolePolicy;
 use Contexts\CategoryManagement\Infrastructure\Records\CategoryRecord;
 
@@ -143,6 +144,31 @@
     $response->assertStatus(200);
 });
 
+it('can get a list of articles with sorting via api', function () {
+    $initialCount = ArticleRecord::count();
+
+    $articles = ArticleRecord::factory(3)->create();
+    $articles->each(function ($article) {
+        $article->categories()->attach($this->categories->pluck('id')->toArray());
+    });
+
+    $response = $this->get('articles?sorting=[{"id":"id","desc":false}]');
+
+    $response->assertStatus(200);
+    $response->assertJsonCount(3 + $initialCount, 'data');
+
+    $responseIds = collect($response->json('data'))->pluck('id')->all();
+    $sortedIds = collect($responseIds)->sort()->values()->all();
+    expect($responseIds)->toBe($sortedIds);
+
+    $response = $this->get('articles?sorting=[{"id":"id","desc":true}]');
+    $response->assertStatus(200);
+
+    $responseIds = collect($response->json('data'))->pluck('id')->all();
+    $sortedIds = collect($responseIds)->sortDesc()->values()->all();
+    expect($responseIds)->toBe($sortedIds);
+});
+
 it('can update an article via api', function () {
 
     $response = $this->postJson('articles', [