Merge pull request #5 from didoda/feat/bedita-5

BEdita 5

.github/workflows/php.yml

@@ -16,12 +16,12 @@ jobs:
   cs:
     uses: bedita/github-workflows/.github/workflows/php-cs.yml@v1
     with:
-      php_versions: '["7.4"]'
+      php_versions: '["7.4", "8.1", "8.2"]'
 
   stan:
     uses: bedita/github-workflows/.github/workflows/php-stan.yml@v1
     with:
-      php_versions: '["7.4"]'
+      php_versions: '["7.4", "8.1", "8.2"]'
 
   unit:
     name: 'Run unit tests'
@@ -30,7 +30,7 @@ jobs:
 
     strategy:
       matrix:
-        php-version: [7.4]
+        php-version: [7.4, 8.1, 8.2]
 
     steps:
       - name: 'Checkout current revision'

.github/workflows/release.yml

@@ -17,5 +17,5 @@ jobs:
     uses: bedita/github-workflows/.github/workflows/release.yml@v1
     with:
       main_branch: 'main'
-      dist_branches: '["main"]'
+      dist_branches: '["main","1.x"]'
       version_bump: ${{ inputs.releaseType }}

.gitignore

@@ -4,3 +4,4 @@
 /phpunit.xml
 /vendor
 config/Migrations/schema-dump-default.lock
+.phpunit.result.cache

.scrutinizer.yml

@@ -7,12 +7,12 @@ filter:
     - 'vendor/*'
 
 build:
-  image: default-bionic
+  image: default-jammy
   nodes:
     analysis:
       environment:
         php:
-          version: 7.4
+          version: 8.2
           pecl_extensions:
             - zip
       tests:

composer.json

@@ -5,15 +5,16 @@
     "license": "LGPL-3.0-or-later",
     "require": {
         "php": ">= 7.4",
-        "cakephp/cakephp": "^3.8",
-        "bedita/core": "^4.7",
-        "bedita/api": "^4.7"
+        "cakephp/cakephp": "^4.4",
+        "bedita/core": "^5.14",
+        "bedita/api": "^5.14"
     },
     "require-dev": {
-        "cakephp/cakephp-codesniffer": "^3.0",
+        "cakephp/cakephp-codesniffer": "^4.5",
         "cakephp/plugin-installer": "^1.3",
-        "phpunit/phpunit": "^6.0",
-        "phpstan/phpstan": "^1.5"
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.7",
+        "league/flysystem-memory": "^2.0.0"
     },
     "autoload": {
         "psr-4": {
@@ -35,7 +36,8 @@
     },
     "config": {
         "allow-plugins": {
-            "cakephp/plugin-installer": true
+            "cakephp/plugin-installer": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
         }
     }
 }

phpstan.neon.dist

@@ -6,3 +6,4 @@ parameters:
     - tests
   level: 8
   checkMissingIterableValueType: false
+  checkGenericClassInNonGenericObjectType: false

phpunit.xml.dist

@@ -3,33 +3,25 @@
     colors="true"
     processIsolation="false"
     stopOnFailure="false"
-    bootstrap="tests/bootstrap.php"
-    >
+    bootstrap="./tests/bootstrap.php"
+    forceCoversAnnotation="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
     <php>
         <ini name="memory_limit" value="-1"/>
         <ini name="apc.enable_cli" value="1"/>
     </php>
-
-    <!-- Add any additional test suites you want to run here -->
     <testsuites>
         <testsuite name="BEdita/Placeholders">
-            <directory>tests/TestCase/</directory>
+            <directory>./tests/TestCase</directory>
         </testsuite>
     </testsuites>
-
-    <!-- Setup a listener for fixtures -->
-    <listeners>
-        <listener class="Cake\TestSuite\Fixture\FixtureInjector">
-            <arguments>
-                <object class="Cake\TestSuite\Fixture\FixtureManager"/>
-            </arguments>
-        </listener>
-    </listeners>
-
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-
+    <extensions>
+        <extension class="\Cake\TestSuite\Fixture\PHPUnitExtension" />
+    </extensions>
+    <coverage>
+        <include>
+            <directory suffix=".php">./src/</directory>
+        </include>
+    </coverage>
 </phpunit>

