obsolete annotation

Author: gam6itko

src/Annotation/Obsolete.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Annotation;
+
+use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
+
+/**
+ * Used to safely drop column from table which used in several services.For safely drop column from table which used in several services.
+ * The property should not be displayed in schema but should remain in the tableThe property should not be in schema.
+ *
+ * @Annotation
+ * @NamedArgumentConstructor
+ * @Target({"PROPERTY"})
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]
+class Obsolete
+{
+}

src/Configurator.php

@@ -9,6 +9,7 @@
 use Cycle\Annotated\Annotation\Entity;
 use Cycle\Annotated\Annotation\ForeignKey;
 use Cycle\Annotated\Annotation\GeneratedValue;
+use Cycle\Annotated\Annotation\Obsolete;
 use Cycle\Annotated\Annotation\Relation as RelationAnnotation;
 use Cycle\Annotated\Exception\AnnotationException;
 use Cycle\Annotated\Exception\AnnotationRequiredArgumentsException;
@@ -96,7 +97,7 @@ public function initEmbedding(Embeddable $emb, \ReflectionClass $class): EntityS
 
     public function initFields(EntitySchema $entity, \ReflectionClass $class, string $columnPrefix = ''): void
     {
-        foreach ($class->getProperties() as $property) {
+        foreach ($this->getActualProperties($class) as $property) {
             try {
                 $column = $this->reader->firstPropertyMetadata($property, Column::class);
             } catch (\Exception $e) {
@@ -119,7 +120,7 @@ public function initFields(EntitySchema $entity, \ReflectionClass $class, string
 
     public function initRelations(EntitySchema $entity, \ReflectionClass $class): void
     {
-        foreach ($class->getProperties() as $property) {
+        foreach ($this->getActualProperties($class) as $property) {
             $metadata = $this->getPropertyMetadata($property, RelationAnnotation\RelationInterface::class);
 
             foreach ($metadata as $meta) {
@@ -413,4 +414,22 @@ private function isOnInsertGeneratedField(Field $field): bool
             default => $field->isPrimary(),
         };
     }
+
+    /**
+     * @return \Generator<\ReflectionProperty>
+     */
+    private function getActualProperties(\ReflectionClass $class): \Generator
+    {
+        foreach ($class->getProperties() as $property) {
+            // Obsolete property must not be included in the scheme.
+            $metadata = \iterator_to_array(
+                $this->getPropertyMetadata($property, Obsolete::class),
+            );
+            if ([] !== $metadata) {
+                continue;
+            }
+
+            yield $property;
+        }
+    }
 }

tests/Annotated/Fixtures/Fixtures26/User.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Tests\Fixtures\Fixtures26;
+
+use Cycle\Annotated\Annotation\Column;
+use Cycle\Annotated\Annotation\Entity;
+use Cycle\Annotated\Annotation\Obsolete;
+
+/**
+ * @Entity(table="user")
+ */
+#[Entity(table: 'user')]
+class User
+{
+    /** @Column(type="primary") */
+    #[Column(type: 'primary')]
+    protected $id;
+
+    /** @Column(type="string") */
+    #[Column(type: 'string')]
+    protected $name;
+
+    /**
+     * @Column(type="integer", nullable=true)
+     * @Obsolete
+     *
+     * @deprecated Since May 5, 2025
+     */
+    #[Obsolete]
+    #[Column(type: 'string', nullable: true)]
+    protected $skype = null;
+
+    /**
+     * There is must not be problems with it.
+     */
+    #[Obsolete]
+    private $secret;
+}

