AnnotationLoaderTest.php

<?php declare(strict_types=1);

/*
 * This file is part of Biurad opensource projects.
 *
 * @copyright 2022 Biurad Group (https://biurad.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Biurad\Annotations\Tests;

use Biurad\Annotations\AnnotationLoader;
use Doctrine\Common\Annotations\AnnotationRegistry;
use PHPUnit\Framework as t;
use Spiral\Attributes\AnnotationReader;
use Spiral\Attributes\AttributeReader;
use Spiral\Attributes\Composite\MergeReader;

beforeAll(function (): void {
    require_once __DIR__.'/Fixtures/Annotation/function.php';

    // doctrine/annotations ^1.0 compatibility.
    if (\method_exists(AnnotationRegistry::class, 'registerLoader')) {
        AnnotationRegistry::registerLoader('class_exists');
    }
});

dataset("loaders", [
    'Load by File' => [AnnotationLoader::REQUIRE_FILE],
    'Load by Tokenized' => [AnnotationLoader::TOKENIZED],
]);

test('annotations with resources and a listener', function (int $loader): void {
    $annotation = new AnnotationLoader(new AnnotationReader(), $loader);
    $result = $names = [];

    $annotation->listener(new Fixtures\SampleListener(), 'test');
    $annotation->resource(...[
        __DIR__.'/Fixtures/Annotation/Valid',
        'non-existing-file.php',
    ]);

    t\assertCount(1, $founds = [$annotation->load()]);

    /** @var Fixtures\SampleCollector $found */
    foreach ($founds as $found) {
        t\assertInstanceOf(Fixtures\SampleCollector::class, $found);

        $collected = $found->getCollected();
        $collected->ksort();

        foreach ($collected as $name => $sample) {
            $names[] = $name;
            $result[] = $sample;
        }
    }

    t\assertEquals([
        'default',
        'global_property',
        'global_specific_name',
        'global_specific_none',
        'mtp_end',
        'mtp_next',
        'mtp_start',
        'multiple_1_default',
        'multiple_1_protected_property',
        'multiple_2_default',
        'multiple_2_protected_property',
        'multiple_3_default',
        'multiple_3_protected_property',
        'priority',
        'private',
        'private_property',
        'protected',
        'protected_property',
        'public_property',
        'single',
    ], $names);

    t\assertEquals([
        ['handler' => \ReflectionMethod::class, 'priority' => 24],
        ['handler' => \ReflectionProperty::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 14],
        ['handler' => \ReflectionMethod::class, 'priority' => 1],
        ['handler' => \ReflectionMethod::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 24],
        ['handler' => \ReflectionProperty::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 24],
        ['handler' => \ReflectionProperty::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 24],
        ['handler' => \ReflectionProperty::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 0],
        ['handler' => \ReflectionMethod::class, 'priority' => 0],
        ['handler' => \ReflectionProperty::class, 'priority' => 4],
        ['handler' => \ReflectionMethod::class, 'priority' => 323],
        ['handler' => \ReflectionProperty::class, 'priority' => 0],
        ['handler' => \ReflectionProperty::class, 'priority' => 0],
        ['handler' => \ReflectionClass::class, 'priority' => 0],
    ], $result);

    t\assertInstanceOf(Fixtures\SampleCollector::class, $annotation->load('test'));
})->with('loaders')->setRunTestInSeparateProcess(true);

test('annotations with attributes', function (int $loader): void {
    $resources = [
        __DIR__.'/Fixtures/Annotation/Attribute',
        'Biurad\\Annotations\\Tests\\Fixtures\\Annotation\\annotated_function',
    ];
    $annotation = new AnnotationLoader(new AttributeReader(), $loader);
    t\assertEmpty($annotation->load(Fixtures\Sample::class));

    $annotation->listener(new Fixtures\SampleListener(), 'test');
    $annotation->resource(...$resources);

    t\assertInstanceOf(Fixtures\SampleCollector::class, $collector = $annotation->load('test'));
    t\assertCount(11, $collector->getCollected()->getArrayCopy());
})->with('loaders')->setRunTestInSeparateProcess(true);

test('annotations with native attributes', function (int $loader): void {
    $resources = [
        Fixtures\Annotation\Attribute\GlobalDefaultsClass::class,
        'Biurad\\Annotations\\Tests\\Fixtures\\Annotation\\annotated_function',
    ];
    $annotation = new AnnotationLoader(null, $loader);
    $annotation->listener(new Fixtures\SampleListener(), 'test');

    t\assertEmpty($annotation->load(Fixtures\Sample::class));
    $annotation->resource(...$resources);

    t\assertNull($annotation->getReader());
    t\assertInstanceOf(Fixtures\SampleCollector::class, $collector = $annotation->load('test'));
    t\assertCount(11, $collector->getCollected()->getArrayCopy());
})->throwsIf(PHP_MAJOR_VERSION <= 7, \RuntimeException::class)->with('loaders')->setRunTestInSeparateProcess(true);

test('annotations with functions', function (int $loader): void {
    $annotation = new AnnotationLoader(new MergeReader([new AnnotationReader(), new AttributeReader()]), $loader);
    $annotation->resource('Biurad\\Annotations\\Tests\\Fixtures\\Annotation\\annotated_function');
    $collector = (new Fixtures\SampleListener())->load($annotation->load(Fixtures\Sample::class));

    $collected = $collector->getCollected();
    $collected->ksort();

    t\assertEquals(['attributed_function', 'function_property'], \array_keys((array) $collected));
})->with('loaders')->setRunTestInSeparateProcess(true);