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 <[email protected]>
Co-authored-by: Chris Nizzardini <[email protected]>

Author: 3 people

.github/workflows/master.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: ['8.0']
+        php-versions: ['8.1']
 
     name: Upload coverage report
     steps:
@@ -38,5 +38,5 @@ jobs:
           COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           composer global require php-coveralls/php-coveralls
-          export CODECOVERAGE=1 && vendor/bin/phpunit --verbose --coverage-clover=clover.xml
+          export CODECOVERAGE=1 && vendor/bin/phpunit --coverage-clover=clover.xml
           php-coveralls --coverage_clover=clover.xml -v

.github/workflows/pull-request.yml

@@ -5,12 +5,11 @@ on:
 
 jobs:
   build:
+    name: PHP ${{ matrix.php-versions }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: ['8.0', '8.1', '8.2']
-
-    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+        php-versions: ['8.3']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -21,7 +20,6 @@ jobs:
           php-version: ${{ matrix.php-versions }}
           extensions: mbstring, intl, sqlite3, xml, simplexml, mysqli
           tools: composer:v2
-          coverage: xdebug
 
       - name: Matrix PHP Version
         run: |
@@ -34,54 +32,86 @@ jobs:
       - name: Install
         run: |
           composer install --prefer-dist --no-interaction --no-progress
+          composer update
           cp config/.env.example config/.env
           cp config/app_local.example.php config/app_local.php
 
-      - name: Test Suite + Static Analysis (PHP 8.0)
-        if: ${{ matrix.php-versions == '8.0' }}
+      - name: Test Suite + Static Analysis
+        if: ${{ matrix.php-versions}}
         run: |
           composer analyze
 
-      - name: Upload coverage results to Coveralls (PHP 8.0)
-        if: ${{ matrix.php-versions == '8.0' }}
+  coverage:
+    name: PHP ${{ matrix.php-versions }} w/ Coverage Report
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: ['8.1']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring, intl, sqlite3, xml, simplexml, mysqli
+          tools: composer:v2
+          coverage: xdebug
+
+      - name: Composer Check
+        run: composer validate
+
+      - name: Install
+        run: |
+          composer install --prefer-dist --no-interaction --no-progress
+          composer update
+          cp config/.env.example config/.env
+          cp config/app_local.example.php config/app_local.php
+
+      - name: Coverage Report
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           composer global require php-coveralls/php-coveralls
-          export CODECOVERAGE=1 && vendor/bin/phpunit --verbose --coverage-clover=clover.xml
+          export CODECOVERAGE=1 && vendor/bin/phpunit --coverage-clover=clover.xml
           php-coveralls --coverage_clover=clover.xml -v
 
-      - name: Test Suite (PHP 8.1)
-        if: ${{ matrix.php-versions == '8.1' }}
-        run: |
-          composer test
-
   #
-  # CakePHP version compatability
+  # Test plugins individually
   #
-  compatibility:
+  plugins:
+    name: ${{ matrix.plugin }}
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        version: ['~4.2.0', '~4.3.0', '^4.4']
+        plugin: [
+          'bake',
+          'collection-view',
+          'crud',
+          'exception-render',
+          'hal-view',
+          'json-ld-view',
+          'jwt-auth'
+        ]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           extensions: mbstring, intl, sqlite3, xml, simplexml, mysqli
 
       - name: PHP Version
         run: php -v
 
-      - name: CakePHP ${{matrix.version}} Compatability
+      - name: ${{matrix.plugin}} tests
         run: |
           cp config/.env.example config/.env
-          composer self-update
+          cp plugins/${{matrix.plugin}}/composer.json .
           rm -rf composer.lock
-          composer require cakephp/cakephp:${{matrix.version}} --no-update
-          composer install --prefer-dist --no-progress
-          composer test
+          composer install
+          vendor/bin/phpunit plugins/${{matrix.plugin}}

.gitignore

@@ -25,27 +25,21 @@ Thumbs.db
 
 # Tool specific files #
 #######################
-# PHPUnit
 .phpunit.result.cache
-# vim
 *~
 *.swp
 *.swo
-# sublime text & textmate
 *.sublime-*
 *.stTheme.cache
 *.tmlanguage.cache
 *.tmPreferences.cache
-# Eclipse
 .settings/*
-# JetBrains, aka PHPStorm, IntelliJ IDEA
 .idea/*
-# NetBeans
 nbproject/*
-# Visual Studio Code
 .vscode
-# Sass preprocessor
 .sass-cache/
+.phpunit.cache/
+/composer.lock
 
 # MIXERAPI               #
 ##########################

composer.json

@@ -5,38 +5,35 @@
     "type": "project",
     "license": "MIT",
     "require": {
-        "php": "^8.0",
-        "ext-json": "*",
+        "php": "^8.1",
         "ext-openssl": "*",
         "ext-simplexml": "*",
         "ext-xml": "*",
         "adbario/php-dot-notation": "^2.3",
-        "cakephp/cakephp": "^4.2",
-        "cakephp/migrations": "^3.0",
+        "cakephp/cakephp": "^5.0",
+        "cakephp/migrations": "^4.0",
         "cakephp/plugin-installer": "^1.3",
-        "cnizzardini/cakephp-swagger-bake": "^2.1",
-        "friendsofcake/search": "^6.0",
+        "cnizzardini/cakephp-swagger-bake": "^3.0",
+        "kcs/class-finder": "^0.3",
+        "mixerapi/core": "^2.0",
         "mobiledetect/mobiledetectlib": "^2.8"
     },
     "require-dev": {
         "ext-mysqli": "*",
         "ext-sqlite3": "*",
-        "cakephp/authentication": "2.9.*",
-        "cakephp/bake": "^2.0.3",
+        "cakephp/authentication": "^3.0",
+        "cakephp/bake": "^3.0",
         "cakephp/cakephp-codesniffer": "^4.2",
-        "cakephp/debug_kit": "^4.1",
-        "dereuromark/cakephp-ide-helper": "^1.10",
-        "firebase/php-jwt": "^5.5",
+        "cakephp/debug_kit": "5.x-dev",
+        "dereuromark/cakephp-ide-helper": "^2.0",
+        "firebase/php-jwt": "^6.2",
+        "friendsofcake/search": "^7.0",
         "josegonzalez/dotenv": "^3.2",
-        "phpmd/phpmd": "^2.10",
-        "phpro/grumphp": "^1.3",
-        "phpstan/phpstan": "^0.12.64",
-        "phpunit/phpunit": "^9.0",
+        "phpmd/phpmd": "~2.10.0",
+        "phpstan/phpstan": "^1.8.5",
+        "phpunit/phpunit": "^10.0",
         "psy/psysh": "@stable"
     },
-    "replace": {
-        "mixerapi/core": "^1.0"
-    },
     "suggest": {
         "markstory/asset_compress": "An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.",
         "dereuromark/cakephp-ide-helper": "After baking your code, this keeps your annotations in sync with the code evolving from there on for maximum IDE and PHPStan/Psalm compatibility.",
@@ -48,13 +45,11 @@
             "MixerApi\\": "plugins/mixerapi/src/",
             "MixerApi\\Bake\\": "plugins/bake/src/",
             "MixerApi\\CollectionView\\": "plugins/collection-view/src/",
-            "MixerApi\\Core\\": "plugins/core/src/",
             "MixerApi\\Crud\\": "plugins/crud/src/",
             "MixerApi\\ExceptionRender\\": "plugins/exception-render/src/",
             "MixerApi\\HalView\\": "plugins/hal-view/src/",
             "MixerApi\\JsonLdView\\": "plugins/json-ld-view/src/",
-            "MixerApi\\JwtAuth\\": "plugins/jwt-auth/src/",
-            "MixerApi\\Rest\\": "plugins/rest/src/"
+            "MixerApi\\JwtAuth\\": "plugins/jwt-auth/src/"
         }
     },
     "autoload-dev": {
@@ -65,23 +60,18 @@
             "MixerApi\\Bake\\Test\\App\\": "plugins/bake/tests/test_app/src/",
             "MixerApi\\CollectionView\\Test\\": "plugins/collection-view/tests/",
             "MixerApi\\CollectionView\\Test\\App\\": "plugins/collection-view/tests/test_app/src/",
-            "MixerApi\\Core\\Test\\": "plugins/core/tests/",
-            "MixerApi\\Core\\Test\\App\\": "plugins/core/tests/test_app/src/",
             "MixerApi\\Crud\\Test\\": "plugins/crud/tests/",
             "MixerApi\\Crud\\Test\\App\\": "plugins/crud/tests/test_app/src/",
             "MixerApi\\ExceptionRender\\Test\\": "plugins/exception-render/tests/",
             "MixerApi\\ExceptionRender\\Test\\App\\": "plugins/exception-render/tests/test_app/src/",
             "MixerApi\\HalView\\Test\\": "plugins/hal-view/tests/",
             "MixerApi\\HalView\\Test\\App\\": "plugins/hal-view/tests/test_app/src/",
-            "MixerApi\\JwtAuth\\Test\\": "plugins/jwt-auth/tests/",
-            "MixerApi\\JwtAuth\\Test\\App\\": "plugins/jwt-auth/tests/test_app/src/",
             "MixerApi\\JsonLdView\\Test\\": "plugins/json-ld-view/tests/",
             "MixerApi\\JsonLdView\\Test\\App\\": "plugins/json-ld-view/tests/test_app/src/",
+            "MixerApi\\JwtAuth\\Test\\": "plugins/jwt-auth/tests/",
+            "MixerApi\\JwtAuth\\Test\\App\\": "plugins/jwt-auth/tests/test_app/src/",
             "MixerApi\\Test\\": "plugins/mixerapi/tests/",
-            "MixerApi\\Test\\App\\": "plugins/mixerapi/tests/test_app/src/",
-            "MixerApi\\Rest\\Test\\": "plugins/rest/tests/",
-            "MixerApi\\Rest\\Test\\App\\": "plugins/rest/tests/test_app/src/",
-            "MixerApi\\Rest\\Test\\MyPlugin\\": "plugins/rest/tests/plugins/MyPlugin/"
+            "MixerApi\\Test\\App\\": "plugins/mixerapi/tests/test_app/src/"
         }
     },
     "scripts": {
@@ -123,17 +113,7 @@
         "sort-packages": true,
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true,
-            "cakephp/plugin-installer": true,
-            "phpro/grumphp": true
-        }
-    },
-    "repositories": [
-        {
-            "type": "path",
-            "url": "./plugins/core",
-            "options": {
-                "symlink": true
-            }
+            "cakephp/plugin-installer": true
         }
-    ]
+    }
 }