File: AbstractClassMetadataFactoryTest.php

package info (click to toggle)
php-doctrine-persistence 4.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 656 kB
  • sloc: php: 3,669; makefile: 22
file content (185 lines) | stat: -rw-r--r-- 5,804 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?php

declare(strict_types=1);

namespace Doctrine\Tests\Persistence\Mapping;

use Doctrine\Persistence\Mapping\AbstractClassMetadataFactory;
use Doctrine\Persistence\Mapping\ClassMetadata;
use Doctrine\Persistence\Mapping\Driver\MappingDriver;
use Doctrine\Persistence\Mapping\MappingException;
use Doctrine\Persistence\Mapping\ReflectionService;
use Doctrine\Tests\DoctrineTestCase;
use RuntimeException;

final class AbstractClassMetadataFactoryTest extends DoctrineTestCase
{
    /** @param ClassMetadata<object>|null $metadata */
    private function createTestFactory(
        MappingDriver|null $driver = null,
        ClassMetadata|null $metadata = null,
    ): TestAbstractClassMetadataFactory {
        return new TestAbstractClassMetadataFactory($driver, $metadata);
    }

    public function testItSkipsTransientClasses(): void
    {
        $driver = $this->createMock(MappingDriver::class);
        $cmf    = $this->createTestFactory($driver);

        $metadataCallCount                     = 0;
        $cmf->newClassMetadataInstanceCallback = function ($className) use (&$metadataCallCount) {
            $metadataCallCount++;
            if ($metadataCallCount === 1) {
                self::assertEquals(SomeGrandParentEntity::class, $className);
            } elseif ($metadataCallCount === 2) {
                self::assertEquals(SomeEntity::class, $className);
            }

            return $this->createMock(ClassMetadata::class);
        };

        $driverCallCount = 0;
        $driver->expects(self::exactly(2))
            ->method('isTransient')
            ->willReturnCallback(static function ($className) use (&$driverCallCount) {
                $driverCallCount++;
                if ($driverCallCount === 1) {
                    self::assertEquals(SomeGrandParentEntity::class, $className);

                    return false;
                }

                if ($driverCallCount === 2) {
                    self::assertEquals(SomeParentEntity::class, $className);

                    return true;
                }
            });

        $cmf->getMetadataFor(SomeEntity::class);
    }

    public function testItThrowsWhenAttemptingToGetMetadataForAnonymousClass(): void
    {
        $cmf = $this->createTestFactory();
        $this->expectException(MappingException::class);
        $cmf->getMetadataFor((new class {
        })::class);
    }

    public function testAnonymousClassIsNotMistakenForShortAlias(): void
    {
        $driver = $this->createMock(MappingDriver::class);
        $driver->method('isTransient')->willReturn(false);
        $cmf = $this->createTestFactory($driver);

        self::assertFalse($cmf->isTransient((new class () {
        })::class));
    }

    public function testItThrowsWhenAttemptingToGetMetadataForShortAlias(): void
    {
        $cmf = $this->createTestFactory();
        $this->expectException(MappingException::class);
        // @phpstan-ignore-next-line
        $cmf->getMetadataFor('App:Test');
    }

    public function testItThrowsWhenAttemptingToCheckTransientForShortAlias(): void
    {
        $cmf = $this->createTestFactory();
        $this->expectException(MappingException::class);
        // @phpstan-ignore-next-line
        $cmf->isTransient('App:Test');
    }

    public function testItGetsTheSameMetadataForBackslashedClassName(): void
    {
        $driver = $this->createMock(MappingDriver::class);
        $cmf    = $this->createTestFactory($driver);

        $metadata                              = self::createStub(ClassMetadata::class);
        $cmf->newClassMetadataInstanceCallback = static function ($className) use ($metadata) {
            self::assertEquals(SomeOtherEntity::class, $className);

            return $metadata;
        };

        self::assertSame($cmf->getMetadataFor(SomeOtherEntity::class), $cmf->getMetadataFor('\\' . SomeOtherEntity::class));
    }
}

class SomeGrandParentEntity
{
}

class SomeParentEntity extends SomeGrandParentEntity
{
}

final class SomeEntity extends SomeParentEntity
{
}

final class SomeOtherEntity
{
}

/** @template-extends AbstractClassMetadataFactory<ClassMetadata<object>> */
class TestAbstractClassMetadataFactory extends AbstractClassMetadataFactory
{
    /** @var callable|null */
    public $newClassMetadataInstanceCallback;

    /** @param ClassMetadata<object>|null $defaultMetadata */
    public function __construct(
        private MappingDriver|null $driver = null,
        private ClassMetadata|null $defaultMetadata = null,
    ) {
    }

    protected function initialize(): void
    {
        $this->initialized = true;
    }

    protected function getDriver(): MappingDriver
    {
        return $this->driver ?? throw new RuntimeException('Driver not set');
    }

    protected function wakeupReflection(ClassMetadata $class, ReflectionService $reflService): void
    {
        // No-op for tests
    }

    protected function initializeReflection(ClassMetadata $class, ReflectionService $reflService): void
    {
        // No-op for tests
    }

    protected function isEntity(ClassMetadata $class): bool
    {
        return true;
    }

    /** @param list<class-string> $nonSuperclassParents */
    protected function doLoadMetadata(
        ClassMetadata $class,
        ClassMetadata|null $parent,
        bool $rootEntityFound,
        array $nonSuperclassParents,
    ): void {
        // No-op for tests - metadata loading is handled by driver
    }

    protected function newClassMetadataInstance(string $className): ClassMetadata
    {
        if ($this->newClassMetadataInstanceCallback !== null) {
            return ($this->newClassMetadataInstanceCallback)($className);
        }

        return $this->defaultMetadata ?? throw new RuntimeException('Default metadata not set');
    }
}