Skip to content

Commit

Permalink
add FixturesAnnotationToAttributeRector Rector rule
Browse files Browse the repository at this point in the history
  • Loading branch information
Ondřej Ešler committed Sep 15, 2024
1 parent fd966a4 commit d7088a0
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 1 deletion.
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"require-dev": {
"robmorgan/phinx": "^0.12",
"mongodb/mongodb": "^1.5",
"symfony/yaml": "^7"
"symfony/yaml": "^7",
"rector/rector": "^1.2"
}
}
121 changes: 121 additions & 0 deletions src/FixturesAnnotationToAttributeRector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<?php

declare(strict_types=1);

namespace IW\PHPUnit\DbFixtures;

use Nette\Utils\Json;
use PhpParser\Node;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\Rector\AbstractRector;
use Rector\ValueObject\PhpVersionFeature;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;

final class FixturesAnnotationToAttributeRector extends AbstractRector implements MinPhpVersionInterface
{
public function __construct(
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
private readonly PhpAttributeGroupFactory $phpAttributeGroupFactory,
private readonly PhpDocTagRemover $phpDocTagRemover,
private readonly DocBlockUpdater $docBlockUpdater,
private readonly PhpDocInfoFactory $phpDocInfoFactory
) {
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Change @fixtures annotation to #[Fixtures] attribute',
[
new CodeSample(
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
final class SomeFixture extends TestCase
{
/**
* @fixtures mysql write users.yml jobs.yml
*/
public function test(): void
{
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use IW\PHPUnit\DbFixtures\Fixtures;
use PHPUnit\Framework\TestCase;
final class SomeFixture extends TestCase
{
#[Fixtures(['mysql', 'write', 'users.yml', 'jobs.yml'])]
public function test(): void
{
}
}
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->isTestClassMethod($node)) {
return null;
}

$phpDocInfo = $this->phpDocInfoFactory->createFromNode($node);
if (! $phpDocInfo instanceof PhpDocInfo) {
return null;
}

foreach ($phpDocInfo->getTagsByName('fixtures') as $fixturesPhpDocTagNode) {
/** @var PhpDocTagNode $fixturesPhpDocTagNode */
if (!$fixturesPhpDocTagNode->value instanceof DoctrineAnnotationTagValueNode) {
continue; // no value
}

// test from doc blocks
$this->phpDocTagRemover->removeTagValueFromNode($phpDocInfo, $fixturesPhpDocTagNode);

// extract attribute params configuration
$fixtures = explode(' ', $fixturesPhpDocTagNode->value->getAttribute('attribute_comment'));

$attributeGroups[] = $this->phpAttributeGroupFactory
->createFromClassWithItems(Fixtures::class, [$fixtures]);
}

$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
$node->attrGroups = array_merge($node->attrGroups, $attributeGroups ?? []);

return $node;
}

public function provideMinPhpVersion(): int
{
return PhpVersionFeature::ATTRIBUTES;
}
}

0 comments on commit d7088a0

Please sign in to comment.