Skip to content

Commit 8eaaa75

Browse files
VincentLangletVincentLanglet
committed
Add support for symfony uuid
1 parent 934f573 commit 8eaaa75

File tree

10 files changed

+452
-26
lines changed

10 files changed

+452
-26
lines changed

‎composer.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@
3636
"phpstan/phpstan-strict-rules": "^2.0",
3737
"phpunit/phpunit": "^9.6.20",
3838
"ramsey/uuid": "^4.2",
39-
"symfony/cache": "^5.4"
39+
"symfony/cache": "^5.4",
40+
"symfony/uid": "^5.4 || ^6.4 || ^7.3"
4041
},
4142
"config": {
4243
"sort-packages": true,

‎extension.neon‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,16 @@ services:
418418
tags: [phpstan.doctrine.typeDescriptor]
419419
arguments:
420420
uuidTypeName: Ramsey\Uuid\Doctrine\UuidBinaryOrderedTimeType
421+
-
422+
class: PHPStan\Type\Doctrine\Descriptors\Symfony\UuidTypeDescriptor
423+
tags: [phpstan.doctrine.typeDescriptor]
424+
arguments:
425+
uuidTypeName: Symfony\Bridge\Doctrine\Types\UuidType
426+
-
427+
class: PHPStan\Type\Doctrine\Descriptors\Symfony\UlidTypeDescriptor
428+
tags: [phpstan.doctrine.typeDescriptor]
429+
arguments:
430+
uuidTypeName: Symfony\Bridge\Doctrine\Types\UlidType
421431

422432
# Doctrine Collection
423433
-

‎src/Type/Doctrine/Descriptors/Ramsey/UuidTypeDescriptor.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace PHPStan\Type\Doctrine\Descriptors\Ramsey;
44

5-
use PHPStan\Rules\Doctrine\ORM\FakeTestingUuidType;
5+
use PHPStan\Rules\Doctrine\ORM\FakeTestingRamseyUuidType;
66
use PHPStan\ShouldNotHappenException;
77
use PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor;
88
use PHPStan\Type\ObjectType;
@@ -20,7 +20,7 @@ class UuidTypeDescriptor implements DoctrineTypeDescriptor
2020
'Ramsey\Uuid\Doctrine\UuidType',
2121
'Ramsey\Uuid\Doctrine\UuidBinaryType',
2222
'Ramsey\Uuid\Doctrine\UuidBinaryOrderedTimeType',
23-
FakeTestingUuidType::class,
23+
FakeTestingRamseyUuidType::class,
2424
];
2525

2626
private string $uuidTypeName;

‎src/Type/Doctrine/Descriptors/Symfony/UlidTypeDescriptor.php‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\Doctrine\Descriptors\Symfony;
4+
5+
use PHPStan\Rules\Doctrine\ORM\FakeTestingSymfonyUlidType;
6+
use PHPStan\ShouldNotHappenException;
7+
use PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor;
8+
use PHPStan\Type\ObjectType;
9+
use PHPStan\Type\StringType;
10+
use PHPStan\Type\Type;
11+
use PHPStan\Type\TypeCombinator;
12+
use Symfony\Component\Uid\Ulid;
13+
use function in_array;
14+
use function sprintf;
15+
16+
class UlidTypeDescriptor implements DoctrineTypeDescriptor
17+
{
18+
19+
private const SUPPORTED_UUID_TYPES = [
20+
'Symfony\Bridge\Doctrine\Types\UlidType',
21+
FakeTestingSymfonyUlidType::class,
22+
];
23+
24+
private string $uuidTypeName;
25+
26+
public function __construct(
27+
string $uuidTypeName
28+
)
29+
{
30+
if (!in_array($uuidTypeName, self::SUPPORTED_UUID_TYPES, true)) {
31+
throw new ShouldNotHappenException(sprintf(
32+
'Unexpected UUID column type "%s" provided',
33+
$uuidTypeName,
34+
));
35+
}
36+
37+
$this->uuidTypeName = $uuidTypeName;
38+
}
39+
40+
public function getType(): string
41+
{
42+
/** @var class-string<\Doctrine\DBAL\Types\Type> */
43+
return $this->uuidTypeName;
44+
}
45+
46+
public function getWritableToPropertyType(): Type
47+
{
48+
return new ObjectType(Ulid::class);
49+
}
50+
51+
public function getWritableToDatabaseType(): Type
52+
{
53+
return TypeCombinator::union(
54+
new StringType(),
55+
new ObjectType(Ulid::class),
56+
);
57+
}
58+
59+
public function getDatabaseInternalType(): Type
60+
{
61+
return new StringType();
62+
}
63+
64+
}

