|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +namespace Patchlevel\ODM\Tests\Unit\Metadata; |
| 6 | + |
| 7 | +use Patchlevel\ODM\Attribute\Document; |
| 8 | +use Patchlevel\ODM\Attribute\Id; |
| 9 | +use Patchlevel\ODM\Index; |
| 10 | +use Patchlevel\ODM\Metadata\AttributeDocumentMetadataFactory; |
| 11 | +use Patchlevel\ODM\Metadata\ClassIsNotAnDocument; |
| 12 | +use Patchlevel\ODM\Metadata\DocumentMetadata; |
| 13 | +use Patchlevel\ODM\Metadata\FieldMapping; |
| 14 | +use Patchlevel\ODM\Metadata\FieldMappingResolver; |
| 15 | +use Patchlevel\ODM\Metadata\MultipleIdPropertiesFound; |
| 16 | +use Patchlevel\ODM\Metadata\NoIdPropertyFound; |
| 17 | +use Patchlevel\ODM\Tests\Unit\Fixtures\Address; |
| 18 | +use Patchlevel\ODM\Tests\Unit\Fixtures\Profile; |
| 19 | +use PHPUnit\Framework\Attributes\CoversClass; |
| 20 | +use PHPUnit\Framework\TestCase; |
| 21 | +use ReflectionProperty; |
| 22 | + |
| 23 | +#[CoversClass(AttributeDocumentMetadataFactory::class)] |
| 24 | +#[CoversClass(ClassIsNotAnDocument::class)] |
| 25 | +#[CoversClass(NoIdPropertyFound::class)] |
| 26 | +#[CoversClass(MultipleIdPropertiesFound::class)] |
| 27 | +#[CoversClass(FieldMapping::class)] |
| 28 | +final class AttributeDocumentMetadataFactoryTest extends TestCase |
| 29 | +{ |
| 30 | + public function testMetadata(): void |
| 31 | + { |
| 32 | + $expected = new DocumentMetadata( |
| 33 | + className: Profile::class, |
| 34 | + database: null, |
| 35 | + collection: 'rango_documents', |
| 36 | + idProperty: 'id', |
| 37 | + indexes: [new Index('by_status', ['status' => 'asc'], unique: false)], |
| 38 | + fields: ['id' => new FieldMapping('_id', [])], |
| 39 | + ); |
| 40 | + |
| 41 | + $factory = new AttributeDocumentMetadataFactory(); |
| 42 | + $metadata = $factory->metadata(Profile::class); |
| 43 | + |
| 44 | + self::assertEquals($expected, $metadata); |
| 45 | + } |
| 46 | + |
| 47 | + public function testMetadataOnNonDocumentExpectClassIsNotAnDocument(): void |
| 48 | + { |
| 49 | + $factory = new AttributeDocumentMetadataFactory(); |
| 50 | + $this->expectException(ClassIsNotAnDocument::class); |
| 51 | + |
| 52 | + $factory->metadata(Address::class); |
| 53 | + } |
| 54 | + |
| 55 | + public function testMetadataInMemoryCache(): void |
| 56 | + { |
| 57 | + $factory = new AttributeDocumentMetadataFactory(); |
| 58 | + $metadataFirst = $factory->metadata(Profile::class); |
| 59 | + $metadataSecond = $factory->metadata(Profile::class); |
| 60 | + |
| 61 | + self::assertSame($metadataFirst, $metadataSecond); |
| 62 | + } |
| 63 | + |
| 64 | + public function testMetadataNonIdDocument(): void |
| 65 | + { |
| 66 | + $class = new #[Document('rango_documents')] |
| 67 | + class () { |
| 68 | + }; |
| 69 | + |
| 70 | + $factory = new AttributeDocumentMetadataFactory(); |
| 71 | + $this->expectException(NoIdPropertyFound::class); |
| 72 | + |
| 73 | + $factory->metadata($class::class); |
| 74 | + } |
| 75 | + |
| 76 | + public function testMetadataMultipleIdDocument(): void |
| 77 | + { |
| 78 | + $class = new #[Document('rango_documents')] |
| 79 | + class ('1', '2') { |
| 80 | + public function __construct( |
| 81 | + #[Id] |
| 82 | + public string $id, |
| 83 | + #[Id] |
| 84 | + public string $id2, |
| 85 | + ) { |
| 86 | + } |
| 87 | + }; |
| 88 | + |
| 89 | + $factory = new AttributeDocumentMetadataFactory(); |
| 90 | + $this->expectException(MultipleIdPropertiesFound::class); |
| 91 | + |
| 92 | + $factory->metadata($class::class); |
| 93 | + } |
| 94 | + |
| 95 | + public function testMetadataWithFieldResolver(): void |
| 96 | + { |
| 97 | + $expected = new DocumentMetadata( |
| 98 | + className: Profile::class, |
| 99 | + database: null, |
| 100 | + collection: 'rango_documents', |
| 101 | + idProperty: 'id', |
| 102 | + indexes: [new Index('by_status', ['status' => 'asc'], unique: false)], |
| 103 | + fields: [ |
| 104 | + 'id' => new FieldMapping('_id', []), |
| 105 | + 'status' => new FieldMapping('_newStatus', []), |
| 106 | + ], |
| 107 | + ); |
| 108 | + |
| 109 | + $fieldResolver = new class implements FieldMappingResolver |
| 110 | + { |
| 111 | + public function resolve(ReflectionProperty $reflectionProperty): FieldMapping|null |
| 112 | + { |
| 113 | + if ($reflectionProperty->getName() === 'status') { |
| 114 | + return new FieldMapping('_newStatus', []); |
| 115 | + } |
| 116 | + |
| 117 | + return null; |
| 118 | + } |
| 119 | + }; |
| 120 | + |
| 121 | + $factory = new AttributeDocumentMetadataFactory($fieldResolver); |
| 122 | + $metadata = $factory->metadata(Profile::class); |
| 123 | + |
| 124 | + self::assertEquals($expected, $metadata); |
| 125 | + } |
| 126 | + |
| 127 | + public function testMetadataWithFieldResolverNotUsedForId(): void |
| 128 | + { |
| 129 | + $expected = new DocumentMetadata( |
| 130 | + className: Profile::class, |
| 131 | + database: null, |
| 132 | + collection: 'rango_documents', |
| 133 | + idProperty: 'id', |
| 134 | + indexes: [new Index('by_status', ['status' => 'asc'], unique: false)], |
| 135 | + fields: ['id' => new FieldMapping('_id', [])], |
| 136 | + ); |
| 137 | + |
| 138 | + $fieldResolver = new class implements FieldMappingResolver |
| 139 | + { |
| 140 | + public function resolve(ReflectionProperty $reflectionProperty): FieldMapping|null |
| 141 | + { |
| 142 | + if ($reflectionProperty->getName() === 'id') { |
| 143 | + return new FieldMapping('_otherId', []); |
| 144 | + } |
| 145 | + |
| 146 | + return null; |
| 147 | + } |
| 148 | + }; |
| 149 | + |
| 150 | + $factory = new AttributeDocumentMetadataFactory($fieldResolver); |
| 151 | + $metadata = $factory->metadata(Profile::class); |
| 152 | + |
| 153 | + self::assertEquals($expected, $metadata); |
| 154 | + } |
| 155 | +} |
0 commit comments