src/Controller/Component/PlaceholdersComponent.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2022 Atlas Srl, Chialab Srl
@@ -24,7 +26,7 @@ class PlaceholdersComponent extends Component
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $_defaultConfig = [
         'relations' => ['placeholder', 'placeholded'],
@@ -38,11 +40,20 @@ class PlaceholdersComponent extends Component
     public function beforeFilter(): void
     {
         $request = $this->getController()->getRequest();
-        if ($request->getParam('action') !== 'relationships' || !in_array($request->getParam('relationship'), (array)$this->getConfig('relations'))) {
+        if (
+            $request->getParam('action') !== 'relationships' ||
+            !in_array($request->getParam('relationship'), (array)$this->getConfig('relations'))
+        ) {
             return;
         }
         if (!in_array(mb_strtoupper($request->getMethod()), ['GET', 'HEAD', 'OPTIONS'])) {
-            throw new ForbiddenException(__d('placeholders', 'Relationships of type {0} can only be managed saving an object', $request->getParam('relationship')));
+            throw new ForbiddenException(
+                __d(
+                    'placeholders',
+                    'Relationships of type {0} can only be managed saving an object',
+                    $request->getParam('relationship')
+                )
+            );
         }
     }
 }

src/Event/BootstrapEventHandler.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2022 Atlas Srl, Chialab Srl
@@ -25,7 +27,7 @@
 class BootstrapEventHandler implements EventListenerInterface
 {
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      *
      * @codeCoverageIgnore
      */

src/Event/JsonSchemaEventHandler.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2022 Atlas Srl, Chialab Srl
@@ -28,7 +30,7 @@ class JsonSchemaEventHandler implements EventListenerInterface
     /**
      * @inheritDoc
      */
-    public function implementedEvents()
+    public function implementedEvents(): array
     {
         return [
             'ObjectType.getSchema' => 'onGetSchema',

src/Model/Behavior/GetAssociationTrait.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2022 Atlas Srl, Chialab Srl
@@ -26,7 +28,7 @@ trait GetAssociationTrait
      *
      * @return \Cake\ORM\Table
      */
-    abstract public function getTable();
+    abstract public function table();
 
     /**
      * Get association for a relation.
@@ -37,7 +39,7 @@ abstract public function getTable();
     protected function getAssociation(string $relation): ?Association
     {
         $name = Inflector::camelize($relation);
-        $table = $this->getTable();
+        $table = $this->table();
         if (!$table->hasAssociation($name)) {
             return null;
         }

src/Model/Behavior/PlaceholdedBehavior.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2022 Atlas Srl, Chialab Srl
@@ -17,6 +19,7 @@
 use Cake\Datasource\EntityInterface;
 use Cake\Event\Event;
 use Cake\ORM\Behavior;
+use Cake\Utility\Hash;
 
 /**
  * Placeholded behavior
@@ -30,7 +33,7 @@ class PlaceholdedBehavior extends Behavior
      *
      * - `relations`: names of the BEdita relations to check.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $_defaultConfig = [
         'relations' => ['placeholded'],
@@ -57,12 +60,11 @@ public function beforeSave(Event $event, EntityInterface $entity): void
      *
      * @param \Cake\Datasource\EntityInterface $entity Entity being checked.
      * @return void
-     *
      * @throws \BEdita\Core\Exception\LockedResourceException
      */
     protected function ensureNotPlaceholded(EntityInterface $entity): void
     {
-        $Table = $this->getTable();
+        $Table = $this->table();
 
         $relations = $this->getConfig('relations', []);
         foreach ($relations as $relation) {
@@ -83,7 +85,7 @@ protected function ensureNotPlaceholded(EntityInterface $entity): void
                 throw new LockedResourceException(__d(
                     'placeholders',
                     'Cannot delete object {0} because it is still {1} in {2,plural,=1{one object} other{# objects}}',
-                    $entity->id,
+                    (string)Hash::get($entity, 'id'),
                     $relation,
                     $refCount
                 ));

src/Model/Behavior/PlaceholdersBehavior.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2022 Atlas Srl, Chialab Srl
@@ -13,7 +15,6 @@
 
 namespace BEdita\Placeholders\Model\Behavior;
 
-use BEdita\Core\Exception\LockedResourceException;
 use BEdita\Core\Model\Action\SetRelatedObjectsAction;
 use Cake\Database\Expression\QueryExpression;
 use Cake\Datasource\EntityInterface;
@@ -48,7 +49,7 @@ class PlaceholdersBehavior extends Behavior
      *      a list of associative arrays with `id` and `params` fields.
      *      If `null`, uses {@see \BEdita\Core\Model\Behavior\PlaceholdersBehavior::extractPlaceholders()}.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $_defaultConfig = [
         'relation' => 'placeholder',
@@ -59,7 +60,7 @@ class PlaceholdersBehavior extends Behavior
     /**
      * Extract placeholders from an entity.
      *
-     * @param EntityInterface $entity The entity from which to extract placeholder references.
+     * @param \Cake\Datasource\EntityInterface $entity The entity from which to extract placeholder references.
      * @param string[] $fields Field names.
      * @return array[] A list of arrays, each with `id` and `params` set.
      */
@@ -72,7 +73,10 @@ public static function extractPlaceholders(EntityInterface $entity, array $field
                 continue;
             }
 
-            if (!is_string($datum) || preg_match_all(static::REGEX, $datum, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE) === false) {
+            if (
+                !is_string($datum) ||
+                preg_match_all(static::REGEX, $datum, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE) === false
+            ) {
                 throw new RuntimeException(__d('bedita', 'Error extracting placeholders'));
             }
 
@@ -161,6 +165,7 @@ protected function prepareEntities(Table $table, array $placeholders): array
             ->where(function (QueryExpression $exp) use ($table, $pk, $ids): QueryExpression {
                 return $exp->in($table->aliasField($pk), $ids);
             })
+            ->all()
             ->map(function (EntityInterface $entity) use ($pk, $placeholders): EntityInterface {
                 $id = $entity->get($pk);
                 foreach ($placeholders as $datum) {

src/Plugin.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2022 Atlas Srl, Chialab Srl
@@ -29,7 +31,7 @@ class Plugin extends BasePlugin
      *
      * @codeCoverageIgnore
      */
-    public function bootstrap(PluginApplicationInterface $app)
+    public function bootstrap(PluginApplicationInterface $app): void
     {
         parent::bootstrap($app);
 

tests/Fixture/ObjectRelationsFixture.php

@@ -1,8 +1,9 @@
 <?php
+declare(strict_types=1);
 
 namespace BEdita\Placeholders\Test\Fixture;
 
-use BEdita\Core\TestSuite\Fixture\TestFixture;
+use Cake\TestSuite\Fixture\TestFixture;
 
 /**
  * Fixture for `object_relations` table.

tests/Fixture/RelationTypesFixture.php

@@ -1,8 +1,9 @@
 <?php
+declare(strict_types=1);
 
 namespace BEdita\Placeholders\Test\Fixture;
 
-use BEdita\Core\TestSuite\Fixture\TestFixture;
+use Cake\TestSuite\Fixture\TestFixture;
 
 /**
  * Fixture for `relation_types` table.

tests/Fixture/RelationsFixture.php

@@ -1,8 +1,9 @@
 <?php
+declare(strict_types=1);
 
 namespace BEdita\Placeholders\Test\Fixture;
 
-use BEdita\Core\TestSuite\Fixture\TestFixture;
+use Cake\TestSuite\Fixture\TestFixture;
 
 /**
  * Fixture for `relations` table.