‎src/Type/Doctrine/Descriptors/Symfony/UuidTypeDescriptor.php‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\Doctrine\Descriptors\Symfony;
4+
5+
use PHPStan\Rules\Doctrine\ORM\FakeTestingSymfonyUuidType;
6+
use PHPStan\ShouldNotHappenException;
7+
use PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor;
8+
use PHPStan\Type\ObjectType;
9+
use PHPStan\Type\StringType;
10+
use PHPStan\Type\Type;
11+
use PHPStan\Type\TypeCombinator;
12+
use Symfony\Component\Uid\Uuid;
13+
use function in_array;
14+
use function sprintf;
15+
16+
class UuidTypeDescriptor implements DoctrineTypeDescriptor
17+
{
18+
19+
private const SUPPORTED_UUID_TYPES = [
20+
'Symfony\Bridge\Doctrine\Types\UuidType',
21+
FakeTestingSymfonyUuidType::class,
22+
];
23+
24+
private string $uuidTypeName;
25+
26+
public function __construct(
27+
string $uuidTypeName
28+
)
29+
{
30+
if (!in_array($uuidTypeName, self::SUPPORTED_UUID_TYPES, true)) {
31+
throw new ShouldNotHappenException(sprintf(
32+
'Unexpected UUID column type "%s" provided',
33+
$uuidTypeName,
34+
));
35+
}
36+
37+
$this->uuidTypeName = $uuidTypeName;
38+
}
39+
40+
public function getType(): string
41+
{
42+
/** @var class-string<\Doctrine\DBAL\Types\Type> */
43+
return $this->uuidTypeName;
44+
}
45+
46+
public function getWritableToPropertyType(): Type
47+
{
48+
return new ObjectType(Uuid::class);
49+
}
50+
51+
public function getWritableToDatabaseType(): Type
52+
{
53+
return TypeCombinator::union(
54+
new StringType(),
55+
new ObjectType(Uuid::class),
56+
);
57+
}
58+
59+
public function getDatabaseInternalType(): Type
60+
{
61+
return new StringType();
62+
}
63+
64+
}

‎tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php‎

Lines changed: 62 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,12 @@
2121
use PHPStan\Type\Doctrine\Descriptors\EnumType;
2222
use PHPStan\Type\Doctrine\Descriptors\IntegerType;
2323
use PHPStan\Type\Doctrine\Descriptors\JsonType;
24-
use PHPStan\Type\Doctrine\Descriptors\Ramsey\UuidTypeDescriptor;
24+
use PHPStan\Type\Doctrine\Descriptors\Ramsey\UuidTypeDescriptor as RamseyUuidTypeDescriptor;
2525
use PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor;
2626
use PHPStan\Type\Doctrine\Descriptors\SimpleArrayType;
2727
use PHPStan\Type\Doctrine\Descriptors\StringType;
28+
use PHPStan\Type\Doctrine\Descriptors\Symfony\UuidTypeDescriptor as SymfonyUuidTypeDescriptor;
29+
use PHPStan\Type\Doctrine\Descriptors\Symfony\UlidTypeDescriptor as SymfonyUlidTypeDescriptor;
2830
use PHPStan\Type\Doctrine\ObjectMetadataResolver;
2931
use function array_unshift;
3032
use function class_exists;
@@ -41,16 +43,51 @@ class EntityColumnRuleTest extends RuleTestCase
4143

4244
private ?string $objectManagerLoader = null;
4345

