Updated Rector to commit 3e0132d324099a3d45e1f8f0d28be76d310ee0eb

3e0132d324 [CodeQuality] Add CompleteMissingIfElseBracketRector (#5121)
2023-10-05 14:38:05 +00:00 · 2023-10-05 14:38:05 +00:00 · 798d9b99b4
parent 75299a0e31
commit 798d9b99b4
7 changed files with 136 additions and 15 deletions
--- a/config/set/code-quality.php
+++ b/config/set/code-quality.php
@ -52,6 +52,7 @@ use Rector\CodeQuality\Rector\Identical\SimplifyBoolIdenticalTrueRector;
 use Rector\CodeQuality\Rector\Identical\SimplifyConditionsRector;
 use Rector\CodeQuality\Rector\Identical\StrlenZeroToIdenticalEmptyStringRector;
 use Rector\CodeQuality\Rector\If_\CombineIfRector;
+use Rector\CodeQuality\Rector\If_\CompleteMissingIfElseBracketRector;
 use Rector\CodeQuality\Rector\If_\ConsecutiveNullCompareReturnsToNullCoalesceQueueRector;
 use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
 use Rector\CodeQuality\Rector\If_\ShortenElseIfRector;
@ -108,5 +109,5 @@ return static function (RectorConfig $rectorConfig) : void {
        'mbstrrpos' => 'mb_strrpos',
        'mbsubstr' => 'mb_substr',
    ]);
