[DX] Add strict PHPStan rules - step #4 (#1333)

Co-authored-by: GitHub Action <action@github.com>
rectorphp · Nov 28, 2021 · 185ee1b · 185ee1b
1 parent 6340d26
commit 185ee1b
Show file tree

Hide file tree

Showing 35 changed files with 109 additions and 85 deletions.
diff --git a/packages/BetterPhpDocParser/Printer/PhpDocInfoPrinter.php b/packages/BetterPhpDocParser/Printer/PhpDocInfoPrinter.php
@@ -177,7 +177,7 @@ private function printPhpDocNode(PhpDocNode $phpDocNode): string
         if (StringUtils::isMatch(
             $output,
             self::OPENING_DOCBLOCK_REGEX
-        ) && $output && ! StringUtils::isMatch($output, self::CLOSING_DOCBLOCK_REGEX)) {
+        ) && ! StringUtils::isMatch($output, self::CLOSING_DOCBLOCK_REGEX)) {
             $output .= ' */';
         }
 
@@ -247,7 +247,12 @@ private function printEnd(string $output): string
     {
         $lastTokenPosition = $this->getCurrentPhpDocInfo()
             ->getPhpDocNode()
-            ->getAttribute(PhpDocAttributeKey::LAST_PHP_DOC_TOKEN_POSITION) ?: $this->currentTokenPosition;
+            ->getAttribute(PhpDocAttributeKey::LAST_PHP_DOC_TOKEN_POSITION);
+
+        if ($lastTokenPosition === null) {
+            $lastTokenPosition = $this->currentTokenPosition;
+        }
+
         if ($lastTokenPosition === 0) {
             $lastTokenPosition = 1;
         }

diff --git a/packages/Caching/Config/FileHashComputer.php b/packages/Caching/Config/FileHashComputer.php
@@ -56,7 +56,7 @@ private function createFileLoader(string $filePath, ContainerBuilder $containerB
 
         $loaderResolver = new LoaderResolver($fileLoaders);
         $loader = $loaderResolver->resolve($filePath);
-        if (! $loader) {
+        if ($loader === false) {
             throw new ShouldNotHappenException();
         }
 

diff --git a/packages/ChangesReporting/Output/ConsoleOutputFormatter.php b/packages/ChangesReporting/Output/ConsoleOutputFormatter.php
@@ -82,7 +82,7 @@ private function reportFileDiffs(array $fileDiffs): void
             $message = sprintf('<options=bold>%d) %s</>', ++$i, $relativeFilePath);
 
             $this->outputStyle->writeln($message);
-            $this->outputStyle->newLine();
+            $this->outputStyle->newline();
             $this->outputStyle->writeln($fileDiff->getDiffConsoleFormatted());
 
             $rectorsChangelogsLines = $this->createRectorChangelogLines($fileDiff);

diff --git a/packages/NodeTypeResolver/NodeTypeResolver/VariableTypeResolver.php b/packages/NodeTypeResolver/NodeTypeResolver/VariableTypeResolver.php
@@ -5,6 +5,7 @@
 namespace Rector\NodeTypeResolver\NodeTypeResolver;
 
 use PhpParser\Node;
+use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Param;
 use PHPStan\Analyser\Scope;
@@ -17,6 +18,8 @@
 
 /**
  * @see \Rector\Tests\NodeTypeResolver\PerNodeTypeResolver\VariableTypeResolver\VariableTypeResolverTest
+ *
+ * @implements NodeTypeResolverInterface<Variable>
  */
 final class VariableTypeResolver implements NodeTypeResolverInterface
 {
@@ -27,7 +30,7 @@ public function __construct(
     }
 
     /**
-     * @return array<class-string<Node>>
+     * @return array<class-string<Expr>>
      */
     public function getNodeClasses(): array
     {

diff --git a/packages/NodeTypeResolver/PHPStan/Type/StaticTypeAnalyzer.php b/packages/NodeTypeResolver/PHPStan/Type/StaticTypeAnalyzer.php
@@ -86,6 +86,10 @@ private function isAlwaysTruableUnionType(Type $type): bool
     private function isAlwaysTruableArrayType(ArrayType $arrayType): bool
     {
         $itemType = $arrayType->getItemType();
-        return $itemType instanceof ConstantScalarType && $itemType->getValue();
+        if (! $itemType instanceof ConstantScalarType) {
+            return false;
+        }
+
+        return (bool) $itemType->getValue();
     }
 }
diff --git a/...solver/Reflection/BetterReflection/SourceLocatorProvider/DynamicSourceLocatorProvider.php b/...solver/Reflection/BetterReflection/SourceLocatorProvider/DynamicSourceLocatorProvider.php
@@ -52,7 +52,7 @@ public function provide(): SourceLocator
         // do not cache for PHPUnit, as in test every fixture is different
         $isPHPUnitRun = StaticPHPUnitEnvironment::isPHPUnitRun();
 
-        if ($this->aggregateSourceLocator && ! $isPHPUnitRun) {
+        if ($this->aggregateSourceLocator instanceof AggregateSourceLocator && ! $isPHPUnitRun) {
             return $this->aggregateSourceLocator;
         }
 

diff --git a/packages/Parallel/Application/ParallelFileProcessor.php b/packages/Parallel/Application/ParallelFileProcessor.php
@@ -179,10 +179,7 @@ function (array $json) use (
                         $fileDiffs[] = FileDiff::decode($jsonError);
                     }
 
-                    // @todo why there is a null check?
-                    if ($postFileCallback !== null) {
-                        $postFileCallback($json[Bridge::FILES_COUNT]);
-                    }
+                    $postFileCallback($json[Bridge::FILES_COUNT]);
 
                     $systemErrorsCount += $json[Bridge::SYSTEM_ERRORS_COUNT];
                     if ($systemErrorsCount >= self::SYSTEM_ERROR_COUNT_LIMIT) {

diff --git a/packages/ReadWrite/Contract/ReadNodeAnalyzerInterface.php b/packages/ReadWrite/Contract/ReadNodeAnalyzerInterface.php
@@ -4,11 +4,17 @@
 
 namespace Rector\ReadWrite\Contract;
 
-use PhpParser\Node;
+use PhpParser\Node\Expr;
 
+/**
+ * @template TExpr as Expr
+ */
 interface ReadNodeAnalyzerInterface
 {
-    public function supports(Node $node): bool;
+    public function supports(Expr $expr): bool;
 
-    public function isRead(Node $node): bool;
+    /**
+     * @param TExpr $expr
+     */
+    public function isRead(Expr $expr): bool;
 }
diff --git a/packages/ReadWrite/ReadNodeAnalyzer/LocalPropertyFetchReadNodeAnalyzer.php b/packages/ReadWrite/ReadNodeAnalyzer/LocalPropertyFetchReadNodeAnalyzer.php
@@ -5,6 +5,7 @@
 namespace Rector\ReadWrite\ReadNodeAnalyzer;
 
 use PhpParser\Node;
+use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\StaticPropertyFetch;
 use PhpParser\Node\Stmt\Class_;
@@ -13,6 +14,9 @@
 use Rector\NodeNameResolver\NodeNameResolver;
 use Rector\ReadWrite\Contract\ReadNodeAnalyzerInterface;
 
+/**
+ * @implements ReadNodeAnalyzerInterface<PropertyFetch|StaticPropertyFetch>
+ */
 final class LocalPropertyFetchReadNodeAnalyzer implements ReadNodeAnalyzerInterface
 {
     public function __construct(
@@ -23,23 +27,20 @@ public function __construct(
     ) {
     }
 
-    public function supports(Node $node): bool
+    public function supports(Expr $expr): bool
     {
-        return $node instanceof PropertyFetch || $node instanceof StaticPropertyFetch;
+        return $expr instanceof PropertyFetch || $expr instanceof StaticPropertyFetch;
     }
 
-    /**
-     * @param PropertyFetch $node
-     */
-    public function isRead(Node $node): bool
+    public function isRead(Expr $expr): bool
     {
-        $class = $this->betterNodeFinder->findParentType($node, Class_::class);
+        $class = $this->betterNodeFinder->findParentType($expr, Class_::class);
         if (! $class instanceof Class_) {
             // assume worse to keep node protected
             return true;
         }
 
-        $propertyName = $this->nodeNameResolver->getName($node->name);
+        $propertyName = $this->nodeNameResolver->getName($expr->name);
         if ($propertyName === null) {
             // assume worse to keep node protected
             return true;

diff --git a/packages/ReadWrite/ReadNodeAnalyzer/VariableReadNodeAnalyzer.php b/packages/ReadWrite/ReadNodeAnalyzer/VariableReadNodeAnalyzer.php
@@ -4,12 +4,15 @@
 
 namespace Rector\ReadWrite\ReadNodeAnalyzer;
 
-use PhpParser\Node;
+use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\Variable;
 use Rector\NodeNestingScope\ParentScopeFinder;
 use Rector\ReadWrite\Contract\ReadNodeAnalyzerInterface;
 use Rector\ReadWrite\NodeFinder\NodeUsageFinder;
 
+/**
+ * @implements ReadNodeAnalyzerInterface<Variable>
+ */
 final class VariableReadNodeAnalyzer implements ReadNodeAnalyzerInterface
 {
     public function __construct(
@@ -19,22 +22,22 @@ public function __construct(
     ) {
     }
 
-    public function supports(Node $node): bool
+    public function supports(Expr $expr): bool
     {
-        return $node instanceof Variable;
+        return $expr instanceof Variable;
     }
 
     /**
-     * @param Variable $node
+     * @param Variable $expr
      */
-    public function isRead(Node $node): bool
+    public function isRead(Expr $expr): bool
     {
-        $parentScope = $this->parentScopeFinder->find($node);
+        $parentScope = $this->parentScopeFinder->find($expr);
         if ($parentScope === null) {
             return false;
         }
 
-        $variableUsages = $this->nodeUsageFinder->findVariableUsages((array) $parentScope->stmts, $node);
+        $variableUsages = $this->nodeUsageFinder->findVariableUsages((array) $parentScope->stmts, $expr);
         foreach ($variableUsages as $variableUsage) {
             if ($this->justReadExprAnalyzer->isReadContext($variableUsage)) {
                 return true;

diff --git a/packages/StaticTypeMapper/Contract/PhpDocParser/PhpDocTypeMapperInterface.php b/packages/StaticTypeMapper/Contract/PhpDocParser/PhpDocTypeMapperInterface.php
@@ -9,12 +9,18 @@
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Type;
 
+/**
+ * @template TTypeNode as TypeNode
+ */
 interface PhpDocTypeMapperInterface
 {
     /**
-     * @return class-string<TypeNode>
+     * @return class-string<TTypeNode>
      */
     public function getNodeType(): string;
 
+    /**
+     * @param TTypeNode $typeNode
+     */
     public function mapToPHPStanType(TypeNode $typeNode, Node $node, NameScope $nameScope): Type;
 }
diff --git a/packages/StaticTypeMapper/Naming/NameScopeFactory.php b/packages/StaticTypeMapper/Naming/NameScopeFactory.php
@@ -14,7 +14,6 @@
 use PHPStan\Type\Generic\TemplateTypeMap;
 use PHPStan\Type\Type;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
-use Rector\Core\Exception\ShouldNotHappenException;
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\StaticTypeMapper\StaticTypeMapper;
@@ -96,15 +95,10 @@ private function resolveUseNamesByAlias(array $useNodes): array
                 $aliasName = $useUse->getAlias()
                     ->name;
 
-                $useName = $useUse->name->toString();
-                if (! is_string($useName)) {
-                    throw new ShouldNotHappenException();
-                }
-
                 // uses must be lowercase, as PHPStan lowercases it
                 $lowercasedAliasName = strtolower($aliasName);
 
-                $useNamesByAlias[$lowercasedAliasName] = $useName;
+                $useNamesByAlias[$lowercasedAliasName] = $useUse->name->toString();
             }
         }
 

diff --git a/packages/StaticTypeMapper/PhpDocParser/IdentifierTypeMapper.php b/packages/StaticTypeMapper/PhpDocParser/IdentifierTypeMapper.php
@@ -27,6 +27,9 @@
 use Rector\StaticTypeMapper\ValueObject\Type\SelfObjectType;
 use Rector\TypeDeclaration\PHPStan\Type\ObjectTypeSpecifier;
 
+/**
+ * @implements PhpDocTypeMapperInterface<IdentifierTypeNode>
+ */
 final class IdentifierTypeMapper implements PhpDocTypeMapperInterface
 {
     public function __construct(
@@ -38,9 +41,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return class-string<TypeNode>
-     */
     public function getNodeType(): string
     {
         return IdentifierTypeNode::class;

diff --git a/packages/StaticTypeMapper/PhpDocParser/IntersectionTypeMapper.php b/packages/StaticTypeMapper/PhpDocParser/IntersectionTypeMapper.php
@@ -14,13 +14,13 @@
 use Rector\StaticTypeMapper\PhpDoc\PhpDocTypeMapper;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements PhpDocTypeMapperInterface<IntersectionTypeNode>
+ */
 final class IntersectionTypeMapper implements PhpDocTypeMapperInterface
 {
     private PhpDocTypeMapper $phpDocTypeMapper;
 
-    /**
-     * @return class-string<TypeNode>
-     */
     public function getNodeType(): string
     {
         return IntersectionTypeNode::class;

diff --git a/packages/StaticTypeMapper/PhpDocParser/NullableTypeMapper.php b/packages/StaticTypeMapper/PhpDocParser/NullableTypeMapper.php
@@ -15,6 +15,9 @@
 use PHPStan\Type\UnionType;
 use Rector\StaticTypeMapper\Contract\PhpDocParser\PhpDocTypeMapperInterface;
 
+/**
+ * @implements PhpDocTypeMapperInterface<NullableTypeNode>
+ */
 final class NullableTypeMapper implements PhpDocTypeMapperInterface
 {
     public function __construct(
@@ -23,17 +26,11 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return class-string<TypeNode>
-     */
     public function getNodeType(): string
     {
         return NullableTypeNode::class;
     }
 
-    /**
-     * @param NullableTypeNode $typeNode
-     */
     public function mapToPHPStanType(TypeNode $typeNode, Node $node, NameScope $nameScope): Type
     {
         $type = $typeNode->type;

diff --git a/packages/StaticTypeMapper/PhpDocParser/UnionTypeMapper.php b/packages/StaticTypeMapper/PhpDocParser/UnionTypeMapper.php
@@ -14,6 +14,9 @@
 use Rector\StaticTypeMapper\PhpDoc\PhpDocTypeMapper;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements PhpDocTypeMapperInterface<UnionTypeNode>
+ */
 final class UnionTypeMapper implements PhpDocTypeMapperInterface
 {
     private PhpDocTypeMapper $phpDocTypeMapper;
@@ -23,9 +26,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return class-string<TypeNode>
-     */
     public function getNodeType(): string
     {
         return UnionTypeNode::class;

diff --git a/packages/StaticTypeMapper/PhpParser/ExprNodeMapper.php b/packages/StaticTypeMapper/PhpParser/ExprNodeMapper.php
@@ -17,9 +17,6 @@
  */
 final class ExprNodeMapper implements PhpParserNodeMapperInterface
 {
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return Expr::class;

diff --git a/packages/StaticTypeMapper/PhpParser/FullyQualifiedNodeMapper.php b/packages/StaticTypeMapper/PhpParser/FullyQualifiedNodeMapper.php
@@ -28,9 +28,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return FullyQualified::class;

diff --git a/packages/StaticTypeMapper/PhpParser/IdentifierNodeMapper.php b/packages/StaticTypeMapper/PhpParser/IdentifierNodeMapper.php
@@ -20,9 +20,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return Identifier::class;

diff --git a/packages/StaticTypeMapper/PhpParser/NameNodeMapper.php b/packages/StaticTypeMapper/PhpParser/NameNodeMapper.php
@@ -42,9 +42,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return Name::class;

diff --git a/packages/StaticTypeMapper/PhpParser/StringNodeMapper.php b/packages/StaticTypeMapper/PhpParser/StringNodeMapper.php
@@ -15,9 +15,6 @@
  */
 final class StringNodeMapper implements PhpParserNodeMapperInterface
 {
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return String_::class;