Rule::requiredIf treated as required

[apasquini95]

Hi everyone and super thanks for this awesome tool :)

I'm quite new to Scramble so maybe I'm missing something, but I noticed that when I write a request body whose rules contains a call to the Illuminate\Validation\Rule::requiredIf(), the rule is treated as if it was simply required. Here's an example of my request body:

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;

class MyRequest extends FormRequest
{
    public function rules(): array
    {
        return [
            'maybe_required'      => [
                // This is just an example, obviously the logic behind is much more complex than a random boolean 
                Rule::requiredIf( fn () => (bool)rand_int(0,1) ) 
            ],
            'always_required'     => ['required']
        ];
    }
}

The resulting request body specification is represented as follows:

"MyRequest": {
    "type": "object",
    "properties": {
        "maybe_required": {
            "type": "string"
        },
        "always_required": {
            "type": "string"
        }
    },
    "required": [
        "maybe_required",
        "always_required"
    ],
    "title": "MyRequest"
}

As you can see, the maybe_required field is marked as required, but is really a required_if an "always required"?

I gave also a look to the Dedoc\Scramble\Support\OperationExtensions\RulesExtractor\RulesToParameter::generate() method and I saw that when it is a Illuminate\Validation\Rules\RequiredIf rule object the result of the __toString() method is always 'required', even if Laravel produces this string evaluating the given condition:

// RulesToParameter.php#41

$rules = collect($this->rules)
    ->map(function ($v) {
        if (! method_exists($v, '__toString')) {
            return $v;
        }
        try {
            return $v->__toString();           // This is always 'required' when it comes to RequiredIf
        } catch (\Throwable) {
            return $v;
        }
    })
    ->sortByDesc($this->rulesSorter());

<?php

namespace Illuminate\Validation\Rules;

use Closure;
use InvalidArgumentException;
use Stringable;

class RequiredIf implements Stringable
{
  // All laravel's logic ...

    /**
     * Convert the rule to a validation string.
     *
     * @return string
     */
    public function __toString()
    {
        if (is_callable($this->condition)) {
            return call_user_func($this->condition) ? 'required' : '';
        }

        return $this->condition ? 'required' : '';
    }
}

When the condition is not met, Laravel returns an empty string for the RequiredIf rule, so it shouldn't be really a required one. Wouldn't it be simpler to treat a RequiredIf as a nullable rule? So the resulting specification would be something like this:

"MyRequest": {
    "type": "object",
    "properties": {
        "maybe_required": {
            "type": "string"
        },
        "always_required": {
            "type": "string"
        }
    },
    "required": [
        "always_required"
    ],
    "title": "MyRequest"
}

Am I missing something maybe or is this intended?

[romalytvynenko]

@apasquini95 this is an issue indeed and I consider it a bug! Feel free to create an issue or even submit a PR

[apasquini95]

Here's the issue
#936