-    $rectorConfig->rules([CombinedAssignRector::class, SimplifyEmptyArrayCheckRector::class, ReplaceMultipleBooleanNotRector::class, ForeachToInArrayRector::class, SimplifyForeachToCoalescingRector::class, SimplifyFuncGetArgsCountRector::class, SimplifyInArrayValuesRector::class, SimplifyStrposLowerRector::class, GetClassToInstanceOfRector::class, SimplifyArraySearchRector::class, SimplifyConditionsRector::class, SimplifyIfNotNullReturnRector::class, SimplifyIfReturnBoolRector::class, SimplifyUselessVariableRector::class, UnnecessaryTernaryExpressionRector::class, RemoveExtraParametersRector::class, SimplifyDeMorganBinaryRector::class, SimplifyTautologyTernaryRector::class, SingleInArrayToCompareRector::class, SimplifyIfElseToTernaryRector::class, JoinStringConcatRector::class, ConsecutiveNullCompareReturnsToNullCoalesceQueueRector::class, ExplicitBoolCompareRector::class, CombineIfRector::class, UseIdenticalOverEqualWithSameTypeRector::class, SimplifyBoolIdenticalTrueRector::class, SimplifyRegexPatternRector::class, BooleanNotIdenticalToNotIdenticalRector::class, StrvalToTypeCastRector::class, FloatvalToTypeCastRector::class, CallableThisArrayToAnonymousFunctionRector::class, AndAssignsToSeparateLinesRector::class, CompactToVariablesRector::class, CompleteDynamicPropertiesRector::class, IsAWithStringWithThirdArgumentRector::class, StrlenZeroToIdenticalEmptyStringRector::class, ThrowWithPreviousExceptionRector::class, RemoveSoleValueSprintfRector::class, ShortenElseIfRector::class, ArrayMergeOfNonArraysToSimpleArrayRector::class, IntvalToTypeCastRector::class, BoolvalToTypeCastRector::class, ArrayKeyExistsTernaryThenValueToCoalescingRector::class, AbsolutizeRequireAndIncludePathRector::class, ChangeArrayPushToArrayAssignRector::class, ForRepeatedCountToOwnVariableRector::class, ForeachItemsAssignToEmptyArrayToAssignRector::class, InlineIfToExplicitIfRector::class, UnusedForeachValueToArrayKeysRector::class, CommonNotEqualRector::class, SetTypeToCastRector::class, LogicalToBooleanRector::class, VarToPublicPropertyRector::class, IssetOnPropertyObjectToPropertyExistsRector::class, NewStaticToNewSelfRector::class, UnwrapSprintfOneArgumentRector::class, SwitchNegatedTernaryRector::class, SingularSwitchToIfRector::class, SimplifyIfNullableReturnRector::class, FuncGetArgsToVariadicParamRector::class, CallUserFuncToMethodCallRector::class, CallUserFuncWithArrowFunctionToInlineRector::class, CountArrayToEmptyArrayComparisonRector::class, FlipTypeControlToUseExclusiveTypeRector::class, InlineArrayReturnAssignRector::class, InlineIsAInstanceOfRector::class, TernaryFalseExpressionToIfRector::class, InlineConstructorDefaultToPropertyRector::class, TernaryEmptyArrayArrayDimFetchToCoalesceRector::class, OptionalParametersAfterRequiredRector::class, SimplifyEmptyCheckOnEmptyArrayRector::class, SwitchTrueToIfRector::class, CleanupUnneededNullsafeOperatorRector::class, DisallowedEmptyRuleFixerRector::class, ConvertStaticPrivateConstantToSelfRector::class, LocallyCalledStaticMethodToNonStaticRector::class, NumberCompareToMaxFuncCallRector::class]);
+    $rectorConfig->rules([CombinedAssignRector::class, SimplifyEmptyArrayCheckRector::class, ReplaceMultipleBooleanNotRector::class, ForeachToInArrayRector::class, SimplifyForeachToCoalescingRector::class, SimplifyFuncGetArgsCountRector::class, SimplifyInArrayValuesRector::class, SimplifyStrposLowerRector::class, GetClassToInstanceOfRector::class, SimplifyArraySearchRector::class, SimplifyConditionsRector::class, SimplifyIfNotNullReturnRector::class, SimplifyIfReturnBoolRector::class, SimplifyUselessVariableRector::class, UnnecessaryTernaryExpressionRector::class, RemoveExtraParametersRector::class, SimplifyDeMorganBinaryRector::class, SimplifyTautologyTernaryRector::class, SingleInArrayToCompareRector::class, SimplifyIfElseToTernaryRector::class, JoinStringConcatRector::class, ConsecutiveNullCompareReturnsToNullCoalesceQueueRector::class, ExplicitBoolCompareRector::class, CombineIfRector::class, UseIdenticalOverEqualWithSameTypeRector::class, SimplifyBoolIdenticalTrueRector::class, SimplifyRegexPatternRector::class, BooleanNotIdenticalToNotIdenticalRector::class, StrvalToTypeCastRector::class, FloatvalToTypeCastRector::class, CallableThisArrayToAnonymousFunctionRector::class, AndAssignsToSeparateLinesRector::class, CompactToVariablesRector::class, CompleteDynamicPropertiesRector::class, IsAWithStringWithThirdArgumentRector::class, StrlenZeroToIdenticalEmptyStringRector::class, ThrowWithPreviousExceptionRector::class, RemoveSoleValueSprintfRector::class, ShortenElseIfRector::class, ArrayMergeOfNonArraysToSimpleArrayRector::class, IntvalToTypeCastRector::class, BoolvalToTypeCastRector::class, ArrayKeyExistsTernaryThenValueToCoalescingRector::class, AbsolutizeRequireAndIncludePathRector::class, ChangeArrayPushToArrayAssignRector::class, ForRepeatedCountToOwnVariableRector::class, ForeachItemsAssignToEmptyArrayToAssignRector::class, InlineIfToExplicitIfRector::class, UnusedForeachValueToArrayKeysRector::class, CommonNotEqualRector::class, SetTypeToCastRector::class, LogicalToBooleanRector::class, VarToPublicPropertyRector::class, IssetOnPropertyObjectToPropertyExistsRector::class, NewStaticToNewSelfRector::class, UnwrapSprintfOneArgumentRector::class, SwitchNegatedTernaryRector::class, SingularSwitchToIfRector::class, SimplifyIfNullableReturnRector::class, FuncGetArgsToVariadicParamRector::class, CallUserFuncToMethodCallRector::class, CallUserFuncWithArrowFunctionToInlineRector::class, CountArrayToEmptyArrayComparisonRector::class, FlipTypeControlToUseExclusiveTypeRector::class, InlineArrayReturnAssignRector::class, InlineIsAInstanceOfRector::class, TernaryFalseExpressionToIfRector::class, InlineConstructorDefaultToPropertyRector::class, TernaryEmptyArrayArrayDimFetchToCoalesceRector::class, OptionalParametersAfterRequiredRector::class, SimplifyEmptyCheckOnEmptyArrayRector::class, SwitchTrueToIfRector::class, CleanupUnneededNullsafeOperatorRector::class, DisallowedEmptyRuleFixerRector::class, ConvertStaticPrivateConstantToSelfRector::class, LocallyCalledStaticMethodToNonStaticRector::class, NumberCompareToMaxFuncCallRector::class, CompleteMissingIfElseBracketRector::class]);
 };
