Increase PHPStan level to 3

julienfalque · julienfalque · commit 83c8ea1a8d9c · 2020-02-26T09:01:09.000+01:00
diff --git a/dev-tools/composer.json b/dev-tools/composer.json
@@ -4,10 +4,11 @@
     },
     "require-dev": {
         "humbug/box": "^3.8",
+        "jangregor/phpstan-prophecy": "^0.6",
         "localheinz/composer-normalize": "^1.1",
         "mi-schi/phpmd-extension": "^4.3",
         "phpmd/phpmd": "^2.6",
-        "phpstan/phpstan-phpunit": "^0.11.2"
+        "phpstan/phpstan-phpunit": "^0.12"
     },
     "conflict": {
         "hhvm": "*"
diff --git a/dev-tools/install.sh b/dev-tools/install.sh
@@ -56,4 +56,4 @@ composer info -D | sort
 
 echo λλλ phive packages
 
-./bin/phive install --trust-gpg-keys D2CCAC42F6295E7D,8E730BA25823D8B5
+./bin/phive install --trust-gpg-keys D2CCAC42F6295E7D,8E730BA25823D8B5,CF1A108D0E7AE720
diff --git a/dev-tools/phive.xml b/dev-tools/phive.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
   <phar name="composer-require-checker" version="^2.0" installed="2.0.0" location="./tools/composer-require-checker" copy="false"/>
-  <phar name="phpstan" version="^0.11.15" installed="0.11.15" location="./tools/phpstan" 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,14 +1,18 @@
 includes:
+    - dev-tools/vendor/jangregor/phpstan-prophecy/src/extension.neon
     - dev-tools/vendor/phpstan/phpstan-phpunit/extension.neon
 
 parameters:
-    level: 1
+    level: 3
     paths:
         - src
         - tests
     excludes_analyse:
         - tests/Fixtures
     ignoreErrors:
-        - '/^.+::__construct\(\) does not call parent constructor from SplFileInfo\.$/'
         - '/^Return typehint of method PhpCsFixer\\Tests\\Test\\.+::createIsIdenticalStringConstraint\(\) has invalid type PHPUnit_Framework_Constraint_IsIdentical\.$/'
         - '/^Class (Symfony\\Contracts\\EventDispatcher\\Event|Symfony\\Component\\EventDispatcher\\Event) not found.$/'
+        - '/^(Access|Call) to an undefined (property|method) PhpCsFixer\\AccessibleObject\\AccessibleObject::.+$/'
+        -
+            message: '/^Unsafe usage of new static\(\)\.$/'
+            path: src/Config.php
diff --git a/src/AbstractFixer.php b/src/AbstractFixer.php
@@ -140,7 +140,7 @@ public function configure(array $configuration = null)
                     'Option "%s" for rule "%s" is deprecated and will be removed in version %d.0. %s',
                     $name,
                     $this->getName(),
-                    (int) Application::VERSION + 1,
+                    Application::getMajorVersion() + 1,
                     str_replace('`', '"', $option->getDeprecationMessage())
                 );
 
diff --git a/src/Config.php b/src/Config.php
@@ -64,7 +64,7 @@ public function getCustomFixers()
     }
 
     /**
-     * {@inheritdoc}
+     * @return Finder
      */
     public function getFinder()
     {
diff --git a/src/Console/Application.php b/src/Console/Application.php
@@ -63,6 +63,14 @@ public function __construct()
         ));
     }
 
+    /**
+     * @return int
+     */
+    public static function getMajorVersion()
+    {
+        return (int) explode('.', self::VERSION)[0];
+    }
+
     /**
      * {@inheritdoc}
      */
diff --git a/src/Console/Command/DescribeCommand.php b/src/Console/Command/DescribeCommand.php
@@ -25,7 +25,6 @@
 use PhpCsFixer\FixerDefinition\CodeSampleInterface;
 use PhpCsFixer\FixerDefinition\FileSpecificCodeSampleInterface;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
