-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Validator] Add constraint on unique elements collection(Assert\Unique) #26555
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Validator\Constraints; | ||
|
||
use Symfony\Component\Validator\Constraint; | ||
|
||
/** | ||
* @Annotation | ||
* @Target({"PROPERTY", "METHOD", "ANNOTATION"}) | ||
* | ||
* @author Yevgeniy Zholkevskiy <zhenya.zholkevskiy@gmail.com> | ||
*/ | ||
class Unique extends Constraint | ||
{ | ||
public const IS_NOT_UNIQUE = '7911c98d-b845-4da0-94b7-a8dac36bc55a'; | ||
|
||
protected static $errorNames = [ | ||
self::IS_NOT_UNIQUE => 'IS_NOT_UNIQUE', | ||
]; | ||
|
||
public $message = 'This collection should contain only unique elements'; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Validator\Constraints; | ||
|
||
use Symfony\Component\Validator\Constraint; | ||
use Symfony\Component\Validator\ConstraintValidator; | ||
use Symfony\Component\Validator\Exception\UnexpectedValueException; | ||
|
||
/** | ||
* @author Yevgeniy Zholkevskiy <zhenya.zholkevskiy@gmail.com> | ||
*/ | ||
class UniqueValidator extends ConstraintValidator | ||
{ | ||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function validate($value, Constraint $constraint) | ||
{ | ||
if (!$constraint instanceof Unique) { | ||
throw new UnexpectedTypeException($constraint, Unique::class); | ||
} | ||
|
||
if (null === $value) { | ||
return; | ||
} | ||
|
||
if (!\is_array($value) && !$value instanceof \IteratorAggregate) { | ||
throw new UnexpectedValueException($value, 'array|IteratorAggregate'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why not There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. see review chain There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
? was it a blocker for this PR? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i can pass a broken/unrewindbable iterator as aggregate just as easy. But i cant pass a working iterator/iterable directly. That's poor DX IMHO. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consequencies of this validator being applied on non-rewindable iterators are much bigger than in #25506 so yes (generally, after validator validates the data, data is processed) |
||
} | ||
|
||
$collectionElements = []; | ||
foreach ($value as $element) { | ||
if (\in_array($element, $collectionElements, true)) { | ||
$this->context->buildViolation($constraint->message) | ||
->setParameter('{{ value }}', $this->formatValue($value)) | ||
->setCode(Unique::IS_NOT_UNIQUE) | ||
->addViolation(); | ||
|
||
return; | ||
} | ||
$collectionElements[] = $element; | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Validator\Tests\Constraints; | ||
|
||
use Symfony\Component\Validator\Constraints\Unique; | ||
use Symfony\Component\Validator\Constraints\UniqueValidator; | ||
use Symfony\Component\Validator\Test\ConstraintValidatorTestCase; | ||
|
||
class UniqueValidatorTest extends ConstraintValidatorTestCase | ||
{ | ||
protected function createValidator() | ||
{ | ||
return new UniqueValidator(); | ||
} | ||
|
||
/** | ||
* @expectedException \Symfony\Component\Validator\Exception\UnexpectedValueException | ||
*/ | ||
public function testExpectsUniqueConstraintCompatibleType() | ||
{ | ||
$this->validator->validate('', new Unique()); | ||
} | ||
|
||
/** | ||
* @dataProvider getValidValues | ||
*/ | ||
public function testValidValues($value) | ||
{ | ||
$this->validator->validate($value, new Unique()); | ||
|
||
$this->assertNoViolation(); | ||
} | ||
|
||
public function getValidValues() | ||
{ | ||
return [ | ||
yield 'null' => [[null]], | ||
yield 'empty array' => [[]], | ||
yield 'single integer' => [[5]], | ||
yield 'single string' => [['a']], | ||
yield 'single object' => [[new \stdClass()]], | ||
yield 'unique booleans' => [[true, false]], | ||
yield 'unique integers' => [[1, 2, 3, 4, 5, 6]], | ||
yield 'unique floats' => [[0.1, 0.2, 0.3]], | ||
yield 'unique strings' => [['a', 'b', 'c']], | ||
yield 'unique arrays' => [[[1, 2], [2, 4], [4, 6]]], | ||
yield 'unique objects' => [[new \stdClass(), new \stdClass()]], | ||
]; | ||
} | ||
|
||
/** | ||
* @dataProvider getInvalidValues | ||
*/ | ||
public function testInvalidValues($value) | ||
{ | ||
$constraint = new Unique([ | ||
'message' => 'myMessage', | ||
]); | ||
$this->validator->validate($value, $constraint); | ||
|
||
$this->buildViolation('myMessage') | ||
->setParameter('{{ value }}', 'array') | ||
->setCode(Unique::IS_NOT_UNIQUE) | ||
->assertRaised(); | ||
} | ||
|
||
public function getInvalidValues() | ||
{ | ||
$object = new \stdClass(); | ||
|
||
return [ | ||
yield 'not unique booleans' => [[true, true]], | ||
yield 'not unique integers' => [[1, 2, 3, 3]], | ||
yield 'not unique floats' => [[0.1, 0.2, 0.1]], | ||
yield 'not unique string' => [['a', 'b', 'a']], | ||
yield 'not unique arrays' => [[[1, 1], [2, 3], [1, 1]]], | ||
yield 'not unique objects' => [[$object, $object]], | ||
]; | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
UniqueCollection
?