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

Author: TomasVotruba

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 ($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/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,8 +137,8 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        // skip if no parents are involved
-        if ($node->extends === null) {
+        // skip if no parents, nor traits, nor strinables are involved
+        if ($node->extends === null && $node->getTraitUses() === [] && ! $this->implementsStringable($node)) {
             return null;
         }
 
@@ -232,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
@@ -289,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;
+    }
 }