-use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
 use PhpCsFixer\FixerDefinition\VersionSpecificCodeSampleInterface;
 use PhpCsFixer\FixerFactory;
 use PhpCsFixer\Preg;
@@ -330,12 +329,21 @@ private function describeSet(OutputInterface $output, $name)
         $help = '';
 
         foreach ($rules as $rule => $config) {
-            /** @var FixerDefinitionInterface $definition */
-            $definition = $fixers[$rule]->getDefinition();
+            $fixer = $fixers[$rule];
+
+            if (!$fixer instanceof DefinedFixerInterface) {
+                throw new \RuntimeException(sprintf(
+                    'Cannot describe rule %s, the fixer does not implement %s',
+                    $rule,
+                    DefinedFixerInterface::class
+                ));
+            }
+
+            $definition = $fixer->getDefinition();
             $help .= sprintf(
                 " * <info>%s</info>%s\n   | %s\n%s\n",
                 $rule,
-                $fixers[$rule]->isRisky() ? ' <error>risky</error>' : '',
+                $fixer->isRisky() ? ' <error>risky</error>' : '',
                 $definition->getSummary(),
                 true !== $config ? sprintf("   <comment>| Configuration: %s</comment>\n", HelpCommand::toString($config)) : ''
             );
diff --git a/src/Console/Command/HelpCommand.php b/src/Console/Command/HelpCommand.php
@@ -12,6 +12,7 @@
 
 namespace PhpCsFixer\Console\Command;
 
+use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Console\Application;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
@@ -400,7 +401,7 @@ public static function getLatestReleaseVersionFromChangeLog()
             ));
         }
 