--- a/docs/rector_rules_overview.md
+++ b/docs/rector_rules_overview.md
@ -1,4 +1,4 @@
-# 353 Rules Overview
+# 354 Rules Overview

 <br>

@ -6,7 +6,7 @@

 - [Arguments](#arguments) (4)

- [CodeQuality](#codequality) (71)
+- [CodeQuality](#codequality) (72)

 - [CodingStyle](#codingstyle) (29)

@ -455,6 +455,27 @@ Add missing dynamic properties

 <br>

+### CompleteMissingIfElseBracketRector
+
+Complete missing if/else brackets
+
+- class: [`Rector\CodeQuality\Rector\If_\CompleteMissingIfElseBracketRector`](../rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php)
+
+```diff
+ class SomeClass
+ {
+     public function run($value)
+     {
+-        if ($value)
+        if ($value) {
+             return 1;
+        }
+     }
+ }
+```
+
+<br>
+
 ### ConsecutiveNullCompareReturnsToNullCoalesceQueueRector

 Change multiple null compares to ?? queue
--- a/rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php
+++ b/rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php
@ -0,0 +1,97 @@
+<?php
+
+declare (strict_types=1);
+namespace Rector\CodeQuality\Rector\If_;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\If_;
+use Rector\Core\Rector\AbstractRector;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+/**
+ * @see \Rector\Tests\CodeQuality\Rector\If_\CompleteMissingIfElseBracketRector\CompleteMissingIfElseBracketRectorTest
+ */
+final class CompleteMissingIfElseBracketRector extends AbstractRector
+{
+    public function getRuleDefinition() : RuleDefinition
+    {
+        return new RuleDefinition('Complete missing if/else brackets', [new CodeSample(<<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run($value)
+    {
+        if ($value)
+            return 1;
+    }
+}
+CODE_SAMPLE
+, <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run($value)
+    {
+        if ($value) {
+            return 1;
+        }
+    }
+}
+CODE_SAMPLE
+)]);
+    }
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes() : array
+    {
+        return [If_::class];
+    }
+    /**
+     * @param If_ $node
+     */
+    public function refactor(Node $node) : ?Node
+    {
+        if ($this->isBareNewNode($node)) {
+            return null;
+        }
+        $oldTokens = $this->file->getOldTokens();
+        if ($this->isIfConditionFollowedByOpeningCurlyBracket($node, $oldTokens)) {
+            return null;
+        }
+        // invoke reprint with brackets
+        $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
+        return $node;
+    }
+    /**
+     * @param mixed[] $oldTokens
+     */
+    private function isIfConditionFollowedByOpeningCurlyBracket(If_ $if, array $oldTokens) : bool
+    {
+        for ($i = $if->getStartTokenPos(); $i < $if->getEndTokenPos(); ++$i) {
+            if ($oldTokens[$i] !== ')') {
+                continue;
+            }
+            // first closing bracket must be followed by curly opening brackets
+            // what is next token?
+            $nextToken = $oldTokens[$i + 1];
+            if (\is_array($nextToken) && \trim((string) $nextToken[1]) === '') {
+                // next token is whitespace
+                $nextToken = $oldTokens[$i + 2];
+            }
+            if ($nextToken === '{') {
+                // all good
+                return \true;
+            }
+        }
+        return \false;
+    }
+    private function isBareNewNode(If_ $if) : bool
+    {
+        $originalNode = $if->getAttribute(AttributeKey::ORIGINAL_NODE);
+        if (!$originalNode instanceof Node) {
+            return \true;
+        }
+        // not defined, probably new if
+        return $if->getStartTokenPos() === -1;
+    }
+}
--- a/src/Application/VersionResolver.php
+++ b/src/Application/VersionResolver.php
@ -19,12 +19,12 @@ final class VersionResolver
     * @api
     * @var string
     */
-    public const PACKAGE_VERSION = '8e06627e1a34f9a48a56395943ab573681f5db4d';
+    public const PACKAGE_VERSION = '3e0132d324099a3d45e1f8f0d28be76d310ee0eb';
    /**
     * @api
     * @var string
     */
-    public const RELEASE_DATE = '2023-10-05 14:54:01';
+    public const RELEASE_DATE = '2023-10-05 16:35:15';
    /**
     * @var int
     */
--- a/src/PhpParser/Node/NodeFactory.php
+++ b/src/PhpParser/Node/NodeFactory.php
@ -317,6 +317,16 @@ final class NodeFactory
        }
        return $this->createBooleanAndFromNodes($newNodes);
    }
