UseAliasNameMatcherTest.php

<?php

declare(strict_types=1);

namespace Rector\Tests\PhpAttribute;

use Iterator;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use PHPUnit\Framework\Attributes\DataProvider;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Php80\ValueObject\AnnotationToAttribute;
use Rector\PhpAttribute\UseAliasNameMatcher;
use Rector\PhpAttribute\ValueObject\UseAliasMetadata;
use Rector\Testing\PHPUnit\AbstractLazyTestCase;
use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Annotation\OpenApi\Annotation\NestedPastAnnotation;
use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Annotation\OpenApi\PastAnnotation;
use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Attribute\OpenApi\Attribute\NestedFutureAttribute;
use Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Attribute\OpenApi\FutureAttribute;

final class UseAliasNameMatcherTest extends AbstractLazyTestCase
{
    private UseAliasNameMatcher $useAliasNameMatcher;

    protected function setUp(): void
    {
        parent::setUp();

        $this->useAliasNameMatcher = $this->make(UseAliasNameMatcher::class);
    }

    #[DataProvider('provideData')]
    public function test(
        AnnotationToAttribute $annotationToAttribute,
        string $useImportName,
        string $useAlias,
        string $shortAnnotationName,
        // attribute
        string $expectedAttributeUseImportName,
        string $expectedShortAttributeName,
    ): void {
        $useItem = new UseItem(new Name($useImportName), $useAlias);
        $useItem->setAttribute(AttributeKey::ORIGINAL_NODE, $useItem);

        $uses = [new Use_([$useItem])];

        // uses
        $useAliasMetadata = $this->useAliasNameMatcher->match($uses, $shortAnnotationName, $annotationToAttribute);
        $this->assertInstanceOf(UseAliasMetadata::class, $useAliasMetadata);

        // test new use import
        $this->assertSame($expectedShortAttributeName, $useAliasMetadata->getShortAttributeName());

        // test new short attribute name
        $this->assertSame($expectedAttributeUseImportName, $useAliasMetadata->getUseImportName());
    }

    /**
     * @return Iterator<array<int, (AnnotationToAttribute|string)>>
     */
    public static function provideData(): Iterator
    {
        yield [
            // configuration
            new AnnotationToAttribute(PastAnnotation::class, FutureAttribute::class),

            // use import
            'Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Annotation\OpenApi',
            // use import alias
            'OA',
            // short attribute name
            '@OA\PastAnnotation',

            // expected attribute import
            'Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Attribute\OpenApi',
            // expected attribute short name
            'OA\FutureAttribute',
        ];

        yield [
            // configuration
            new AnnotationToAttribute(NestedPastAnnotation::class, NestedFutureAttribute::class),

            // use import
            'Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Annotation\OpenApi\Annotation',
            // use import alias
            'OA',
            // short attribute name
            '@OA\NestedPastAnnotation',

            // expected attribute import
            'Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Source\Attribute\OpenApi\Attribute',
            // expected attribute short name
            'OA\NestedFutureAttribute',
        ];
    }
}