Increase PHPStan level to 5

julienfalque · julienfalque · commit 1222c37599e4 · 2020-03-31T09:54:18.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -51,7 +51,7 @@ jobs:
                     | grep -v tests/TestCase.php \
                     && (echo "UNKNOWN FILES DETECTED" && travis_terminate 1) || echo "NO UNKNOWN FILES"
                 - ./check_trailing_spaces.sh || travis_terminate 1
-                - php -d auto_prepend_file=dev-tools/vendor/autoload.php ./dev-tools/tools/phpstan analyse
+                - dev-tools/vendor/bin/phpstan analyse
                 - if [ -n "$CHANGED_PHP_FILES" ]; then ./dev-tools/vendor/bin/phpmd `echo "$CHANGED_PHP_FILES" | xargs | sed 's/ /,/g'` text phpmd.xml || travis_terminate 1; fi
                 - ./dev-tools/tools/composer-require-checker check composer.json --config-file $(realpath .composer-require-checker.json) || travis_terminate 1
                 - ./dev-tools/tools/composer-normalize composer.json --dry-run
diff --git a/dev-tools/composer.json b/dev-tools/composer.json
@@ -7,6 +7,7 @@
         "jangregor/phpstan-prophecy": "^0.6",
         "mi-schi/phpmd-extension": "^4.3",
         "phpmd/phpmd": "^2.6",
