Add collection method to ResourceDTO

Author: WendellAdriel

src/ResourceDTO.php

@@ -7,6 +7,7 @@
 use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Http\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
+use WendellAdriel\ValidatedDTO\Support\ResourceCollection;
 
 abstract class ResourceDTO extends SimpleDTO implements Responsable
 {
@@ -21,6 +22,11 @@ public function __construct(?array $data = null, int $status = 200, array $heade
         $this->headers = $headers;
     }
 
+    public static function collection(array $data, int $status = 200, array $headers = []): ResourceCollection
+    {
+        return new ResourceCollection($data, static::class, $status, $headers);
+    }
+
     /**
      * @param  Request  $request
      */

src/Support/ResourceCollection.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WendellAdriel\ValidatedDTO\Support;
+
+use Illuminate\Contracts\Support\Responsable;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Validation\ValidationException;
+use Symfony\Component\HttpFoundation\Request;
+use WendellAdriel\ValidatedDTO\Casting\DTOCast;
+use WendellAdriel\ValidatedDTO\Exceptions\CastException;
+use WendellAdriel\ValidatedDTO\Exceptions\CastTargetException;
+
+/**
+ * @internal
+ */
+class ResourceCollection implements Responsable
+{
+    public function __construct(
+        private array $data,
+        private string $dtoClass,
+        private int $status = 200,
+        private array $headers = []
+    ) {
+    }
+
+    /**
+     * @param  Request  $request
+     *
+     * @throws CastException|CastTargetException|ValidationException
+     */
+    public function toResponse($request): JsonResponse
+    {
+        $result = [];
+
+        $dtoCast = new DTOCast($this->dtoClass);
+        foreach ($this->data as $item) {
+            $result[] = $dtoCast->cast('', $item)->toArray();
+        }
+
+        return new JsonResponse($result, $this->status, $this->headers);
+    }
+}

tests/Unit/ResourceDTOTest.php

@@ -6,6 +6,7 @@
 use Illuminate\Http\Request;
 use function Pest\Faker\faker;
 use WendellAdriel\ValidatedDTO\ResourceDTO;
+use WendellAdriel\ValidatedDTO\Support\ResourceCollection;
 use WendellAdriel\ValidatedDTO\Tests\Datasets\UserResourceDTO;
 
 beforeEach(function () {
@@ -42,3 +43,47 @@
         ->and($response->getStatusCode())
         ->toBe(201);
 });
+
+it('validates that a ResourceDTO can return a collection of data into a JsonResponse', function () {
+    $list = [
+        ['name' => $this->name, 'age' => $this->age],
+        ['name' => $this->name, 'age' => $this->age],
+        ['name' => $this->name, 'age' => $this->age],
+    ];
+
+    $resourceDTO = UserResourceDTO::collection($list);
+    $response = $resourceDTO->toResponse(new Request());
+
+    expect($resourceDTO)->toBeInstanceOf(ResourceCollection::class)
+        ->and($response)
+        ->toBeInstanceOf(JsonResponse::class)
+        ->and((array) $response->getData())
+        ->toBeArray()
+        ->toHaveCount(3)
+        ->each()
+        ->toHaveProperties(['name', 'age'])
+        ->and($response->getStatusCode())
+        ->toBe(200);
+});
+
+it('validates that a ResourceDTO can return a collection of data into a JsonResponse with custom code', function () {
+    $list = [
+        ['name' => $this->name, 'age' => $this->age],
+        ['name' => $this->name, 'age' => $this->age],
+        ['name' => $this->name, 'age' => $this->age],
+    ];
+
+    $resourceDTO = UserResourceDTO::collection($list, 201);
+    $response = $resourceDTO->toResponse(new Request());
+
+    expect($resourceDTO)->toBeInstanceOf(ResourceCollection::class)
+        ->and($response)
+        ->toBeInstanceOf(JsonResponse::class)
+        ->and((array) $response->getData())
+        ->toBeArray()
+        ->toHaveCount(3)
+        ->each()
+        ->toHaveProperties(['name', 'age'])
+        ->and($response->getStatusCode())
+        ->toBe(201);
+});