WIP: Adding mapping for relationships & support for advanced design patterns

composer.json

@@ -23,6 +23,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^8.0",
-        "mnapoli/hard-mode": "^0.1.1"
+        "mnapoli/hard-mode": "^0.1.1",
+        "ramsey/uuid": "^3.8"
     }
 }

src/EntityManager/EntityManager.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\EntityManager;
+
+use Aws\DynamoDb\DynamoDbClient;
+use Dynamap\Serializer\EntitySerializer;
+
+final class EntityManager
+{
+    /** @var DynamoDbClient */
+    private $client;
+    /** @var EntitySerializer */
+    private $serializer;
+
+    public function __construct(DynamoDbClient $client, EntitySerializer $serializer)
+    {
+        $this->client = $client;
+
+        $this->serializer = $serializer;
+    }
+
+    public function persist($entity): void
+    {
+    }
+
+    public function fetch($entity): object
+    {
+    }
+
+    public function delete($entity): void
+    {
+    }
+
+    // create
+    // read
+    // update
+    // delete
+}

src/Mapping/ClassMapping.php

@@ -0,0 +1,103 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping;
+
+use Dynamap\Mapping\Exception\CannotMapNonExistentFieldException;
+use Dynamap\Mapping\Exception\ClassNameInvalidException;
+use Dynamap\Mapping\Exception\MappingNotFoundException;
+use Dynamap\Mapping\Exception\NoFieldsMappedForClassException;
+use Dynamap\Mapping\Field\DynamoDBField;
+
+class ClassMapping
+{
+    /** @var string */
+    private $tableName;
+    /** @var string */
+    private $className;
+    /** @var array */
+    private $mapping;
+
+    private function __construct(string $tableName, string $className, array $config)
+    {
+        $this->className = $className;
+        $this->mapping = $config;
+        $this->tableName = $tableName;
+    }
+
+    public static function fromArray(string $tableName, string $className, array $config): ClassMapping
+    {
+        if (\class_exists($className) === false) {
+            throw new ClassNameInvalidException('Could not map ' . $className . ' as the class was not found');
+        }
+
+        if (empty($config['fields']) === false) {
+            $fields = self::mapProperties($className, $config['fields']);
+
+            $config['fields'] = $fields;
+        }
+
+        return new static($tableName, $className, $config);
+    }
+
+    public function getClassName(): string
+    {
+        return $this->className;
+    }
+
+    public function getTableName(): string
+    {
+        return $this->tableName;
+    }
+
+    public function getMappedProperty(string $propertyName): DynamoDBField
+    {
+        if (empty($this->mapping['fields']) === true) { // todo: add a test for this
+            throw new NoFieldsMappedForClassException('You have tried to access mapping for a class which has no mapped properties');
+        }
+
+        if ($this->hasMappedProperty($propertyName) === false) {
+            throw new MappingNotFoundException('Mapping for ' . $propertyName . ' could not be found');
+        }
+
+        return $this->mapping['fields'][$propertyName];
+    }
+
+    public function hasMappedProperty(string $propertyName): bool
+    {
+        // todo: add a test for this
+        if (\array_key_exists('fields', $this->mapping) === false) {
+            return false;
+        }
+
+        return \array_key_exists($propertyName, $this->mapping['fields']);
+    }
+
+    /**
+     * @param array $fields
+     * @return array
+     * @throws CannotMapNonExistentFieldException
+     * @throws \ReflectionException
+     */
+    private static function mapProperties(string $className, array $fields): array
+    {
+        $reflection = new \ReflectionClass($className);
+
+        $classProperties = array_reduce($reflection->getProperties(), static function ($carry, $item) {
+            $carry[] = $item->getName();
+            return $carry;
+        }, []);
+
+        $mappedFields = [];
+        $factory = new FieldMappingFactory;
+
+        foreach ($fields as $classField => $type) {
+            if (\in_array($classField, $classProperties, false) === false) {
+                throw new CannotMapNonExistentFieldException('The field ' . $classField . ' does not exist in ' . $className);
+            }
+
+            $mappedFields[$classField] = $factory->getDynamoDbType($type);
+        }
+
+        return $mappedFields;
+    }
+}

src/Mapping/Exception/CannotMapNonExistentFieldException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Exception;
+
+class CannotMapNonExistentFieldException extends \Exception
+{
+}

src/Mapping/Exception/ClassNameInvalidException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Exception;
+
+class ClassNameInvalidException extends \Exception
+{
+}

src/Mapping/Exception/MappingNotFoundException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Exception;
+
+class MappingNotFoundException extends \Exception
+{
+}