+        "phpstan/phpstan": "0.12.18",
         "phpstan/phpstan-phpunit": "^0.12"
     },
     "conflict": {
diff --git a/dev-tools/install.sh b/dev-tools/install.sh
@@ -39,7 +39,7 @@ fi
 bin/phive --version
 
 echo λλλ phive packages
-./bin/phive install --trust-gpg-keys D2CCAC42F6295E7D,8E730BA25823D8B5,C00543248C87FB13,CF1A108D0E7AE720
+./bin/phive install --trust-gpg-keys D2CCAC42F6295E7D,8E730BA25823D8B5,C00543248C87FB13
 
 echo λλλ checkbashisms
 if [ ! -x bin/checkbashisms ]; then
diff --git a/dev-tools/phive.xml b/dev-tools/phive.xml
@@ -2,5 +2,4 @@
 <phive xmlns="https://phar.io/phive">
   <phar name="composer-normalize" version="^2.1.2" installed="2.1.2" location="./tools/composer-normalize" copy="false"/>
   <phar name="composer-require-checker" version="^2.0" installed="2.0.0" location="./tools/composer-require-checker" copy="false"/>
-  <phar name="phpstan" version="^0.12" installed="0.12.9" location="./tools/phpstan" copy="true"/>
 </phive>
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,9 +1,10 @@
 includes:
     - dev-tools/vendor/jangregor/phpstan-prophecy/src/extension.neon
+    - dev-tools/vendor/phpstan/phpstan/conf/bleedingEdge.neon
     - dev-tools/vendor/phpstan/phpstan-phpunit/extension.neon
 
 parameters:
-    level: 3
+    level: 5
     paths:
         - src
         - tests
@@ -16,3 +17,33 @@ parameters:
         -
             message: '/^Unsafe usage of new static\(\)\.$/'
             path: src/Config.php
+        -
+            message: '/^Else branch is unreachable because previous condition is always true\.$/'
+            path: src/Event/Event.php
+        -
+            message: '/^Strict comparison using !== between ''@git-commit@'' and ''@git-commit@'' will always evaluate to false\.$/'
+            path: src/Console/Application.php
+        -
+            message: '/^Result of && is always false\.$/'
+            path: src/Config.php
+        -
+            message: '/^Strict comparison using === between false and true will always evaluate to false\.$/'
+            path: src/Config.php
+        -
+            message: '/^Else branch is unreachable because ternary operator condition is always true\.$/'
+            paths:
+                - src/Config.php
+                - src/Tokenizer/Token.php
+        -
+            message: '/^Parameter #1 \$fixers of method PhpCsFixer\\Config::registerCustomFixers\(\) expects iterable<PhpCsFixer\\Fixer\\FixerInterface>, string given\.$/'
+            path: tests/ConfigTest.php
+        -
+            message: '/^Parameter #1 \$options of method PhpCsFixer\\FixerConfiguration\\FixerConfigurationResolverRootless::resolve\(\) expects array<string, mixed>, array<int, string> given\.$/'
+            path: tests/FixerConfiguration/FixerConfigurationResolverRootlessTest.php
+        -
+            message: '/^Parameter #1 \$function of function register_shutdown_function expects callable\(\): void, array\(\$this\(PhpCsFixer\\FileRemoval\), ''clean''\) given\.$/'
+            path: src/FileRemoval.php
+        -
+            message: '/^Parameter #1 \$finder of method PhpCsFixer\\Config::setFinder\(\) expects iterable<string>, int given\.$/'
+            path: tests/ConfigTest.php
+    tipsOfTheDay: false
diff --git a/src/AbstractNoUselessElseFixer.php b/src/AbstractNoUselessElseFixer.php
@@ -162,7 +162,7 @@ private function isInConditionWithoutBraces(Tokens $tokens, $index, $lowerLimitI
                 return true;
             }
 
-            if ($token->equals(';', '}')) {
+            if ($token->equals(';')) {
                 return false;
             }
             if ($token->equals('{')) {
diff --git a/src/Cache/Cache.php b/src/Cache/Cache.php
@@ -55,13 +55,6 @@ public function get($file)
 
     public function set($file, $hash)
     {
-        if (!\is_int($hash)) {
-            throw new \InvalidArgumentException(sprintf(
-                'Value needs to be an integer, got "%s".',
-                \is_object($hash) ? \get_class($hash) : \gettype($hash)
-            ));
-        }
-
         $this->hashes[$file] = $hash;
     }
 
@@ -105,7 +98,7 @@ public static function fromJson($json)
         if (null === $data && JSON_ERROR_NONE !== json_last_error()) {
             throw new \InvalidArgumentException(sprintf(
                 'Value needs to be a valid JSON string, got "%s", error: "%s".',
-                \is_object($json) ? \get_class($json) : \gettype($json),
+                $json,
                 json_last_error_msg()
             ));
         }
diff --git a/src/ConfigurationException/InvalidConfigurationException.php b/src/ConfigurationException/InvalidConfigurationException.php
@@ -25,10 +25,11 @@
 class InvalidConfigurationException extends \InvalidArgumentException
 {
     /**
-     * @param string   $message
-     * @param null|int $code
+     * @param string          $message
+     * @param null|int        $code
+     * @param null|\Throwable $previous
      */
-    public function __construct($message, $code = null, \Exception $previous = null)
+    public function __construct($message, $code = null, $previous = null)
     {
         parent::__construct(
             $message,
diff --git a/src/ConfigurationException/InvalidFixerConfigurationException.php b/src/ConfigurationException/InvalidFixerConfigurationException.php
@@ -30,10 +30,11 @@ class InvalidFixerConfigurationException extends InvalidConfigurationException
     private $fixerName;
 
     /**
-     * @param string $fixerName
-     * @param string $message
+     * @param string          $fixerName
+     * @param string          $message
+     * @param null|\Throwable $previous
      */
-    public function __construct($fixerName, $message, \Exception $previous = null)
+    public function __construct($fixerName, $message, $previous = null)
     {
         parent::__construct(
             sprintf('[%s] %s', $fixerName, $message),
diff --git a/src/Console/Application.php b/src/Console/Application.php
@@ -97,11 +97,11 @@ public function doRun(InputInterface $input, OutputInterface $output)
      */
     public function getLongVersion()
     {
-        $version = parent::getLongVersion();
-        if (self::VERSION_CODENAME) {
-            $version .= ' <info>'.self::VERSION_CODENAME.'</info>';
-        }
-        $version .= ' by <comment>Fabien Potencier</comment> and <comment>Dariusz Ruminski</comment>';
+        $version = sprintf(
+            '%s <info>%s</info> by <comment>Fabien Potencier</comment> and <comment>Dariusz Ruminski</comment>',
+            parent::getLongVersion(),
+            self::VERSION_CODENAME
+        );
 
         $commit = '@git-commit@';
 
diff --git a/src/Console/ConfigurationResolver.php b/src/Console/ConfigurationResolver.php
@@ -847,7 +847,7 @@ static function ($path) {
             }
 
             return new \CallbackFilterIterator(
-                $nestedFinder,
+                new \IteratorIterator($nestedFinder),
                 static function (\SplFileInfo $current) use ($pathsByType) {
                     $currentRealPath = $current->getRealPath();
 
diff --git a/src/Fixer/Basic/BracesFixer.php b/src/Fixer/Basic/BracesFixer.php
@@ -212,12 +212,15 @@ private function fixCommentBeforeBrace(Tokens $tokens)
                 continue;
             }
 
+            /** @var Token $tokenTmp */
             $tokenTmp = $tokens[$braceIndex];
 
             $newBraceIndex = $prevIndex + 1;
             for ($i = $braceIndex; $i > $newBraceIndex; --$i) {
                 // we might be moving one white space next to another, these have to be merged
-                $tokens[$i] = $tokens[$i - 1];
+                /** @var Token $previousToken */
+                $previousToken = $tokens[$i - 1];
+                $tokens[$i] = $previousToken;
                 if ($tokens[$i]->isWhitespace() && $tokens[$i + 1]->isWhitespace()) {
                     $tokens[$i] = new Token([T_WHITESPACE, $tokens[$i]->getContent().$tokens[$i + 1]->getContent()]);
                     $tokens->clearAt($i + 1);
@@ -809,8 +812,6 @@ private function findStatementEnd(Tokens $tokens, $parenthesisEndIndex)
                 return $tokens->getPrevNonWhitespace($index);
             }
         }
-
-        throw new \RuntimeException('Statement end not found.');
     }
 
     private function getControlTokens()
diff --git a/src/Fixer/Basic/EncodingFixer.php b/src/Fixer/Basic/EncodingFixer.php
@@ -77,6 +77,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
         $content = $tokens[0]->getContent();
 
         if (0 === strncmp($content, $this->BOM, 3)) {
+            /** @var false|string $newContent until support for PHP 5.6 is dropped */
             $newContent = substr($content, 3);
 
             if (false === $newContent) {
diff --git a/src/Fixer/Basic/Psr0Fixer.php b/src/Fixer/Basic/Psr0Fixer.php
@@ -105,6 +105,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
             $dir = \dirname($path);
 
             if ('' !== $this->configuration['dir']) {
+                /** @var false|string $dir until support for PHP 5.6 is dropped */
                 $dir = substr($dir, \strlen(realpath($this->configuration['dir'])) + 1);
 
                 if (false === $dir) {
@@ -120,6 +121,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
                 }
             }
 
+            /** @var false|string $dir until support for PHP 5.6 is dropped */
             $dir = substr($dir, -\strlen($normNamespace));
             if (false === $dir) {
                 $dir = '';
diff --git a/src/Fixer/ClassNotation/OrderedClassElementsFixer.php b/src/Fixer/ClassNotation/OrderedClassElementsFixer.php
@@ -346,8 +346,6 @@ private function getElements(Tokens $tokens, $startIndex)
             $elements[] = $element;
             $startIndex = $element['end'] + 1;
         }
-
-        return [];
     }
 
     /**
diff --git a/src/Fixer/Phpdoc/PhpdocAlignFixer.php b/src/Fixer/Phpdoc/PhpdocAlignFixer.php
@@ -331,7 +331,7 @@ private function fixDocBlock(DocBlock $docBlock)
      * @param string $line
      * @param bool   $matchCommentOnly
      *
-     * @return null|string[]
+     * @return null|array<string, null|string>
      */
     private function getMatches($line, $matchCommentOnly = false)
     {
diff --git a/src/Runner/FileFilterIterator.php b/src/Runner/FileFilterIterator.php
@@ -41,10 +41,14 @@ final class FileFilterIterator extends \FilterIterator
     private $visitedElements = [];
 
     public function __construct(
-        \Iterator $iterator,
+        \Traversable $iterator,
         EventDispatcherInterface $eventDispatcher = null,
         CacheManagerInterface $cacheManager
     ) {
+        if (!$iterator instanceof \Iterator) {
+            $iterator = new \IteratorIterator($iterator);
+        }
+
         parent::__construct($iterator);
 
         $this->eventDispatcher = $eventDispatcher;
diff --git a/src/Tokenizer/Tokens.php b/src/Tokenizer/Tokens.php
@@ -25,9 +25,6 @@
  * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
  *
  * @extends \SplFixedArray<Token>
- *
- * @method Token current()
- * @method Token offsetGet($index)
  */
 class Tokens extends \SplFixedArray
 {
@@ -315,7 +312,7 @@ public function offsetSet($index, $newval)
     {
         $this->blockEndCache = [];
 
-        if (!$this[$index] || !$this[$index]->equals($newval)) {
+        if (!isset($this[$index]) || !$this[$index]->equals($newval)) {
             $this->changed = true;
 
             if (isset($this[$index])) {
@@ -365,7 +362,9 @@ public function clearEmptyTokens()
 
         for ($count = $index; $index < $limit; ++$index) {
             if (!$this->isEmptyAt($index)) {
-                $this[$count++] = $this[$index];
+                /** @var Token $token */
+                $token = $this[$index];
+                $this[$count++] = $token;
             }
         }
 
@@ -870,8 +869,8 @@ public function findSequence(array $sequence, $start = 0, $end = null, $caseSens
     /**
      * Insert instances of Token inside collection.
      *
-     * @param int                  $index start inserting index
-     * @param Token|Token[]|Tokens $items instances of Token to insert
+     * @param int                       $index start inserting index
+     * @param array<Token>|Token|Tokens $items instances of Token to insert
      */
     public function insertAt($index, $items)
     {
@@ -963,9 +962,9 @@ public function overrideAt($index, $token)
     /**
      * Override tokens at given range.
      *
-     * @param int            $indexStart start overriding index
-     * @param int            $indexEnd   end overriding index
-     * @param Token[]|Tokens $items      tokens to insert
+     * @param int                 $indexStart start overriding index
+     * @param int                 $indexEnd   end overriding index
+     * @param array<Token>|Tokens $items      tokens to insert
      */
     public function overrideRange($indexStart, $indexEnd, $items)
     {
diff --git a/tests/Cache/CacheTest.php b/tests/Cache/CacheTest.php
@@ -63,19 +63,6 @@ public function testDefaults()
         static::assertNull($cache->get($file));
     }
 
-    public function testSetThrowsInvalidArgumentExceptionIfValueIsNotAnInteger()
-    {
-        $this->expectException(\InvalidArgumentException::class);
-
-        $signature = $this->getSignatureDouble();
-
-        $cache = new Cache($signature);
-
-        $file = 'test.php';
-
-        $cache->set($file, null);
-    }
-
     public function testCanSetAndGetValue()
     {
         $signature = $this->getSignatureDouble();
diff --git a/tests/Fixer/PhpTag/NoClosingTagFixerTest.php b/tests/Fixer/PhpTag/NoClosingTagFixerTest.php
@@ -42,8 +42,6 @@ public function testWithShortOpenTag($expected, $input = null)
     {
         if (!ini_get('short_open_tag')) {
             static::markTestSkipped('The short_open_tag option is required to be enabled.');
-
-            return;
         }
 
         $this->doTest($expected, $input);
diff --git a/tests/FixerDefinition/FixerDefinitionTest.php b/tests/FixerDefinition/FixerDefinitionTest.php
@@ -12,6 +12,7 @@
 
 namespace PhpCsFixer\Tests\FixerDefinition;
 
+use PhpCsFixer\FixerDefinition\CodeSampleInterface;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\Tests\TestCase;
 
@@ -31,9 +32,14 @@ public function testGetSummary()
 
     public function testGetCodeSamples()
     {
-        $definition = new FixerDefinition('', ['Bar', 'Baz']);
+        $samples = [
+            $this->prophesize(CodeSampleInterface::class)->reveal(),
+            $this->prophesize(CodeSampleInterface::class)->reveal(),
+        ];
 
-        static::assertSame(['Bar', 'Baz'], $definition->getCodeSamples());
+        $definition = new FixerDefinition('', $samples);
+
+        static::assertSame($samples, $definition->getCodeSamples());
     }
 
     public function testGetDescription()
diff --git a/tests/PregTest.php b/tests/PregTest.php
@@ -103,7 +103,9 @@ public function testPatternValidation($pattern, $expected = null, $expectedExcep
             return;
         }
 
-        $setup() || $this->addToAssertionCount(1);
+        if (!$setup()) {
+            $this->addToAssertionCount(1);
+        }
     }
 
     /**
@@ -147,7 +149,9 @@ public function testPatternsValidation($pattern, $expected = null, $expectedExce
             return;
         }
 
-        $setup() || $this->addToAssertionCount(1);
+        if (!$setup()) {
+            $this->addToAssertionCount(1);
+        }
     }
 
     public function testMatchAllFailing()
diff --git a/tests/RuleSetTest.php b/tests/RuleSetTest.php
@@ -663,8 +663,6 @@ public function testHasIntegrationTest($setDefinitionName)
 
         if (\in_array($setDefinitionName, $setsWithoutTests, true)) {
             static::markTestIncomplete(sprintf('Set "%s" has no integration test.', $setDefinitionName));
-
-            return;
         }
 
         $setDefinitionFileNamePrefix = str_replace(':', '-', $setDefinitionName);
diff --git a/tests/Test/IntegrationCase.php b/tests/Test/IntegrationCase.php

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ private function isInConditionWithoutBraces(Tokens $tokens, $index, $lowerLimitI`
`162`	`162`	`return true;`
`163`	`163`	`}`
`164`	`164`
`165`		`- if ($token->equals(';', '}')) {`
	`165`	`+ if ($token->equals(';')) {`
`166`	`166`	`return false;`
`167`	`167`	`}`
`168`	`168`	`if ($token->equals('{')) {`