[tests] add known iterable types

TomasVotruba · TomasVotruba · commit fcede0a34a4b · 2025-09-29T19:56:29.000+02:00
diff --git a/rector.php b/rector.php
@@ -13,7 +13,7 @@
         codeQuality: true,
         codingStyle: true,
         typeDeclarations: true,
-        typeDeclarationDocblocks: true,
+        // typeDeclarationDocblocks: true,
         privatization: true,
         naming: true,
         instanceOf: true,
diff --git a/rules-tests/CodingStyle/ClassNameImport/ShortNameResolver/ShortNameResolverTest.php b/rules-tests/CodingStyle/ClassNameImport/ShortNameResolver/ShortNameResolverTest.php
@@ -37,6 +37,9 @@ public function test(string $filePath, array $expectedShortNames): void
         $this->assertSame($expectedShortNames, $shortNames);
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideData(): Iterator
     {
         yield [__DIR__ . '/Fixture/various_imports.php.inc', [
diff --git a/rules-tests/Naming/Naming/PropertyNamingTest.php b/rules-tests/Naming/Naming/PropertyNamingTest.php
@@ -57,6 +57,9 @@ public function testPropertyName(string $objectName, string $expectedVariableNam
         $this->assertSame($expectedVariableName, $variableName);
     }
 
+    /**
+     * @return Iterator<array<int, string>>
+     */
     public static function provideDataPropertyName(): Iterator
     {
         yield ['SomeVariable', 'someVariable'];
diff --git a/tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/DoctrineTest.php b/tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/DoctrineTest.php
@@ -26,6 +26,9 @@ public function testClass(string $docFilePath, string $className): void
         $this->assertSame($docComment, $printedPhpDocInfo);
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideDataClass(): Iterator
     {
         yield [__DIR__ . '/Source/Doctrine/index_in_table.txt', IndexInTable::class];
diff --git a/tests/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/ArrayParserTest.php b/tests/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/ArrayParserTest.php
@@ -41,6 +41,9 @@ public function test(string $docContent, array $expectedArrayItemNodes): void
         $this->assertEquals($expectedArrayItemNodes, $arrayItemNodes);
     }
 
+    /**
+     * @return Iterator<array<int, (array<int, ArrayItemNode>|string)>>
+     */
     public static function provideData(): Iterator
     {
         yield ['{key: "value"}', [new ArrayItemNode(new StringNode('value'), 'key')]];
diff --git a/tests/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/StaticDoctrineAnnotationParserTest.php b/tests/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/StaticDoctrineAnnotationParserTest.php
@@ -43,6 +43,9 @@ public function test(string $docContent, CurlyListNode | array $expectedValue):
         $this->assertEquals($expectedValue, $value);
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideData(): Iterator
     {
         $curlyListNode = new CurlyListNode([
diff --git a/tests/FileSystem/FilePathHelperTest.php b/tests/FileSystem/FilePathHelperTest.php
@@ -26,6 +26,9 @@ public function test(string $inputPath, string $expectedNormalizedPath): void
         $this->assertSame($expectedNormalizedPath, $normalizedPath);
     }
 
+    /**
+     * @return Iterator<array<int, string>>
+     */
     public static function provideData(): Iterator
     {
         // based on Linux
diff --git a/tests/Naming/ExpectedNameResolver/InflectorSingularResolverTest.php b/tests/Naming/ExpectedNameResolver/InflectorSingularResolverTest.php
@@ -27,6 +27,9 @@ public function testResolveForForeach(string $currentName, string $expectedSingu
         $this->assertSame($expectedSingularName, $singularValue);
     }
 
+    /**
+     * @return Iterator<array<int, string>>
+     */
     public static function provideData(): Iterator
     {
         yield ['psr4NamespacesToPaths', 'psr4NamespaceToPath'];
diff --git a/tests/NodeTypeResolver/PerNodeTypeResolver/ParamTypeResolver/ParamTypeResolverTest.php b/tests/NodeTypeResolver/PerNodeTypeResolver/ParamTypeResolver/ParamTypeResolverTest.php
@@ -25,6 +25,9 @@ public function test(string $file, int $nodePosition, string $expectedType): voi
         $this->assertSame($resolvedType::class, $expectedType);
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideData(): Iterator
     {
         yield [__DIR__ . '/Source/MethodParamTypeHint.php', 0, FullyQualifiedObjectType::class];
diff --git a/tests/NodeTypeResolver/PerNodeTypeResolver/PropertyTypeResolver/PropertyTypeResolverTest.php b/tests/NodeTypeResolver/PerNodeTypeResolver/PropertyTypeResolver/PropertyTypeResolverTest.php
@@ -41,6 +41,9 @@ public function test(string $file, int $nodePosition, Type $expectedType): void
         $this->assertSame($expectedTypeAsString, $resolvedTypeAsString);
     }
 
+    /**
+     * @return Iterator<array<int, (int|ObjectType|UnionType|string)>>
+     */
     public static function provideData(): Iterator
     {
         yield [__DIR__ . '/Source/MethodParamDocBlock.php', 0, new ObjectType(Html::class)];
diff --git a/tests/NodeTypeResolver/PerNodeTypeResolver/VariableTypeResolver/VariableTypeResolverTest.php b/tests/NodeTypeResolver/PerNodeTypeResolver/VariableTypeResolver/VariableTypeResolverTest.php
@@ -29,6 +29,9 @@ public function test(string $file, int $nodePosition, TypeWithClassName $expecte
         $this->assertSame($expectedTypeWithClassName->getClassName(), $resolvedType->getClassName());
     }
 
+    /**
+     * @return Iterator<array<int, (int|ObjectType|string)>>
+     */
     public static function provideData(): Iterator
     {
         $anotherTypeObjectType = new ObjectType(AnotherType::class);
diff --git a/tests/NodeTypeResolver/StaticTypeMapper/StaticTypeMapperTest.php b/tests/NodeTypeResolver/StaticTypeMapper/StaticTypeMapperTest.php
@@ -44,6 +44,9 @@ public function testMapPHPStanPhpDocTypeNodeToPHPStanType(TypeNode $typeNode, st
         $this->assertInstanceOf($expectedType, $phpStanType);
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideData(): Iterator
     {
         $genericTypeNode = new GenericTypeNode(new IdentifierTypeNode('Traversable'), []);
@@ -85,6 +88,9 @@ public function testMapPhpParserNodePHPStanType(Node $node, string $expectedType
         $this->assertInstanceOf($expectedType, $phpStanType);
     }
 
+    /**
+     * @return Iterator<array<int, (class-string<IterableType>|Identifier)>>
+     */
     public static function provideDataForMapPhpParserNodePHPStanType(): Iterator
     {
         yield [new Identifier('iterable'), IterableType::class];
diff --git a/tests/PHPStanStaticTypeMapper/TypeMapper/ArrayTypeMapperTest.php b/tests/PHPStanStaticTypeMapper/TypeMapper/ArrayTypeMapperTest.php
@@ -53,6 +53,9 @@ public static function provideDataWithoutKeys(): Iterator
         yield [$arrayType, 'string[]'];
     }
 
+    /**
+     * @return Iterator<array<int, (ArrayType|string)>>
+     */
     public static function provideDataUnionedWithoutKeys(): Iterator
     {
         $stringAndIntegerUnionType = new UnionType([new StringType(), new IntegerType()]);
@@ -66,6 +69,9 @@ public static function provideDataUnionedWithoutKeys(): Iterator
         yield [$evenMoreNestedUnionArrayType, 'string[][][]|int[][][]'];
     }
 
+    /**
+     * @return Iterator<array<int, (ArrayType|string)>>
+     */
     public static function provideDataWithKeys(): Iterator
     {
         $arrayMixedToStringType = new ArrayType(new MixedType(), new StringType());
diff --git a/tests/PhpAttribute/AnnotationToAttributeMapper/AnnotationToAttributeMapperTest.php b/tests/PhpAttribute/AnnotationToAttributeMapper/AnnotationToAttributeMapperTest.php
@@ -42,6 +42,9 @@ public function test(mixed $input, string $expectedTypeClass): void
         }
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideData(): Iterator
     {
         yield [false, ConstFetch::class];
diff --git a/tests/PhpAttribute/UseAliasNameMatcherTest.php b/tests/PhpAttribute/UseAliasNameMatcherTest.php
@@ -56,6 +56,9 @@ public function test(
         $this->assertSame($expectedAttributeUseImportName, $useAliasMetadata->getUseImportName());
     }
 
+    /**
+     * @return Iterator<array<int, (AnnotationToAttribute|string)>>
+     */
     public static function provideData(): Iterator
     {
         yield [
diff --git a/tests/PhpParser/Printer/BetterStandardPrinterTest.php b/tests/PhpParser/Printer/BetterStandardPrinterTest.php
@@ -80,6 +80,9 @@ public function testYield(Node $node, string $expectedPrintedNode): void
         $this->assertSame($expectedPrintedNode, $printedNode);
     }
 
+    /**
+     * @return Iterator<array<int, (Yield_|Expression|string)>>
+     */
     public static function provideDataForYield(): Iterator
     {
         $yield = new Yield_(new String_('value'));
diff --git a/tests/Set/SetManager/SetManagerTest.php b/tests/Set/SetManager/SetManagerTest.php
@@ -37,6 +37,9 @@ public function testByVersion(string $projectDirectory, array $expectedSets): vo
         $this->assertSame($expectedSets, $composerTriggeredSets);
     }
 
+    /**
+     * @return Iterator<(array<int, array<bool>>|array<int, array<int, bool>>|array<int, array<int, string>>|array<int, string>)>
+     */
     public static function provideInstalledTwigData(): Iterator
     {
         // here we cannot used features coming up in 2.4, as we only have 2.0
diff --git a/tests/Skipper/FileSystem/FnMatchPathNormalizerTest.php b/tests/Skipper/FileSystem/FnMatchPathNormalizerTest.php
@@ -28,6 +28,9 @@ public function testPaths(string $path, string $expectedNormalizedPath): void
         $this->assertSame($expectedNormalizedPath, $normalizedPath);
     }
 
+    /**
+     * @return Iterator<array<int, string>>
+     */
     public static function providePaths(): Iterator
     {
         yield ['path/with/no/asterisk', 'path/with/no/asterisk'];
diff --git a/tests/Skipper/Skipper/SkipperTest.php b/tests/Skipper/Skipper/SkipperTest.php
@@ -86,6 +86,9 @@ public function testSkipElementAndFilePath(string $element, string $filePath, bo
         $this->assertSame($expectedSkip, $resolvedSkip);
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideCheckerAndFile(): Iterator
     {
         yield [FifthElement::class, __DIR__ . '/Fixture', true];
@@ -97,6 +100,9 @@ public static function provideCheckerAndFile(): Iterator
         yield [NotSkippedClass::class, __DIR__ . '/Fixture/someOtherFile', false];
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideDataShouldSkipElement(): Iterator
     {
         yield [ThreeMan::class, false];
diff --git a/tests/Util/Reflection/PrivatesAccessorTest.php b/tests/Util/Reflection/PrivatesAccessorTest.php
@@ -36,6 +36,9 @@ public function test(
         $this->assertSame($expectedResult, $result);
     }
 
+    /**
+     * @return Iterator<array<array<int, mixed>, mixed>>
+     */
     public static function provideData(): Iterator
     {
         yield [SomeClassWithPrivateMethods::class, 'getNumber', [], 5];
diff --git a/tests/Validation/RectorAssertTest.php b/tests/Validation/RectorAssertTest.php
@@ -89,6 +89,9 @@ public function testInvalidFunctionName(string $functionName): void
         RectorAssert::functionName($functionName);
     }
 
+    /**
+     * @return Iterator<array<int, string>>
+     */
     public static function provideDataInvalidFunctionNames(): Iterator
     {
         yield ['35'];

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,9 @@ public function test(string $filePath, array $expectedShortNames): void`
`37`	`37`	`$this->assertSame($expectedShortNames, $shortNames);`
`38`	`38`	`}`
`39`	`39`
	`40`	`+ /**`
	`41`	`+ * @return Iterator<array<array<int, mixed>, mixed>>`
	`42`	`+ */`
`40`	`43`	`public static function provideData(): Iterator`
`41`	`44`	`{`
`42`	`45`	`yield [__DIR__ . '/Fixture/various_imports.php.inc', [`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,9 @@ public function testPropertyName(string $objectName, string $expectedVariableNam`
`57`	`57`	`$this->assertSame($expectedVariableName, $variableName);`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ /**`
	`61`	`+ * @return Iterator<array<int, string>>`
	`62`	`+ */`
`60`	`63`	`public static function provideDataPropertyName(): Iterator`
`61`	`64`	`{`
`62`	`65`	`yield ['SomeVariable', 'someVariable'];`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@ public function testClass(string $docFilePath, string $className): void`
`26`	`26`	`$this->assertSame($docComment, $printedPhpDocInfo);`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ /**`
	`30`	`+ * @return Iterator<array<array<int, mixed>, mixed>>`
	`31`	`+ */`
`29`	`32`	`public static function provideDataClass(): Iterator`
`30`	`33`	`{`
`31`	`34`	`yield [__DIR__ . '/Source/Doctrine/index_in_table.txt', IndexInTable::class];`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,9 @@ public function test(string $docContent, array $expectedArrayItemNodes): void`
`41`	`41`	`$this->assertEquals($expectedArrayItemNodes, $arrayItemNodes);`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ /**`
	`45`	`+ * @return Iterator<array<int, (array<int, ArrayItemNode>\|string)>>`
	`46`	`+ */`
`44`	`47`	`public static function provideData(): Iterator`
`45`	`48`	`{`
`46`	`49`	`yield ['{key: "value"}', [new ArrayItemNode(new StringNode('value'), 'key')]];`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,9 @@ public function test(string $docContent, CurlyListNode \| array $expectedValue):`
`43`	`43`	`$this->assertEquals($expectedValue, $value);`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ /**`
	`47`	`+ * @return Iterator<array<array<int, mixed>, mixed>>`
	`48`	`+ */`
`46`	`49`	`public static function provideData(): Iterator`
`47`	`50`	`{`
`48`	`51`	`$curlyListNode = new CurlyListNode([`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@ public function test(string $inputPath, string $expectedNormalizedPath): void`
`26`	`26`	`$this->assertSame($expectedNormalizedPath, $normalizedPath);`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ /**`
	`30`	`+ * @return Iterator<array<int, string>>`
	`31`	`+ */`
`29`	`32`	`public static function provideData(): Iterator`
`30`	`33`	`{`
`31`	`34`	`// based on Linux`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,9 @@ public function testResolveForForeach(string $currentName, string $expectedSingu`
`27`	`27`	`$this->assertSame($expectedSingularName, $singularValue);`
`28`	`28`	`}`
`29`	`29`
	`30`	`+ /**`
	`31`	`+ * @return Iterator<array<int, string>>`
	`32`	`+ */`
`30`	`33`	`public static function provideData(): Iterator`
`31`	`34`	`{`
`32`	`35`	`yield ['psr4NamespacesToPaths', 'psr4NamespaceToPath'];`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,9 @@ public function test(string $file, int $nodePosition, string $expectedType): voi`
`25`	`25`	`$this->assertSame($resolvedType::class, $expectedType);`
`26`	`26`	`}`
`27`	`27`
	`28`	`+ /**`
	`29`	`+ * @return Iterator<array<array<int, mixed>, mixed>>`
	`30`	`+ */`
`28`	`31`	`public static function provideData(): Iterator`
`29`	`32`	`{`
`30`	`33`	`yield [__DIR__ . '/Source/MethodParamTypeHint.php', 0, FullyQualifiedObjectType::class];`