+    public function createReprintedExpr(Expr $expr) : Expr
+    {
+        // reset original node, to allow the printer to re-use the expr
+        $expr->setAttribute(AttributeKey::ORIGINAL_NODE, null);
+        $this->simpleCallableNodeTraverser->traverseNodesWithCallable($expr, static function (Node $node) : Node {
+            $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
+            return $node;
+        });
+        return $expr;
+    }
    /**
     * @param string|int|null $key
     * @param mixed $item
@ -401,14 +411,4 @@ final class NodeFactory
        }
        return $exprOrVariableName;
    }
-    public function createReprintedExpr(Expr $expr) : Expr
-    {
-        // reset original node, to allow the printer to re-use the expr
-        $expr->setAttribute(AttributeKey::ORIGINAL_NODE, null);
-        $this->simpleCallableNodeTraverser->traverseNodesWithCallable($expr, static function (Node $node) : Node {
-            $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
-            return $node;
-        });
-        return $expr;
-    }
 }
--- a/vendor/composer/autoload_classmap.php
+++ b/vendor/composer/autoload_classmap.php
@ -1065,6 +1065,7 @@ return array(
    'Rector\\CodeQuality\\Rector\\Identical\\SimplifyConditionsRector' => $baseDir . '/rules/CodeQuality/Rector/Identical/SimplifyConditionsRector.php',
    'Rector\\CodeQuality\\Rector\\Identical\\StrlenZeroToIdenticalEmptyStringRector' => $baseDir . '/rules/CodeQuality/Rector/Identical/StrlenZeroToIdenticalEmptyStringRector.php',
    'Rector\\CodeQuality\\Rector\\If_\\CombineIfRector' => $baseDir . '/rules/CodeQuality/Rector/If_/CombineIfRector.php',
+    'Rector\\CodeQuality\\Rector\\If_\\CompleteMissingIfElseBracketRector' => $baseDir . '/rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php',
    'Rector\\CodeQuality\\Rector\\If_\\ConsecutiveNullCompareReturnsToNullCoalesceQueueRector' => $baseDir . '/rules/CodeQuality/Rector/If_/ConsecutiveNullCompareReturnsToNullCoalesceQueueRector.php',
    'Rector\\CodeQuality\\Rector\\If_\\ExplicitBoolCompareRector' => $baseDir . '/rules/CodeQuality/Rector/If_/ExplicitBoolCompareRector.php',
    'Rector\\CodeQuality\\Rector\\If_\\ShortenElseIfRector' => $baseDir . '/rules/CodeQuality/Rector/If_/ShortenElseIfRector.php',
--- a/vendor/composer/autoload_static.php
+++ b/vendor/composer/autoload_static.php
@ -1284,6 +1284,7 @@ class ComposerStaticInit46a0b0ac2ea1371bb06be09a20f71c2b
        'Rector\\CodeQuality\\Rector\\Identical\\SimplifyConditionsRector' => __DIR__ . '/../..' . '/rules/CodeQuality/Rector/Identical/SimplifyConditionsRector.php',
        'Rector\\CodeQuality\\Rector\\Identical\\StrlenZeroToIdenticalEmptyStringRector' => __DIR__ . '/../..' . '/rules/CodeQuality/Rector/Identical/StrlenZeroToIdenticalEmptyStringRector.php',
        'Rector\\CodeQuality\\Rector\\If_\\CombineIfRector' => __DIR__ . '/../..' . '/rules/CodeQuality/Rector/If_/CombineIfRector.php',
+        'Rector\\CodeQuality\\Rector\\If_\\CompleteMissingIfElseBracketRector' => __DIR__ . '/../..' . '/rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php',
        'Rector\\CodeQuality\\Rector\\If_\\ConsecutiveNullCompareReturnsToNullCoalesceQueueRector' => __DIR__ . '/../..' . '/rules/CodeQuality/Rector/If_/ConsecutiveNullCompareReturnsToNullCoalesceQueueRector.php',
        'Rector\\CodeQuality\\Rector\\If_\\ExplicitBoolCompareRector' => __DIR__ . '/../..' . '/rules/CodeQuality/Rector/If_/ExplicitBoolCompareRector.php',
        'Rector\\CodeQuality\\Rector\\If_\\ShortenElseIfRector' => __DIR__ . '/../..' . '/rules/CodeQuality/Rector/If_/ShortenElseIfRector.php',