Ramsey UUID TypeDescriptor

Author: mhujer

composer.json

@@ -29,6 +29,7 @@
 		"phpstan/phpstan-phpunit": "^0.12",
 		"phpstan/phpstan-strict-rules": "^0.12",
 		"phpunit/phpunit": "^7.0",
+		"ramsey/uuid-doctrine": "^1.5.0",
 		"slevomat/coding-standard": "^4.5.2",
 		"doctrine/common": "^2.7",
 		"doctrine/orm": "^2.5",

extension.neon

@@ -255,3 +255,20 @@ services:
 	-
 		class: PHPStan\Type\Doctrine\Descriptors\TimeType
 		tags: [phpstan.doctrine.typeDescriptor]
+
+	# 3rd party Type descriptors
+	-
+		class: PHPStan\Type\Doctrine\Descriptors\Ramsey\UuidTypeDescriptor
+		tags: [phpstan.doctrine.typeDescriptor]
+		arguments:
+			uuidTypeName: Ramsey\Uuid\Doctrine\UuidType
+	-
+		class: PHPStan\Type\Doctrine\Descriptors\Ramsey\UuidTypeDescriptor
+		tags: [phpstan.doctrine.typeDescriptor]
+		arguments:
+			uuidTypeName: Ramsey\Uuid\Doctrine\UuidBinaryType
+	-
+		class: PHPStan\Type\Doctrine\Descriptors\Ramsey\UuidTypeDescriptor
+		tags: [phpstan.doctrine.typeDescriptor]
+		arguments:
+			uuidTypeName: Ramsey\Uuid\Doctrine\UuidBinaryOrderedTimeType

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

@@ -0,0 +1,57 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine\Descriptors\Ramsey;
+
+use PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+use Ramsey\Uuid\UuidInterface;
+
+class UuidTypeDescriptor implements DoctrineTypeDescriptor
+{
+
+	private const SUPPORTED_UUID_TYPES = [
+		\Ramsey\Uuid\Doctrine\UuidType::class,
+		\Ramsey\Uuid\Doctrine\UuidBinaryType::class,
+		\Ramsey\Uuid\Doctrine\UuidBinaryOrderedTimeType::class,
+	];
+
+	/**
+	 * @phpstan-var class-string<\Doctrine\DBAL\Types\Type>
+	 * @var string
+	 */
+	private $uuidTypeName;
+
+	public function __construct(
+		string $uuidTypeName
+	)
+	{
+		if (!in_array($uuidTypeName, self::SUPPORTED_UUID_TYPES, true)) {
+			throw new \PHPStan\ShouldNotHappenException(sprintf(
+				'Unexpected UUID column type "%s" provided',
+				$uuidTypeName
+			));
+		}
+
+		$this->uuidTypeName = $uuidTypeName;
+	}
+
+	public function getType(): string
+	{
+		return $this->uuidTypeName;
+	}
+
+	public function getWritableToPropertyType(): Type
+	{
+		return new \PHPStan\Type\ObjectType(UuidInterface::class);
+	}
+
+	public function getWritableToDatabaseType(): Type
+	{
+		return TypeCombinator::union(
+			new \PHPStan\Type\StringType(),
+			new \PHPStan\Type\ObjectType(UuidInterface::class)
+		);
+	}
+
+}

tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php

@@ -13,9 +13,11 @@
 use PHPStan\Type\Doctrine\Descriptors\DateTimeType;
 use PHPStan\Type\Doctrine\Descriptors\DateType;
 use PHPStan\Type\Doctrine\Descriptors\IntegerType;
+use PHPStan\Type\Doctrine\Descriptors\Ramsey\UuidTypeDescriptor;
 use PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor;
 use PHPStan\Type\Doctrine\Descriptors\StringType;
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
+use Ramsey\Uuid\Doctrine\UuidType;
 
 /**
  * @extends RuleTestCase<EntityColumnRule>
@@ -28,6 +30,9 @@ protected function getRule(): Rule
 		if (!Type::hasType(CustomType::NAME)) {
 			Type::addType(CustomType::NAME, CustomType::class);
 		}
+		if (!Type::hasType(UuidType::NAME)) {
+			Type::addType(UuidType::NAME, UuidType::class);
+		}
 
 		return new EntityColumnRule(
 			new ObjectMetadataResolver(__DIR__ . '/entity-manager.php', null),
@@ -40,6 +45,7 @@ protected function getRule(): Rule
 				new IntegerType(),
 				new ReflectionDescriptor(CustomType::class, $this->createBroker()),
 				new DateType(),
+				new UuidTypeDescriptor(UuidType::class),
 			]),
 			true
 		);
@@ -72,6 +78,14 @@ public function testRule(): void
 				'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$four type mapping mismatch: property can contain DateTime but database expects DateTimeImmutable.',
 				43,
 			],
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$uuidInvalidType type mapping mismatch: database can contain Ramsey\Uuid\UuidInterface but property expects int.',
+				72,
+			],
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$uuidInvalidType type mapping mismatch: property can contain int but database expects Ramsey\Uuid\UuidInterface|string.',
+				72,
+			],
 		]);
 	}
 

tests/Rules/Doctrine/ORM/data/MyBrokenEntity.php

@@ -59,4 +59,16 @@ class MyBrokenEntity extends MyBrokenSuperclass
 	 */
 	private $never;
 
+	/**
+	 * @ORM\Column(type="uuid")
+	 * @var \Ramsey\Uuid\UuidInterface
+	 */
+	private $uuid;
+
+	/**
+	 * @ORM\Column(type="uuid")
+	 * @var int
+	 */
+	private $uuidInvalidType;
+
 }