[tests] add known iterator return types

rector.php

@@ -13,6 +13,7 @@
         codeQuality: true,
         codingStyle: true,
         typeDeclarations: true,
+        // typeDeclarationDocblocks: true,
         privatization: true,
         naming: true,
         instanceOf: true,

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', [

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'];

rules/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector.php

@@ -93,6 +93,9 @@ public function run(array $items)
         );
     }
 
+    /**
+     * @return array<int, class-string<ClassMethod>>
+     */
     public function getNodeTypes(): array
     {
         return [ClassMethod::class];

rules/CodeQuality/Rector/Foreach_/SimplifyForeachToCoalescingRector.php

@@ -54,6 +54,7 @@ public function getRuleDefinition(): RuleDefinition
 
     /**
      * @innerForeachReturn array<class-string<Node>>
+     * @return array<int, class-string<StmtsAwareInterface>>
      */
     public function getNodeTypes(): array
     {

rules/CodeQuality/Rector/FunctionLike/SimplifyUselessVariableRector.php

@@ -46,6 +46,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->onlyDirectAssign = $configuration[self::ONLY_DIRECT_ASSIGN] ?? false;

rules/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector.php

@@ -55,6 +55,9 @@ final class EncapsedStringsToSprintfRector extends AbstractRector implements Con
      */
     private array $argumentVariables = [];
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->always = $configuration[self::ALWAYS] ?? false;

rules/DeadCode/Rector/ClassLike/RemoveTypedPropertyNonMockDocblockRector.php

@@ -68,6 +68,9 @@ final class SomeTest extends TestCase
         );
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

rules/DeadCode/Rector/FuncCall/RemoveFilterVarOnExactTypeRector.php

@@ -38,6 +38,9 @@ function (int $value) {
         );
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/NetteUtils/Rector/StaticCall/UtilsJsonStaticCallNamedArgRector.php

@@ -40,6 +40,9 @@ public function getRuleDefinition(): RuleDefinition
         ]);
     }
 
+    /**
+     * @return array<int, class-string<StaticCall>>
+     */
     public function getNodeTypes(): array
     {
         return [StaticCall::class];

rules/Php80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector.php

@@ -137,6 +137,9 @@ public function __construct(
         );
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->inlinePublic = $configuration[self::INLINE_PUBLIC] ?? false;

rules/Php82/Rector/New_/FilesystemIteratorSkipDotsRector.php

@@ -42,6 +42,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<New_>>
+     */
     public function getNodeTypes(): array
     {
         return [New_::class];

rules/Php82/Rector/Param/AddSensitiveParameterAttributeRector.php

@@ -44,6 +44,9 @@ public function configure(array $configuration): void
         $this->sensitiveParameters = (array) ($configuration[self::SENSITIVE_PARAMETERS] ?? []);
     }
 
+    /**
+     * @return array<int, class-string<Param>>
+     */
     public function getNodeTypes(): array
     {
         return [Param::class];

rules/Php83/Rector/ClassConst/AddTypeToConstRector.php

@@ -63,6 +63,9 @@ final class SomeClass
         ]);
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

rules/Php83/Rector/FuncCall/DynamicClassConstFetchRector.php

@@ -41,6 +41,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/Php84/Rector/FuncCall/RoundingModeEnumRector.php

@@ -36,6 +36,9 @@ public function getRuleDefinition(): RuleDefinition
         ]);
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/Php84/Rector/Param/ExplicitNullableParamTypeRector.php

@@ -50,6 +50,9 @@ function foo(?string $param = null) {}
         ]);
     }
 
+    /**
+     * @return array<int, class-string<Param>>
+     */
     public function getNodeTypes(): array
     {
         return [Param::class];

rules/Php85/Rector/Const_/DeprecatedAnnotationToDeprecatedAttributeRector.php

@@ -42,6 +42,9 @@ public function getRuleDefinition(): RuleDefinition
         ]);
     }
 
