Skip to content

Commit 7dad356

Browse files
msmakouzroxblnfk
msmakouz
and
roxblnfk
authored
Support for generated fields (#95)
 Co-authored-by: roxblnfk <[email protected]>
1 parent 5565329 commit 7dad356

File tree

12 files changed

+311
-3
lines changed

12 files changed

+311
-3
lines changed

‎composer.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
],
3939
"require": {
4040
"php": ">=8.1",
41-
"cycle/orm": "^2.2.0",
42-
"cycle/schema-builder": "^2.6",
41+
"cycle/orm": "^2.7",
42+
"cycle/schema-builder": "^2.8",
4343
"spiral/attributes": "^2.8|^3.0",
4444
"spiral/tokenizer": "^2.8|^3.0",
4545
"doctrine/inflector": "^2.0"

‎src/Annotation/GeneratedValue.php‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Cycle\Annotated\Annotation;
6+
7+
use Cycle\ORM\Schema\GeneratedField;
8+
use Spiral\Attributes\NamedArgumentConstructor;
9+
10+
/**
11+
* @Annotation
12+
* @NamedArgumentConstructor
13+
* @Target({"PROPERTY"})
14+
*/
15+
#[\Attribute(\Attribute::TARGET_PROPERTY)]
16+
#[NamedArgumentConstructor]
17+
class GeneratedValue
18+
{
19+
public function __construct(
20+
protected bool $beforeInsert = false,
21+
protected bool $onInsert = false,
22+
protected bool $beforeUpdate = false,
23+
) {
24+
}
25+
26+
public function getFlags(): ?int
27+
{
28+
if (!$this->beforeInsert && !$this->onInsert && !$this->beforeUpdate) {
29+
return null;
30+
}
31+
32+
return
33+
($this->beforeInsert ? GeneratedField::BEFORE_INSERT : 0) |
34+
($this->onInsert ? GeneratedField::ON_INSERT : 0) |
35+
($this->beforeUpdate ? GeneratedField::BEFORE_UPDATE : 0);
36+
}
37+
}

‎src/Configurator.php‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@
88
use Cycle\Annotated\Annotation\Embeddable;
99
use Cycle\Annotated\Annotation\Entity;
1010
use Cycle\Annotated\Annotation\ForeignKey;
11+
use Cycle\Annotated\Annotation\GeneratedValue;
1112
use Cycle\Annotated\Annotation\Relation as RelationAnnotation;
1213
use Cycle\Annotated\Exception\AnnotationException;
1314
use Cycle\Annotated\Exception\AnnotationRequiredArgumentsException;
1415
use Cycle\Annotated\Exception\AnnotationWrongTypeArgumentException;
1516
use Cycle\Annotated\Utils\EntityUtils;
17+
use Cycle\ORM\Schema\GeneratedField;
1618
use Cycle\Schema\Definition\Entity as EntitySchema;
17-
use Cycle\Schema\Definition\ForeignKey as ForeignKeySchema;
1819
use Cycle\Schema\Definition\Field;
20+
use Cycle\Schema\Definition\ForeignKey as ForeignKeySchema;
1921
use Cycle\Schema\Definition\Relation;
2022
use Cycle\Schema\Generator\SyncTables;
2123
use Cycle\Schema\SchemaModifierInterface;
@@ -232,6 +234,9 @@ public function initField(string $name, Column $column, \ReflectionClass $class,
232234
$field->setColumn($columnName);
233235

234236
$field->setPrimary($column->isPrimary());
237+
if ($this->isOnInsertGeneratedField($field)) {
238+
$field->setGenerated(GeneratedField::ON_INSERT);
239+
}
235240

236241
$field->setTypecast($this->resolveTypecast($column->getTypecast(), $class));
237242

@@ -297,6 +302,20 @@ public function initForeignKeys(Entity $ann, EntitySchema $entity, \ReflectionCl
297302
}
298303
}
299304

305+
public function initGeneratedFields(EntitySchema $entity, \ReflectionClass $class): void
306+
{
307+
foreach ($class->getProperties() as $property) {
308+
try {
309+
$generated = $this->reader->firstPropertyMetadata($property, GeneratedValue::class);
310+
if ($generated !== null) {
311+
$entity->getFields()->get($property->getName())->setGenerated($generated->getFlags());
312+
}
313+
} catch (\Throwable $e) {
314+
throw new AnnotationException($e->getMessage(), (int) $e->getCode(), $e);
315+
}
316+
}
317+
}
318+
300319
/**
301320
* Resolve class or role name relative to the current class.
302321
*
@@ -386,4 +405,12 @@ private function getPropertyMetadata(\ReflectionProperty $property, string $name
386405
throw new AnnotationException($e->getMessage(), (int) $e->getCode(), $e);
387406
}
388407
}
408+
409+
private function isOnInsertGeneratedField(Field $field): bool
410+
{
411+
return match ($field->getType()) {
412+
'serial', 'bigserial', 'smallserial' => true,
413+
default => $field->isPrimary()
414+
};
415+
}
389416
}

‎src/Entities.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ public function run(Registry $registry): Registry
7777
continue;
7878
}
7979

80+
// generated fields
81+
$this->generator->initGeneratedFields($e, $entity->class);
82+
8083
// register entity (OR find parent)
8184
$registry->register($e);
8285

‎tests/Annotated/Fixtures/Fixtures25/PostgreSQL/WithGeneratedSerial.php‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Cycle\Annotated\Tests\Fixtures\Fixtures25\PostgreSQL;
6+
7+
use Cycle\Annotated\Annotation\Column;
8+
use Cycle\Annotated\Annotation\Entity;
9+
10+
/**
11+
* @Entity(role="withGeneratedSerial", table="with_generated_serial")
12+
*/
13+
#[Entity(role: 'withGeneratedSerial', table: 'with_generated_serial')]
14+
class WithGeneratedSerial
15+
{
16+
/**
17+
* @Column(type="primary")
18+
*/
19+
#[Column(type: 'primary')]
20+
public int $id;
21+
22+
/**
23+
* @Column(type="smallserial", name="small_serial")
24+
*/
25+
#[Column(type: 'smallserial', name: 'small_serial')]
26+
public int $smallSerial;
27+
28+
/**
29+
* @Column(type="serial")
30+
*/
31+
#[Column(type: 'serial')]
32+
public int $serial;
33+
34+
/**
35+
* @Column(type="bigserial", name="big_serial")
36+
*/
37+
#[Column(type: 'bigserial', name: 'big_serial')]
38+
public int $bigSerial;
39+
}

‎tests/Annotated/Fixtures/Fixtures25/WithGeneratedFields.php‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Cycle\Annotated\Tests\Fixtures\Fixtures25;
6+
7+
use Cycle\Annotated\Annotation\Column;
8+
use Cycle\Annotated\Annotation\Entity;
9+
use Cycle\Annotated\Annotation\GeneratedValue;
10+
11+
/**
12+
* @Entity(role="withGeneratedFields", table="with_generated_fields")
13+
*/
14+
#[Entity(role: 'withGeneratedFields', table: 'with_generated_fields')]
15+
class WithGeneratedFields
16+
{
17+
/**
18+
* @Column(type="primary")
19+
*/
20+
#[Column(type: 'primary')]
21+
public int $id;
22+
23+
/**
24+
* @Column(type="datetime", name="created_at")
25+
* @GeneratedValue(beforeInsert=true)
26+
*/
27+
#[
28+
Column(type: 'datetime', name: 'created_at'),
29+
GeneratedValue(beforeInsert: true)
30+
]
31+
public \DateTimeImmutable $createdAt;
32+
33+
/**
34+
* @Column(type="datetime", name="created_at_generated_by_database")
35+
* @GeneratedValue(onInsert=true)
36+
*/
37+
#[
38+
Column(type: 'datetime', name: 'created_at_generated_by_database'),
39+
GeneratedValue(onInsert: true)
40+
]
41+
public \DateTimeImmutable $createdAtGeneratedByDatabase;
42+
43+
/**
44+
* @Column(type="datetime", name="created_at")
45+
* @GeneratedValue(beforeInsert=true, beforeUpdate=true)
46+
*/
47+
#[
48+
Column(type: 'datetime', name: 'updated_at'),
49+
GeneratedValue(beforeInsert: true, beforeUpdate: true)
50+
]
51+
public \DateTimeImmutable $updatedAt;
52+
}

