Updated Rector to commit 09398c3d4f07bb6ad664a55b87cab955278a467e

TomasVotruba · TomasVotruba · commit 428336c22c6d · 2024-02-05T16:07:43.000Z
rectorphp/rector-src@09398c3 Decouple AddFunctionVoidReturnTypeWhereNoReturnRector to allow leveling by simple node first (#5563)
diff --git a/config/set/type-declaration.php b/config/set/type-declaration.php
@@ -34,11 +34,12 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\StrictStringParamConcatRector;
 use Rector\TypeDeclaration\Rector\Closure\AddClosureVoidReturnTypeWhereNoReturnRector;
 use Rector\TypeDeclaration\Rector\Empty_\EmptyOnNullableObjectToInstanceOfRector;
+use Rector\TypeDeclaration\Rector\Function_\AddFunctionVoidReturnTypeWhereNoReturnRector;
 use Rector\TypeDeclaration\Rector\FunctionLike\AddParamTypeSplFixedArrayRector;
 use Rector\TypeDeclaration\Rector\FunctionLike\AddReturnTypeDeclarationFromYieldsRector;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictSetUpRector;
 return static function (RectorConfig $rectorConfig) : void {
-    $rectorConfig->rules([AddArrowFunctionReturnTypeRector::class, ParamTypeByMethodCallTypeRector::class, TypedPropertyFromAssignsRector::class, AddReturnTypeDeclarationBasedOnParentClassMethodRector::class, ReturnTypeFromStrictTypedPropertyRector::class, TypedPropertyFromStrictConstructorRector::class, AddClosureVoidReturnTypeWhereNoReturnRector::class, AddVoidReturnTypeWhereNoReturnRector::class, ReturnTypeFromStrictFluentReturnRector::class, ReturnTypeFromReturnNewRector::class, AddMethodCallBasedStrictParamTypeRector::class, ReturnTypeFromStrictBoolReturnExprRector::class, ReturnTypeFromStrictNativeCallRector::class, ReturnTypeFromStrictNewArrayRector::class, ReturnTypeFromStrictScalarReturnExprRector::class, ReturnTypeFromStrictParamRector::class, TypedPropertyFromStrictSetUpRector::class, ParamTypeByParentCallTypeRector::class, AddParamTypeSplFixedArrayRector::class, AddParamTypeBasedOnPHPUnitDataProviderRector::class, AddParamTypeFromPropertyTypeRector::class, AddReturnTypeDeclarationFromYieldsRector::class, ReturnTypeFromReturnDirectArrayRector::class, ReturnTypeFromStrictConstantReturnRector::class, ReturnTypeFromStrictTypedCallRector::class, ReturnNeverTypeRector::class, EmptyOnNullableObjectToInstanceOfRector::class, PropertyTypeFromStrictSetterGetterRector::class, ReturnTypeFromStrictTernaryRector::class, BoolReturnTypeFromStrictScalarReturnsRector::class, NumericReturnTypeFromStrictScalarReturnsRector::class, StrictArrayParamDimFetchRector::class, ReturnUnionTypeRector::class, StrictStringParamConcatRector::class, MergeDateTimePropertyTypeDeclarationRector::class]);
+    $rectorConfig->rules([AddArrowFunctionReturnTypeRector::class, ParamTypeByMethodCallTypeRector::class, TypedPropertyFromAssignsRector::class, AddReturnTypeDeclarationBasedOnParentClassMethodRector::class, ReturnTypeFromStrictTypedPropertyRector::class, TypedPropertyFromStrictConstructorRector::class, AddClosureVoidReturnTypeWhereNoReturnRector::class, AddFunctionVoidReturnTypeWhereNoReturnRector::class, AddVoidReturnTypeWhereNoReturnRector::class, ReturnTypeFromStrictFluentReturnRector::class, ReturnTypeFromReturnNewRector::class, AddMethodCallBasedStrictParamTypeRector::class, ReturnTypeFromStrictBoolReturnExprRector::class, ReturnTypeFromStrictNativeCallRector::class, ReturnTypeFromStrictNewArrayRector::class, ReturnTypeFromStrictScalarReturnExprRector::class, ReturnTypeFromStrictParamRector::class, TypedPropertyFromStrictSetUpRector::class, ParamTypeByParentCallTypeRector::class, AddParamTypeSplFixedArrayRector::class, AddParamTypeBasedOnPHPUnitDataProviderRector::class, AddParamTypeFromPropertyTypeRector::class, AddReturnTypeDeclarationFromYieldsRector::class, ReturnTypeFromReturnDirectArrayRector::class, ReturnTypeFromStrictConstantReturnRector::class, ReturnTypeFromStrictTypedCallRector::class, ReturnNeverTypeRector::class, EmptyOnNullableObjectToInstanceOfRector::class, PropertyTypeFromStrictSetterGetterRector::class, ReturnTypeFromStrictTernaryRector::class, BoolReturnTypeFromStrictScalarReturnsRector::class, NumericReturnTypeFromStrictScalarReturnsRector::class, StrictArrayParamDimFetchRector::class, ReturnUnionTypeRector::class, StrictStringParamConcatRector::class, MergeDateTimePropertyTypeDeclarationRector::class]);
 };
diff --git a/rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php b/rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php
@@ -4,10 +4,8 @@
 namespace Rector\TypeDeclaration\Rector\ClassMethod;
 
 use PhpParser\Node;
-use PhpParser\Node\Expr\Closure;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Stmt\ClassMethod;
-use PhpParser\Node\Stmt\Function_;
 use PhpParser\Node\Stmt\Throw_;
 use Rector\NodeAnalyzer\MagicClassMethodAnalyzer;
 use Rector\Rector\AbstractRector;
@@ -79,10 +77,10 @@ public function getValues(): void
      */
     public function getNodeTypes() : array
     {
-        return [ClassMethod::class, Function_::class, Closure::class];
+        return [ClassMethod::class];
     }
     /**
-     * @param ClassMethod|Function_|Closure $node
+     * @param ClassMethod $node
      */
     public function refactor(Node $node) : ?Node
     {
@@ -96,7 +94,7 @@ public function refactor(Node $node) : ?Node
         if (!$this->silentVoidResolver->hasExclusiveVoid($node)) {
             return null;
         }
-        if ($node instanceof ClassMethod && $this->classMethodReturnVendorLockResolver->isVendorLocked($node)) {
+        if ($this->classMethodReturnVendorLockResolver->isVendorLocked($node)) {
             return null;
         }
         $node->returnType = new Identifier('void');
@@ -106,32 +104,26 @@ public function provideMinPhpVersion() : int
     {
         return PhpVersionFeature::VOID_TYPE;
     }
-    /**
-     * @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure $functionLike
-     */
-    private function shouldSkipClassMethod($functionLike) : bool
+    private function shouldSkipClassMethod(ClassMethod $classMethod) : bool
     {
-        if (!$functionLike instanceof ClassMethod) {
-            return \false;
-        }
-        if ($this->magicClassMethodAnalyzer->isUnsafeOverridden($functionLike)) {
+        if ($this->magicClassMethodAnalyzer->isUnsafeOverridden($classMethod)) {
             return \true;
         }
-        if ($functionLike->isAbstract()) {
+        if ($classMethod->isAbstract()) {
             return \true;
         }
         // is not final and has only exception? possibly implemented by child
-        if ($this->isNotFinalAndHasExceptionOnly($functionLike)) {
+        if ($this->isNotFinalAndHasExceptionOnly($classMethod)) {
             return \true;
         }
         // possibly required by child implementation
-        if ($this->isNotFinalAndEmpty($functionLike)) {
+        if ($this->isNotFinalAndEmpty($classMethod)) {
             return \true;
         }
-        if ($functionLike->isProtected()) {
-            return !$this->classModifierChecker->isInsideFinalClass($functionLike);
+        if ($classMethod->isProtected()) {
+            return !$this->classModifierChecker->isInsideFinalClass($classMethod);
         }
-        return $this->classModifierChecker->isInsideAbstractClass($functionLike) && $functionLike->getStmts() === [];
+        return $this->classModifierChecker->isInsideAbstractClass($classMethod) && $classMethod->getStmts() === [];
     }
     private function isNotFinalAndHasExceptionOnly(ClassMethod $classMethod) : bool
     {
diff --git a/rules/TypeDeclaration/Rector/Function_/AddFunctionVoidReturnTypeWhereNoReturnRector.php b/rules/TypeDeclaration/Rector/Function_/AddFunctionVoidReturnTypeWhereNoReturnRector.php
@@ -0,0 +1,67 @@
+<?php
+
+declare (strict_types=1);
+namespace Rector\TypeDeclaration\Rector\Function_;
+
+use PhpParser\Node;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Stmt\Function_;
+use Rector\Rector\AbstractRector;
+use Rector\TypeDeclaration\TypeInferer\SilentVoidResolver;
+use Rector\ValueObject\PhpVersionFeature;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+/**
+ * @see \Rector\Tests\TypeDeclaration\Rector\Function_\AddFunctionVoidReturnTypeWhereNoReturnRector\AddFunctionVoidReturnTypeWhereNoReturnRectorTest
+ */
+final class AddFunctionVoidReturnTypeWhereNoReturnRector extends AbstractRector implements MinPhpVersionInterface
+{
+    /**
+     * @readonly
+     * @var \Rector\TypeDeclaration\TypeInferer\SilentVoidResolver
+     */
+    private $silentVoidResolver;
+    public function __construct(SilentVoidResolver $silentVoidResolver)
+    {
+        $this->silentVoidResolver = $silentVoidResolver;
+    }
+    public function getRuleDefinition() : RuleDefinition
+    {
+        return new RuleDefinition('Add function return type void if there is no return', [new CodeSample(<<<'CODE_SAMPLE'
+function restore() {
+}
+CODE_SAMPLE
+, <<<'CODE_SAMPLE'
+function restore(): void {
+}
+CODE_SAMPLE
+)]);
+    }
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes() : array
+    {
+        return [Function_::class];
+    }
+    /**
+     * @param Function_ $node
+     */
+    public function refactor(Node $node) : ?Node
+    {
+        // already has return type → skip
+        if ($node->returnType instanceof Node) {
+            return null;
+        }
+        if (!$this->silentVoidResolver->hasExclusiveVoid($node)) {
+            return null;
+        }
+        $node->returnType = new Identifier('void');
+        return $node;
+    }
+    public function provideMinPhpVersion() : int
+    {
+        return PhpVersionFeature::VOID_TYPE;
+    }
+}
diff --git a/src/Application/VersionResolver.php b/src/Application/VersionResolver.php
@@ -19,12 +19,12 @@ final class VersionResolver
      * @api
      * @var string
      */
-    public const PACKAGE_VERSION = '56c250771518c2aa2e17bc64c9986c2dbe9b6fd8';
+    public const PACKAGE_VERSION = '09398c3d4f07bb6ad664a55b87cab955278a467e';
     /**
      * @api
      * @var string
      */
-    public const RELEASE_DATE = '2024-02-05 16:54:04';
+    public const RELEASE_DATE = '2024-02-05 17:05:25';
     /**
      * @var int
      */
diff --git a/src/Configuration/Levels/TypeCoverageLevel.php b/src/Configuration/Levels/TypeCoverageLevel.php
@@ -28,6 +28,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\StrictStringParamConcatRector;
 use Rector\TypeDeclaration\Rector\Closure\AddClosureVoidReturnTypeWhereNoReturnRector;
 use Rector\TypeDeclaration\Rector\Empty_\EmptyOnNullableObjectToInstanceOfRector;
+use Rector\TypeDeclaration\Rector\Function_\AddFunctionVoidReturnTypeWhereNoReturnRector;
 use Rector\TypeDeclaration\Rector\FunctionLike\AddParamTypeSplFixedArrayRector;
 use Rector\TypeDeclaration\Rector\FunctionLike\AddReturnTypeDeclarationFromYieldsRector;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;
@@ -54,7 +55,7 @@ final class TypeCoverageLevel
         // php 7.0
         // start with closure first, as safest
         AddClosureVoidReturnTypeWhereNoReturnRector::class,
-        // @todo continue with functions
+        AddFunctionVoidReturnTypeWhereNoReturnRector::class,
         AddVoidReturnTypeWhereNoReturnRector::class,
         // php 7.4
         AddArrowFunctionReturnTypeRector::class,
diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php
@@ -2360,6 +2360,7 @@
     'Rector\\TypeDeclaration\\Rector\\Empty_\\EmptyOnNullableObjectToInstanceOfRector' => $baseDir . '/rules/TypeDeclaration/Rector/Empty_/EmptyOnNullableObjectToInstanceOfRector.php',
     'Rector\\TypeDeclaration\\Rector\\FunctionLike\\AddParamTypeSplFixedArrayRector' => $baseDir . '/rules/TypeDeclaration/Rector/FunctionLike/AddParamTypeSplFixedArrayRector.php',
     'Rector\\TypeDeclaration\\Rector\\FunctionLike\\AddReturnTypeDeclarationFromYieldsRector' => $baseDir . '/rules/TypeDeclaration/Rector/FunctionLike/AddReturnTypeDeclarationFromYieldsRector.php',
+    'Rector\\TypeDeclaration\\Rector\\Function_\\AddFunctionVoidReturnTypeWhereNoReturnRector' => $baseDir . '/rules/TypeDeclaration/Rector/Function_/AddFunctionVoidReturnTypeWhereNoReturnRector.php',
     'Rector\\TypeDeclaration\\Rector\\Property\\AddPropertyTypeDeclarationRector' => $baseDir . '/rules/TypeDeclaration/Rector/Property/AddPropertyTypeDeclarationRector.php',
     'Rector\\TypeDeclaration\\Rector\\Property\\TypedPropertyFromAssignsRector' => $baseDir . '/rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php',
     'Rector\\TypeDeclaration\\Rector\\Property\\TypedPropertyFromStrictConstructorRector' => $baseDir . '/rules/TypeDeclaration/Rector/Property/TypedPropertyFromStrictConstructorRector.php',
diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php
@@ -2574,6 +2574,7 @@ class ComposerStaticInitf637847380e2ddf55dcae18dded1d2b3
         'Rector\\TypeDeclaration\\Rector\\Empty_\\EmptyOnNullableObjectToInstanceOfRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Empty_/EmptyOnNullableObjectToInstanceOfRector.php',
         'Rector\\TypeDeclaration\\Rector\\FunctionLike\\AddParamTypeSplFixedArrayRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/FunctionLike/AddParamTypeSplFixedArrayRector.php',
         'Rector\\TypeDeclaration\\Rector\\FunctionLike\\AddReturnTypeDeclarationFromYieldsRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/FunctionLike/AddReturnTypeDeclarationFromYieldsRector.php',
+        'Rector\\TypeDeclaration\\Rector\\Function_\\AddFunctionVoidReturnTypeWhereNoReturnRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Function_/AddFunctionVoidReturnTypeWhereNoReturnRector.php',
         'Rector\\TypeDeclaration\\Rector\\Property\\AddPropertyTypeDeclarationRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Property/AddPropertyTypeDeclarationRector.php',
         'Rector\\TypeDeclaration\\Rector\\Property\\TypedPropertyFromAssignsRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php',
         'Rector\\TypeDeclaration\\Rector\\Property\\TypedPropertyFromStrictConstructorRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Property/TypedPropertyFromStrictConstructorRector.php',

Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,8 @@`
`4`	`4`	`namespace Rector\TypeDeclaration\Rector\ClassMethod;`
`5`	`5`
`6`	`6`	`use PhpParser\Node;`
`7`		`-use PhpParser\Node\Expr\Closure;`
`8`	`7`	`use PhpParser\Node\Identifier;`
`9`	`8`	`use PhpParser\Node\Stmt\ClassMethod;`
`10`		`-use PhpParser\Node\Stmt\Function_;`
`11`	`9`	`use PhpParser\Node\Stmt\Throw_;`
`12`	`10`	`use Rector\NodeAnalyzer\MagicClassMethodAnalyzer;`
`13`	`11`	`use Rector\Rector\AbstractRector;`
`@@ -79,10 +77,10 @@ public function getValues(): void`
`79`	`77`	`*/`
`80`	`78`	`public function getNodeTypes() : array`
`81`	`79`	`{`
`82`		`- return [ClassMethod::class, Function_::class, Closure::class];`
	`80`	`+ return [ClassMethod::class];`
`83`	`81`	`}`
`84`	`82`	`/**`
`85`		`- * @param ClassMethod\|Function_\|Closure $node`
	`83`	`+ * @param ClassMethod $node`
`86`	`84`	`*/`
`87`	`85`	`public function refactor(Node $node) : ?Node`
`88`	`86`	`{`
`@@ -96,7 +94,7 @@ public function refactor(Node $node) : ?Node`
`96`	`94`	`if (!$this->silentVoidResolver->hasExclusiveVoid($node)) {`
`97`	`95`	`return null;`
`98`	`96`	`}`
`99`		`- if ($node instanceof ClassMethod && $this->classMethodReturnVendorLockResolver->isVendorLocked($node)) {`
	`97`	`+ if ($this->classMethodReturnVendorLockResolver->isVendorLocked($node)) {`
`100`	`98`	`return null;`
`101`	`99`	`}`
`102`	`100`	`$node->returnType = new Identifier('void');`
`@@ -106,32 +104,26 @@ public function provideMinPhpVersion() : int`
`106`	`104`	`{`
`107`	`105`	`return PhpVersionFeature::VOID_TYPE;`
`108`	`106`	`}`
`109`		`- /**`
`110`		`- * @param \PhpParser\Node\Stmt\ClassMethod\|\PhpParser\Node\Stmt\Function_\|\PhpParser\Node\Expr\Closure $functionLike`
`111`		`- */`
`112`		`- private function shouldSkipClassMethod($functionLike) : bool`
	`107`	`+ private function shouldSkipClassMethod(ClassMethod $classMethod) : bool`
`113`	`108`	`{`
`114`		`- if (!$functionLike instanceof ClassMethod) {`
`115`		`- return \false;`
`116`		`- }`
`117`		`- if ($this->magicClassMethodAnalyzer->isUnsafeOverridden($functionLike)) {`
	`109`	`+ if ($this->magicClassMethodAnalyzer->isUnsafeOverridden($classMethod)) {`
`118`	`110`	`return \true;`
`119`	`111`	`}`
`120`		`- if ($functionLike->isAbstract()) {`
	`112`	`+ if ($classMethod->isAbstract()) {`
`121`	`113`	`return \true;`
`122`	`114`	`}`
`123`	`115`	`// is not final and has only exception? possibly implemented by child`
`124`		`- if ($this->isNotFinalAndHasExceptionOnly($functionLike)) {`
	`116`	`+ if ($this->isNotFinalAndHasExceptionOnly($classMethod)) {`
`125`	`117`	`return \true;`
`126`	`118`	`}`
`127`	`119`	`// possibly required by child implementation`
`128`		`- if ($this->isNotFinalAndEmpty($functionLike)) {`
	`120`	`+ if ($this->isNotFinalAndEmpty($classMethod)) {`
`129`	`121`	`return \true;`
`130`	`122`	`}`
`131`		`- if ($functionLike->isProtected()) {`
`132`		`- return !$this->classModifierChecker->isInsideFinalClass($functionLike);`
	`123`	`+ if ($classMethod->isProtected()) {`
	`124`	`+ return !$this->classModifierChecker->isInsideFinalClass($classMethod);`
`133`	`125`	`}`
`134`		`- return $this->classModifierChecker->isInsideAbstractClass($functionLike) && $functionLike->getStmts() === [];`
	`126`	`+ return $this->classModifierChecker->isInsideAbstractClass($classMethod) && $classMethod->getStmts() === [];`
`135`	`127`	`}`
`136`	`128`	`private function isNotFinalAndHasExceptionOnly(ClassMethod $classMethod) : bool`
`137`	`129`	`{`