[PHP 8.3] Apply rest of ugprade set (#7840)

* early return

* [php 8.3] exclude test case setup from override attribute, as not helpful

* make use of Override attribute

Author: TomasVotruba

phpunit.xml

@@ -14,6 +14,7 @@
             <directory>tests</directory>
             <directory>rules-tests</directory>
             <directory>utils-tests</directory>
+            <exclude>rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Source/SomeAbstractTest.php</exclude>
         </testsuite>
     </testsuites>
 

rector.php

@@ -6,7 +6,6 @@
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
 use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
-use Rector\Php83\Rector\ClassConst\AddTypeToConstRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\AddSeeTestAnnotationRector;
 use Rector\Utils\Rector\RemoveRefactorDuplicatedNodeInstanceCheckRector;
 
@@ -26,7 +25,7 @@
     )
     ->withAttributesSets()
     ->withComposerBased(phpunit: true)
-    ->withPhpSets(php82: true)
+    ->withPhpSets()
     ->withPaths([
         __DIR__ . '/bin',
         __DIR__ . '/config',
@@ -40,10 +39,7 @@
     ])
     ->withRootFiles()
     ->withImportNames(removeUnusedImports: true)
-    ->withRules([
-        RemoveRefactorDuplicatedNodeInstanceCheckRector::class, AddSeeTestAnnotationRector::class,
-        AddTypeToConstRector::class,
-    ])
+    ->withRules([RemoveRefactorDuplicatedNodeInstanceCheckRector::class, AddSeeTestAnnotationRector::class])
     ->withSkip([
         StringClassNameToClassConstantRector::class,
         // tests

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_setup_phpunit_as_clutter.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\SomeAbstractTest;
+
+final class SkipSetupPHPUnitAsClutter extends SomeAbstractTest
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $someValue = 1;
+    }
+}

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Source/SomeAbstractTest.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source;
+
+use PHPUnit\Framework\TestCase;
+
+abstract class SomeAbstractTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        $value = 1000;
+    }
+}

