Merge pull request #37 from WendellAdriel/feature/new-dtos

ResourceDTO and Wireable Trait

Author: WendellAdriel

README.md

@@ -17,7 +17,7 @@
     <a href="#features">Features</a> |
     <a href="#installation">Installation</a> |
     <a href="#generating-dtos">Generating DTOs</a> |
-    <a href="#simple-dtos">Simple DTOs</a> |
+    <a href="#more-dtos">More DTOs</a> |
     <a href="#credits">Credits</a> |
     <a href="#contributing">Contributing</a>
 </p>
@@ -37,6 +37,8 @@
 - Support casting of **nested data**
 - Easily create **custom Type Casters** for your own needs
 - Custom Data Mapping
+- Use DTOs for wrapping, typing and transforming API responses
+- **[Laravel Livewire](https://laravel-livewire.com/)** support
 
 ## Installation
 
@@ -955,8 +957,9 @@ class AttributesDTO extends ValidatedDTO
     }
 }
 ```
+## More DTOs
 
-## Simple DTOs
+### Simple DTOs
 
 If you don't need to validate the data, you can use the `SimpleDTO` class instead of the `ValidatedDTO` class.
 The DTOs created with this class will not validate the data, but will still have all the other features of the `ValidatedDTO` class:
@@ -1008,6 +1011,71 @@ To generate a `SimpleDTO` you can use the `--simple` flag:
 php artisan make:dto SimpleUserDTO --simple
 ```
 
+### Resource DTOs
+
+If you want to use DTOs to wrap, type and transform your API responses, you can use the `ResourceDTO` class.
+This class will have the same features as the `SimpleDTO` class and will implement the `Illuminate\Contracts\Support\Responsable` interface:
+
+```php
+class UserResourceDTO extends ResourceDTO
+{
+    public string $name;
+
+    public string $email;
+
+    public int $age;
+
+    // Your DTO methods...
+}
+```
+
+Then you can return your DTOs from your controllers:
+
+```php
+class UserController extends Controller
+{
+    public function show(int $id)
+    {
+        return UserResourceDTO::fromModel(User::findOrFail($id));
+    }
+}
+```
+
+You can also return a collection/list of your DTOs as a response using the `ResourceDTO::collection()` method:
+
+```php
+class UserController extends Controller
+{
+    public function index()
+    {
+        return UserResourceDTO::collection(User::all());
+    }
+}
+```
+
+This way every item in the collection will be converted to a `UserResourceDTO` instance before sending
+the response to the client, using all the typing, casting and mapping features of your DTO class.
+
+To generate a `ResourceDTO` you can use the `--resource` flag:
+
+```bash
+php artisan make:dto UserResourceDTO --resource
+```
+
+### Wireable DTOS
+
+If you're using **[Laravel Livewire](https://laravel-livewire.com/)**, you can turn your DTOs into **wireable** DTOs
+by adding the `WendellAdriel\ValidatedDTO\Concerns\Wireable` trait to your DTOs:
+
+```php
+class UserDTO extends ValidatedDTO
+{
+    use Wireable;
+
+    // Your DTO code...
+}
+```
+
 ## Credits
 
 - [Wendell Adriel](https://github.com/WendellAdriel)

config/dto.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
     /*
     |--------------------------------------------------------------------------

pint.json

@@ -1,6 +1,26 @@
 {
     "preset": "laravel",
     "rules": {
+        "array_push": true,
+        "assign_null_coalescing_to_coalesce_equal": true,
+        "combine_consecutive_issets": true,
+        "combine_consecutive_unsets": true,
+        "concat_space": {
+            "spacing": "one"
+        },
+        "declare_strict_types": true,
+        "explicit_indirect_variable": true,
+        "explicit_string_variable": true,
+        "global_namespace_import": true,
+        "method_argument_space": {
+            "on_multiline": "ensure_fully_multiline"
+        },
+        "modernize_strpos": true,
+        "modernize_types_casting": true,
+        "new_with_braces": true,
+        "no_superfluous_elseif": true,
+        "no_useless_else": true,
+        "nullable_type_declaration_for_default_null_value": true,
         "ordered_imports": {
             "sort_algorithm": "alpha"
         },
@@ -28,6 +48,9 @@
                 "method_private"
             ],
             "sort_algorithm": "none"
-        }
+        },
+        "strict_comparison": true,
+        "ternary_to_null_coalescing": true,
+        "use_arrow_functions": true
     }
-}
+}

src/Casting/ArrayCast.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace WendellAdriel\ValidatedDTO\Casting;
 
 class ArrayCast implements Castable

src/Casting/BooleanCast.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace WendellAdriel\ValidatedDTO\Casting;
 
 class BooleanCast implements Castable
@@ -14,6 +16,6 @@ public function cast(string $property, mixed $value): bool
             return filter_var($value, FILTER_VALIDATE_BOOLEAN);
         }
 
-        return boolval($value);
+        return (bool) $value;
     }
 }

src/Casting/CarbonCast.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace WendellAdriel\ValidatedDTO\Casting;
 
 use Carbon\Carbon;

src/Casting/CarbonImmutableCast.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace WendellAdriel\ValidatedDTO\Casting;
 
 use Carbon\CarbonImmutable;

src/Casting/Castable.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace WendellAdriel\ValidatedDTO\Casting;
 
 interface Castable

src/Casting/CollectionCast.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace WendellAdriel\ValidatedDTO\Casting;
 
 use Illuminate\Support\Collection;
@@ -16,8 +18,6 @@ public function cast(string $property, mixed $value): Collection
         $value = $arrayCast->cast($property, $value);
 
         return Collection::make($value)
-            ->when($this->type, function ($collection, $castable) use ($property) {
-                return $collection->map(fn ($item) => $castable->cast($property, $item));
-            });
+            ->when($this->type, fn ($collection, $castable) => $collection->map(fn ($item) => $castable->cast($property, $item)));
     }
 }

src/Casting/DTOCast.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace WendellAdriel\ValidatedDTO\Casting;
 
 use Illuminate\Validation\ValidationException;