Template tag name cannot be empty string

phpstan · May 31, 2024 · 08dbe82 · 08dbe82
1 parent 745e99e
commit 08dbe82
Show file tree

Hide file tree

Showing 31 changed files with 160 additions and 65 deletions.
diff --git a/src/PhpDoc/Tag/TemplateTag.php b/src/PhpDoc/Tag/TemplateTag.php
@@ -9,10 +9,16 @@
 class TemplateTag
 {
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(private string $name, private Type $bound, private TemplateTypeVariance $variance)
 	{
 	}
 
+	/**
+	 * @return non-empty-string
+	 */
 	public function getName(): string
 	{
 		return $this->name;

diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -68,7 +68,7 @@ class CallableType implements CompoundType, CallableParametersAcceptor
 	/**
 	 * @api
 	 * @param array<int, ParameterReflection>|null $parameters
-	 * @param array<string, TemplateTag> $templateTags
+	 * @param array<non-empty-string, TemplateTag> $templateTags
 	 */
 	public function __construct(
 		?array $parameters = null,
@@ -89,7 +89,7 @@ public function __construct(
 	}
 
 	/**
-	 * @return array<string, TemplateTag>
+	 * @return array<non-empty-string, TemplateTag>
 	 */
 	public function getTemplateTags(): array
 	{

diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -78,7 +78,7 @@ class ClosureType implements TypeWithClassName, CallableParametersAcceptor
 	/**
 	 * @api
 	 * @param array<int, ParameterReflection>|null $parameters
-	 * @param array<string, TemplateTag> $templateTags
+	 * @param array<non-empty-string, TemplateTag> $templateTags
 	 * @param SimpleThrowPoint[] $throwPoints
 	 * @param SimpleImpurePoint[] $impurePoints
 	 * @param InvalidateExprNode[] $invalidateExpressions
@@ -108,7 +108,7 @@ public function __construct(
 	}
 
 	/**
-	 * @return array<string, TemplateTag>
+	 * @return array<non-empty-string, TemplateTag>
 	 */
 	public function getTemplateTags(): array
 	{

diff --git a/src/Type/Generic/TemplateArrayType.php b/src/Type/Generic/TemplateArrayType.php
@@ -13,6 +13,9 @@ final class TemplateArrayType extends ArrayType implements TemplateType
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateBenevolentUnionType.php b/src/Type/Generic/TemplateBenevolentUnionType.php
@@ -12,6 +12,9 @@ final class TemplateBenevolentUnionType extends BenevolentUnionType implements T
 	/** @use TemplateTypeTrait<BenevolentUnionType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateBooleanType.php b/src/Type/Generic/TemplateBooleanType.php
@@ -13,6 +13,9 @@ final class TemplateBooleanType extends BooleanType implements TemplateType
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateConstantArrayType.php b/src/Type/Generic/TemplateConstantArrayType.php
@@ -13,6 +13,9 @@ final class TemplateConstantArrayType extends ConstantArrayType implements Templ
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateConstantIntegerType.php b/src/Type/Generic/TemplateConstantIntegerType.php
@@ -13,6 +13,9 @@ final class TemplateConstantIntegerType extends ConstantIntegerType implements T
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateConstantStringType.php b/src/Type/Generic/TemplateConstantStringType.php
@@ -13,6 +13,9 @@ final class TemplateConstantStringType extends ConstantStringType implements Tem
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateFloatType.php b/src/Type/Generic/TemplateFloatType.php
@@ -13,6 +13,9 @@ final class TemplateFloatType extends FloatType implements TemplateType
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateGenericObjectType.php b/src/Type/Generic/TemplateGenericObjectType.php
@@ -13,6 +13,9 @@ final class TemplateGenericObjectType extends GenericObjectType implements Templ
 	/** @use TemplateTypeTrait<GenericObjectType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateIntegerType.php b/src/Type/Generic/TemplateIntegerType.php
@@ -13,6 +13,9 @@ final class TemplateIntegerType extends IntegerType implements TemplateType
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateIntersectionType.php b/src/Type/Generic/TemplateIntersectionType.php
@@ -11,6 +11,9 @@ final class TemplateIntersectionType extends IntersectionType implements Templat
 	/** @use TemplateTypeTrait<IntersectionType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateKeyOfType.php b/src/Type/Generic/TemplateKeyOfType.php
@@ -14,6 +14,9 @@ final class TemplateKeyOfType extends KeyOfType implements TemplateType
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateMixedType.php b/src/Type/Generic/TemplateMixedType.php
@@ -15,6 +15,9 @@ final class TemplateMixedType extends MixedType implements TemplateType
 	/** @use TemplateTypeTrait<MixedType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateObjectShapeType.php b/src/Type/Generic/TemplateObjectShapeType.php
@@ -13,6 +13,9 @@ final class TemplateObjectShapeType extends ObjectShapeType implements TemplateT
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateObjectType.php b/src/Type/Generic/TemplateObjectType.php
@@ -13,6 +13,9 @@ final class TemplateObjectType extends ObjectType implements TemplateType
 	/** @use TemplateTypeTrait<ObjectType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateObjectWithoutClassType.php b/src/Type/Generic/TemplateObjectWithoutClassType.php
@@ -13,6 +13,9 @@ class TemplateObjectWithoutClassType extends ObjectWithoutClassType implements T
 	/** @use TemplateTypeTrait<ObjectWithoutClassType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateStrictMixedType.php b/src/Type/Generic/TemplateStrictMixedType.php
@@ -15,6 +15,9 @@ final class TemplateStrictMixedType extends StrictMixedType implements TemplateT
 	/** @use TemplateTypeTrait<StrictMixedType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateStringType.php b/src/Type/Generic/TemplateStringType.php
@@ -13,6 +13,9 @@ final class TemplateStringType extends StringType implements TemplateType
 	use TemplateTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/src/Type/Generic/TemplateType.php b/src/Type/Generic/TemplateType.php
@@ -11,6 +11,7 @@
 interface TemplateType extends CompoundType
 {
 
+	/** @return non-empty-string */
 	public function getName(): string;
 
 	public function getScope(): TemplateTypeScope;

diff --git a/src/Type/Generic/TemplateTypeFactory.php b/src/Type/Generic/TemplateTypeFactory.php
@@ -25,6 +25,9 @@
 final class TemplateTypeFactory
 {
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public static function create(TemplateTypeScope $scope, string $name, ?Type $bound, TemplateTypeVariance $variance, ?TemplateTypeStrategy $strategy = null): TemplateType
 	{
 		$strategy ??= new TemplateTypeParameterStrategy();

diff --git a/src/Type/Generic/TemplateTypeTrait.php b/src/Type/Generic/TemplateTypeTrait.php
@@ -25,6 +25,7 @@
 trait TemplateTypeTrait
 {
 
+	/** @var non-empty-string */
 	private string $name;
 
 	private TemplateTypeScope $scope;
@@ -36,6 +37,7 @@ trait TemplateTypeTrait
 	/** @var TBound */
 	private Type $bound;
 
+	/** @return non-empty-string */
 	public function getName(): string
 	{
 		return $this->name;

diff --git a/src/Type/Generic/TemplateUnionType.php b/src/Type/Generic/TemplateUnionType.php
@@ -11,6 +11,9 @@ final class TemplateUnionType extends UnionType implements TemplateType
 	/** @use TemplateTypeTrait<UnionType> */
 	use TemplateTypeTrait;
 
+	/**
+	 * @param non-empty-string $name
+	 */
 	public function __construct(
 		TemplateTypeScope $scope,
 		TemplateTypeStrategy $templateTypeStrategy,

diff --git a/tests/PHPStan/Reflection/GenericParametersAcceptorResolverTest.php b/tests/PHPStan/Reflection/GenericParametersAcceptorResolverTest.php
@@ -29,12 +29,15 @@ class GenericParametersAcceptorResolverTest extends PHPStanTestCase
 	 */
 	public function dataResolve(): array
 	{
-		$templateType = static fn (string $name, ?Type $type = null): Type => TemplateTypeFactory::create(
-			TemplateTypeScope::createWithFunction('a'),
-			$name,
-			$type,
-			TemplateTypeVariance::createInvariant(),
-		);
+		$templateType = static function (string $name, ?Type $type = null): Type {
+			/** @var non-empty-string $name */
+			return TemplateTypeFactory::create(
+				TemplateTypeScope::createWithFunction('a'),
+				$name,
+				$type,
+				TemplateTypeVariance::createInvariant(),
+			);
+		};
 
 		return [
 			'one param, one arg' => [

diff --git a/tests/PHPStan/Type/ArrayTypeTest.php b/tests/PHPStan/Type/ArrayTypeTest.php
@@ -179,12 +179,15 @@ public function testDescribe(
 
 	public function dataInferTemplateTypes(): array
 	{
-		$templateType = static fn (string $name): Type => TemplateTypeFactory::create(
-			TemplateTypeScope::createWithFunction('a'),
-			$name,
-			new MixedType(),
-			TemplateTypeVariance::createInvariant(),
-		);
+		$templateType = static function (string $name): Type {
+			/** @var non-empty-string $name */
+			return TemplateTypeFactory::create(
+				TemplateTypeScope::createWithFunction('a'),
+				$name,
+				new MixedType(),
+				TemplateTypeVariance::createInvariant(),
+			);
+		};
 
 		return [
 			'valid templated item' => [

diff --git a/tests/PHPStan/Type/CallableTypeTest.php b/tests/PHPStan/Type/CallableTypeTest.php
@@ -177,12 +177,15 @@ public function dataInferTemplateTypes(): array
 			null,
 		);
 
-		$templateType = static fn (string $name): Type => TemplateTypeFactory::create(
-			TemplateTypeScope::createWithFunction('a'),
-			$name,
-			new MixedType(),
-			TemplateTypeVariance::createInvariant(),
-		);
+		$templateType = static function (string $name): Type {
+			/** @var non-empty-string $name */
+			return TemplateTypeFactory::create(
+				TemplateTypeScope::createWithFunction('a'),
+				$name,
+				new MixedType(),
+				TemplateTypeVariance::createInvariant(),
+			);
+		};
 
 		return [
 			'template param' => [

diff --git a/tests/PHPStan/Type/Constant/ConstantArrayTypeTest.php b/tests/PHPStan/Type/Constant/ConstantArrayTypeTest.php
@@ -610,12 +610,15 @@ public function testIsSuperTypeOf(ConstantArrayType $type, Type $otherType, Trin
 
 	public function dataInferTemplateTypes(): array
 	{
-		$templateType = static fn (string $name): Type => TemplateTypeFactory::create(
-			TemplateTypeScope::createWithFunction('a'),
-			$name,
-			new MixedType(),
-			TemplateTypeVariance::createInvariant(),
-		);
+		$templateType = static function (string $name): Type {
+			/** @var non-empty-string $name */
+			return TemplateTypeFactory::create(
+				TemplateTypeScope::createWithFunction('a'),
+				$name,
+				new MixedType(),
+				TemplateTypeVariance::createInvariant(),
+			);
+		};
 
 		return [
 			'receive constant array' => [

diff --git a/tests/PHPStan/Type/Generic/GenericObjectTypeTest.php b/tests/PHPStan/Type/Generic/GenericObjectTypeTest.php
@@ -351,12 +351,15 @@ public function testAccepts(
 	/** @return array<string,array{Type,Type,array<string,string>}> */
 	public function dataInferTemplateTypes(): array
 	{
-		$templateType = static fn (string $name, ?Type $bound = null): Type => TemplateTypeFactory::create(
-			TemplateTypeScope::createWithFunction('a'),
-			$name,
-			$bound ?? new MixedType(),
-			TemplateTypeVariance::createInvariant(),
-		);
+		$templateType = static function (string $name, ?Type $bound = null): Type {
+			/** @var non-empty-string $name */
+			return TemplateTypeFactory::create(
+				TemplateTypeScope::createWithFunction('a'),
+				$name,
+				$bound ?? new MixedType(),
+				TemplateTypeVariance::createInvariant(),
+			);
+		};
 
 		return [
 			'simple' => [
@@ -464,12 +467,15 @@ public function testResolveTemplateTypes(Type $received, Type $template, array $
 	/** @return array<array{TemplateTypeVariance,Type,bool,array<TemplateTypeReference>}> */
 	public function dataGetReferencedTypeArguments(): array
 	{
-		$templateType = static fn (string $name, ?Type $bound = null): TemplateType => TemplateTypeFactory::create(
-			TemplateTypeScope::createWithFunction('a'),
-			$name,
-			$bound ?? new MixedType(),
-			TemplateTypeVariance::createInvariant(),
-		);
+		$templateType = static function (string $name, ?Type $bound = null): Type {
+			/** @var non-empty-string $name */
+			return TemplateTypeFactory::create(
+				TemplateTypeScope::createWithFunction('a'),
+				$name,
+				$bound ?? new MixedType(),
+				TemplateTypeVariance::createInvariant(),
+			);
+		};
 
 		return [
 			'param: Invariant<T>' => [