Skip to content

Add unique validation rule. #1011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: v5
Choose a base branch
from
Open

Add unique validation rule. #1011

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0ccb5e9
Add unique validation support.
Ferks-FK Jul 19, 2025
71ab2f7
Remove dump.
Ferks-FK Jul 19, 2025
4725bb9
Merge branch 'v5' into add_unique_validation
shalvah Jul 28, 2025
16ec6e1
Fix incorrect description
Ferks-FK Jul 30, 2025
ba15bd9
Merge branch 'add_unique_validation' of github.com:Ferks-FK/scribe in…
Ferks-FK Jul 30, 2025
70eaa56
Refactor messages and code.
Ferks-FK Aug 2, 2025
70cf989
Fix tests and messages being concatenated unexpectedly.
Ferks-FK Aug 2, 2025
f3a9131
Merge branch 'v5' into add_unique_validation
shalvah Oct 20, 2025
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
20 changes: 19 additions & 1 deletion src/Extracting/ParsesValidationRules.php
View file
Open in desktop
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,24 @@ protected function processRule($rule, $ruleArguments, array &$parameterData, arr
case 'nullable':
$parameterData['nullable'] = true;
break;
case 'unique':
$table = $ruleArguments[0] ?? 'table';
$column = isset($ruleArguments[1])
? ($ruleArguments[1] === 'NULL' ? 'id' : $ruleArguments[1])
: 'id'; // If the column is not specified, assume it is 'id'.
Copy link
Contributor

@shalvah shalvah Jul 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think doing this may cause some issues for people with some other column. Can we change this to not mention a column instead?

Copy link
Author

@Ferks-FK Ferks-FK Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As it stands, it does not require the column to be provided.
Rule::unique('vouchers') It is the equivalent Rule::unique('vouchers', 'id')
The ID column is assumed, because Laravel assumes that it is also ID.

Copy link
Contributor

@shalvah shalvah Aug 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just go with "Must not be taken" (which is Rails' default unique validation message). Database table and column names are implementation details that API consumers should neither know or care about.


// For cases where an ID is passed to be ignored in an update.
if (count($ruleArguments) >= 3 && !empty($ruleArguments[2]) && $ruleArguments[2] !== 'NULL') {
$except = $ruleArguments[2];
$idColumn = $ruleArguments[3] ?? 'id';
$parameterData['description'] .= " Must be unique in the <code>{$table}</code> table for column <code>{$column}</code> (ignoring record with <code>{$idColumn}</code> = <code>{$except}</code>).";
} else {
$parameterData['description'] .= " Must be unique in the <code>{$table}</code> table for column <code>{$column}</code>.";
}

$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
33 changes: 31 additions & 2 deletions tests/Unit/ValidationRuleParsingTest.php
View file
Open in desktop
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,30 @@ 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 for column <code>email</code>.',
'type' => 'string',
],
];
yield 'unique (simple)' => [
['unique_simple_param' => 'unique:users'],
[],
[
'description' => 'Must be unique in the <code>users</code> table for column <code>id</code>.',
'type' => 'string',
],
];
yield 'unique (with except)' => [
['unique_except_param' => 'unique:users,email,1,id'],
[],
[
'description' => 'Must be unique in the <code>users</code> table for column <code>email</code> (ignoring record with <code>id</code> = <code>1</code>).',
'type' => 'string',
],
];
yield 'string' => [
['string_param' => 'string'],
['string_param' => ['description' => $description]],
Expand Down