Merge pull request #53 from WendellAdriel/fix-dto-transform

Fix issue when transforming DTOs with nested DTOs into array or json

Author: WendellAdriel

src/Concerns/DataResolver.php

@@ -56,7 +56,7 @@ public static function fromModel(Model $model): static
      */
     public static function fromCommandArguments(Command $command): static
     {
-        return new static($command->arguments());
+        return new static(self::filterArguments($command->arguments()));
     }
 
     /**
@@ -72,6 +72,18 @@ public static function fromCommandOptions(Command $command): static
      */
     public static function fromCommand(Command $command): static
     {
-        return new static(array_merge($command->arguments(), $command->options()));
+        return new static(array_merge(self::filterArguments($command->arguments()), $command->options()));
+    }
+
+    private static function filterArguments(array $arguments): array
+    {
+        $result = [];
+        foreach ($arguments as $key => $value) {
+            if (! is_numeric($key)) {
+                $result[$key] = $value;
+            }
+        }
+
+        return $result;
     }
 }

src/SimpleDTO.php

@@ -177,6 +177,7 @@ protected function passedValidation(): void
                 $formatted = $this->shouldReturnNull($key, $value)
                     ? null
                     : $this->castValue($casts[$key], $key, $value);
+
                 $this->{$key} = $formatted;
                 $this->validatedData[$key] = $formatted;
             }
@@ -343,10 +344,6 @@ private function buildDataForExport(): array
 
     private function mapDTOData(array $mapping, array $data): array
     {
-        if (empty($mapping)) {
-            return $data;
-        }
-
         $mappedData = [];
         foreach ($data as $key => $value) {
             $properties = $this->getMappedProperties($mapping, $key);
@@ -364,7 +361,9 @@ private function mapDTOData(array $mapping, array $data): array
                 ? $mapping[$key]
                 : $key;
 
-            $mappedData[$property] = $value;
+            $mappedData[$property] = $this->isArrayable($value)
+                ? $this->formatArrayableValue($value)
+                : $value;
         }
 
         return $mappedData;
@@ -399,15 +398,26 @@ private function isArrayable(mixed $value): bool
 
     private function formatArrayableValue(mixed $value): array
     {
-        if (is_array($value)) {
-            return $value;
-        }
+        return match (true) {
+            is_array($value) => $value,
+            $value instanceof Collection => $value->toArray(),
+            $value instanceof Model => $value->toArray(),
+            $value instanceof SimpleDTO => $this->transformDTOToArray($value),
+            is_object($value) => (array) $value,
+            default => [],
+        };
+    }
 
-        if (is_object($value)) {
-            return (array) $value;
+    private function transformDTOToArray(SimpleDTO $dto): array
+    {
+        $result = [];
+        foreach ($dto->validatedData as $key => $value) {
+            $result[$key] = $this->isArrayable($value)
+                ? $this->formatArrayableValue($value)
+                : $value;
         }
 
-        return $value->toArray();
+        return $result;
     }
 
     private function initConfig(): void

tests/Datasets/UserNestedDTO.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WendellAdriel\ValidatedDTO\Tests\Datasets;
+
+use WendellAdriel\ValidatedDTO\Casting\DTOCast;
+use WendellAdriel\ValidatedDTO\ValidatedDTO;
+
+class UserNestedDTO extends ValidatedDTO
+{
+    public NameDTO $name;
+
+    public string $email;
+
+    protected function rules(): array
+    {
+        return [
+            'name' => ['required', 'array'],
+            'email' => ['required', 'email'],
+        ];
+    }
+
+    protected function defaults(): array
+    {
+        return [];
+    }
+
+    protected function casts(): array
+    {
+        return [
+            'name' => new DTOCast(NameDTO::class),
+        ];
+    }
+}

tests/Unit/ValidatedDTOTest.php

@@ -16,11 +16,13 @@
 use WendellAdriel\ValidatedDTO\Tests\Datasets\NullableDTO;
 use WendellAdriel\ValidatedDTO\Tests\Datasets\User;
 use WendellAdriel\ValidatedDTO\Tests\Datasets\UserDTO;
+use WendellAdriel\ValidatedDTO\Tests\Datasets\UserNestedDTO;
 use WendellAdriel\ValidatedDTO\Tests\Datasets\ValidatedDTOInstance;
 use WendellAdriel\ValidatedDTO\ValidatedDTO;
 
 beforeEach(function () {
     $this->subject_name = fake()->name;
+    $this->subject_email = fake()->unique()->safeEmail;
 });
 
 it('instantiates a ValidatedDTO validating its data', function () {
@@ -218,6 +220,60 @@ public function __invoke()
         ->toBe(json_encode(['name' => $this->subject_name], JSON_PRETTY_PRINT));
 });
 
+it('validates that the ValidatedDTO with nested data can be converted into an array', function () {
+    $validatedDTO = new UserNestedDTO([
+        'name' => [
+            'first_name' => $this->subject_name,
+            'last_name' => 'Doe',
+        ],
+        'email' => $this->subject_email,
+    ]);
+
+    expect($validatedDTO)->toArray()
+        ->toBe([
+            'name' => [
+                'first_name' => $this->subject_name,
+                'last_name' => 'Doe',
+            ],
+            'email' => $this->subject_email,
+        ]);
+});
+
+it('validates that the ValidatedDTO with nested data can be converted into a JSON string', function () {
+    $validatedDTO = new UserNestedDTO([
+        'name' => [
+            'first_name' => $this->subject_name,
+            'last_name' => 'Doe',
+        ],
+        'email' => $this->subject_email,
+    ]);
+
+    expect($validatedDTO)->toJson()
+        ->toBe('{"name":{"first_name":"' . $this->subject_name . '","last_name":"Doe"},"email":"' . $this->subject_email . '"}');
+});
+
+it('validates that the ValidatedDTO with nested data can be converted into a pretty JSON string', function () {
+    $validatedDTO = new UserNestedDTO([
+        'name' => [
+            'first_name' => $this->subject_name,
+            'last_name' => 'Doe',
+        ],
+        'email' => $this->subject_email,
+    ]);
+
+    expect($validatedDTO)->toPrettyJson()
+        ->toBe(json_encode(
+            [
+                'name' => [
+                    'first_name' => $this->subject_name,
+                    'last_name' => 'Doe',
+                ],
+                'email' => $this->subject_email,
+            ],
+            JSON_PRETTY_PRINT
+        ));
+});
+
 it('validates that the ValidatedDTO can be converted into an Eloquent Model', function () {
     $validatedDTO = new ValidatedDTOInstance(['name' => $this->subject_name]);