MixerAPI v2.0.0 - CakePHP 5 support (#141)

* cleaing up deprecations, wip

* cakephp5 compatibility

* Ci updates with plugin tests (#137)

- Now runs each plugin individually to catch any issues in the plugins composer.json
- Moves coverage report into its own jobs

* Require php81 cakephp44 (#138)

* Require PHP 8.1 and CakePHP 4.4

* Require php 8.1 and cakephp 4.4 (#139)

* Upgrade to CakePHP 5

* Update github actions

* Get mixerapi/jwt-auth passing

* composer changes for jwt-auth

* Various fixes to JsonLdView and Core plugins for cake 5

* cake 5

* tests

* update depedencies

* fix bake test

* fix collection-view

* fix crud

* remove grump

* update plugin composers to cake 5 stable packages

* ignore phpunit cache

* remove debug code

* fix bad merge on collection-view

* remove phpunit cache

* update plugin composers to cake 5 stable packages

* downgrade phpmd to php 8.1 compatibility

* fix failing jsonld test

* fix failing jsonld test

* appease the static analyzers

* bounds test for php versions

* remove grump package for plugin composer deps

* debugging pipeline

* fix coverage reporting

* only run php 8.1 action once but do so with coverage reporting

* split out mixerapi/core to avoid circular dependency problem

* remove lock

* split out mixerapi/core to avoid circular dependency problem

* split out mixerapi/core to avoid circular dependency problem

* min stability dev to pull in mixerapi/core

* fix depedencies

* fix composer

* replace dev core package with stable one

* update to latest swagger bake with cakephp 5 support

* Handle non-named arg deprecations in Crud plugin

* phpcs

* mark test incomplete due to issue in MixerApi/Core NamespaceUtility

---------

Co-authored-by: Masa Koni <masa.koni@riesenia.com>
Co-authored-by: Chris Nizzardini <chris.nizzardini@thecmigroupa.ca>

Author: 3 people

assets/jsonld_config.php

@@ -18,6 +18,9 @@
  *
  * @var string $entrypointUrl: Describes API default entry point
  * default: `/`
+ *
+ * @var string $connectionName: The name of your cakephp database connection (typically in config/app.php)
+ * default: `default`
  */
 return [
     'JsonLdView' => [
@@ -26,6 +29,7 @@
         'vocabUrl' => '/vocab',
         'title' => 'API Documentation',
         'description' => '',
-        'entrypointUrl' => '/'
+        'entrypointUrl' => '/',
+        'connectionName' => 'default'
     ]
-];
+];

composer.json

@@ -5,16 +5,28 @@
     "license": "MIT",
     "keywords": ["cakephp", "json-ld", "jsonld", "cakephp json-ld", "cakephp jsonld"],
     "require": {
-        "php": "^8.0",
-        "cakephp/cakephp": "^4.2",
-        "mixerapi/core": "^1.0"
+        "php": "^8.1",
+        "cakephp/cakephp": "^5.0",
+        "mixerapi/core": "^2.0"
+    },
+    "require-dev": {
+        "josegonzalez/dotenv": "^3.2",
+        "phpunit/phpunit": "^10.0"
     },
     "autoload": {
         "psr-4": {
             "MixerApi\\JsonLdView\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "MixerApi\\JsonLdView\\": "plugins/json-ld-view/src/",
+            "MixerApi\\JsonLdView\\Test\\": "plugins/json-ld-view/tests/",
+            "MixerApi\\JsonLdView\\Test\\App\\": "plugins/json-ld-view/tests/test_app/src/"
+        }
+    },
     "support": {
+        "issues": "https://github.com/mixerapi/mixerapi-dev/issues",
         "source": "https://github.com/mixerapi/json-ld-view"
     },
     "authors": [
@@ -23,6 +35,10 @@
             "role": "Organization"
         }
     ],
-    "prefer-stable": true,
-    "minimum-stability": "dev"
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "cakephp/plugin-installer": true
+        }
+    }
 }

src/Controller/Component/JsonLdContextComponent.php

@@ -4,70 +4,42 @@
 namespace MixerApi\JsonLdView\Controller\Component;
 
 use Cake\Controller\Component;
-use Cake\Controller\ComponentRegistry;
 use Cake\Core\Configure;
-use Cake\Database\Connection;
-use Cake\Datasource\ConnectionManager;
-use Cake\Utility\Inflector;
+use Cake\ORM\Locator\LocatorAwareTrait;
 use MixerApi\Core\Model\ModelFactory;
-use MixerApi\Core\Utility\NamespaceUtility;
 use MixerApi\JsonLdView\JsonLdEntityContext;
