Skip to content

Add ReplaceTestFunctionPrefixWithAttributeRector #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samsonasik merged 3 commits into from
Oct 30, 2024
Merged

Add ReplaceTestFunctionPrefixWithAttributeRector #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b628039
Add ReplaceTestFunctionPrefixWithAttributeRector
blackwolf12333 Oct 17, 2024
3e00c38
Stop replacing test prefix if it's the whole name
blackwolf12333 Oct 18, 2024
aa17adf
Update rules/CodeQuality/Rector/ClassMethod/ReplaceTestFunctionPrefix…
samsonasik Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions ...lassMethod/ReplaceTestFunctionPrefixWithAttributeRector/Fixture/fixture_camelCase.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\ReplaceTestAnnotationWithPrefixedFunctionRector\Fixture;

class SomeTest extends \PHPUnit\Framework\TestCase
{
public function testOnePlusOneShouldBeTwo()
{
$this->assertSame(2, 1+1);
}
}

?>
-----
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\ReplaceTestAnnotationWithPrefixedFunctionRector\Fixture;

class SomeTest extends \PHPUnit\Framework\TestCase
{
#[\PHPUnit\Framework\Attributes\Test]
public function onePlusOneShouldBeTwo()
{
$this->assertSame(2, 1+1);
}
}

?>
28 changes: 28 additions & 0 deletions ...ethod/ReplaceTestFunctionPrefixWithAttributeRector/Fixture/fixture_just_test_name.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\ReplaceTestAnnotationWithPrefixedFunctionRector\Fixture;

class SomeTest extends \PHPUnit\Framework\TestCase
{
public function test_()
{
$this->assertSame(2, 1+1);
}
}

?>
-----
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\ReplaceTestAnnotationWithPrefixedFunctionRector\Fixture;

class SomeTest extends \PHPUnit\Framework\TestCase
{
#[\PHPUnit\Framework\Attributes\Test]
public function test_()
{
$this->assertSame(2, 1+1);
}
}

?>
28 changes: 28 additions & 0 deletions ...assMethod/ReplaceTestFunctionPrefixWithAttributeRector/Fixture/fixture_snake_case.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\ReplaceTestAnnotationWithPrefixedFunctionRector\Fixture;

class SomeTest extends \PHPUnit\Framework\TestCase
{
public function test_one_plus_one_should_be_two()
{
$this->assertSame(2, 1+1);
}
}

?>
-----
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\ReplaceTestAnnotationWithPrefixedFunctionRector\Fixture;

class SomeTest extends \PHPUnit\Framework\TestCase
{
#[\PHPUnit\Framework\Attributes\Test]
public function one_plus_one_should_be_two()
{
$this->assertSame(2, 1+1);
}
}

?>
28 changes: 28 additions & 0 deletions ...estFunctionPrefixWithAttributeRector/ReplaceTestFunctionPrefixWithAttributeRectorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace CodeQuality\Rector\ClassMethod\ReplaceTestFunctionPrefixWithAttributeRector;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;

final class ReplaceTestFunctionPrefixWithAttributeRectorTest 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';
}
}
10 changes: 10 additions & 0 deletions ...ector/ClassMethod/ReplaceTestFunctionPrefixWithAttributeRector/config/configured_rule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;
use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\ReplaceTestFunctionPrefixWithAttributeRector;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->rule(ReplaceTestFunctionPrefixWithAttributeRector::class);
};
102 changes: 102 additions & 0 deletions rules/CodeQuality/Rector/ClassMethod/ReplaceTestFunctionPrefixWithAttributeRector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<?php

declare(strict_types=1);

namespace Rector\PHPUnit\CodeQuality\Rector\ClassMethod;

use PhpParser\Node;
use PhpParser\Node\AttributeGroup;
use PhpParser\Node\Stmt\ClassMethod;
use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
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\ReplaceTestAnnotationWithPrefixedFunctionRector\ReplaceTestAnnotationWithPrefixedFunctionRectorTest
*/
final class ReplaceTestFunctionPrefixWithAttributeRector extends AbstractRector
{
public function __construct(
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
private readonly PhpAttributeGroupFactory $phpAttributeGroupFactory,
private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer,
) {
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Replace @test with prefixed function', [
new CodeSample(
<<<'CODE_SAMPLE'
class SomeTest extends \PHPUnit\Framework\TestCase
{
public function testOnePlusOneShouldBeTwo()
{
$this->assertSame(2, 1+1);
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class SomeTest extends \PHPUnit\Framework\TestCase
{
#[Test]
public function onePlusOneShouldBeTwo()
{
$this->assertSame(2, 1+1);
}
}
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;
}

if (! str_starts_with($node->name->toString(), 'test')) {
return null;
}

if ($this->phpAttributeAnalyzer->hasPhpAttributes($node, ['PHPUnit\\Framework\\Attributes\\Test'])) {
return null;
}

if ($node->name->toString() !== 'test' && $node->name->toString() !== 'test_') {
if (str_starts_with($node->name->toString(), 'test_')) {
$node->name->name = lcfirst(substr($node->name->name, 5));
} elseif (str_starts_with($node->name->toString(), 'test')) {
$node->name->name = lcfirst(substr($node->name->name, 4));
}
}

$coversAttributeGroup = $this->createAttributeGroup();
$node->attrGroups = array_merge($node->attrGroups, [$coversAttributeGroup]);

return $node;
}

private function createAttributeGroup(): AttributeGroup
{
$attributeClass = 'PHPUnit\\Framework\\Attributes\\Test';

return $this->phpAttributeGroupFactory->createFromClassWithItems($attributeClass, []);
}
}