Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion src/Extracting/ParsesValidationRules.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

trait ParsesValidationRules
{
use ParamHelpers;
use ParamHelpers;

public static \stdClass $MISSING_VALUE;

Expand Down Expand Up @@ -548,6 +548,26 @@ protected function processRule($rule, $ruleArguments, array &$parameterData, arr
case 'nullable':
$parameterData['nullable'] = true;
break;
case 'unique':
$table = $ruleArguments[0] ?? null;
$column = $ruleArguments[1] ?? null;

$isUpdate = count($ruleArguments) >= 3 && !empty($ruleArguments[2]) && $ruleArguments[2] !== 'NULL';
$hasTable = $column && $column !== 'NULL';

if ($isUpdate) {
$parameterData['description'] .= $hasTable
? " Must be unique in the <code>{$table}</code> table (ignoring current record during updates)."
: " Must be unique (ignoring current record during updates).";
} else {
$parameterData['description'] .= $hasTable
? " Must be unique in the <code>{$table}</code> table."
: " Must be unique.";
}

$parameterData['setter'] = fn() => $this->getFaker()->unique()->word();
$parameterData['type'] = 'string';
break;
case 'exists':
$parameterData['description'] .= " The <code>{$ruleArguments[1]}</code> of an existing record in the {$ruleArguments[0]} table.";
break;
Expand Down
25 changes: 23 additions & 2 deletions tests/Unit/ValidationRuleParsingTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,10 @@ public function parse($validationRules, $customParameterData = []): array
*/
public function can_parse_supported_rules(array $ruleset, array $customInfo, array $expected)
{
// Needed for `exists` rule
// Needed for `exists` and `unique` rules
Schema::create('users', function ($table) {
$table->id();
$table->string('email')->unique();
});

$results = $this->strategy->parse($ruleset, $customInfo);
Expand All @@ -55,7 +56,11 @@ public function can_parse_supported_rules(array $ruleset, array $customInfo, arr
}

// Validate that the generated values actually pass validation (for rules where we can generate some data)
if (is_string($ruleset[$parameterName]) && str_contains($ruleset[$parameterName], "exists")) return;
// Skip validation for exists and unique rules as they require database data
if (is_string($ruleset[$parameterName]) &&
(str_contains($ruleset[$parameterName], "exists") || str_contains($ruleset[$parameterName], "unique"))) {
return;
}

$exampleData = [$parameterName => $results[$parameterName]['example']];
$validator = Validator::make($exampleData, $ruleset);
Expand Down Expand Up @@ -138,6 +143,22 @@ public static function supportedRules()
// Second is custom information (from bodyParameters() or comments)
// Third is expected result

yield 'unique' => [
['unique_param' => 'unique:users,email'],
[],
[
'description' => 'Must be unique in the <code>users</code> table.',
'type' => 'string',
],
];
yield 'unique (with except)' => [
['unique_except_param' => 'unique:users,email,1,id'],
[],
[
'description' => 'Must be unique in the <code>users</code> table (ignoring current record during updates).',
'type' => 'string',
],
];
yield 'string' => [
['string_param' => 'string'],
['string_param' => ['description' => $description]],
Expand Down