-        for ($i = (int) Application::VERSION; $i > 0; --$i) {
+        for ($i = Application::getMajorVersion(); $i > 0; --$i) {
             if (1 === Preg::match('/Changelog for v('.$i.'.\d+.\d+)/', $changelog, $matches)) {
                 $version = $matches[1];
 
@@ -440,6 +441,7 @@ private static function getFixersHelp()
     {
         $help = '';
         $fixerFactory = new FixerFactory();
+        /** @var AbstractFixer[] $fixers */
         $fixers = $fixerFactory->registerBuiltInFixers()->getFixers();
 
         // sort fixers by name
diff --git a/src/Console/ConfigurationResolver.php b/src/Console/ConfigurationResolver.php
@@ -762,7 +762,7 @@ private function validateRules(array $rules)
             if (isset($rules[$fixerName]) && $fixer instanceof DeprecatedFixerInterface) {
                 $successors = $fixer->getSuccessorsNames();
                 $messageEnd = [] === $successors
-                    ? sprintf(' and will be removed in version %d.0.', (int) Application::VERSION + 1)
+                    ? sprintf(' and will be removed in version %d.0.', Application::getMajorVersion())
                     : sprintf('. Use %s instead.', str_replace('`', '"', Utils::naturalLanguageJoinWithBackticks($successors)));
 
                 $message = "Rule \"{$fixerName}\" is deprecated{$messageEnd}";
diff --git a/src/Fixer/FunctionNotation/NoUnreachableDefaultArgumentValueFixer.php b/src/Fixer/FunctionNotation/NoUnreachableDefaultArgumentValueFixer.php
@@ -136,6 +136,8 @@ private function getLastNonDefaultArgumentIndex(Tokens $tokens, $startIndex, $en
                 return $i;
             }
         }
+
+        return null;
     }
 
     /**
diff --git a/src/Fixer/FunctionNotation/PhpdocToReturnTypeFixer.php b/src/Fixer/FunctionNotation/PhpdocToReturnTypeFixer.php
@@ -32,7 +32,7 @@
 final class PhpdocToReturnTypeFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
 {
     /**
-     * @var array<array<int, string>>
+     * @var array<int, array<int, int|string>>
      */
     private $blacklistFuncNames = [
         [T_STRING, '__construct'],
diff --git a/src/Fixer/LanguageConstruct/ClassKeywordRemoveFixer.php b/src/Fixer/LanguageConstruct/ClassKeywordRemoveFixer.php
@@ -95,6 +95,7 @@ private function storeImports(Tokens $tokens, $startIndex, $endIndex)
         $tokensAnalyzer = new TokensAnalyzer($tokens);
         $this->imports = [];
 
+        /** @var int $index */
         foreach ($tokensAnalyzer->getImportUseIndexes() as $index) {
             if ($index < $startIndex || $index > $endIndex) {
                 continue;
diff --git a/src/Fixer/PhpUnit/PhpUnitSizeClassFixer.php b/src/Fixer/PhpUnit/PhpUnitSizeClassFixer.php
@@ -257,7 +257,7 @@ private function getSingleLineDocBlockEntry($line)
     }
 
     /**
-     * @return Annotation[]
+     * @return Annotation[][]
      */
     private function filterDocBlock(DocBlock $doc)
     {
diff --git a/tests/AutoReview/FixerFactoryTest.php b/tests/AutoReview/FixerFactoryTest.php
@@ -441,11 +441,12 @@ public function testProvideFixersPriorityCasesAreSorted()
 
         usort(
             $sorted,
+            /**
+             * @param array<FixerInterface> $priorityPair1
+             * @param array<FixerInterface> $priorityPair2
+             */
             static function (array $priorityPair1, array $priorityPair2) {
-                /** @var FixerInterface $fixer */
                 $fixer1 = $priorityPair1[0];
-
-                /** @var FixerInterface $fixer */
                 $fixer2 = $priorityPair2[0];
 
                 if ($fixer1->getName() === $fixer2->getName()) {
diff --git a/tests/AutoReview/FixerTest.php b/tests/AutoReview/FixerTest.php
@@ -12,9 +12,9 @@
 
 namespace PhpCsFixer\Tests\AutoReview;
 
+use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
-use PhpCsFixer\Fixer\DefinedFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer;
@@ -50,11 +50,10 @@ final class FixerTest extends TestCase
     /**
      * @dataProvider provideFixerDefinitionsCases
      */
-    public function testFixerDefinitions(FixerInterface $fixer)
+    public function testFixerDefinitions(AbstractFixer $fixer)
     {
         static::assertInstanceOf(\PhpCsFixer\Fixer\DefinedFixerInterface::class, $fixer);
 
-        /** @var DefinedFixerInterface $fixer */
         $fixerName = $fixer->getName();
         $definition = $fixer->getDefinition();
         $fixerIsConfigurable = $fixer instanceof ConfigurationDefinitionFixerInterface;
@@ -185,7 +184,7 @@ public function testFixerDefinitions(FixerInterface $fixer)
      * @expectedDeprecation PhpCsFixer\FixerDefinition\FixerDefinition::getConfigurationDescription is deprecated and will be removed in 3.0.
      * @expectedDeprecation PhpCsFixer\FixerDefinition\FixerDefinition::getDefaultConfiguration is deprecated and will be removed in 3.0.
      */
-    public function testLegacyFixerDefinitions(FixerInterface $fixer)
+    public function testLegacyFixerDefinitions(AbstractFixer $fixer)
     {
         $definition = $fixer->getDefinition();
 
@@ -217,7 +216,7 @@ public function testFixersAreDefined(FixerInterface $fixer)
     /**
      * @dataProvider provideFixerDefinitionsCases
      */
-    public function testDeprecatedFixersHaveCorrectSummary(FixerInterface $fixer)
+    public function testDeprecatedFixersHaveCorrectSummary(AbstractFixer $fixer)
     {
         $reflection = new \ReflectionClass($fixer);
         $comment = $reflection->getDocComment();
diff --git a/tests/AutoReview/TravisTest.php b/tests/AutoReview/TravisTest.php
@@ -152,7 +152,7 @@ private function getMaxPhpVersionFromEntryFile()
             throw new \LogicException("Can't find version - perhaps entry file was modified?");
         }
 
-        $phpVerId = end($sequence)->getContent();
+        $phpVerId = (int) end($sequence)->getContent();
 
         return $this->convertPhpVerIdToNiceVer((string) ($phpVerId - 100));
     }
diff --git a/tests/Console/ApplicationTest.php b/tests/Console/ApplicationTest.php
@@ -29,4 +29,9 @@ public function testApplication()
         $app = new Application();
         static::assertStringMatchesFormat('%s by <comment>Fabien Potencier</comment> and <comment>Dariusz Ruminski</comment>', $app->getLongVersion());
     }
+
+    public function testGetMajorVersion()
+    {
+        static::assertSame(2, Application::getMajorVersion());
+    }
 }
diff --git a/tests/Console/Command/SelfUpdateCommandTest.php b/tests/Console/Command/SelfUpdateCommandTest.php
@@ -32,7 +32,7 @@
 final class SelfUpdateCommandTest extends TestCase
 {
     /**
-     * @var vfsStreamDirectory
+     * @var null|vfsStreamDirectory
      */
     private $root;
 
diff --git a/tests/Fixer/ControlStructure/NoUselessElseFixerTest.php b/tests/Fixer/ControlStructure/NoUselessElseFixerTest.php
@@ -781,8 +781,8 @@ public function provideConditionsWithoutBracesCases()
     }
 
     /**
-     * @param string            $input
-     * @param string<int, bool> $indexes
+     * @param string           $input
+     * @param array<int, bool> $indexes
      *
      * @dataProvider provideIsInConditionWithoutBracesCases
      */
@@ -959,7 +959,7 @@ public function provideIsInConditionWithoutBracesCases()
      * @param string      $expected
      * @param null|string $input
      *
-     * @return array<string, string>
+     * @return array<array<string>>
      */
     private function generateCases($expected, $input = null)
     {
diff --git a/tests/Fixer/FunctionNotation/MethodArgumentSpaceFixerTest.php b/tests/Fixer/FunctionNotation/MethodArgumentSpaceFixerTest.php
@@ -12,6 +12,7 @@
 
 namespace PhpCsFixer\Tests\Fixer\FunctionNotation;
 
+use PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer;
 use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixer\WhitespacesFixerConfig;
@@ -25,6 +26,11 @@
  */
 final class MethodArgumentSpaceFixerTest extends AbstractFixerTestCase
 {
+    /**
+     * @var MethodArgumentSpaceFixer
+     */
+    protected $fixer;
+
     /**
      * @param string      $expected
      * @param null|string $input
diff --git a/tests/Fixer/PhpUnit/PhpUnitTestAnnotationFixerTest.php b/tests/Fixer/PhpUnit/PhpUnitTestAnnotationFixerTest.php
@@ -962,7 +962,6 @@ public function test_() {}
      *
      * @param string      $expected
      * @param null|string $input
-     * @param null|array  $config
      */
     public function testFixLegacyCaseOption($expected, $input = null, array $config = [])
     {
diff --git a/tests/Fixer/Phpdoc/PhpdocReturnSelfReferenceFixerTest.php b/tests/Fixer/Phpdoc/PhpdocReturnSelfReferenceFixerTest.php
@@ -156,11 +156,6 @@ public function AB($self)
         $this->doTest($expected, $input);
     }
 
-    /**
-     * Expected after fixing, return type to fix.
-     *
-     * @return array<array<string, string>
-     */
     public function provideGeneratedFixCases()
     {
         return [
diff --git a/tests/Fixer/Whitespace/NoExtraBlankLinesFixerTest.php b/tests/Fixer/Whitespace/NoExtraBlankLinesFixerTest.php
@@ -101,8 +101,7 @@ public function testLegacyConfigNull()
     }
 
     /**
-     * @param int[]         $lineNumberRemoved Line numbers expected to be removed after fixing
-     * @param null|string[] $config
+     * @param int[] $lineNumberRemoved Line numbers expected to be removed after fixing
      *
      * @group legacy
      * @dataProvider provideWithConfigCases
@@ -116,8 +115,7 @@ public function testLegacyWithConfig(array $lineNumberRemoved, array $config)
     }
 
     /**
-     * @param int[]         $lineNumberRemoved Line numbers expected to be removed after fixing
-     * @param null|string[] $config
+     * @param int[] $lineNumberRemoved Line numbers expected to be removed after fixing
      *
      * @dataProvider provideWithConfigCases
      */
diff --git a/tests/FixerFactoryTest.php b/tests/FixerFactoryTest.php
@@ -12,7 +12,6 @@
 
 namespace PhpCsFixer\Tests;
 
-use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\FixerFactory;
 use PhpCsFixer\RuleSet;
 use PhpCsFixer\WhitespacesFixerConfig;
@@ -343,7 +342,6 @@ public function testConfigurableFixerIsConfigured()
 
     private function createFixerDouble($name, $priority = 0)
     {
-        /** @var FixerInterface $fixer */
         $fixer = $this->prophesize(\PhpCsFixer\Fixer\FixerInterface::class);
         $fixer->getName()->willReturn($name);
         $fixer->getPriority()->willReturn($priority);
diff --git a/tests/Indicator/PhpUnitTestCaseIndicatorTest.php b/tests/Indicator/PhpUnitTestCaseIndicatorTest.php
@@ -123,8 +123,8 @@ public function testThrowsExceptionIfNotClass()
     }
 
     /**
-     * @param array<[int, int]> $expectedIndexes
-     * @param string            $code
+     * @param array<int,int> $expectedIndexes
+     * @param string         $code
      *
      * @dataProvider provideFindPhpUnitClassesCases
      */
diff --git a/tests/PregTest.php b/tests/PregTest.php
@@ -66,7 +66,7 @@ public function providePatternValidationCases()
     /**
      * @dataProvider providePatternValidationCases
      *
-     * @param $pattern
+     * @param string      $pattern
      * @param null|int    $expected
      * @param null|string $expectedException
      * @param null|string $expectedMessage
diff --git a/tests/Report/AbstractReporterTestCase.php b/tests/Report/AbstractReporterTestCase.php
@@ -24,7 +24,7 @@
 abstract class AbstractReporterTestCase extends TestCase
 {
     /**
-     * @var ReporterInterface
+     * @var null|ReporterInterface
      */
     protected $reporter;
 
diff --git a/tests/Report/CheckstyleReporterTest.php b/tests/Report/CheckstyleReporterTest.php
diff --git a/tests/Report/JunitReporterTest.php b/tests/Report/JunitReporterTest.php
diff --git a/tests/Report/XmlReporterTest.php b/tests/Report/XmlReporterTest.php
diff --git a/tests/RuleSetTest.php b/tests/RuleSetTest.php
diff --git a/tests/Test/AbstractFixerTestCase.php b/tests/Test/AbstractFixerTestCase.php
diff --git a/tests/Test/AbstractFixerWithAliasedOptionsTestCase.php b/tests/Test/AbstractFixerWithAliasedOptionsTestCase.php
diff --git a/tests/Test/AbstractIntegrationTestCase.php b/tests/Test/AbstractIntegrationTestCase.php

Original file line number	Diff line number	Diff line change
`@@ -56,4 +56,4 @@ composer info -D \| sort`
`56`	`56`
`57`	`57`	`echo λλλ phive packages`
`58`	`58`
`59`		`-./bin/phive install --trust-gpg-keys D2CCAC42F6295E7D,8E730BA25823D8B5`
	`59`	`+./bin/phive install --trust-gpg-keys D2CCAC42F6295E7D,8E730BA25823D8B5,CF1A108D0E7AE720`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function getCustomFixers()`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`
`67`		`- * {@inheritdoc}`
	`67`	`+ * @return Finder`
`68`	`68`	`*/`
`69`	`69`	`public function getFinder()`
`70`	`70`	`{`