[depre] Deprecate CreateMockToAnonymousClassRector as requires manual work, often value object setter can be better alternative (#562)

Author: TomasVotruba

rules-tests/CodeQuality/Rector/ClassMethod/CreateMockToAnonymousClassRector/CreateMockToAnonymousClassRectorTest.php

@@ -4,40 +4,19 @@
 
 namespace Rector\PHPUnit\CodeQuality\Rector\ClassMethod;
 
-use PhpParser\Modifiers;
 use PhpParser\Node;
-use PhpParser\Node\Arg;
-use PhpParser\Node\Expr;
-use PhpParser\Node\Expr\Array_;
-use PhpParser\Node\Expr\Assign;
-use PhpParser\Node\Expr\ClassConstFetch;
-use PhpParser\Node\Expr\MethodCall;
-use PhpParser\Node\Expr\New_;
-use PhpParser\Node\Name;
-use PhpParser\Node\Scalar;
-use PhpParser\Node\Scalar\String_;
-use PhpParser\Node\Stmt;
-use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
-use PhpParser\Node\Stmt\Expression;
-use PhpParser\Node\Stmt\Return_;
-use Rector\Exception\NotImplementedYetException;
+use Rector\Configuration\Deprecation\Contract\DeprecatedInterface;
 use Rector\Exception\ShouldNotHappenException;
-use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
- * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\CreateMockToAnonymousClassRector\CreateMockToAnonymousClassRectorTest
+ * @deprecated as this rule works only sometimes. It requires manual check, as value object can be better solution.
  */
-final class CreateMockToAnonymousClassRector extends AbstractRector
+final class CreateMockToAnonymousClassRector extends AbstractRector implements DeprecatedInterface
 {
-    public function __construct(
-        private readonly TestsNodeAnalyzer $testsNodeAnalyzer
-    ) {
-    }
-
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition('Change $this->createMock() with methods to direct anonymous class', [
@@ -91,169 +70,9 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
-        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
-            return null;
-        }
-
-        if ($node->stmts === []) {
-            return null;
-        }
-
-        $anonymousClassPosition = null;
-        $anonymousClass = null;
-        $mockExpr = null;
-
-        $hasDynamicReturnExprs = false;
-
-        $anonymousClassMethods = [];
-        $createMockMethodCallAssign = null;
-
-        foreach ((array) $node->stmts as $key => $classMethodStmt) {
-            if ($mockExpr instanceof Expr) {
-                // possible call on mock expr
-                if ($classMethodStmt instanceof Expression && $classMethodStmt->expr instanceof MethodCall) {
-                    $methodCall = $classMethodStmt->expr;
-
-                    $rootMethodCall = $methodCall;
-                    while ($rootMethodCall->var instanceof MethodCall) {
-                        $rootMethodCall = $rootMethodCall->var;
-                    }
-
-                    if (! $this->nodeComparator->areNodesEqual($rootMethodCall->var, $mockExpr)) {
-                        continue;
-                    }
-
-                    if (! $this->isName($rootMethodCall->name, 'method')) {
-                        continue;
-                    }
-
-                    if ($methodCall->isFirstClassCallable()) {
-                        continue;
-                    }
-
-                    // has dynamic return?
-                    if ($hasDynamicReturnExprs === false) {
-                        $returnedExpr = $methodCall->getArgs()[0]
-                            ->value;
-                        $hasDynamicReturnExprs = ! $returnedExpr instanceof Scalar && ! $returnedExpr instanceof Array_;
-                    }
-
-                    $anonymousClassMethods[$key] = $this->createMockedClassMethod($rootMethodCall, $methodCall);
-                }
-
-                continue;
-            }
-
-            $createMockMethodCallAssign = $this->matchCreateMockAssign($classMethodStmt);
-            if (! $createMockMethodCallAssign instanceof Assign) {
-                continue;
-            }
-
-            // change to anonymous class
-            /** @var MethodCall $methodCall */
-            $methodCall = $createMockMethodCallAssign->expr;
-
-            if ($methodCall->isFirstClassCallable()) {
-                continue;
-            }
-
-            $firstArg = $methodCall->getArgs()[0];
-
-            $mockExpr = $createMockMethodCallAssign->var;
-
-            $anonymousClass = $this->createAnonymousClass($firstArg);
-            $anonymousClassPosition = $key;
-        }
-
-        if ($anonymousClassPosition === null) {
-            return null;
-        }
-
-        if (! $anonymousClass instanceof Class_) {
-            return null;
-        }
-
-        if ($hasDynamicReturnExprs) {
-            return null;
-        }
-
-        foreach ($anonymousClassMethods as $keyToRemove => $anonymousClassMethod) {
-            unset($node->stmts[$keyToRemove]);
-            $anonymousClass->stmts[] = $anonymousClassMethod;
-        }
-
-        if (! $createMockMethodCallAssign instanceof Assign) {
-            throw new ShouldNotHappenException();
-        }
-
-        $new = new New_($anonymousClass);
-        $newAnonymousClassAssign = new Assign($createMockMethodCallAssign->var, $new);
-        $node->stmts[$anonymousClassPosition] = new Expression($newAnonymousClassAssign);
-
-        return $node;
-    }
-
-    private function createAnonymousClass(Arg $firstArg): Class_
-    {
-        if ($firstArg->value instanceof ClassConstFetch) {
-            $className = $firstArg->value->class;
-        } else {
-            throw new NotImplementedYetException();
-        }
-
-        if (! $className instanceof Name) {
-            throw new NotImplementedYetException();
-        }
-
-        // must respect PHPStan anonymous internal naming \Rector\NodeTypeResolver\PHPStan\Scope\PHPStanNodeScopeResolver::ANONYMOUS_CLASS_START_REGEX
-        return new Class_('AnonymousClass1234', [
-            'extends' => $className,
-        ], [
-            'startLine' => $firstArg->getStartLine(),
-            'endLine' => $firstArg->getEndLine(),
-        ]);
-    }
-
-    private function matchCreateMockAssign(Stmt $stmt): ?Assign
-    {
-        if (! $stmt instanceof Expression) {
-            return null;
-        }
-
-        if (! $stmt->expr instanceof Assign) {
-            return null;
-        }
-
-        // assign method call to variable
-        $assign = $stmt->expr;
-        if (! $assign->expr instanceof MethodCall) {
-            return null;
-        }
-
-        if (! $this->isName($assign->expr->name, 'createMock')) {
-            return null;
-        }
-
-        return $assign;
-    }
-
-    private function createMockedClassMethod(MethodCall $rootMethodCall, MethodCall $methodCall): ClassMethod
-    {
-        $rootMethodCallFirstArg = $rootMethodCall->getArgs()[0];
-
-        $methodNameExpr = $rootMethodCallFirstArg->value;
-        if ($methodNameExpr instanceof String_) {
-            $methodName = $methodNameExpr->value;
-        } else {
-            throw new NotImplementedYetException();
-        }
-
-        $returnedExpr = $methodCall->getArgs()[0]
-            ->value;
-
-        return new ClassMethod($methodName, [
-            'flags' => Modifiers::PUBLIC,
-            'stmts' => [new Return_($returnedExpr)],
-        ]);
+        throw new ShouldNotHappenException(sprintf(
+            '"%s" rule is deprecated, as works only sometimes. It requires manual check, as value object can be better solution.',
+            self::class
+        ));
     }
 }