‎tests/Annotated/Functional/Driver/Common/GeneratedFieldsTestCase.php‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Cycle\Annotated\Tests\Functional\Driver\Common;
6+
7+
use Cycle\Annotated\Entities;
8+
use Cycle\Annotated\Locator\TokenizerEntityLocator;
9+
use Cycle\ORM\Schema\GeneratedField;
10+
use Cycle\ORM\SchemaInterface;
11+
use Cycle\Schema\Compiler;
12+
use Cycle\Schema\Registry;
13+
use PHPUnit\Framework\Attributes\DataProvider;
14+
use Spiral\Attributes\ReaderInterface;
15+
use Spiral\Tokenizer\Config\TokenizerConfig;
16+
use Spiral\Tokenizer\Tokenizer;
17+
18+
abstract class GeneratedFieldsTestCase extends BaseTestCase
19+
{
20+
#[DataProvider('allReadersProvider')]
21+
public function testGeneratedFields(ReaderInterface $reader): void
22+
{
23+
$tokenizer = new Tokenizer(new TokenizerConfig([
24+
'directories' => [__DIR__ . '/../../../Fixtures/Fixtures25'],
25+
'exclude' => ['PostgreSQL'],
26+
]));
27+
28+
$locator = $tokenizer->classLocator();
29+
30+
$r = new Registry($this->dbal);
31+
$schema = (new Compiler())->compile($r, [
32+
new Entities(new TokenizerEntityLocator($locator, $reader), $reader),
33+
]);
34+
35+
$this->assertSame(
36+
[
37+
'id' => GeneratedField::ON_INSERT,
38+
'createdAt' => GeneratedField::BEFORE_INSERT,
39+
'createdAtGeneratedByDatabase' => GeneratedField::ON_INSERT,
40+
'updatedAt' => GeneratedField::BEFORE_INSERT | GeneratedField::BEFORE_UPDATE,
41+
],
42+
$schema['withGeneratedFields'][SchemaInterface::GENERATED_FIELDS]
43+
);
44+
}
45+
}

