diff --git a/config/sets/phpunit-code-quality.php b/config/sets/phpunit-code-quality.php index 1446f105..058e2a9a 100644 --- a/config/sets/phpunit-code-quality.php +++ b/config/sets/phpunit-code-quality.php @@ -149,9 +149,6 @@ AddStubIntersectionVarToStubPropertyRector::class, InlineStubPropertyToCreateStubMethodCallRector::class, - // @test first, enable later - // \Rector\PHPUnit\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector::class, - FinalizeTestCaseClassRector::class, DeclareStrictTypesTestsRector::class, WithCallbackIdenticalToStandaloneAssertsRector::class, diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/ConfiguredMockEntityToSetterObjectRectorTest.php b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/ConfiguredMockEntityToSetterObjectRectorTest.php deleted file mode 100644 index 05bb0767..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/ConfiguredMockEntityToSetterObjectRectorTest.php +++ /dev/null @@ -1,28 +0,0 @@ -doTestFile($filePath); - } - - public static function provideData(): Iterator - { - return self::yieldFilesFromDirectory(__DIR__ . '/Fixture'); - } - - public function provideConfigFilePath(): string - { - return __DIR__ . '/config/configured_rule.php'; - } -} diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/direct-return.php.inc b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/direct-return.php.inc deleted file mode 100644 index 52263153..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/direct-return.php.inc +++ /dev/null @@ -1,35 +0,0 @@ -createConfiguredMock(SomeEntityToBeConfigured::class, [ - 'getName'=> 'John', - ]); - } -} - -?> ------ -setName('John'); - return $someEntityToBeConfigured; - } -} - -?> diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/fixture.php.inc b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/fixture.php.inc deleted file mode 100644 index 8d68759d..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/fixture.php.inc +++ /dev/null @@ -1,34 +0,0 @@ -createConfiguredMock(SomeEntityToBeConfigured::class, [ - 'getName'=> 'John', - ]); - } -} - -?> ------ -setName('John'); - } -} - -?> diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/skip_abstract_entity.php.inc b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/skip_abstract_entity.php.inc deleted file mode 100644 index 87a7054a..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/skip_abstract_entity.php.inc +++ /dev/null @@ -1,15 +0,0 @@ -createConfiguredMock(AbstractEntityToBeConfigured::class, [ - 'getName'=> 'John', - ]); - } -} diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/skip_non_entity.php.inc b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/skip_non_entity.php.inc deleted file mode 100644 index 8d38d375..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Fixture/skip_non_entity.php.inc +++ /dev/null @@ -1,15 +0,0 @@ -createConfiguredMock(SomeObjectToBeConfigured::class, [ - 'getName'=> 'John', - ]); - } -} diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/AbstractEntityToBeConfigured.php b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/AbstractEntityToBeConfigured.php deleted file mode 100644 index 62198c7b..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/AbstractEntityToBeConfigured.php +++ /dev/null @@ -1,21 +0,0 @@ -name = $name; - } - - public function getName(): string - { - return $this->name; - } -} diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeEntityToBeConfigured.php b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeEntityToBeConfigured.php deleted file mode 100644 index b752ec72..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeEntityToBeConfigured.php +++ /dev/null @@ -1,21 +0,0 @@ -name = $name; - } - - public function getName(): string - { - return $this->name; - } -} diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeObjectToBeConfigured.php b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeObjectToBeConfigured.php deleted file mode 100644 index c4aff6ad..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/Source/SomeObjectToBeConfigured.php +++ /dev/null @@ -1,18 +0,0 @@ -name = $name; - } - - public function getName(): string - { - return $this->name; - } -} diff --git a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/config/configured_rule.php b/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/config/configured_rule.php deleted file mode 100644 index e9afb3c3..00000000 --- a/rules-tests/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector/config/configured_rule.php +++ /dev/null @@ -1,10 +0,0 @@ -rule(ConfiguredMockEntityToSetterObjectRector::class); -}; diff --git a/rules/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector.php b/rules/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector.php index d506f469..08787805 100644 --- a/rules/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector.php +++ b/rules/CodeQuality/Rector/Expression/ConfiguredMockEntityToSetterObjectRector.php @@ -4,43 +4,20 @@ namespace Rector\PHPUnit\CodeQuality\Rector\Expression; -use Nette\Utils\Strings; 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\MethodCall; -use PhpParser\Node\Expr\New_; -use PhpParser\Node\Expr\Variable; -use PhpParser\Node\Name\FullyQualified; -use PhpParser\Node\Stmt; -use PhpParser\Node\Stmt\Class_; use PhpParser\Node\Stmt\Expression; use PhpParser\Node\Stmt\Return_; -use PHPStan\Reflection\ReflectionProvider; -use Rector\Doctrine\NodeAnalyzer\DoctrineEntityDetector; -use Rector\PhpParser\AstResolver; -use Rector\PhpParser\Node\Value\ValueResolver; -use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer; +use Rector\Configuration\Deprecation\Contract\DeprecatedInterface; +use Rector\Exception\ShouldNotHappenException; use Rector\Rector\AbstractRector; use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; /** - * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\Expression\ConfiguredMockEntityToSetterObjectRector\ConfiguredMockEntityToSetterObjectRectorTest + * @deprecated This rule is deprecated as experimental. It can generate broken code - it drops non-"get" config keys silently and assumes a matching setter exists. Handle it in a custom way or keep the code untouched. */ -final class ConfiguredMockEntityToSetterObjectRector extends AbstractRector +final class ConfiguredMockEntityToSetterObjectRector extends AbstractRector implements DeprecatedInterface { - public function __construct( - private readonly ReflectionProvider $reflectionProvider, - private readonly TestsNodeAnalyzer $testsNodeAnalyzer, - private readonly ValueResolver $valueResolver, - private readonly AstResolver $astResolver, - private readonly DoctrineEntityDetector $doctrineEntityDetector, - ) { - } - public function getRuleDefinition(): RuleDefinition { return new RuleDefinition( @@ -90,151 +67,12 @@ public function getNodeTypes(): array /** * @param Expression|Return_ $node - * @return Stmt[]|null - */ - public function refactor(Node $node): ?array - { - if (! $this->testsNodeAnalyzer->isInTestClass($node)) { - return null; - } - - $assign = null; - if ($node instanceof Return_) { - if ($node->expr instanceof MethodCall) { - $methodCall = $node->expr; - } else { - return null; - } - } elseif ($node->expr instanceof Assign) { - $assign = $node->expr; - if (! $assign->expr instanceof MethodCall) { - return null; - } - - $methodCall = $assign->expr; - } else { - return null; - } - - if (! $this->isName($methodCall->name, 'createConfiguredMock')) { - return null; - } - - if ($methodCall->isFirstClassCallable()) { - return null; - } - - $mockedClassArg = $methodCall->getArgs()[0]; - - $doctrineClass = $this->matchDoctrineClassName($mockedClassArg->value); - if (! is_string($doctrineClass)) { - return null; - } - - $definedGettersArg = $methodCall->getArgs()[1]; - if (! $definedGettersArg->value instanceof Array_) { - return null; - } - - if ($node instanceof Expression) { - return $this->createForAssign($doctrineClass, $assign, $definedGettersArg->value, $node); - } - - return $this->createForReturn($doctrineClass, $definedGettersArg->value, $node); - - } - - /** - * @return Expression[] - */ - private function createEntitySetterExpressions(Array_ $definedGettersArray, Expr $expr): array - { - $setterExpressions = []; - - foreach ($definedGettersArray->items as $arrayItem) { - if (! $arrayItem->key instanceof Expr) { - continue; - } - - $getterName = $this->valueResolver->getValue($arrayItem->key); - if (! is_string($getterName)) { - continue; - } - - // remove "get" prefix - if (! str_starts_with($getterName, 'get')) { - continue; - } - - $setterName = 'set' . substr($getterName, 3); - - $setterMethodCall = new MethodCall($expr, $setterName, [new Arg($arrayItem->value)]); - $setterExpressions[] = new Expression($setterMethodCall); - } - - return $setterExpressions; - } - - private function matchDoctrineClassName(Expr $expr): string|null - { - $mockedClassValue = $this->valueResolver->getValue($expr); - if (! is_string($mockedClassValue)) { - return null; - } - - if (! $this->reflectionProvider->hasClass($mockedClassValue)) { - return null; - } - - $classReflection = $this->reflectionProvider->getClass($mockedClassValue); - if ($classReflection->isInterface() || $classReflection->isAbstract()) { - return null; - } - - $mockedClass = $this->astResolver->resolveClassFromName($mockedClassValue); - if (! $mockedClass instanceof Class_) { - return null; - } - - if (! $this->doctrineEntityDetector->detect($mockedClass)) { - return null; - } - - return $mockedClassValue; - } - - /** - * @return Stmt[] */ - private function createForReturn(string $doctrineClass, Array_ $array, Return_ $return): array + public function refactor(Node $node): ?Node { - $shortClassName = Strings::after($doctrineClass, '\\', -1); - $objectVariable = new Variable(lcfirst((string) $shortClassName)); - - $new = new New_(new FullyQualified($doctrineClass)); - $assign = new Assign($objectVariable, $new); - - $setterExpressions = $this->createEntitySetterExpressions($array, $objectVariable); - - $return->expr = $objectVariable; - - return array_merge([new Expression($assign)], $setterExpressions, [$return]); - } - - /** - * @return Stmt[] - */ - private function createForAssign( - string $doctrineClass, - Assign $assign, - Array_ $definedGettersArray, - Expression $expression - ): array { - $assign->expr = new New_(new FullyQualified($doctrineClass)); - $objectVariable = $assign->var; - - $setterExpressions = $this->createEntitySetterExpressions($definedGettersArray, $objectVariable); - - return array_merge([$expression], $setterExpressions); + throw new ShouldNotHappenException(sprintf( + '"%s" is deprecated and should not be used anymore. Remove it from your config files.', + self::class, + )); } }