Dev/3.2.0 (#2)

* Added generating snake_case array field names based on DTOs field names in StraightKeyParser

* Updated CHANGELOG.md

* Rebuilt StraightKeyParser

* Updated tests after RDTO update

* DTO updated to v3

Author: grixu

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to `api-client` will be documented in this file
 
+## 3.2.0 - 2021-04-29
+
+- Use snake_case naming convention in results data array instead of camelCase
+- Updated DTO to v3
+
 ## 3.1.2 - 2021-03-30
 
 - New StraightKeyParser
@@ -26,7 +31,8 @@ All notable changes to `api-client` will be documented in this file
 - Huge rebuild package both in concept and code layer.
 - Uses PHP8, dropped PHP 7.4 compatibility.
 - More concentrated on delivery flexible package that could be use directly in apps rather than in other packages
-- Made interfaces & classes for configuration, authorization, data fetching, containing & parsing to final classes delivered by user
+- Made interfaces & classes for configuration, authorization, data fetching, containing & parsing to final classes
+  delivered by user
 - Prepared classes for config, url creating & fetching data from JSON API
 
 ## 2.0.1 - 2021-01-20

composer.json

@@ -25,7 +25,7 @@
         "spatie/laravel-enum": "^2.2"
     },
     "require-dev": {
-        "spatie/data-transfer-object": "^2.8",
+        "spatie/data-transfer-object": "^3.1",
         "orchestra/testbench": "^6.0",
         "phpunit/phpunit": "^9.4"
     },

src/Data/StraightKeyParser.php

@@ -2,10 +2,9 @@
 
 namespace Grixu\ApiClient\Data;
 
-use ErrorException;
 use Grixu\ApiClient\Contracts\ResponseParser;
-use Illuminate\Support\Carbon;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
 use ReflectionClass;
 use ReflectionProperty;
 
@@ -42,23 +41,31 @@ protected function parseElement(array $input): array
         $data = [];
 
         foreach ($this->fields as $field) {
-            /** @var ReflectionProperty $field */
-            $type = $field->getType()->getName();
-            $fieldName = $field->getName();
-
-            try {
-                if (str_contains($type, 'Enum')) {
-                    $data[$fieldName] = new $type($input[$fieldName]);
-                } elseif ($type === 'Illuminate\Support\Carbon') {
-                    $data[$fieldName] = Carbon::createFromTimeString($input[$fieldName]);
-                } else {
-                    $data[$fieldName] = $input[$fieldName];
-                }
-            } catch (ErrorException) {
-                $data[$fieldName] = null;
+            $dtoFieldName = $field->getName();
+            $arrayFieldName = Str::snake($dtoFieldName);
+
+            if ($dtoFieldName === 'relationships') {
+                $data[$dtoFieldName] = $this->parseRelationship($input[$arrayFieldName]);
+            } else {
+                $data[$dtoFieldName] = $input[$arrayFieldName] ?? null;
             }
         }
 
         return $data;
     }
+
+    protected function parseRelationship(array $inputRelationships): array
+    {
+        $relationships = [];
+
+        foreach ($inputRelationships as $input) {
+            $relationship = [];
+            foreach ($input as $key => $value) {
+                $relationship[Str::camel($key)] = $value;
+            }
+            $relationships[] = $relationship;
+        }
+
+        return $relationships;
+    }
 }

tests/Helpers/CarbonCaster.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Grixu\ApiClient\Tests\Helpers;
+
+use Illuminate\Support\Carbon;
+use Spatie\DataTransferObject\Caster;
+
+class CarbonCaster implements Caster
+{
+    public function cast(mixed $value): Carbon
+    {
+        return Carbon::createFromTimeString($value);
+    }
+}

tests/Helpers/ExampleDto.php

@@ -3,14 +3,20 @@
 namespace Grixu\ApiClient\Tests\Helpers;
 
 use Illuminate\Support\Carbon;
+use Spatie\DataTransferObject\Attributes\CastWith;
 use Spatie\DataTransferObject\DataTransferObject;
 
 class ExampleDto extends DataTransferObject
 {
     public string $first;
     public string $second;
     public string $third;
-    public ?Carbon $date;
-    public ?FakeEnum $enum;
-    public ?int $id;
+
+    #[CastWith(CarbonCaster::class)]
+    public Carbon|null $date;
+
+    #[CastWith(FakeEnumCaster::class)]
+    public FakeEnum|null $enum;
+
+    public int|null $id;
 }

tests/Helpers/FakeEnum.php

@@ -2,9 +2,17 @@
 
 namespace Grixu\ApiClient\Tests\Helpers;
 
+use JetBrains\PhpStorm\Pure;
+
 class FakeEnum
 {
     public function __construct(public string $value)
     {
     }
+
+    #[Pure]
+    public static function make(mixed $value): static
+    {
+        return new static($value);
+    }
 }

tests/Helpers/FakeEnumCaster.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Grixu\ApiClient\Tests\Helpers;
+
+use Spatie\DataTransferObject\Caster;
+
+class FakeEnumCaster implements Caster
+{
+    public function cast(mixed $value): FakeEnum
+    {
+        if ($value instanceof FakeEnum) return $value;
+
+        return FakeEnum::make($value);
+    }
+}