Introduce shipmonk/phpstan-rules (#1046)

Author: kubawerlos

.dev-tools/composer.json

@@ -13,6 +13,7 @@
         "phpstan/phpstan-phpunit": "^2.0.6",
         "phpstan/phpstan-strict-rules": "^2.0.4",
         "shipmonk/composer-dependency-analyser": "^1.8.3",
+        "shipmonk/phpstan-rules": "^4.1.4",
         "squizlabs/php_codesniffer": "^3.13.2",
         "tomasvotruba/type-coverage": "^2.0.2",
         "vimeo/psalm": "^6.12"

.dev-tools/composer.lock

@@ -7,7 +7,8 @@ parameters:
     - ../vendor/autoload.php
   level: max
   ignoreErrors:
-    - '~internal (class|method) PhpCsFixer(CustomFixers(Dev)?)?\\~'
+    - message: '~internal (class|method) PhpCsFixer(CustomFixers(Dev)?)?\\~'
+    - identifier: shipmonk.checkedExceptionInYieldingMethod
   paths:
     - ../src
     - ../tests

.dev-tools/phpstan.neon

@@ -20,7 +20,7 @@ final class SwitchAnalysis
     private int $casesEnd;
 
     /** @var list<CaseAnalysis> */
-    private array $cases = [];
+    private array $cases;
 
     /**
      * @param list<CaseAnalysis> $cases

src/Analyzer/Analysis/SwitchAnalysis.php

@@ -85,7 +85,9 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
 
             $keyStartIndex = $tokens->getNextMeaningfulToken($openBrackets);
             \assert(\is_int($keyStartIndex));
+
             $keyEndIndex = $tokens->getPrevMeaningfulToken($closeBrackets);
+            \assert(\is_int($keyEndIndex));
 
             $keyTokens = [];
             for ($i = $keyStartIndex; $i <= $keyEndIndex; $i++) {

src/Fixer/IssetToArrayKeyExistsFixer.php

@@ -151,6 +151,7 @@ private static function getInterfaces(Tokens $tokens, int $classKeywordIndex, in
         $interface = '';
         for (
             $index = $tokens->getNextMeaningfulToken($implementsIndex);
+            // @phpstan-ignore-next-line
             $index < $classOpenBraceIndex;
             $index = $tokens->getNextMeaningfulToken($index)
         ) {

src/Fixer/StringableInterfaceFixer.php

@@ -94,7 +94,7 @@ public function testDataProvidersKeys(string $className): void
             \assert($dataSet instanceof \Iterator);
 
             $keyType = null;
-            foreach (\array_keys(\iterator_to_array($dataSet)) as $key) {
+            foreach (\array_keys(\iterator_to_array($dataSet, true)) as $key) {
                 // based on the type of first key determine what type should be for all keys
                 if ($keyType === null) {
                     $keyType = \is_int($key) ? 'int' : 'string';
@@ -127,9 +127,9 @@ public function testDataProvidersValues(string $className): void
         $dataProviders = self::getDataProviders($className);
 
         foreach ($dataProviders as $dataProvider) {
-            /** @var \Iterator<array<int, null|string>> $dataSet */
-            $dataSet = $dataProvider->invoke(null);
-            $dataSet = \iterator_to_array($dataSet);
+            /** @var \Iterator<array<int, null|string>> $dataSetIterator */
+            $dataSetIterator = $dataProvider->invoke(null);
+            $dataSet = \iterator_to_array($dataSetIterator, false);
 
             $doNotChangeCases = [];
             foreach ($dataSet as $value) {
@@ -170,7 +170,7 @@ public static function provideTestClassCases(): iterable
                 ->notName('autoload.php')
                 ->in(__DIR__ . '/..');
 
-            $tests = [];
+            $testsArray = [];
 
             /** @var SplFileInfo $file */
             foreach ($finder as $file) {
@@ -180,10 +180,10 @@ public static function provideTestClassCases(): iterable
                 }
 
                 $className .= '\\' . $file->getBasename('.php');
-                $tests[$className] = [$className];
+                $testsArray[$className] = [$className];
             }
 
-            $tests = new \ArrayIterator($tests);
+            $tests = new \ArrayIterator($testsArray);
         }
 
         return $tests;

tests/AutoReview/TestsCodeTest.php

@@ -308,12 +308,12 @@ public function testTokenIsUseful(int $token): void
 
         $property->setValue($fixer, \array_diff($tokens, [$token]));
 
-        $tokens = Tokens::fromCode(self::EXAMPLE_WITH_ALL_TOKENS);
-        $fixer->fix(self::createSplFileInfoDouble(), $tokens);
+        $allTokens = Tokens::fromCode(self::EXAMPLE_WITH_ALL_TOKENS);
+        $fixer->fix(self::createSplFileInfoDouble(), $allTokens);
 
         self::assertNotSame(
             $expectedTokens->generateCode(),
-            $tokens->generateCode(),
+            $allTokens->generateCode(),
             \sprintf('Removing token %s did not broke fixing', Token::getNameForId($token)),
         );
     }

tests/Fixer/SingleSpaceAfterStatementFixerTest.php

@@ -62,13 +62,13 @@ public static function provideFixerIsInCollectionCases(): iterable
     }
 
     /**
-     * @return array<array-key, string>
+     * @return list<string>
      */
     private static function fixerNamesFromCollection(): array
     {
         return \array_map(
             static fn (FixerInterface $fixer): string => $fixer->getName(),
-            \iterator_to_array(new Fixers()),
+            \iterator_to_array(new Fixers(), false),
         );
     }
 }