RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-03-11 10:06:09 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1823 from chrisguitarguy/fix_constraints

Browse Source 
Fix Count and Range Constraints
This commit is contained in:
Guilhem Niot 2021-05-27 13:25:30 +02:00 committed by GitHub
commit 7f3926cc89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 156 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
ModelDescriber/Annotations/SymfonyConstraintAnnotationReader.php
View File

@ -76,13 +76,21 @@ class SymfonyConstraintAnnotationReader
} elseif ($annotation instanceof Assert\Regex) {
$this->appendPattern($property, $annotation->getHtmlPattern());
} elseif ($annotation instanceof Assert\Count) {
$property->minItems = (int) $annotation->min;
$property->maxItems = (int) $annotation->max;
if (isset($annotation->min)) {
$property->minItems = (int) $annotation->min;
}
if (isset($annotation->max)) {
$property->maxItems = (int) $annotation->max;
}
} elseif ($annotation instanceof Assert\Choice) {
$this->applyEnumFromChoiceConstraint($property, $annotation, $reflection);
} elseif ($annotation instanceof Assert\Range) {
$property->minimum = (int) $annotation->min;
$property->maximum = (int) $annotation->max;
if (isset($annotation->min)) {
$property->minimum = (int) $annotation->min;
}
if (isset($annotation->max)) {
$property->maximum = (int) $annotation->max;
}
} elseif ($annotation instanceof Assert\LessThan) {
$property->exclusiveMaximum = true;
$property->maximum = (int) $annotation->value;

144
Tests/ModelDescriber/Annotations/SymfonyConstraintAnnotationReaderTest.php
View File

@ -244,4 +244,148 @@ class SymfonyConstraintAnnotationReaderTest extends TestCase
}];
}
}
/**
* @param object $entity
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1821
* @dataProvider provideCountConstraintDoesNotSetMinItemsIfMinIsNotSet
*/
public function testCountConstraintDoesNotSetMinItemsIfMinIsNotSet($entity)
{
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->minItems);
$this->assertSame(10, $schema->properties[0]->maxItems);
}
public function provideCountConstraintDoesNotSetMinItemsIfMinIsNotSet(): iterable
{
yield 'Annotations' => [new class() {
/**
* @Assert\Count(max = 10)
*/
private $property1;
}];
if (\PHP_VERSION_ID >= 80000) {
yield 'Attributes' => [new class() {
#[Assert\Count(max: 10)]
private $property1;
}];
}
}
/**
* @param object $entity
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1821
* @dataProvider provideCountConstraintDoesNotSetMaxItemsIfMaxIsNotSet
*/
public function testCountConstraintDoesNotSetMaxItemsIfMaxIsNotSet($entity)
{
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->maxItems);
$this->assertSame(10, $schema->properties[0]->minItems);
}
public function provideCountConstraintDoesNotSetMaxItemsIfMaxIsNotSet(): iterable
{
yield 'Annotations' => [new class() {
/**
* @Assert\Count(min = 10)
*/
private $property1;
}];
if (\PHP_VERSION_ID >= 80000) {
yield 'Attributes' => [new class() {
#[Assert\Count(min: 10)]
private $property1;
}];
}
}
/**
* @param object $entity
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1822
* @dataProvider provideRangeConstraintDoesNotSetMaximumIfMaxIsNotSet
*/
public function testRangeConstraintDoesNotSetMaximumIfMaxIsNotSet($entity)
{
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->maximum);
$this->assertSame(10, $schema->properties[0]->minimum);
}
public function provideRangeConstraintDoesNotSetMaximumIfMaxIsNotSet(): iterable
{
yield 'Annotations' => [new class() {
/**
* @Assert\Range(min = 10)
*/
private $property1;
}];
if (\PHP_VERSION_ID >= 80000) {
yield 'Attributes' => [new class() {
#[Assert\Range(min: 10)]
private $property1;
}];
}
}
/**
* @param object $entity
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1822
* @dataProvider provideRangeConstraintDoesNotSetMinimumIfMinIsNotSet
*/
public function testRangeConstraintDoesNotSetMinimumIfMinIsNotSet($entity)
{
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->minimum);
$this->assertSame(10, $schema->properties[0]->maximum);
}
public function provideRangeConstraintDoesNotSetMinimumIfMinIsNotSet(): iterable
{
yield 'Annotations' => [new class() {
/**
* @Assert\Range(max = 10)
*/
private $property1;
}];
if (\PHP_VERSION_ID >= 80000) {
yield 'Attributes' => [new class() {
#[Assert\Range(max: 10)]
private $property1;
}];
}
}
}