From 422d9a6dbdda953055bbad91c694df5959a93810 Mon Sep 17 00:00:00 2001
From: Aldarien <aldarien85@gmail.com>
Date: Mon, 10 Oct 2022 16:36:47 -0300
Subject: [PATCH] Improve mapping

---
 src/Alias/Model/Repository.php   |  93 +++++++++++-
 src/Concept/Model/Factory.php    |  37 +++++
 src/Concept/Model/Repository.php | 241 ++++++++++++++++++++++++++++++-
 src/Implement/Model/Factory.php  |  15 ++
 4 files changed, 376 insertions(+), 10 deletions(-)

diff --git a/src/Alias/Model/Repository.php b/src/Alias/Model/Repository.php
index 3ba812a..3e6aed4 100644
--- a/src/Alias/Model/Repository.php
+++ b/src/Alias/Model/Repository.php
@@ -73,6 +73,54 @@ abstract class Repository implements RepositoryInterface
     {
         return $this->table;
     }
+    protected array $mappings;
+    public function getMappings(): array
+    {
+        if (isset($this->mappings)) {
+            return $this->mappings;
+        }
+        $mappings = [];
+        foreach ($this->getColumns() as $column) {
+            $mappings []= (object) ['column' => $column, 'property' => $column];
+        }
+        return $mappings;
+    }
+    public function addMapping(string $column, string $property): Repository
+    {
+        $this->mappings []= (object) compact('column', 'property');
+        return $this;
+    }
+    public function setMappings(array $mappings): Repository
+    {
+        foreach ($mappings as $mapping) {
+            if (is_array($mapping)) {
+                $this->addMapping($mapping['column'], $mapping['property']);
+            }
+            if (is_object($mapping)) {
+                $this->addMapping($mapping->column, $mapping->property);
+            }
+        }
+        return $this;
+    }
+    public function findColumnByProperty(string $property): string
+    {
+        foreach ($this->getMappings() as $mapping) {
+            if ($mapping->property === $property) {
+                return $mapping->column;
+            }
+        }
+        throw new \InvalidArgumentException("Property {$property} not found in mapping in " . get_called_class());
+    }
+    public function findPropertyByColumn(string $column): string
+    {
+        foreach ($this->getMappings() as $mapping) {
+            if ($mapping->column === $column) {
+                return $mapping->property;
+            }
+        }
+        throw new \InvalidArgumentException("Column {$column} not found in mapping in " . get_called_class());
+    }
+
     protected array $columns;
     public function setColumns(array $columns): RepositoryInterface
     {
@@ -90,6 +138,23 @@ abstract class Repository implements RepositoryInterface
     {
         return $this->columns;
     }
+    protected array $properties;
+    public function getProperties(): array
+    {
+        return $this->properties;
+    }
+    public function addProperty(string $property): RepositoryInterface
+    {
+        $this->properties []= $property;
+        return $this;
+    }
+    public function setProperties(array $properties): RepositoryInterface
+    {
+        foreach ($properties as $property) {
+            $this->addProperty($property);
+        }
+        return $this;
+    }
     protected array $required;
     public function setRequired(array $columns): RepositoryInterface
     {
@@ -131,9 +196,9 @@ abstract class Repository implements RepositoryInterface
         return $this->optional ?? [];
     }
 
-    public function getMethod(string $column, bool $get = true): string
+    public function getMethod(string $property, bool $get = true): string
     {
-        $m = str_replace(' ', '', ucwords(str_replace('_', ' ', $column)));
+        $m = str_replace(' ', '', ucwords(str_replace('_', ' ', $property)));
         if ($get) {
             return "get{$m}";
         }
@@ -149,18 +214,28 @@ abstract class Repository implements RepositoryInterface
     }
     public function fillData(Model $model, array $data): Model
     {
-        foreach ($this->getRequired() as $column) {
-            $m = $this->getMethod($column, false);
+        foreach ($this->getColumns() as $column) {
+            try {
+                $property = $this->findPropertyByColumn($column);
+            } catch (\InvalidArgumentException $e) {
+                continue;
+            }
+            $m = $this->getMethod($property, false);
             if (!method_exists($model, $m)) {
                 continue;
             }
             $model->{$m}($data[$column]);
         }
         foreach ($this->getOptional() as $column) {
+            try {
+                $property = $this->findPropertyByColumn($column);
+            } catch (\InvalidArgumentException $e) {
+                continue;
+            }
+            $m = $this->getMethod($property, false);
             if (!isset($data[$column])) {
                 continue;
             }
-            $m = $this->getMethod($column, false);
             if (!method_exists($model, $m)) {
                 continue;
             }
@@ -170,11 +245,13 @@ abstract class Repository implements RepositoryInterface
     }
     public function mapArray(Model $model, array $data): array
     {
-        foreach ($this->getColumns() as $column) {
-            if (isset($data[$column])) {
+        foreach ($this->getProperties() as $property) {
+            try {
+                $column = $this->findColumnByProperty($property);
+            } catch (\InvalidArgumentException $e) {
                 continue;
             }
-            $m = $this->getMethod($column);
+            $m = $this->getMethod($property);
             if (!method_exists($model, $m)) {
                 continue;
             }
diff --git a/src/Concept/Model/Factory.php b/src/Concept/Model/Factory.php
index 8e1f566..1ab4a94 100644
--- a/src/Concept/Model/Factory.php
+++ b/src/Concept/Model/Factory.php
@@ -1,11 +1,48 @@
 <?php
 namespace ProVM\Concept\Model;
 
+use ProVM\Concept\Model;
 use Psr\Container\ContainerInterface;
 
 interface Factory
 {
+    /**
+     * @param ContainerInterface $container
+     * @return Factory
+     */
     public function setContainer(ContainerInterface $container): Factory;
+
+    /**
+     * @return ContainerInterface
+     */
     public function getContainer(): ContainerInterface;
+
+    /**
+     * Get Repository by class
+     * @param string $repository_class
+     * @return Repository
+     */
     public function get(string $repository_class): Repository;
+
+    /**
+     * Get Repository by Model class
+     * @param string $model_class
+     * @return Repository
+     */
+    public function getByModel(string $model_class): Repository;
+
+    /**
+     * Fetch Model by Id
+     * @param string $model_class
+     * @param int $id
+     * @return Model
+     */
+    public function fetchById(string $model_class, int $id): Model;
+
+    /**
+     * Fetch all Models
+     * @param string $model_class
+     * @return array
+     */
+    public function fetchAll(string $model_class): array;
 }
diff --git a/src/Concept/Model/Repository.php b/src/Concept/Model/Repository.php
index 7a79fb9..a15c2c8 100644
--- a/src/Concept/Model/Repository.php
+++ b/src/Concept/Model/Repository.php
@@ -7,37 +7,274 @@ use ProVM\Concept\Model;
 
 interface Repository
 {
+    /**
+     * @param Connection $connection
+     * @return Repository
+     */
     public function setConnection(Connection $connection): Repository;
+
+    /**
+     * @return Connection
+     */
     public function getConnection(): Connection;
+
+    /**
+     * @param QueryBuilder $builder
+     * @return Repository
+     */
     public function setQueryBuilder(QueryBuilder $builder): Repository;
+
+    /**
+     * @return QueryBuilder
+     */
     public function getQueryBuilder(): QueryBuilder;
+
+    /**
+     * @param Factory $factory
+     * @return Repository
+     */
     public function setFactory(Factory $factory): Repository;
+
+    /**
+     * @return Factory
+     */
     public function getFactory(): Factory;
+
+    /**
+     * @param string $model_class
+     * @return Repository
+     */
     public function setModel(string $model_class): Repository;
+
+    /**
+     * @return string
+     */
     public function getModel(): string;
+
+    /**
+     * Get clean empty Model
+     * @return Model
+     */
     public function getNewModel(): Model;
+
+    /**
+     * Set up the Repository
+     * SHOULD CALL
+     *      setTable
+     *      setColumns [setRequired, setOptional]
+     *      setProperties
+     *      setMapping
+     *      setModel
+     * @return Repository
+     */
     public function setup(): Repository;
-    public function setTable(string $table): Repository;
+
+    /**
+     * @return string
+     */
     public function getTable(): string;
+
+    /**
+     * @param string $table
+     * @return Repository
+     */
+    public function setTable(string $table): Repository;
+
+    /**
+     * Get Model - table mapping
+     * @return array
+     */
+    public function getMappings(): array;
+
+    /**
+     * @param string $column
+     * @param string $property
+     * @return Repository
+     */
+    public function addMapping(string $column, string $property): Repository;
+
+    /**
+     * Set Model - table mappings
+     * @param array $mappings
+     * @return Repository
+     */
+    public function setMappings(array $mappings): Repository;
+
+    /**
+     * Find a property from mapping by column
+     * @param string $column
+     * @return string
+     */
+    public function findPropertyByColumn(string $column): string;
+
+    /**
+     * Find a column from mapping by property
+     * @param string $property
+     * @return string
+     */
+    public function findColumnByProperty(string $property): string;
+
+    /**
+     * Set columns in table
+     * @param array $columns
+     * @return Repository
+     */
     public function setColumns(array $columns): Repository;
+
+    /**
+     * @param string $column
+     * @return Repository
+     */
     public function addColumn(string $column): Repository;
+
+    /**
+     * Get table columns
+     * @return array
+     */
     public function getColumns(): array;
+
+    /**
+     * Get Model properties
+     * @return array
+     */
+    public function getProperties(): array;
+
+    /**
+     * @param string $property
+     * @param $value
+     * @return Repository
+     */
+    public function addProperty(string $property): Repository;
+
+    /**
+     * Set Model properties
+     * @param array $properties
+     * @return Repository
+     */
+    public function setProperties(array $properties): Repository;
+
+    /**
+     * Set required columns
+     * Optional
+     * @param array $columns
+     * @return Repository
+     */
     public function setRequired(array $columns): Repository;
+
+    /**
+     * @param string $column
+     * @return Repository
+     */
     public function addRequired(string $column): Repository;
+
+    /**
+     * Get required columns
+     * @return array
+     */
     public function getRequired(): array;
+
+    /**
+     * Set optional columns
+     * @param array $columns
+     * @return Repository
+     */
     public function setOptional(array $columns): Repository;
+
+    /**
+     * @param string $column
+     * @return Repository
+     */
     public function addOptional(string $column): Repository;
+
+    /**
+     * Get optional columns
+     * @return array
+     */
     public function getOptional(): array;
-    public function getMethod(string $column, bool $get = true): string;
+
+    /**
+     * Get Model method
+     * @param string $property
+     * @param bool $get
+     * @return string
+     */
+    public function getMethod(string $property, bool $get = true): string;
+
+    /**
+     * @param string $method
+     * @return string
+     */
     public function getProperty(string $method): string;
+
+    /**
+     * Fill empty Model with data
+     * @param Model $model
+     * @param array $data
+     * @return Model
+     */
     public function fillData(Model $model, array $data): Model;
+
+    /**
+     * Fill data array with Model values
+     * @param Model $model
+     * @param array $data
+     * @return array
+     */
     public function mapArray(Model $model, array $data): array;
+
+    /**
+     * Transform result array to Model
+     * @param array $data
+     * @return Model
+     */
     public function load(array $data): Model;
+
+    /**
+     * Save Model to table
+     * @param Model $model
+     * @return void
+     */
     public function save(Model $model): void;
+
+    /**
+     * Update table value with Model
+     * @param Model $model
+     * @return void
+     */
     public function update(Model $model): void;
+
+    /**
+     * Create new Model with data
+     * @param array $data
+     * @return Model
+     */
     public function create(array $data): Model;
+
+    /**
+     * Edit Model with data
+     * @param Model $model
+     * @param array $data
+     * @return Model
+     */
     public function edit(Model $model, array $data): Model;
+
+    /**
+     * Delete Model from table
+     * @param Model $model
+     * @return void
+     */
     public function delete(Model $model): void;
+
+    /**
+     * Fetch Model by Id
+     * @param int $id
+     * @return Model
+     */
     public function fetchById(int $id): Model;
+
+    /**
+     * Fetch all Models
+     * @return array
+     */
     public function fetchAll(): array;
 }
diff --git a/src/Implement/Model/Factory.php b/src/Implement/Model/Factory.php
index c172593..8c8d33d 100644
--- a/src/Implement/Model/Factory.php
+++ b/src/Implement/Model/Factory.php
@@ -1,6 +1,7 @@
 <?php
 namespace ProVM\Implement\Model;
 
+use ProVM\Concept\Model;
 use Psr\Container\ContainerInterface;
 use ProVM\Concept\Model\Factory as FactoryInterface;
 use ProVM\Concept\Model\Repository;
@@ -26,4 +27,18 @@ class Factory implements FactoryInterface
     {
         return $this->getContainer()->get($repository_class);
     }
+    public function getByModel(string $model_class): Repository
+    {
+        $class = str_replace('Model', 'Repository', $model_class);
+        return $this->get($class);
+    }
+
+    public function fetchById(string $model_class, int $id): Model
+    {
+        return $this->getByModel($model_class)->fetchById($id);
+    }
+    public function fetchAll(string $model_class): array
+    {
+        return $this->getByModel($model_class)->fetchAll();
+    }
 }