Fix for validating uploads with a Rules\File::class instance

Author: pascalbaljet

UPGRADING.md

@@ -1,4 +1,10 @@
-# To v0.4
+# Upgrade Guide
+
+## From v0.x to v1.0
+
+If you've published the vendor Blade templates in v0.x, they all ended up in `/resources/views/vendor/splade`. Starting with v1.0, the templates are being published in that folder but are split into a `components` and `functional` subfolder. The `functional` folder won't be published as there's nothing to customize. Check out the [default repository](https://github.com/protonemedia/laravel-splade/tree/main/resources/views) to see the new grouping of the templates.
+
+## To v0.4
 
 * Default data passed to `<x-form>` now requires the `unguarded` attribute when binding an Eloquent Model or Fluent instance. This is not necessary when using the new Form Components.
 * The new Form Components come with Choices.js and Flatpickr integrations. Splade now comes with a default stylesheet to give the libraries some basic styling. This is completely optional, but you probably want to import this default stylesheet into your main JavaScript file:
@@ -11,7 +17,7 @@ import { createApp } from "vue";
 ...
 ```
 
-# To v0.2
+## To v0.2
 
 * There's a new Blade `@spladeHead` directive to support title and meta tags. You may add this directive to your root template.
 * Splade now supports SSR. This is optional, so you may follow the [manual installation guide](https://splade.dev/docs/ssr) to set up SSR.

app/app/Http/Controllers/FilepondController.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers;
 
 use App\Http\Requests\AvatarUpload;
+use App\Http\Requests\AvatarUploadFileRule;
 use Illuminate\Http\Request;
 use Illuminate\Routing\Controller;
 use ProtoneMedia\Splade\FileUploads\HandleSpladeFileUploads;
@@ -67,4 +68,11 @@ public function storeWithFormRequest(AvatarUpload $request)
 
         return redirect()->route('navigation.one');
     }
+
+    public function storeWithFormRequestRuleObject(AvatarUploadFileRule $request)
+    {
+        $request->file('avatar')->storeAs('avatars', 'avatar.jpg');
+
+        return redirect()->route('navigation.one');
+    }
 }

app/app/Http/Requests/AvatarUploadFileRule.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rules\File;
+use ProtoneMedia\Splade\FileUploads\HasSpladeFileUploads;
+
+class AvatarUploadFileRule extends FormRequest implements HasSpladeFileUploads
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, mixed>
+     */
+    public function rules()
+    {
+        return [
+            'avatar' => ['required', File::image()],
+        ];
+    }
+}

app/resources/views/form/components/filepond.blade.php

@@ -34,6 +34,11 @@
     <x-splade-submit />
 </x-splade-form>
 
+<x-splade-form dusk="form-request-rule-object" :action="route('form.components.filepond.storeWithFormRequestRuleObject')" class="space-y-4">
+    <x-splade-file filepond name="avatar" server />
+    <x-splade-submit />
+</x-splade-form>
+
 <x-splade-form dusk="js-config">
     <x-splade-file filepond="{ credits: null }" name="file" />
 </x-splade-form>

app/routes/web.php

@@ -152,6 +152,7 @@
         ->name('form.components.filepond.storeWithRouteMiddleware');
 
     Route::post('form/components/storeWithFormRequest', [FilepondController::class, 'storeWithFormRequest'])->name('form.components.filepond.storeWithFormRequest');
+    Route::post('form/components/storeWithFormRequestRuleObject', [FilepondController::class, 'storeWithFormRequestRuleObject'])->name('form.components.filepond.storeWithFormRequestRuleObject');
 
     Route::view('form/components/selectPlaceholder', 'form.components.selectPlaceholder')->name('form.components.selectPlaceholder');
 

app/tests/Browser/Form/FilepondTest.php

@@ -134,6 +134,23 @@ public function it_can_upload_a_temporary_file_using_a_form_request()
         });
     }
 
+    /** @test */
+    public function it_can_upload_a_temporary_file_using_a_form_request_that_has_a_validation_rule_object()
+    {
+        $this->browse(function (Browser $browser) {
+            $browser->visit('form/components/filepond')
+                ->waitForText('FormFilePond')
+                ->within('@form-request-rule-object', function (Browser $browser) {
+                    $browser->attach('avatar', __DIR__ . '/../small.jpeg')
+                        ->waitForText('Upload complete')
+                        ->press('Submit');
+                })
+                ->waitForRoute('navigation.one');
+
+            $this->assertFileExists(storage_path('app/avatars/avatar.jpg'));
+        });
+    }
+
     /** @test */
     public function it_can_use_a_custom_js_config()
     {

src/FileUploads/HandleSpladeFileUploads.php

@@ -10,6 +10,7 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\Str;
+use Illuminate\Validation\Rules\File;
 
 class HandleSpladeFileUploads extends TransformsRequest
 {
@@ -78,7 +79,17 @@ public static function forFormRequest(FormRequest $formRequest): FormRequest
         $rules = Validator::make([], $formRequest->rules())->getRules();
 
         $keys = Collection::make($rules)->filter(function ($rules) {
-            return in_array('file', $rules);
+            if (in_array('file', $rules)) {
+                return true;
+            }
+
+            foreach ($rules as $rule) {
+                if ($rule instanceof File) {
+                    return true;
+                }
+            }
+
+            return false;
         })->keys()->values();
 
         return static::forRequest($formRequest, $keys->isEmpty() ? null : $keys->all());