Support int and string as template type bound

ondrejmirtes · ondrejmirtes · commit 768bfab11b31 · 2021-02-25T14:31:31.000+01:00
diff --git a/src/Rules/Generics/TemplateTypeCheck.php b/src/Rules/Generics/TemplateTypeCheck.php
@@ -8,9 +8,11 @@
 use PHPStan\Rules\ClassNameNodePair;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\Generic\TemplateTypeScope;
+use PHPStan\Type\IntegerType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\ObjectWithoutClassType;
+use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeTraverser;
 use PHPStan\Type\UnionType;
@@ -107,6 +109,8 @@ public function check(
 				$boundClass = get_class($type);
 				if (
 					$boundClass === MixedType::class
+					|| $boundClass === StringType::class
+					|| $boundClass === IntegerType::class
 					|| $boundClass === ObjectWithoutClassType::class
 					|| $boundClass === ObjectType::class
 					|| $type instanceof UnionType
diff --git a/src/Type/Generic/TemplateIntegerType.php b/src/Type/Generic/TemplateIntegerType.php
@@ -0,0 +1,58 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Generic;
+
+use PHPStan\Type\IntegerType;
+use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
+use PHPStan\Type\Type;
+
+final class TemplateIntegerType extends IntegerType implements TemplateType
+{
+
+	use TemplateTypeTrait;
+	use UndecidedComparisonCompoundTypeTrait;
+
+	public function __construct(
+		TemplateTypeScope $scope,
+		TemplateTypeStrategy $templateTypeStrategy,
+		TemplateTypeVariance $templateTypeVariance,
+		string $name
+	)
+	{
+		$this->scope = $scope;
+		$this->strategy = $templateTypeStrategy;
+		$this->variance = $templateTypeVariance;
+		$this->name = $name;
+		$this->bound = new IntegerType();
+	}
+
+	public function toArgument(): TemplateType
+	{
+		return new self(
+			$this->scope,
+			new TemplateTypeArgumentStrategy(),
+			$this->variance,
+			$this->name
+		);
+	}
+
+	protected function shouldGeneralizeInferredType(): bool
+	{
+		return false;
+	}
+
+	/**
+	 * @param mixed[] $properties
+	 * @return Type
+	 */
+	public static function __set_state(array $properties): Type
+	{
+		return new self(
+			$properties['scope'],
+			$properties['strategy'],
+			$properties['variance'],
+			$properties['name']
+		);
+	}
+
+}
diff --git a/src/Type/Generic/TemplateStringType.php b/src/Type/Generic/TemplateStringType.php
@@ -0,0 +1,58 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Generic;
+
+use PHPStan\Type\StringType;
+use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
+use PHPStan\Type\Type;
+
+final class TemplateStringType extends StringType implements TemplateType
+{
+
+	use TemplateTypeTrait;
+	use UndecidedComparisonCompoundTypeTrait;
+
+	public function __construct(
+		TemplateTypeScope $scope,
+		TemplateTypeStrategy $templateTypeStrategy,
+		TemplateTypeVariance $templateTypeVariance,
+		string $name
+	)
+	{
+		$this->scope = $scope;
+		$this->strategy = $templateTypeStrategy;
+		$this->variance = $templateTypeVariance;
+		$this->name = $name;
+		$this->bound = new StringType();
+	}
+
+	public function toArgument(): TemplateType
+	{
+		return new self(
+			$this->scope,
+			new TemplateTypeArgumentStrategy(),
+			$this->variance,
+			$this->name
+		);
+	}
+
+	protected function shouldGeneralizeInferredType(): bool
+	{
+		return false;
+	}
+
+	/**
+	 * @param mixed[] $properties
+	 * @return Type
+	 */
+	public static function __set_state(array $properties): Type
+	{
+		return new self(
+			$properties['scope'],
+			$properties['strategy'],
+			$properties['variance'],
+			$properties['name']
+		);
+	}
+
+}
diff --git a/src/Type/Generic/TemplateTypeFactory.php b/src/Type/Generic/TemplateTypeFactory.php
@@ -4,16 +4,19 @@
 
 use PHPStan\PhpDoc\Tag\TemplateTag;
 use PHPStan\Type\BenevolentUnionType;
+use PHPStan\Type\IntegerType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\ObjectWithoutClassType;
+use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
+use PHPStan\Type\TypeWithClassName;
 use PHPStan\Type\UnionType;
 
 final class TemplateTypeFactory
 {
 
-	public static function create(TemplateTypeScope $scope, string $name, ?Type $bound, TemplateTypeVariance $variance): Type
+	public static function create(TemplateTypeScope $scope, string $name, ?Type $bound, TemplateTypeVariance $variance): TemplateType
 	{
 		$strategy = new TemplateTypeParameterStrategy();
 
@@ -22,13 +25,21 @@ public static function create(TemplateTypeScope $scope, string $name, ?Type $bou
 		}
 
 		$boundClass = get_class($bound);
-		if ($boundClass === ObjectType::class) {
+		if ($bound instanceof TypeWithClassName && $boundClass === ObjectType::class) {
 			return new TemplateObjectType($scope, $strategy, $variance, $name, $bound->getClassName());
 		}
 		if ($boundClass === ObjectWithoutClassType::class) {
 			return new TemplateObjectWithoutClassType($scope, $strategy, $variance, $name);
 		}
 
+		if ($boundClass === StringType::class) {
+			return new TemplateStringType($scope, $strategy, $variance, $name);
+		}
+
+		if ($boundClass === IntegerType::class) {
+			return new TemplateIntegerType($scope, $strategy, $variance, $name);
+		}
+
 		if ($boundClass === MixedType::class) {
 			return new TemplateMixedType($scope, $strategy, $variance, $name);
 		}
@@ -46,7 +57,7 @@ public static function create(TemplateTypeScope $scope, string $name, ?Type $bou
 		return new TemplateMixedType($scope, $strategy, $variance, $name);
 	}
 
-	public static function fromTemplateTag(TemplateTypeScope $scope, TemplateTag $tag): Type
+	public static function fromTemplateTag(TemplateTypeScope $scope, TemplateTag $tag): TemplateType
 	{
 		return self::create($scope, $tag->getName(), $tag->getBound(), $tag->getVariance());
 	}
diff --git a/src/Type/Generic/TemplateTypeTrait.php b/src/Type/Generic/TemplateTypeTrait.php
@@ -155,7 +155,7 @@ public function inferTemplateTypes(Type $receivedType): TemplateTypeMap
 
 		if ($this->getBound()->isSuperTypeOf($receivedType)->yes()) {
 			return new TemplateTypeMap([
-				$this->name => TemplateTypeHelper::generalizeType($receivedType),
+				$this->name => $this->shouldGeneralizeInferredType() ? TemplateTypeHelper::generalizeType($receivedType) : $receivedType,
 			]);
 		}
 
@@ -172,4 +172,9 @@ public function getVariance(): TemplateTypeVariance
 		return $this->variance;
 	}
 
+	protected function shouldGeneralizeInferredType(): bool
+	{
+		return true;
+	}
+
 }
diff --git a/tests/PHPStan/Generics/TemplateTypeFactoryTest.php b/tests/PHPStan/Generics/TemplateTypeFactoryTest.php
@@ -3,7 +3,6 @@
 namespace PHPStan\Generics;
 
 use PHPStan\Type\ErrorType;
-use PHPStan\Type\Generic\TemplateType;
 use PHPStan\Type\Generic\TemplateTypeFactory;
 use PHPStan\Type\Generic\TemplateTypeScope;
 use PHPStan\Type\Generic\TemplateTypeVariance;
@@ -36,7 +35,11 @@ public function dataCreate(): array
 			],
 			[
 				new StringType(),
-				new MixedType(),
+				new StringType(),
+			],
+			[
+				new IntegerType(),
+				new IntegerType(),
 			],
 			[
 				new ErrorType(),
@@ -77,7 +80,6 @@ public function testCreate(?Type $bound, Type $expectedBound): void
 			TemplateTypeVariance::createInvariant()
 		);
 
-		$this->assertInstanceOf(TemplateType::class, $templateType);
 		$this->assertTrue(
 			$expectedBound->equals($templateType->getBound()),
 			sprintf('%s -> equals(%s)', $expectedBound->describe(VerbosityLevel::precise()), $templateType->getBound()->describe(VerbosityLevel::precise()))
diff --git a/tests/PHPStan/Rules/Generics/ClassTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/ClassTemplateTypeRuleTest.php
@@ -33,7 +33,7 @@ public function testRule(): void
 				16,
 			],
 			[
-				'PHPDoc tag @template T for class ClassTemplateType\Baz with bound type int is not supported.',
+				'PHPDoc tag @template T for class ClassTemplateType\Baz with bound type float is not supported.',
 				24,
 			],
 			[
@@ -53,7 +53,7 @@ public function testRule(): void
 				50,
 			],
 			[
-				'PHPDoc tag @template T for anonymous class with bound type int is not supported.',
+				'PHPDoc tag @template T for anonymous class with bound type float is not supported.',
 				55,
 			],
 			[
diff --git a/tests/PHPStan/Rules/Generics/FunctionTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/FunctionTemplateTypeRuleTest.php
@@ -34,7 +34,7 @@ public function testRule(): void
 				16,
 			],
 			[
-				'PHPDoc tag @template T for function FunctionTemplateType\baz() with bound type int is not supported.',
+				'PHPDoc tag @template T for function FunctionTemplateType\baz() with bound type float is not supported.',
 				24,
 			],
 			[
diff --git a/tests/PHPStan/Rules/Generics/InterfaceTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/InterfaceTemplateTypeRuleTest.php
@@ -34,7 +34,7 @@ public function testRule(): void
 				16,
 			],
 			[
-				'PHPDoc tag @template T for interface InterfaceTemplateType\Baz with bound type int is not supported.',
+				'PHPDoc tag @template T for interface InterfaceTemplateType\Baz with bound type float is not supported.',
 				24,
 			],
 			[
diff --git a/tests/PHPStan/Rules/Generics/MethodTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/MethodTemplateTypeRuleTest.php
@@ -38,7 +38,7 @@ public function testRule(): void
 				37,
 			],
 			[
-				'PHPDoc tag @template T for method MethodTemplateType\Baz::doFoo() with bound type int is not supported.',
+				'PHPDoc tag @template T for method MethodTemplateType\Baz::doFoo() with bound type float is not supported.',
 				50,
 			],
 			[
diff --git a/tests/PHPStan/Rules/Generics/TraitTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/TraitTemplateTypeRuleTest.php
@@ -34,7 +34,7 @@ public function testRule(): void
 				16,
 			],
 			[
-				'PHPDoc tag @template T for trait TraitTemplateType\Baz with bound type int is not supported.',
+				'PHPDoc tag @template T for trait TraitTemplateType\Baz with bound type float is not supported.',
 				24,
 			],
 			[
diff --git a/tests/PHPStan/Rules/Generics/data/bug-3769.php b/tests/PHPStan/Rules/Generics/data/bug-3769.php
@@ -38,3 +38,40 @@ function foo(
 function fooUnion($foo): void {
 	assertType('T of Exception|stdClass (function Bug3769\fooUnion(), argument)', $foo);
 }
+
+/**
+ * @template T
+ * @param T $a
+ * @return T
+ */
+function mixedBound($a)
+{
+	return $a;
+}
+
+/**
+ * @template T of int
+ * @param T $a
+ * @return T
+ */
+function intBound(int $a)
+{
+	return $a;
+}
+
+/**
+ * @template T of string
+ * @param T $a
+ * @return T
+ */
+function stringBound(string $a)
+{
+	return $a;
+}
+
+function (): void {
+	assertType('int', mixedBound(1));
+	assertType('string', mixedBound('str'));
+	assertType('1', intBound(1));
+	assertType('\'str\'', stringBound('str'));
+};
diff --git a/tests/PHPStan/Rules/Generics/data/class-template.php b/tests/PHPStan/Rules/Generics/data/class-template.php
@@ -19,7 +19,7 @@ class Bar
 }
 
 /**
- * @template T of int
+ * @template T of float
  */
 class Baz
 {
@@ -52,7 +52,7 @@ class Ipsum
 
 };
 
-new /** @template T of int */ class
+new /** @template T of float */ class
 {
 
 };
diff --git a/tests/PHPStan/Rules/Generics/data/function-template.php b/tests/PHPStan/Rules/Generics/data/function-template.php
@@ -19,7 +19,7 @@ function bar()
 }
 
 /**
- * @template T of int
+ * @template T of float
  */
 function baz()
 {
diff --git a/tests/PHPStan/Rules/Generics/data/interface-template.php b/tests/PHPStan/Rules/Generics/data/interface-template.php
@@ -19,7 +19,7 @@ interface Bar
 }
 
 /**
- * @template T of int
+ * @template T of float
  */
 interface Baz
 {
diff --git a/tests/PHPStan/Rules/Generics/data/method-template.php b/tests/PHPStan/Rules/Generics/data/method-template.php
@@ -45,7 +45,7 @@ class Baz
 {
 
 	/**
-	 * @template T of int
+	 * @template T of float
 	 */
 	public function doFoo()
 	{
diff --git a/tests/PHPStan/Rules/Generics/data/trait-template.php b/tests/PHPStan/Rules/Generics/data/trait-template.php
@@ -19,7 +19,7 @@ trait Bar
 }
 
 /**
- * @template T of int
+ * @template T of float
  */
 trait Baz
 {
diff --git a/tests/PHPStan/Type/Generic/GenericObjectTypeTest.php b/tests/PHPStan/Type/Generic/GenericObjectTypeTest.php
diff --git a/tests/PHPStan/Type/StringTypeTest.php b/tests/PHPStan/Type/StringTypeTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,16 +4,19 @@`
`4`	`4`
`5`	`5`	`use PHPStan\PhpDoc\Tag\TemplateTag;`
`6`	`6`	`use PHPStan\Type\BenevolentUnionType;`
	`7`	`+use PHPStan\Type\IntegerType;`
`7`	`8`	`use PHPStan\Type\MixedType;`
`8`	`9`	`use PHPStan\Type\ObjectType;`
`9`	`10`	`use PHPStan\Type\ObjectWithoutClassType;`
	`11`	`+use PHPStan\Type\StringType;`
`10`	`12`	`use PHPStan\Type\Type;`
	`13`	`+use PHPStan\Type\TypeWithClassName;`
`11`	`14`	`use PHPStan\Type\UnionType;`
`12`	`15`
`13`	`16`	`final class TemplateTypeFactory`
`14`	`17`	`{`
`15`	`18`
`16`		`- public static function create(TemplateTypeScope $scope, string $name, ?Type $bound, TemplateTypeVariance $variance): Type`
	`19`	`+ public static function create(TemplateTypeScope $scope, string $name, ?Type $bound, TemplateTypeVariance $variance): TemplateType`
`17`	`20`	`{`
`18`	`21`	`$strategy = new TemplateTypeParameterStrategy();`
`19`	`22`
`@@ -22,13 +25,21 @@ public static function create(TemplateTypeScope $scope, string $name, ?Type $bou`
`22`	`25`	`}`
`23`	`26`
`24`	`27`	`$boundClass = get_class($bound);`
`25`		`- if ($boundClass === ObjectType::class) {`
	`28`	`+ if ($bound instanceof TypeWithClassName && $boundClass === ObjectType::class) {`
`26`	`29`	`return new TemplateObjectType($scope, $strategy, $variance, $name, $bound->getClassName());`
`27`	`30`	`}`
`28`	`31`	`if ($boundClass === ObjectWithoutClassType::class) {`
`29`	`32`	`return new TemplateObjectWithoutClassType($scope, $strategy, $variance, $name);`
`30`	`33`	`}`
`31`	`34`
	`35`	`+ if ($boundClass === StringType::class) {`
	`36`	`+ return new TemplateStringType($scope, $strategy, $variance, $name);`
	`37`	`+ }`
	`38`	`+`
	`39`	`+ if ($boundClass === IntegerType::class) {`
	`40`	`+ return new TemplateIntegerType($scope, $strategy, $variance, $name);`
	`41`	`+ }`
	`42`	`+`
`32`	`43`	`if ($boundClass === MixedType::class) {`
`33`	`44`	`return new TemplateMixedType($scope, $strategy, $variance, $name);`
`34`	`45`	`}`
`@@ -46,7 +57,7 @@ public static function create(TemplateTypeScope $scope, string $name, ?Type $bou`
`46`	`57`	`return new TemplateMixedType($scope, $strategy, $variance, $name);`
`47`	`58`	`}`
`48`	`59`
`49`		`- public static function fromTemplateTag(TemplateTypeScope $scope, TemplateTag $tag): Type`
	`60`	`+ public static function fromTemplateTag(TemplateTypeScope $scope, TemplateTag $tag): TemplateType`
`50`	`61`	`{`
`51`	`62`	`return self::create($scope, $tag->getName(), $tag->getBound(), $tag->getVariance());`
`52`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ public function inferTemplateTypes(Type $receivedType): TemplateTypeMap`
`155`	`155`
`156`	`156`	`if ($this->getBound()->isSuperTypeOf($receivedType)->yes()) {`
`157`	`157`	`return new TemplateTypeMap([`
`158`		`- $this->name => TemplateTypeHelper::generalizeType($receivedType),`
	`158`	`+ $this->name => $this->shouldGeneralizeInferredType() ? TemplateTypeHelper::generalizeType($receivedType) : $receivedType,`
`159`	`159`	`]);`
`160`	`160`	`}`
`161`	`161`
`@@ -172,4 +172,9 @@ public function getVariance(): TemplateTypeVariance`
`172`	`172`	`return $this->variance;`
`173`	`173`	`}`
`174`	`174`
	`175`	`+ protected function shouldGeneralizeInferredType(): bool`
	`176`	`+ {`
	`177`	`+ return true;`
	`178`	`+ }`
	`179`	`+`
`175`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function testRule(): void`
`33`	`33`	`16,`
`34`	`34`	`],`
`35`	`35`	`[`
`36`		`- 'PHPDoc tag @template T for class ClassTemplateType\Baz with bound type int is not supported.',`
	`36`	`+ 'PHPDoc tag @template T for class ClassTemplateType\Baz with bound type float is not supported.',`
`37`	`37`	`24,`
`38`	`38`	`],`
`39`	`39`	`[`
`@@ -53,7 +53,7 @@ public function testRule(): void`
`53`	`53`	`50,`
`54`	`54`	`],`
`55`	`55`	`[`
`56`		`- 'PHPDoc tag @template T for anonymous class with bound type int is not supported.',`
	`56`	`+ 'PHPDoc tag @template T for anonymous class with bound type float is not supported.',`
`57`	`57`	`55,`
`58`	`58`	`],`
`59`	`59`	`[`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function testRule(): void`
`34`	`34`	`16,`
`35`	`35`	`],`
`36`	`36`	`[`
`37`		`- 'PHPDoc tag @template T for function FunctionTemplateType\baz() with bound type int is not supported.',`
	`37`	`+ 'PHPDoc tag @template T for function FunctionTemplateType\baz() with bound type float is not supported.',`
`38`	`38`	`24,`
`39`	`39`	`],`
`40`	`40`	`[`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public function testRule(): void`
`38`	`38`	`37,`
`39`	`39`	`],`
`40`	`40`	`[`
`41`		`- 'PHPDoc tag @template T for method MethodTemplateType\Baz::doFoo() with bound type int is not supported.',`
	`41`	`+ 'PHPDoc tag @template T for method MethodTemplateType\Baz::doFoo() with bound type float is not supported.',`
`42`	`42`	`50,`
`43`	`43`	`],`
`44`	`44`	`[`