‎tests/Annotated/Functional/Driver/Common/Inheritance/SingleTableTestCase.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
use Cycle\ORM\Relation;
2222
use Cycle\ORM\Schema;
2323
use Cycle\ORM\SchemaInterface;
24+
use Cycle\ORM\Schema\GeneratedField;
2425
use Cycle\ORM\Select\Repository;
2526
use Cycle\ORM\Select\Source;
2627
use Cycle\ORM\EntityManager;
@@ -306,6 +307,9 @@ public function testSingleTableInheritanceWithDifferentColumnDeclaration(
306307
],
307308
SchemaInterface::SCHEMA => [],
308309
SchemaInterface::TYPECAST_HANDLER => null,
310+
SchemaInterface::GENERATED_FIELDS => [
311+
'id' => GeneratedField::ON_INSERT,
312+
],
309313
],
310314
$schema['comment']
311315
);

‎tests/Annotated/Functional/Driver/MySQL/GeneratedFieldsTest.php‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Cycle\Annotated\Tests\Functional\Driver\MySQL;
6+
7+
// phpcs:ignore
8+
use Cycle\Annotated\Tests\Functional\Driver\Common\GeneratedFieldsTestCase;
9+
use PHPUnit\Framework\Attributes\Group;
10+
11+
#[Group('driver')]
12+
#[Group('driver-mysql')]
13+
final class GeneratedFieldsTest extends GeneratedFieldsTestCase
14+
{
15+
public const DRIVER = 'mysql';
16+
}

‎tests/Annotated/Functional/Driver/Postgres/GeneratedFieldsTest.php‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Cycle\Annotated\Tests\Functional\Driver\Postgres;
6+
7+
// phpcs:ignore
8+
use Cycle\Annotated\Entities;
9+
use Cycle\Annotated\Locator\TokenizerEntityLocator;
10+
use Cycle\Annotated\Tests\Functional\Driver\Common\GeneratedFieldsTestCase;
11+
use Cycle\ORM\Schema\GeneratedField;
12+
use Cycle\ORM\SchemaInterface;
13+
use Cycle\Schema\Compiler;
14+
use Cycle\Schema\Registry;
15+
use PHPUnit\Framework\Attributes\DataProvider;
16+
use PHPUnit\Framework\Attributes\Group;
17+
use Spiral\Attributes\ReaderInterface;
18+
use Spiral\Tokenizer\Config\TokenizerConfig;
19+
use Spiral\Tokenizer\Tokenizer;
20+
21+
#[Group('driver')]
22+
#[Group('driver-postgres')]
23+
final class GeneratedFieldsTest extends GeneratedFieldsTestCase
24+
{
25+
public const DRIVER = 'postgres';
26+
27+
#[DataProvider('allReadersProvider')]
28+
public function testSerialGeneratedFields(ReaderInterface $reader): void
29+
{
30+
$tokenizer = new Tokenizer(new TokenizerConfig([
31+
'directories' => [__DIR__ . '/../../../Fixtures/Fixtures25/PostgreSQL'],
32+
'exclude' => [],
33+
]));
34+
35+
$locator = $tokenizer->classLocator();
36+
37+
$r = new Registry($this->dbal);
38+
39+
$schema = (new Compiler())->compile($r, [
40+
new Entities(new TokenizerEntityLocator($locator, $reader), $reader),
41+
]);
42+
43+
$this->assertSame(
44+
[
45+
'id' => GeneratedField::ON_INSERT,
46+
'smallSerial' => GeneratedField::ON_INSERT,
47+
'serial' => GeneratedField::ON_INSERT,
48+
'bigSerial' => GeneratedField::ON_INSERT,
49+
],
50+
$schema['withGeneratedSerial'][SchemaInterface::GENERATED_FIELDS]
51+
);
52+
}
53+
}

0 commit comments

Comments
 (0)