[TypeDeclaration] Add FalseReturnClassMethodToNullableRector (#3229)

rectorphp · Dec 20, 2022 · 394fa70 · 394fa70
1 parent cf2805b
commit 394fa70
Show file tree

Hide file tree

Showing 32 changed files with 476 additions and 75 deletions.
diff --git a/build/target-repository/docs/rector_rules_overview.md b/build/target-repository/docs/rector_rules_overview.md
@@ -1,4 +1,4 @@
-# 413 Rules Overview
+# 414 Rules Overview
 
 <br>
 
@@ -64,7 +64,7 @@
 
 - [Transform](#transform) (34)
 
-- [TypeDeclaration](#typedeclaration) (37)
+- [TypeDeclaration](#typedeclaration) (38)
 
 - [Visibility](#visibility) (3)
 
@@ -711,17 +711,11 @@ Flip type control to use exclusive type
 - class: [`Rector\CodeQuality\Rector\Identical\FlipTypeControlToUseExclusiveTypeRector`](../rules/CodeQuality/Rector/Identical/FlipTypeControlToUseExclusiveTypeRector.php)
 
 ```diff
- class SomeClass
- {
-     public function __construct(array $values)
-     {
--        /** @var PhpDocInfo|null $phpDocInfo */
-         $phpDocInfo = $functionLike->getAttribute(AttributeKey::PHP_DOC_INFO);
--        if ($phpDocInfo === null) {
-+        if (! $phpDocInfo instanceof PhpDocInfo) {
-             return;
-         }
-     }
+-/** @var PhpDocInfo|null $phpDocInfo */
+ $phpDocInfo = $functionLike->getAttribute(AttributeKey::PHP_DOC_INFO);
+-if ($phpDocInfo === null) {
++if (! $phpDocInfo instanceof PhpDocInfo) {
+     return;
  }
 ```
 
@@ -9176,6 +9170,33 @@ Add array shape exact types based on constant keys of array
 
 <br>
 
+### FalseReturnClassMethodToNullableRector
+
+Change class method that returns false as invalid state, to nullable
+
+- class: [`Rector\TypeDeclaration\Rector\ClassMethod\FalseReturnClassMethodToNullableRector`](../rules/TypeDeclaration/Rector/ClassMethod/FalseReturnClassMethodToNullableRector.php)
+
+```diff
+ class SomeClass
+ {
+-    /**
+-     * @return false|int
+-     */
+-    public function run(int $number)
++    public function run(int $number): ?int
+     {
+         if ($number === 10) {
+-            return false;
++            return null;
+         }
+
+         return $number;
+     }
+ }
+```
+
+<br>
+
 ### ParamAnnotationIncorrectNullableRector
 
 Add or remove null type from `@param` phpdoc typehint based on php parameter type declaration

diff --git a/packages/PHPStanStaticTypeMapper/Contract/TypeMapperInterface.php b/packages/PHPStanStaticTypeMapper/Contract/TypeMapperInterface.php
@@ -6,6 +6,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\ComplexType;
+use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Type;
@@ -30,7 +31,7 @@ public function mapToPHPStanPhpDocTypeNode(Type $type, string $typeKind): TypeNo
     /**
      * @param TType $type
      * @param TypeKind::* $typeKind
-     * @return Name|ComplexType|null
+     * @return Name|ComplexType|Identifier|null
      */
     public function mapToPhpParserNode(Type $type, string $typeKind): ?Node;
 }
diff --git a/packages/PHPStanStaticTypeMapper/PHPStanStaticTypeMapper.php b/packages/PHPStanStaticTypeMapper/PHPStanStaticTypeMapper.php
@@ -5,6 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper;
 
 use PhpParser\Node\ComplexType;
+use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
@@ -56,7 +57,7 @@ public function mapToPHPStanPhpDocTypeNode(Type $type, string $typeKind): TypeNo
     /**
      * @param TypeKind::* $typeKind
      */
-    public function mapToPhpParserNode(Type $type, string $typeKind): Name | ComplexType | null
+    public function mapToPhpParserNode(Type $type, string $typeKind): Name | ComplexType | Identifier | null
     {
         foreach ($this->typeMappers as $typeMapper) {
             if (! is_a($type, $typeMapper->getNodeClass(), true)) {

diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryLiteralStringTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryLiteralStringTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Accessory\AccessoryLiteralStringType;
@@ -49,6 +49,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryNonEmptyStringTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryNonEmptyStringTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
@@ -49,6 +49,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryNonFalsyStringTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryNonFalsyStringTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Accessory\AccessoryNonFalsyStringType;
@@ -49,6 +49,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryNumericStringTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/AccessoryNumericStringTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Accessory\AccessoryNumericStringType;
@@ -49,6 +49,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/ArrayTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/ArrayTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
@@ -124,7 +124,7 @@ public function mapToPHPStanPhpDocTypeNode(Type $type, string $typeKind): TypeNo
      */
     public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
     {
-        return new Name('array');
+        return new Identifier('array');
     }
 
     /**

diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/BooleanTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/BooleanTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\BooleanType;
@@ -60,10 +60,10 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
         }
 
         if ($this->isFalseBooleanTypeWithUnion($type)) {
-            return new Name('false');
+            return new Identifier('false');
         }
 
-        return new Name('bool');
+        return new Identifier('bool');
     }
 
     private function isFalseBooleanTypeWithUnion(Type $type): bool

diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/ClassStringTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/ClassStringTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\ClassStringType;
@@ -55,6 +55,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/GenericClassStringTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/GenericClassStringTypeMapper.php
@@ -6,7 +6,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
@@ -66,7 +66,7 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 
     private function resolveGenericObjectType(GenericClassStringType $genericClassStringType): ObjectType|Type

diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/HasOffsetTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/HasOffsetTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
@@ -39,6 +39,6 @@ public function mapToPHPStanPhpDocTypeNode(Type $type, string $typeKind): TypeNo
      */
     public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
     {
-        return new Name('array');
+        return new Identifier('array');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/HasOffsetValueTypeTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/HasOffsetValueTypeTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
@@ -39,6 +39,6 @@ public function mapToPHPStanPhpDocTypeNode(Type $type, string $typeKind): TypeNo
      */
     public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
     {
-        return new Name('array');
+        return new Identifier('array');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/IntegerTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/IntegerTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\IntegerType;
@@ -49,6 +49,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('int');
+        return new Identifier('int');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/NonEmptyArrayTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/NonEmptyArrayTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Accessory\NonEmptyArrayType;
@@ -39,6 +39,6 @@ public function mapToPHPStanPhpDocTypeNode(Type $type, string $typeKind): TypeNo
      */
     public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
     {
-        return new Name('array');
+        return new Identifier('array');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/StringTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/StringTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\StringType;
@@ -46,6 +46,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 }
diff --git a/packages/PHPStanStaticTypeMapper/TypeMapper/TypeWithClassNameTypeMapper.php b/packages/PHPStanStaticTypeMapper/TypeMapper/TypeWithClassNameTypeMapper.php
@@ -5,7 +5,7 @@
 namespace Rector\PHPStanStaticTypeMapper\TypeMapper;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
+use PhpParser\Node\Identifier;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Type;
@@ -49,6 +49,6 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
             return null;
         }
 
-        return new Name('string');
+        return new Identifier('string');
     }
 }