tests/Annotated/Functional/Driver/Common/ObsoleteTest.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Tests\Functional\Driver\Common;
+
+use Cycle\Annotated\Entities;
+use Cycle\Annotated\Locator\TokenizerEntityLocator;
+use Cycle\ORM\SchemaInterface;
+use Cycle\Schema\Compiler;
+use Cycle\Schema\Generator\RenderTables;
+use Cycle\Schema\Generator\SyncTables;
+use Cycle\Schema\Registry;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Spiral\Attributes\ReaderInterface;
+use Spiral\Tokenizer\Config\TokenizerConfig;
+use Spiral\Tokenizer\Tokenizer;
+
+abstract class ObsoleteTest extends BaseTestCase
+{
+    #[DataProvider('allReadersProvider')]
+    public function testObsoleteColumn(ReaderInterface $reader): void
+    {
+        $tokenizer = new Tokenizer(
+            new TokenizerConfig([
+                'directories' => [__DIR__ . '/../../../Fixtures/Fixtures26'],
+                'exclude' => [],
+            ])
+        );
+
+        $locator = $tokenizer->classLocator();
+
+        $r = new Registry($this->dbal);
+
+        $schema = (new Compiler())->compile($r, [
+            new Entities(new TokenizerEntityLocator($locator, $reader), $reader),
+            new RenderTables(),
+            new SyncTables(),
+        ]);
+
+        $this->assertArrayNotHasKey('skype', $schema['user'][SchemaInterface::COLUMNS]);
+        $this->assertArrayNotHasKey('skype', $schema['user'][SchemaInterface::TYPECAST]);
+    }
+}

tests/Annotated/Functional/Driver/MySQL/ObsoleteTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Tests\Functional\Driver\MySQL;
+
+// phpcs:ignore
+use Cycle\Annotated\Tests\Functional\Driver\Common\ObsoleteTest as CommonClass;
+
+/**
+ * @group driver
+ * @group driver-mysql
+ */
+class ObsoleteTest extends CommonClass
+{
+    public const DRIVER = 'mysql';
+}

tests/Annotated/Functional/Driver/Postgres/ObsoleteTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Tests\Functional\Driver\Postgres;
+
+// phpcs:ignore
+use Cycle\Annotated\Tests\Functional\Driver\Common\ObsoleteTest as CommonClass;
+
+/**
+ * @group driver
+ * @group driver-postgres
+ */
+class ObsoleteTest extends CommonClass
+{
+    public const DRIVER = 'postgres';
+}

tests/Annotated/Functional/Driver/SQLServer/ObsoleteTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Tests\Functional\Driver\SQLServer;
+
+// phpcs:ignore
+use Cycle\Annotated\Tests\Functional\Driver\Common\ObsoleteTest as CommonClass;
+
+/**
+ * @group driver
+ * @group driver-sqlserver
+ */
+class ObsoleteTest extends CommonClass
+{
+    public const DRIVER = 'sqlserver';
+}

tests/Annotated/Functional/Driver/SQLite/ObsoleteTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Tests\Functional\Driver\SQLite;
+
+// phpcs:ignore
+use Cycle\Annotated\Tests\Functional\Driver\Common\ObsoleteTest as CommonClass;
+
+/**
+ * @group driver
+ * @group driver-sqlite
+ */
+class ObsoleteTest extends CommonClass
+{
+    public const DRIVER = 'sqlite';
+}

tests/generate.php

@@ -1,7 +1,31 @@
 <?php
 
+/**
+ * 1. Create new test case class in folder `tests/Functional/Driver/Common` with content:
+ *
+ *
+ *     namespace Cycle\Annotated\Tests\Functional\Driver\Common;
+ *
+ *     abstract class MyTest extends BaseTest {}
+ *
+ *
+ * 2. run this script
+ *
+ *
+ *     php generate.php
+ *
+ *
+ * 3. Don't forget commit newly created files:
+ *
+ *  - `tests/Functional/Driver/MySQL/MyTest`
+ *  - `tests/Functional/Driver/Postgres/MyTest`
+ *  - `tests/Functional/Driver/SQLite/MyTest`
+ *  - `tests/Functional/Driver/SQLServer/MyTest`
+ */
+
 declare(strict_types=1);
 
+use Cycle\Annotated\Tests\Functional\Driver\Common\BaseTest;
 use Spiral\Tokenizer;
 
 error_reporting(E_ALL | E_STRICT);