+    /**
+     * @return array<int, class-string<Const_>>
+     */
     public function getNodeTypes(): array
     {
         return [Const_::class];

rules/Php85/Rector/FuncCall/ArrayKeyExistsNullToEmptyStringRector.php

@@ -51,6 +51,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/Php85/Rector/FuncCall/ChrArgModuloRector.php

@@ -45,6 +45,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/Php85/Rector/FuncCall/OrdSingleByteRector.php

@@ -46,6 +46,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/Php85/Rector/Switch_/ColonAfterSwitchCaseRector.php

@@ -39,6 +39,9 @@ public function getRuleDefinition(): RuleDefinition
         ]);
     }
 
+    /**
+     * @return array<int, class-string<Switch_>>
+     */
     public function getNodeTypes(): array
     {
         return [Switch_::class];

rules/Transform/Rector/ConstFetch/ConstFetchToClassConstFetchRector.php

@@ -33,6 +33,9 @@ public function getRuleDefinition(): RuleDefinition
         ]);
     }
 
+    /**
+     * @return array<int, class-string<ConstFetch>>
+     */
     public function getNodeTypes(): array
     {
         return [ConstFetch::class];

rules/Transform/Rector/MethodCall/MethodCallToNewRector.php

@@ -53,6 +53,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<MethodCall>>
+     */
     public function getNodeTypes(): array
     {
         return [MethodCall::class];

rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromMockObjectRector.php

@@ -66,6 +66,9 @@ public function createSomeMock(): \PHPUnit\Framework\MockObject\MockObject
         ]);
     }
 
+    /**
+     * @return array<int, class-string<ClassMethod>>
+     */
     public function getNodeTypes(): array
     {
         return [ClassMethod::class];

rules/TypeDeclaration/Rector/Class_/TypedPropertyFromCreateMockAssignRector.php

@@ -74,6 +74,9 @@ protected function setUp(): void
         );
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

rules/TypeDeclaration/Rector/FunctionLike/AddClosureParamTypeForArrayMapRector.php

@@ -59,6 +59,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/TypeDeclaration/Rector/FunctionLike/AddClosureParamTypeForArrayReduceRector.php

@@ -58,6 +58,9 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
+    /**
+     * @return array<int, class-string<FuncCall>>
+     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];

rules/TypeDeclaration/Rector/FunctionLike/AddClosureParamTypeFromIterableMethodCallRector.php

@@ -80,6 +80,9 @@ public function run(Collection $collection)
         );
     }
 
+    /**
+     * @return array<int, class-string<MethodCall>>
+     */
     public function getNodeTypes(): array
     {
         return [MethodCall::class];

rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php

@@ -68,6 +68,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->inlinePublic = $configuration[self::INLINE_PUBLIC] ?? (bool) current($configuration);

rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php

@@ -121,6 +121,9 @@ public function refactor(Node $node): ?Node
         return null;
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         Assert::keyExists($configuration, self::LIMIT);

rules/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockGetterReturnArrayFromPropertyDocblockVarRector.php

@@ -32,6 +32,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return array<int, class-string<ClassMethod>>
+     */
     public function getNodeTypes(): array
     {
         return [ClassMethod::class];

rules/TypeDeclarationDocblocks/Rector/Class_/AddReturnDocblockDataProviderRector.php

@@ -37,6 +37,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

rules/TypeDeclarationDocblocks/Rector/Class_/ClassMethodArrayDocblockParamFromLocalCallsRector.php

@@ -33,6 +33,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

rules/TypeDeclarationDocblocks/Rector/Class_/DocblockVarArrayFromGetterReturnRector.php

@@ -29,6 +29,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

rules/TypeDeclarationDocblocks/Rector/Class_/DocblockVarArrayFromPropertyDefaultsRector.php

@@ -26,6 +26,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

rules/TypeDeclarationDocblocks/Rector/Class_/DocblockVarFromParamDocblockInConstructorRector.php

@@ -30,6 +30,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return array<int, class-string<Class_>>
+     */
     public function getNodeTypes(): array
     {
         return [Class_::class];

src/Util/RectorClassesSorter.php

@@ -14,7 +14,7 @@ final class RectorClassesSorter
 {
     /**
      * @param array<class-string<RectorInterface|PostRectorInterface>> $rectorClasses
-     * @return array<class-string<RectorInterface|PostRectorInterface>>
+     * @return array<class-string<RectorInterface>>
      */
     public static function sortAndFilterOutPostRectors(array $rectorClasses): array
     {

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];

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')]];