46+
private bool $useSymfonyUuid = false;
47+
4448
protected function getRule(): Rule
4549
{
50+
$descriptors = [
51+
new ArrayType(),
52+
new BigIntType(),
53+
new BinaryType(),
54+
new DateTimeImmutableType(),
55+
new DateTimeType(),
56+
new DateType(),
57+
new DecimalType(new DriverDetector()),
58+
new JsonType(),
59+
new IntegerType(),
60+
new StringType(),
61+
new SimpleArrayType(),
62+
new EnumType(),
63+
new ReflectionDescriptor(CarbonImmutableType::class, $this->createReflectionProvider(), self::getContainer()),
64+
new ReflectionDescriptor(CarbonType::class, $this->createReflectionProvider(), self::getContainer()),
65+
new ReflectionDescriptor(CustomType::class, $this->createReflectionProvider(), self::getContainer()),
66+
new ReflectionDescriptor(CustomNumericType::class, $this->createReflectionProvider(), self::getContainer()),
67+
];
68+
4669
if (!Type::hasType(CustomType::NAME)) {
4770
Type::addType(CustomType::NAME, CustomType::class);
4871
}
4972
if (!Type::hasType(CustomNumericType::NAME)) {
5073
Type::addType(CustomNumericType::NAME, CustomNumericType::class);
5174
}
52-
if (!Type::hasType(FakeTestingUuidType::NAME)) {
53-
Type::addType(FakeTestingUuidType::NAME, FakeTestingUuidType::class);
75+
if ($this->useSymfonyUuid) {
76+
if (!Type::hasType(FakeTestingSymfonyUuidType::NAME)) {
77+
Type::addType(FakeTestingSymfonyUuidType::NAME, FakeTestingSymfonyUuidType::class);
78+
}
79+
$descriptors[] = new SymfonyUuidTypeDescriptor(FakeTestingSymfonyUuidType::class);
80+
81+
if (!Type::hasType(FakeTestingSymfonyUlidType::NAME)) {
82+
Type::addType(FakeTestingSymfonyUlidType::NAME, FakeTestingSymfonyUlidType::class);
83+
}
84+
$descriptors[] = new SymfonyUlidTypeDescriptor(FakeTestingSymfonyUlidType::class);
85+
} else {
86+
if (!Type::hasType(FakeTestingRamseyUuidType::NAME)) {
87+
Type::addType(FakeTestingRamseyUuidType::NAME, FakeTestingRamseyUuidType::class);
88+
}
89+
90+
$descriptors[] = new RamseyUuidTypeDescriptor(FakeTestingRamseyUuidType::class);
5491
}
5592
if (!Type::hasType('carbon')) {
5693
Type::addType('carbon', CarbonType::class);
@@ -64,25 +101,7 @@ protected function getRule(): Rule
64101

65102
return new EntityColumnRule(
66103
new ObjectMetadataResolver($this->objectManagerLoader, __DIR__ . '/../../../../tmp'),
67-
new DefaultDescriptorRegistry([
68-
new ArrayType(),
69-
new BigIntType(),
70-
new BinaryType(),
71-
new DateTimeImmutableType(),
72-
new DateTimeType(),
73-
new DateType(),
74-
new DecimalType(new DriverDetector()),
75-
new JsonType(),
76-
new IntegerType(),
77-
new StringType(),
78-
new SimpleArrayType(),
79-
new UuidTypeDescriptor(FakeTestingUuidType::class),
80-
new EnumType(),
81-
new ReflectionDescriptor(CarbonImmutableType::class, $this->createReflectionProvider(), self::getContainer()),
82-
new ReflectionDescriptor(CarbonType::class, $this->createReflectionProvider(), self::getContainer()),
83-
new ReflectionDescriptor(CustomType::class, $this->createReflectionProvider(), self::getContainer()),
84-
new ReflectionDescriptor(CustomNumericType::class, $this->createReflectionProvider(), self::getContainer()),
85-
]),
104+
new DefaultDescriptorRegistry($descriptors),
86105
$this->createReflectionProvider(),
87106
true,
88107
$this->allowNullablePropertyForRequiredField,
@@ -461,6 +480,27 @@ public function testBug677(?string $objectManagerLoader): void
461480
$this->analyse([__DIR__ . '/data/bug-677.php'], []);
462481
}
463482

483+
/**
484+
* @dataProvider dataObjectManagerLoader
485+
*/
486+
public function testSymfonyUuid(?string $objectManagerLoader): void
487+
{
488+
$this->allowNullablePropertyForRequiredField = true;
489+
$this->objectManagerLoader = $objectManagerLoader;
490+
$this->useSymfonyUuid = true;
491+
492+
$this->analyse([__DIR__ . '/data/EntityWithSymfonyUid.php'], [
493+
[
494+
'Property PHPStan\Rules\Doctrine\ORM\EntityWithSymfonyUid::$uuidInvalidType type mapping mismatch: database can contain Symfony\Component\Uid\Uuid but property expects string.',
495+
32,
496+
],
497+
[
498+
'Property PHPStan\Rules\Doctrine\ORM\EntityWithSymfonyUid::$ulidInvalidType type mapping mismatch: database can contain Symfony\Component\Uid\Ulid but property expects string.',
499+
44,
500+
],
501+
]);
502+
}
503+
464504
/**
465505
* @dataProvider dataObjectManagerLoader
466506
*/

‎tests/Rules/Doctrine/ORM/FakeTestingUuidType.php‎ renamed to ‎tests/Rules/Doctrine/ORM/FakeTestingRamseyUuidType.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* From https://github.com/ramsey/uuid-doctrine/blob/fafebbe972cdaba9274c286ea8923e2de2579027/src/UuidType.php
1414
* Copyright (c) 2012-2022 Ben Ramsey <[email protected]>
1515
*/
16-
final class FakeTestingUuidType extends GuidType
16+
final class FakeTestingRamseyUuidType extends GuidType
1717
{
1818

1919
public const NAME = 'uuid';

0 commit comments

Comments
 (0)