[FRAM-182] Allow to define column type different from property type (#102)

* feat: Allow to define column type different from property type (#FRAM-182)

* ci: fix psalm, doc: update changelog

Author: vincent4vx

CHANGELOG

@@ -1,3 +1,8 @@
+v2.3.0
+------
+
+* Feat: Allow to explicitly declare the type of the column in the schema using `FieldBuilder::storedAs()`
+
 v2.2.0
 ------
 

src/Mapper/Builder/FieldBuilder.php

@@ -41,6 +41,7 @@
  *     customSchemaOptions?: array,
  *     platformOptions?: array,
  *     columnDefinition?: string,
+ *     storageType?: string,
  *     virtual?: bool
  * }
  *
@@ -607,6 +608,25 @@ public function fixed(bool $flag = true)
         return $this;
     }
 
+    /**
+     * Define the actual type used to store the data.
+     *
+     * When provided, the schema manager will use this type instead of the default one,
+     * the default type will only be used to parse or normalize the value.
+     *
+     * @param string $type The type name. Should be a constant of TypeInterface.
+     *
+     * @return $this
+     *
+     * @see TypeInterface::* constants
+     */
+    public function storedAs(string $type)
+    {
+        $this->fields[$this->current]['storageType'] = $type;
+
+        return $this;
+    }
+
     /**
      * Declare the column as JSON type instead of TEXT.
      *

src/Mapper/Metadata.php

@@ -30,6 +30,7 @@
  *     unsigned?: bool,
  *     unique?: bool|string,
  *     class?: class-string,
+ *     storageType?: string,
  *     virtual?: bool
  * }
  *

src/Schema/Adapter/Metadata/MetadataColumn.php

@@ -48,15 +48,18 @@ public function name(): string
      */
     public function type(): PlatformTypeInterface
     {
-        return $this->types->native($this->metadata['type']);
+        return isset($this->metadata['storageType'])
+            ? $this->types->native($this->metadata['storageType'])
+            : $this->types->native($this->metadata['type'])
+        ;
     }
 
     /**
      * {@inheritdoc}
      */
     public function defaultValue()
     {
-        return $this->type()->toDatabase($this->metadata['default']);
+        return $this->types->native($this->metadata['type'])->toDatabase($this->metadata['default']);
     }
 
     /**

tests/CRUDTest.php

@@ -542,4 +542,25 @@ public function test_custom_nullable_type()
         $this->assertEquals('SELECT t0.* FROM my_custom_nullable t0 WHERE t0.foo IN (?,?)', $query->toSql());
         $this->assertSame(['0', 'bar'], $query->getBindings());
     }
+
+    public function test_with_custom_storage_type()
+    {
+        $this->pack()->declareEntity(EntityWithCustomStorageType::class);
+        $entity = new EntityWithCustomStorageType([
+            'id' => 42,
+            'name' => 'foo',
+            'value' => ['foo', 'bar', 'baz'],
+            'enabled' => true,
+        ]);
+        $entity->insert();
+
+        $this->assertEquals($entity, EntityWithCustomStorageType::refresh($entity));
+
+        $this->assertEquals([[
+            'id' => '42.0',
+            'name' => 'foo',
+            'value' => ',foo,bar,baz,',
+            'enabled' => '1',
+        ]], EntityWithCustomStorageType::repository()->builder()->execute()->all());
+    }
 }

tests/Mapper/Builder/FieldBuiderTest.php

@@ -4,6 +4,7 @@
 
 use Bdf\Prime\PolymorphSubA;
 use Bdf\Prime\PolymorphSubB;
+use Bdf\Prime\Types\TypeInterface;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -247,6 +248,18 @@ public function test_add_precision()
         $this->assertSame(2, $builder['name']['scale']);
     }
 
+    /**
+     *
+     */
+    public function test_storedAs()
+    {
+        $builder = new FieldBuilder();
+
+        $builder->string('name')->storedAs(TypeInterface::JSON);
+
+        $this->assertSame('json', $builder['name']['storageType']);
+    }
+
     /**
      *
      */

tests/Schema/Adapter/Metadata/MetadataColumnTest.php

@@ -3,6 +3,7 @@
 namespace Bdf\Prime\Schema\Adapter\Metadata;
 
 use Bdf\Prime\Document;
+use Bdf\Prime\EntityWithCustomStorageType;
 use Bdf\Prime\Faction;
 use Bdf\Prime\Mapper\Metadata;
 use Bdf\Prime\Platform\PlatformInterface;
@@ -132,4 +133,13 @@ public function test_defaultValue_must_be_converted_to_db_value()
 
         $this->assertSame(1, $column->defaultValue());
     }
+
+    public function test_custom_storage_type()
+    {
+        $this->metadata = EntityWithCustomStorageType::repository()->mapper()->metadata();
+
+        $column = new MetadataColumn($this->metadata->attributes['enabled'], $this->types);
+
+        $this->assertEquals($this->types->get(TypeInterface::INTEGER), $column->type());
+    }
 }

tests/Schema/ResolverTest.php

@@ -4,6 +4,7 @@
 
 use Bdf\Prime\CrossConnectionSequenceEntity;
 use Bdf\Prime\Customer;
+use Bdf\Prime\EntityWithCustomStorageType;
 use Bdf\Prime\EntityWithIndex;
 use Bdf\Prime\Faction;
 use Bdf\Prime\Prime;
@@ -237,4 +238,10 @@ public function test_diff_with_legacy_indexes_format_without_diff_should_return_
         $resolver->migrate();
         $this->assertEmpty($resolver->diff());
     }
+
+    public function test_custom_storage_type()
+    {
+        $resolver = EntityWithCustomStorageType::repository()->schema();
+        $this->assertEquals(['CREATE TABLE entity_custom_storage_type (id DOUBLE PRECISION NOT NULL, name BLOB NOT NULL, value VARCHAR(32) NOT NULL, enabled INTEGER NOT NULL)'], $resolver->diff());
+    }
 }

tests/_files/TestEntities.php

@@ -20,3 +20,4 @@
 require_once __DIR__.'/entity_with_custom_nullable_type.php';
 require_once __DIR__.'/null_relation_inheritance.php';
 require_once __DIR__.'/json_entities.php';
+require_once __DIR__.'/entity_custom_storage_type.php';

tests/_files/entity_custom_storage_type.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Bdf\Prime;
+
+use Bdf\Prime\Entity\Model;
+use Bdf\Prime\Mapper\Builder\FieldBuilder;
+use Bdf\Prime\Mapper\Mapper;
+use Bdf\Prime\Types\TypeInterface;
+
+class EntityWithCustomStorageType extends Model
+{
+    public ?int $id;
+    public ?string $name;
+    public array $value = [];
+    public bool $enabled = false;
+
+    public function __construct(array $data = [])
+    {
+        $this->import($data);
+    }
+}
+
+class EntityWithCustomStorageTypeMapper extends Mapper
+{
+    public function schema(): array
+    {
+        return [
+            'connection' => 'test',
+            'table' => 'entity_custom_storage_type',
+        ];
+    }
+
+    public function buildFields(FieldBuilder $builder): void
+    {
+        $builder
+            ->integer('id')->autoincrement()->storedAs(TypeInterface::DOUBLE)
+            ->string('name')->storedAs(TypeInterface::BLOB)
+            ->simpleArray('value')->storedAs(TypeInterface::STRING)->length(32)
+            ->boolean('enabled')->storedAs(TypeInterface::INTEGER)
+        ;
+    }
+}