rules/DeadCode/NodeAnalyzer/ParentClassAnalyzer.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DeadCode\NodeAnalyzer;
+
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
+use Rector\NodeNameResolver\NodeNameResolver;
+
+final readonly class ParentClassAnalyzer
+{
+    public function __construct(
+        private NodeNameResolver $nodeNameResolver,
+    ) {
+
+    }
+
+    public function hasParentCall(ClassMethod $classMethod): bool
+    {
+        if ($classMethod->isAbstract()) {
+            return false;
+        }
+
+        if ($classMethod->isPrivate()) {
+            return false;
+        }
+
+        $classMethodName = $classMethod->name->name;
+
+        foreach ((array) $classMethod->stmts as $stmt) {
+            if (! $stmt instanceof Expression) {
+                continue;
+            }
+
+            $expr = $stmt->expr;
+            if (! $expr instanceof StaticCall) {
+                continue;
+            }
+
+            if (! $this->nodeNameResolver->isName($expr->class, 'parent')) {
+                continue;
+            }
+
+            if ($this->nodeNameResolver->isName($expr->name, $classMethodName)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

rules/Php81/Rector/Array_/FirstClassCallableRector.php

@@ -4,6 +4,7 @@
 
 namespace Rector\Php81\Rector\Array_;
 
+use Override;
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\StaticCall;
@@ -15,6 +16,7 @@
  */
 final class FirstClassCallableRector extends ArrayToFirstClassCallableRector implements DeprecatedInterface
 {
+    #[Override]
     public function refactor(Node $node): StaticCall|MethodCall|null
     {
         throw new ShouldNotHappenException(sprintf(

rules/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector.php

@@ -19,6 +19,7 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;
 use Rector\Contract\Rector\ConfigurableRectorInterface;
+use Rector\DeadCode\NodeAnalyzer\ParentClassAnalyzer;
 use Rector\NodeAnalyzer\ClassAnalyzer;
 use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
 use Rector\PhpParser\AstResolver;
@@ -54,6 +55,7 @@ public function __construct(
         private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer,
         private readonly AstResolver $astResolver,
         private readonly ValueResolver $valueResolver,
+        private readonly ParentClassAnalyzer $parentClassAnalyzer,
     ) {
     }
 
@@ -135,6 +137,11 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
+        // skip if no parents, nor traits, nor strinables are involved
+        if ($node->extends === null && $node->getTraitUses() === [] && ! $this->implementsStringable($node)) {
+            return null;
+        }
+
         $className = (string) $this->getName($node);
         if (! $this->reflectionProvider->hasClass($className)) {
             return null;
@@ -227,12 +234,18 @@ private function shouldSkipClassMethod(ClassMethod $classMethod): bool
             return true;
         }
 
+        // nothing to override
         if ($classMethod->isPrivate()) {
             return true;
         }
 
         // ignore if it already uses the attribute
-        return $this->phpAttributeAnalyzer->hasPhpAttribute($classMethod, self::OVERRIDE_CLASS);
+        if ($this->phpAttributeAnalyzer->hasPhpAttribute($classMethod, self::OVERRIDE_CLASS)) {
+            return true;
+        }
+
+        // skip test setup method override, as rather clutters the code than helps
+        return $this->isName($classMethod, 'setUp') && $this->parentClassAnalyzer->hasParentCall($classMethod);
     }
 
     private function shouldSkipParentClassMethod(ClassReflection $parentClassReflection, ClassMethod $classMethod): bool
@@ -284,4 +297,15 @@ private function shouldSkipParentClassMethod(ClassReflection $parentClassReflect
 
         return false;
     }
+
+    private function implementsStringable(Class_ $class): bool
+    {
+        foreach ($class->implements as $implement) {
+            if ($this->isName($implement, 'Stringable')) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

src/BetterPhpDocParser/PhpDoc/SpacelessPhpDocTagNode.php

@@ -4,6 +4,7 @@
 
 namespace Rector\BetterPhpDocParser\PhpDoc;
 
+use Override;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use Stringable;
 
@@ -13,6 +14,7 @@
  */
 final class SpacelessPhpDocTagNode extends PhpDocTagNode implements Stringable
 {
+    #[Override]
     public function __toString(): string
     {
         return $this->name . $this->value;

src/BetterPhpDocParser/PhpDocParser/BetterPhpDocParser.php

@@ -5,6 +5,7 @@
 namespace Rector\BetterPhpDocParser\PhpDocParser;
 
 use Nette\Utils\Strings;
+use Override;
 use PhpParser\Node;
 use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocChildNode;
@@ -90,6 +91,7 @@ public function parseWithNode(BetterTokenIterator $betterTokenIterator, Node $no
         return $phpDocNode;
     }
 
+    #[Override]
     public function parseTag(TokenIterator $tokenIterator): PhpDocTagNode
     {
         // replace generic nodes with DoctrineAnnotations
@@ -106,6 +108,7 @@ public function parseTag(TokenIterator $tokenIterator): PhpDocTagNode
     /**
      * @param BetterTokenIterator $tokenIterator
      */
+    #[Override]
     public function parseTagValue(TokenIterator $tokenIterator, string $tag): PhpDocTagValueNode
     {
         $isPrecededByHorizontalWhitespace = $tokenIterator->isPrecededByHorizontalWhitespace();

src/BetterPhpDocParser/ValueObject/PhpDoc/SpacingAwareTemplateTagValueNode.php

@@ -4,6 +4,7 @@
 
 namespace Rector\BetterPhpDocParser\ValueObject\PhpDoc;
 
+use Override;
 use PHPStan\PhpDocParser\Ast\PhpDoc\TemplateTagValueNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use Stringable;
@@ -19,6 +20,7 @@ public function __construct(
         parent::__construct($name, $typeNode, $description);
     }
 
+    #[Override]
     public function __toString(): string
     {
         // @see https://github.com/rectorphp/rector/issues/3438