Merge pull request #380 from bastien-phi/form_request_normalizer

Introduce FormRequestNormalizer

config/data.php

@@ -47,6 +47,7 @@
      */
     'normalizers' => [
         Spatie\LaravelData\Normalizers\ModelNormalizer::class,
+        // Spatie\LaravelData\Normalizers\FormRequestNormalizer::class,
         Spatie\LaravelData\Normalizers\ArrayableNormalizer::class,
         Spatie\LaravelData\Normalizers\ObjectNormalizer::class,
         Spatie\LaravelData\Normalizers\ArrayNormalizer::class,

src/Normalizers/FormRequestNormalizer.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spatie\LaravelData\Normalizers;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class FormRequestNormalizer implements Normalizer
+{
+    public function normalize(mixed $value): ?array
+    {
+        if (! $value instanceof FormRequest) {
+            return null;
+        }
+
+        return $value->validated();
+    }
+}

tests/Fakes/DataWithNullable.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Spatie\LaravelData\Tests\Fakes;
+
+use Spatie\LaravelData\Data;
+
+class DataWithNullable extends Data
+{
+    public function __construct(
+        public string $string,
+        public ?string $nullableString,
+    ) {
+    }
+}

tests/Normalizers/FormRequestNormalizerTest.php

@@ -0,0 +1,56 @@
+<?php
+
+use Illuminate\Foundation\Http\FormRequest;
+use Spatie\LaravelData\Normalizers\FormRequestNormalizer;
+use Spatie\LaravelData\Tests\Fakes\DataWithNullable;
+
+beforeEach(function () {
+    config()->set('data.normalizers', [FormRequestNormalizer::class]);
+});
+
+it('can create a data object from FormRequest', function () {
+    $request = new class () extends FormRequest {
+        public function rules(): array
+        {
+            return [
+                'string' => 'required|string',
+                'nullableString' => 'nullable|string',
+            ];
+        }
+    };
+    $request
+        ->replace([
+            'string' => 'Hello',
+            'nullableString' => 'World',
+        ])
+        ->setContainer(app())
+        ->validateResolved();
+
+    $originalData = new DataWithNullable('Hello', 'World');
+    $createdData = DataWithNullable::from($request);
+
+    expect($createdData)->toEqual($originalData);
+});
+
+it("excludes unsafe data", function () {
+    $request = new class () extends FormRequest {
+        public function rules(): array
+        {
+            return [
+                'string' => 'required|string',
+            ];
+        }
+    };
+    $request
+        ->replace([
+            'string' => 'Hello',
+            'nullableString' => 'World',
+        ])
+        ->setContainer(app())
+        ->validateResolved();
+
+    $originalData = new DataWithNullable('Hello', null);
+    $createdData = DataWithNullable::from($request);
+
+    expect($createdData)->toEqual($originalData);
+});