[MixerApi/Core] - Adds support for Entity accessible and hidden to ModelProperty (#98)

* Adds support for Entity accessible and  hidden to ModelProperty
* Suggest jwt-auth and readme updates

Author: cnizzardini

plugins/core/src/Model/Model.php

@@ -57,7 +57,8 @@ private function assignProperties(): void
         });
 
         foreach ($columns as $columnName) {
-            $modelProperty = (new ModelPropertyFactory($this->schema, $this->table, $columnName))->create();
+            $modelProperty = (new ModelPropertyFactory($this->schema, $this->table, $columnName, $this->entity))
+                ->create();
 
             $this->properties[$columnName] = $modelProperty;
         }

plugins/core/src/Model/ModelProperty.php

@@ -12,25 +12,35 @@
 class ModelProperty
 {
     /**
-     * @var string
+     * @var string Column (field) name from the database definition
      */
     private string $name = '';
 
     /**
-     * @var string
+     * @var string Data type from the database definition
      */
     private string $type = '';
 
     /**
-     * @var string
+     * @var string Default value from the database definition
      */
     private string $default = '';
 
     /**
-     * @var bool
+     * @var bool Is this column a primary key (using db definition)
      */
     private bool $isPrimaryKey = false;
 
+    /**
+     * @var bool Should this field be hidden from responses (using CakePHP Entity $_hidden)
+     */
+    private bool $isHidden = false;
+
+    /**
+     * @var bool The mass assignment of this field (using CakePHP Entity $_accessible)
+     */
+    private bool $isAccessible = false;
+
     /**
      * @var \Cake\Validation\ValidationSet|null
      */
@@ -112,6 +122,44 @@ public function setIsPrimaryKey(bool $isPrimaryKey)
         return $this;
     }
 
+    /**
+     * @return bool
+     */
+    public function isHidden(): bool
+    {
+        return $this->isHidden;
+    }
+
+    /**
+     * @param bool $isHidden Is this property readable in responses
+     * @return $this
+     */
+    public function setIsHidden(bool $isHidden)
+    {
+        $this->isHidden = $isHidden;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isAccessible(): bool
+    {
+        return $this->isAccessible;
+    }
+
+    /**
+     * @param bool $isAccessible Is this property writable in requests
+     * @return $this
+     */
+    public function setIsAccessible(bool $isAccessible)
+    {
+        $this->isAccessible = $isAccessible;
+
+        return $this;
+    }
+
     /**
      * @return \Cake\Validation\ValidationSet|null
      */

plugins/core/src/Model/ModelPropertyFactory.php

@@ -4,6 +4,7 @@
 namespace MixerApi\Core\Model;
 
 use Cake\Database\Schema\TableSchema;
+use Cake\Datasource\EntityInterface;
 use Cake\ORM\Table;
 use Cake\Validation\Validator;
 
@@ -18,9 +19,14 @@ class ModelPropertyFactory
      * @param \Cake\Database\Schema\TableSchema $schema cake TableSchema instance
      * @param \Cake\ORM\Table $table cake Table instance
      * @param string $columnName the tables column name
+     * @param \Cake\Datasource\EntityInterface $entity EntityInterface
      */
-    public function __construct(private TableSchema $schema, private Table $table, private string $columnName)
-    {
+    public function __construct(
+        private TableSchema $schema,
+        private Table $table,
+        private string $columnName,
+        private EntityInterface $entity
+    ) {
     }
 
     /**
@@ -36,6 +42,8 @@ public function create()
             ->setType($this->schema->getColumnType($this->columnName))
             ->setDefault((string)$default)
             ->setIsPrimaryKey($this->isPrimaryKey($vars, $this->columnName))
+            ->setIsHidden(in_array($this->columnName, $this->entity->getHidden()))
+            ->setIsAccessible($this->isAccessible())
             ->setValidationSet($this->table->validationDefault(new Validator())->field($this->columnName));
     }
 
@@ -55,4 +63,24 @@ private function isPrimaryKey(array $schemaDebugInfo, string $columnName): bool
 
         return in_array($columnName, $schemaDebugInfo['constraints']['primary']['columns']);
     }
+
+    /**
+     * Returns accessibility of the property.
+     *
+     * @link https://book.cakephp.org/4/en/orm/entities.html#mass-assignment
+     * @return bool
+     */
+    private function isAccessible(): bool
+    {
+        $accessible = $this->entity->getAccessible();
+        if (isset($accessible[$this->columnName]) && is_bool($accessible[$this->columnName])) {
+            return $accessible[$this->columnName];
+        }
+
+        if (isset($accessible['*']) && is_bool($accessible['*'])) {
+            return $accessible['*'];
+        }
+
+        return false;
+    }
 }

plugins/core/tests/TestCase/Model/ModelTest.php

@@ -45,6 +45,8 @@ public function test_model_property(): void
 
         $this->assertTrue($model->getProperty('id')->isPrimaryKey());
         $this->assertEmpty($model->getProperty('first_name')->getDefault());
+        $this->assertFalse($model->getProperty('first_name')->isHidden());
+        $this->assertTrue($model->getProperty('first_name')->isAccessible());
         $this->assertEquals('string', $model->getProperty('first_name')->getType());
         $this->assertEquals('first_name', $model->getProperty('first_name')->getName());
         $this->assertInstanceOf(ValidationSet::class, $model->getProperty('first_name')->getValidationSet());

plugins/core/tests/test_app/src/Model/Entity/Actor.php

@@ -20,8 +20,7 @@ class Actor extends Entity
     protected $_accessible = [
         'first_name' => true,
         'last_name' => true,
-        'modified' => true,
-        'film_actors' => true,
+        '*' => false
     ];
 
     /**

plugins/jwt-auth/README.md

@@ -54,11 +54,11 @@ The `secret` string is required when using HMAC. The secret should not be commit
 characters long. You can generate a strong secret using a tool like openssl or gpg:
 
 ```console
-openssl rand -base64 32
+openssl rand -base64 32 | cut -c1-32
 ```
 
 ```console
-gpg --gen-random 1 32 | base64
+gpg --gen-random 1 32 | base64 | cut -c1-32
 ```
 
 #### keys

plugins/mixerapi/composer.json

@@ -32,7 +32,8 @@
     ],
     "suggest": {
         "cnizzardini/cakephp-preloader": "An OpCache preloader for php >= 7.4 cakephp projects",
-        "friendsofcake/search": "Search provides a simple interface to create paginate-able filters for your project"
+        "friendsofcake/search": "Search provides a simple interface to create paginate-able filters for your project",
+        "mixerapi/jwt-auth": "For JWT Authentication"
     },
     "prefer-stable": true,
     "minimum_stability": "dev"