[PHPUnit70] Add ScenarioToTestAnnotationRector to replace scenario annotation with test (#809)

Author: TomasVotruba

config/sets/composer-based.php

@@ -46,6 +46,7 @@
 use Rector\PHPUnit\PHPUnit60\Rector\MethodCall\DelegateExceptionArgumentsRector;
 use Rector\PHPUnit\PHPUnit60\Rector\MethodCall\GetMockBuilderGetMockToCreateMockRector;
 use Rector\PHPUnit\PHPUnit70\Rector\Class_\RemoveDataProviderTestPrefixRector;
+use Rector\PHPUnit\PHPUnit70\Rector\ClassMethod\ScenarioToTestAnnotationRector;
 use Rector\PHPUnit\PHPUnit80\Rector\MethodCall\AssertEqualsParameterToSpecificMethodsTypeRector;
 use Rector\PHPUnit\PHPUnit80\Rector\MethodCall\SpecificAssertContainsRector;
 use Rector\PHPUnit\PHPUnit80\Rector\MethodCall\SpecificAssertInternalTypeRector;
@@ -54,11 +55,9 @@
 use Rector\PHPUnit\PHPUnit90\Rector\MethodCall\ExplicitPhpErrorApiRector;
 use Rector\PHPUnit\PHPUnit90\Rector\MethodCall\SpecificAssertContainsWithoutIdentityRector;
 use Rector\PHPUnit\ValueObject\AnnotationWithValueToAttribute;
-use Rector\Renaming\Rector\ClassMethod\RenameAnnotationRector;
 use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
 use Rector\Renaming\Rector\Name\RenameClassRector;
 use Rector\Renaming\ValueObject\MethodCallRename;
-use Rector\Renaming\ValueObject\RenameAnnotationByType;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeDeclarationRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationRector;
 use Rector\TypeDeclaration\ValueObject\AddParamTypeDeclaration;
@@ -129,6 +128,8 @@
 
         // PHPUnit 7.0
         RemoveDataProviderTestPrefixRector::class,
+        // the "@scenario" annotation was dropped in PHPUnit 7.0
+        ScenarioToTestAnnotationRector::class,
 
         // the assertIsArray(), assertStringContainsString() and assertEqualsWithDelta() families, PHPUnit 7.5
         SpecificAssertInternalTypeRector::class,
@@ -391,11 +392,6 @@
         'PHPUnit_Util_Test' => 'PHPUnit\Util\Test',
     ], 'phpunit/phpunit', '>=6.0');
 
-    // the "scenario" annotation was dropped in PHPUnit 7.0
-    $rectorConfig->ruleWithConfigurationComposerVersionBound(RenameAnnotationRector::class, [
-        new RenameAnnotationByType('PHPUnit\Framework\TestCase', 'scenario', 'test'),
-    ], 'phpunit/phpunit', '>=7.0');
-
     // the TestCase methods were given native types in PHPUnit 8.0
     $rectorConfig->ruleWithConfigurationComposerVersionBound(AddParamTypeDeclarationRector::class, [
         // @see https://github.com/rectorphp/rector/issues/1024 - no type, $dataName

rules-tests/PHPUnit70/Rector/ClassMethod/ScenarioToTestAnnotationRector/Fixture/fixture.php.inc

@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit70\Rector\ClassMethod\ScenarioToTestAnnotationRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeScenarioTest extends TestCase
+{
+    /**
+     * @scenario
+     */
+    public function someMethod()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit70\Rector\ClassMethod\ScenarioToTestAnnotationRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeScenarioTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function someMethod()
+    {
+    }
+}
+
+?>

rules-tests/PHPUnit70/Rector/ClassMethod/ScenarioToTestAnnotationRector/Fixture/skip_outside_test_class.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit70\Rector\ClassMethod\ScenarioToTestAnnotationRector\Fixture;
+
+final class SomeRegularClass
+{
+    /**
+     * @scenario
+     */
+    public function someMethod()
+    {
+    }
+}

rules-tests/PHPUnit70/Rector/ClassMethod/ScenarioToTestAnnotationRector/ScenarioToTestAnnotationRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\PHPUnit70\Rector\ClassMethod\ScenarioToTestAnnotationRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ScenarioToTestAnnotationRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/PHPUnit70/Rector/ClassMethod/ScenarioToTestAnnotationRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\PHPUnit70\Rector\ClassMethod\ScenarioToTestAnnotationRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ScenarioToTestAnnotationRector::class);
+};

rules/PHPUnit70/Rector/ClassMethod/ScenarioToTestAnnotationRector.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\PHPUnit70\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\Comments\NodeDocBlock\DocBlockUpdater;
+use Rector\NodeTypeResolver\PhpDoc\NodeAnalyzer\DocBlockTagReplacer;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Rector\RuleDoc\CodeSample\CodeSample;
+use Rector\RuleDoc\RuleDefinition;
+use Rector\VersionBonding\Contract\ComposerPackageConstraintInterface;
+use Rector\VersionBonding\ValueObject\ComposerPackageConstraint;
+
+/**
+ * @see \Rector\PHPUnit\Tests\PHPUnit70\Rector\ClassMethod\ScenarioToTestAnnotationRector\ScenarioToTestAnnotationRectorTest
+ */
+final class ScenarioToTestAnnotationRector extends AbstractRector implements ComposerPackageConstraintInterface
+{
+    public function __construct(
+        private readonly DocBlockTagReplacer $docBlockTagReplacer,
+        private readonly DocBlockUpdater $docBlockUpdater,
+        private readonly PhpDocInfoFactory $phpDocInfoFactory,
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+    ) {
+    }
+
+    /**
+     * the "@scenario" annotation was dropped in PHPUnit 7.0
+     */
+    public function provideComposerPackageConstraint(): ComposerPackageConstraint
+    {
+        return new ComposerPackageConstraint('phpunit/phpunit', '>=7.0');
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Change `@scenario` annotation to `@test` in a test class', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+/**
+ * @scenario
+ */
+public function someMethod()
+{
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+/**
+ * @test
+ */
+public function someMethod()
+{
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNode($node);
+        if (! $phpDocInfo instanceof PhpDocInfo) {
+            return null;
+        }
+
+        if (! $this->docBlockTagReplacer->replaceTagByAnother($phpDocInfo, 'scenario', 'test')) {
+            return null;
+        }
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
+
+        return $node;
+    }
+}