Allow request validator to accept null (#38)

Author: ClintWinter

src/Traits/HasCustomFields.php

@@ -16,7 +16,7 @@ public function customFields(): MorphMany
  return $this->morphMany(config('custom-fields.models.custom-field'), 'model')->orderBy('order');
  }
 
- public function validateCustomFields(Request|array $fields): Validator
+ public function validateCustomFields(Request|array|null $fields): Validator
  {
  if ($fields instanceof Request) {
  return $this->validateCustomFieldsRequest($fields);
@@ -66,7 +66,7 @@ public function order($fields)
  });
  }
 
- protected function validationData(array $fields, Collection $customFields): array
+ protected function validationData(array|null $fields, Collection $customFields): array
  {
  return collect($fields)
  ->mapWithKeys(function (mixed $field, int $key) use ($customFields) {

tests/Feature/CustomFieldControllerTest.php

@@ -9,6 +9,7 @@
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Route;
+use Illuminate\Validation\ValidationException;
 
 class CustomFieldControllerTest extends TestCase
 {
@@ -28,7 +29,7 @@ public function valid_data_passes_controller_validation()
  $field = $survey->customFields()->first();
 
  Route::post("/surveys/{$survey->id}/responses", function (Request $request) use ($survey) {
- $survey->validateCustomFields($request);
+ $survey->validateCustomFields($request)->validate();
 
  return response('All good', 200);
  });
@@ -317,4 +318,56 @@ public function fields_can_be_saved_from_request_with_convenience_method()
 
  $this->assertCount(1, $surveyResponse->customFieldResponses);
  }
+
+ /** @test */
+ public function can_validate_request_with_no_custom_fields()
+ {
+ $survey = Survey::create();
+ $survey->customfields()->save(
+ CustomField::factory()->make([
+ 'title' => 'favorite_album',
+ 'type' => 'select',
+ 'answers' => ['Tha Carter', 'Tha Carter II', 'Tha Carter III'],
+ ])
+ );
+
+ Route::post("/surveys/{$survey->id}/responses", function (Request $request) use ($survey) {
+ $survey->validateCustomFields($request)->validate();
+
+ return response('All good', 200);
+ });
+
+ $this->post("/surveys/{$survey->id}/responses")
+ ->assertOk();
+ }
+
+ /** @test */
+ public function fails_validation_on_request_with_no_custom_fields_but_is_required()
+ {
+ $survey = Survey::create();
+ $survey->customfields()->save(
+ CustomField::factory()->make([
+ 'title' => 'favorite_album',
+ 'type' => 'select',
+ 'answers' => ['Tha Carter', 'Tha Carter II', 'Tha Carter III'],
+ 'required' => true,
+ ])
+ );
+
+ Route::post("/surveys/{$survey->id}/responses", function (Request $request) use ($survey) {
+ $validator = $survey->validateCustomFields($request)->validate();
+
+ return response('All good', 200);
+ });
+
+ $fieldId = $survey->customFields()->value('id');
+
+ try {
+ $response = $this->post("/surveys/{$survey->id}/responses");
+
+ $this->fail('ValidationException was not thrown');
+ } catch (ValidationException $e) {
+ $this->assertArrayHasKey('field_'. $fieldId, $e->errors());
+ }
+ }
 }