src/Mapping/Exception/MappingNotSpecifiedException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Exception;
+
+class MappingNotSpecifiedException extends \Exception
+{
+}

src/Mapping/Exception/NoFieldsMappedForClassException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Exception;
+
+class NoFieldsMappedForClassException extends \Exception
+{
+}

src/Mapping/Exception/NoTableSpeficiedException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Exception;
+
+class NoTableSpeficiedException extends \Exception
+{
+}

src/Mapping/Exception/TableNameNotSpecifiedException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Exception;
+
+class TableNameNotSpecifiedException extends \Exception
+{
+}

src/Mapping/Field/BooleanField.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Field;
+
+class BooleanField implements DynamoDBField
+{
+    public function getDynamoDBFieldType(): string
+    {
+        return 'BOOL';
+    }
+
+    public function getOriginalFieldType(): string
+    {
+        return 'boolean';
+    }
+
+    public function castToDynamoDBType($value): bool
+    {
+        return $value;
+    }
+
+    public function restoreFromDynamoDBType($value): bool
+    {
+        return (bool) $value;
+    }
+}

src/Mapping/Field/DateTimeField.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Field;
+
+class DateTimeField implements DynamoDBField
+{
+    /** @var string */
+    private $originalFieldType;
+
+    public function __construct(string $originalFieldType)
+    {
+        $this->originalFieldType = $originalFieldType;
+    }
+
+    public function getDynamoDBFieldType(): string
+    {
+        return 'S';
+    }
+
+    public function getOriginalFieldType(): string
+    {
+        return $this->originalFieldType;
+    }
+
+    public function castToDynamoDBType($value)
+    {
+        return $value->format(\DateTime::ATOM);
+    }
+
+    public function restoreFromDynamoDBType($value): \DateTimeInterface
+    {
+        return \DateTime::createFromFormat(\DateTime::ATOM, $value);
+    }
+}

src/Mapping/Field/DynamoDBField.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Field;
+
+interface DynamoDBField
+{
+    public function getOriginalFieldType(): string;
+
+    public function getDynamoDBFieldType(): string;
+
+    public function castToDynamoDBType($value);
+
+    public function restoreFromDynamoDBType($value);
+}

src/Mapping/Field/NumberField.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Field;
+
+class NumberField implements DynamoDBField
+{
+    /** @var string */
+    private $originalFieldType;
+
+    public function __construct(string $originalFieldType)
+    {
+        $this->originalFieldType = $originalFieldType;
+    }
+
+    public function getDynamoDBFieldType(): string
+    {
+        return 'N';
+    }
+
+    public function getOriginalFieldType(): string
+    {
+        return $this->originalFieldType;
+    }
+
+    public function castToDynamoDBType($value)
+    {
+        return $value;
+    }
+
+    public function restoreFromDynamoDBType($value)
+    {
+        return $value;
+    }
+}

src/Mapping/Field/StringField.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping\Field;
+
+use Ramsey\Uuid\Uuid;
+
+class StringField implements DynamoDBField
+{
+    /** @var string */
+    private $originalFieldType;
+
+    public function __construct(string $originalFieldType)
+    {
+        $this->originalFieldType = $originalFieldType;
+    }
+
+    public function getDynamoDBFieldType(): string
+    {
+        return 'S';
+    }
+
+    public function getOriginalFieldType(): string
+    {
+        return $this->originalFieldType;
+    }
+
+    public function castToDynamoDBType($value): string
+    {
+        return (string)$value;
+    }
+
+    public function restoreFromDynamoDBType($value)
+    {
+        if ('uuid' === $this->originalFieldType) {
+            return Uuid::fromString($value);
+        }
+
+        return (string)$value;
+    }
+}

src/Mapping/FieldMappingFactory.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace Dynamap\Mapping;
+
+use Dynamap\Mapping\Field\BooleanField;
+use Dynamap\Mapping\Field\DateTimeField;
+use Dynamap\Mapping\Field\DynamoDBField;
+use Dynamap\Mapping\Field\NumberField;
+use Dynamap\Mapping\Field\StringField;
+
+class FieldMappingFactory
+{
+    public function getDynamoDBType(string $propertyType): DynamoDBField
+    {
+        switch (strtolower($propertyType)) {
+            case 'uuid':
+            case 'string':
+                return new StringField($propertyType);
+                break;
+            case 'float':
+            case 'integer':
+                return new NumberField($propertyType);
+                break;
+            case 'boolean':
+                return new BooleanField;
+                break;
+            case 'datetime':
+                return new DateTimeField($propertyType);
+                break;
+            default: // todo: add a test for this
+                throw new InvalidMappingTypeException;
+        }
+    }
+}