-use RuntimeException;
 
 /**
  * Builds JSON-LD context for the given entity.
  *
  * @link https://json-ld.org/learn.html
- * @uses \Cake\Datasource\ConnectionManager
- * @uses \MixerApi\Core\Model\ModelFactory
- * @uses \MixerApi\Core\Utility\NamespaceUtility
- * @uses \MixerApi\JsonLdView\JsonLdEntityContext
  */
 class JsonLdContextComponent extends Component
 {
-    private array $data = [];
+    use LocatorAwareTrait;
 
     /**
-     * @param \Cake\Controller\ComponentRegistry $registry ComponentRegistry
-     * @param array $config configurations
+     * Returns the entity in JSON-LD form as an array
+     *
+     * @param string $tableAlias The Table alias
+     * @return array
      */
-    public function __construct(ComponentRegistry $registry, array $config = [])
+    public function build(string $tableAlias): array
     {
-        parent::__construct($registry, $config);
-
         $config = Configure::read('JsonLdView');
         if (!empty($config['vocabUrl'])) {
-            $this->data['@vocab'] = $config['vocabUrl'];
+            $data['@vocab'] = $config['vocabUrl'];
         }
         if ($config['isHydra']) {
-            $this->data['hydra'] = 'http://www.w3.org/ns/hydra/core#';
-        }
-    }
-
-    /**
-     * Returns the entity in JSON-LD form as an array
-     *
-     * @param string $entityName entity name (singular)
-     * @return array
-     */
-    public function build(string $entityName): array
-    {
-        $table = NamespaceUtility::findClass(
-            Configure::read('App.namespace') . '\Model\Table\\',
-            Inflector::camelize(Inflector::pluralize($entityName)) . 'Table'
-        );
-
-        $connection = ConnectionManager::get('default');
-
-        if (!$connection instanceof Connection) {
-            throw new RuntimeException('Unable to get Database Connection instance');
+            $data['hydra'] = 'http://www.w3.org/ns/hydra/core#';
         }
 
-        $model = (new ModelFactory($connection, new $table()))->create();
+        $table = $this->getTableLocator()->get($tableAlias);
+        $model = (new ModelFactory($table->getConnection(), $table))->create();
 
         return [
             '@context' => array_merge(
-                $this->data,
+                $data ?? [],
                 (new JsonLdEntityContext($model))->build()
             ),
         ];

src/Controller/Component/JsonLdVocabComponent.php

@@ -7,8 +7,9 @@
 use Cake\Controller\Component;
 use Cake\Controller\ComponentRegistry;
 use Cake\Core\Configure;
-use Cake\Database\Connection;
 use Cake\Datasource\ConnectionManager;
+use Cake\ORM\Locator\LocatorAwareTrait;
+use Cake\ORM\Table;
 use MixerApi\Core\Model\Model;
 use MixerApi\Core\Model\ModelFactory;
 use MixerApi\Core\Model\ModelProperty;
@@ -17,20 +18,16 @@
 use MixerApi\JsonLdView\JsonLdEntityContext;
 use MixerApi\JsonLdView\JsonLdSchema;
 use ReflectionClass;
-use RuntimeException;
 
 /**
  * Builds JSON-LD vocab for entities in your API.
  *
  * @link https://json-ld.org/learn.html
- * @uses \Cake\Collection\Collection
- * @uses \MixerApi\Core\Model\ModelFactory
- * @uses \MixerApi\Core\Utility\NamespaceUtility
- * @uses \MixerApi\JsonLdView\JsonLdEntityContext
- * @uses ReflectionClass
  */
 class JsonLdVocabComponent extends Component
 {
+    use LocatorAwareTrait;
+
     private ?array $data;
 
     private string $hydraPrefix = '';
@@ -77,16 +74,25 @@ public function __construct(ComponentRegistry $registry, array $config = [])
      */
     public function build(): array
     {
-        $connection = ConnectionManager::get('default');
-
-        if (!$connection instanceof Connection) {
-            throw new RuntimeException('Unable to get Database Connection instance');
-        }
-
-        $tables = NamespaceUtility::findClasses(Configure::read('App.namespace') . '\Model\Table');
+        /** @var \Cake\Database\Connection $connection */
+        $connection = ConnectionManager::get(Configure::read('JsonLdView.connectionName', 'default'));
+        $fqn = Configure::read('App.namespace') . '\Model\Table';
+        $tables = NamespaceUtility::findClasses($fqn);
 
         foreach ($tables as $table) {
-            $model = (new ModelFactory($connection, new $table()))->create();
+            if (!class_exists($table)) {
+                continue;
+            }
+            $reflection = new \ReflectionClass($table);
+            if (!$reflection->isInstantiable() || !$reflection->isSubclassOf(Table::class)) {
+                continue;
+            }
+            $class = $reflection->getShortName();
+            if (str_ends_with($class, 'Table')) {
+                $class = substr($class, 0, strlen($class) - 5);
+            }
+            $tableInstance = $this->getTableLocator()->get($class);
+            $model = (new ModelFactory($connection, $tableInstance))->create();
             if ($model === null) {
                 continue;
             }
@@ -177,7 +183,7 @@ function (JsonLdSchema $schema) use ($property) {
      * @param \MixerApi\Core\Model\ModelProperty $property ModelProperty
      * @return bool
      */
-    private function isPropertyRequired(ModelProperty $property)
+    private function isPropertyRequired(ModelProperty $property): bool
     {
         $validationSet = $property->getValidationSet();
         if (is_bool($validationSet->isPresenceRequired())) {
@@ -194,7 +200,7 @@ private function isPropertyRequired(ModelProperty $property)
      * @param \MixerApi\Core\Model\ModelProperty $property ModelProperty
      * @return bool
      */
-    private function isPropertyWriteable(ModelProperty $property)
+    private function isPropertyWriteable(ModelProperty $property): bool
     {
         if ($property->isPrimaryKey()) {
             return false;

src/Controller/JsonLdController.php

@@ -3,18 +3,14 @@
 
 namespace MixerApi\JsonLdView\Controller;
 
+use MixerApi\JsonLdView\View\JsonLdView;
+
+/**
+ * @property \MixerApi\JsonLdView\Controller\Component\JsonLdContextComponent $JsonLdContext
+ * @property \MixerApi\JsonLdView\Controller\Component\JsonLdVocabComponent $JsonLdVocab
+ */
 class JsonLdController extends AppController
 {
-    /**
-     * @var \MixerApi\JsonLdView\Controller\Component\JsonLdContextComponent
-     */
-    protected $JsonLdContext;
-
-    /**
-     * @var \MixerApi\JsonLdView\Controller\Component\JsonLdVocabComponent
-     */
-    protected $JsonLdVocab;
-
     /**
      * @return void
      * @throws \Exception
@@ -26,19 +22,26 @@ public function initialize(): void
         $this->loadComponent('MixerApi/JsonLdView.JsonLdVocab');
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function viewClasses(): array
+    {
+        return [JsonLdView::class];
+    }
+
     /**
      * Displays JSON-LD context for the given entity.
      *
      * @link https://json-ld.org/learn.html
      * @param string|null $entity Entity name
      * @return \Cake\Http\Response
      */
-    public function contexts($entity = null)
+    public function contexts(?string $entity = null): \Cake\Http\Response
     {
         $context = $this->JsonLdContext->build($entity);
 
-        return $this
-                ->response
+        return $this->getResponse()
                 ->withType('application/ld+json')
                 ->withStringBody(json_encode($context, JSON_PRETTY_PRINT));
     }
@@ -50,13 +53,12 @@ public function contexts($entity = null)
      * @return \Cake\Http\Response
      * @throws \ReflectionException
      */
-    public function vocab()
+    public function vocab(): \Cake\Http\Response
     {
-        $context = $this->JsonLdVocab->build();
+        $vocab = $this->JsonLdVocab->build();
 
-        return $this
-            ->response
+        return $this->getResponse()
             ->withType('application/ld+json')
-            ->withStringBody(json_encode($context, JSON_PRETTY_PRINT));
+            ->withStringBody(json_encode($vocab, JSON_PRETTY_PRINT));
     }
 }

src/JsonLdDataInterface.php

@@ -19,8 +19,8 @@ interface JsonLdDataInterface
     public function getJsonLdIdentifier(EntityInterface $entity): string;
 
     /**
-     * Returns a context for the entity such as /contexts/Actor which would return as
-     * `"@context": "/contexts/Actor"`
+     * Returns a context for the entity such as /contexts/Actors which would return as
+     * `"@context": "/contexts/Actors"`. The context should be in plural form i.e. Actors instead of Actor.
      *
      * @return string
      */

src/Plugin.php

@@ -6,7 +6,6 @@
 use Cake\Core\BasePlugin;
 use Cake\Core\Configure;
 use Cake\Core\PluginApplicationInterface;
-use MixerApi\Core\Response\ResponseModifier;
 
 class Plugin extends BasePlugin
 {
@@ -15,45 +14,35 @@ class Plugin extends BasePlugin
      *
      * @var string
      */
-    protected $name = 'MixerApi/JsonLdView';
+    protected ?string $name = 'MixerApi/JsonLdView';
 
     /**
      * Console middleware
      *
      * @var bool
      */
-    protected $consoleEnabled = false;
+    protected bool $consoleEnabled = false;
 
     /**
      * Enable middleware
      *
      * @var bool
      */
-    protected $middlewareEnabled = false;
+    protected bool $middlewareEnabled = false;
 
     /**
      * Register container services
      *
      * @var bool
      */
-    protected $servicesEnabled = false;
+    protected bool $servicesEnabled = false;
 
     /**
      * Load routes or not
      *
      * @var bool
      */
-    protected $routesEnabled = false;
-
-    /**
-     * @var string
-     */
-    private const EXT = 'jsonld';
-
-    /**
-     * @var string
-     */
-    private const VIEW_CLASS = 'MixerApi/JsonLdView.JsonLd';
+    protected bool $routesEnabled = false;
 
     /**
      * @param \Cake\Core\PluginApplicationInterface $app PluginApplicationInterface
@@ -78,7 +67,5 @@ public function bootstrap(PluginApplicationInterface $app): void
                 'entrypointUrl' => '/',
             ]);
         }
-
-        (new ResponseModifier(self::EXT, self::VIEW_CLASS))->listen();
     }
 }