Merge pull request #89 from UseMuffin/cake-5

ADmad · web-flow · commit fadfed91af7f · 2023-10-10T18:59:40.000+05:30
Cake 5
diff --git a/.gitattributes b/.gitattributes
@@ -4,8 +4,8 @@
 .gitignore export-ignore
 .semver export-ignore
 phpunit.xml.dist export-ignore
-.travis.yml export-ignore
 .phpstan.neon export-ignore
 psalm.xml export-ignore
 tests export-ignore
 .github export-ignore
+phpcs.xml export-ignore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,94 +8,14 @@ on:
     branches:
       - '*'
 
+permissions:
+  contents: read
+
 jobs:
   testsuite:
-    runs-on: ubuntu-18.04
-    strategy:
-      fail-fast: false
-      matrix:
-        php-version: ['7.4', '8.0', '8.1']
-        db-type: [mysql, pgsql]
-        prefer-lowest: ['']
-        include:
-          - php-version: '7.2'
-            db-type: 'sqlite'
-            prefer-lowest: 'prefer-lowest'
-
-    services:
-      postgres:
-        image: postgres
-        ports:
-          - 5432:5432
-        env:
-          POSTGRES_PASSWORD: postgres
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Setup Service
-      if: matrix.db-type == 'mysql'
-      run: |
-        sudo service mysql start
-        mysql -h 127.0.0.1 -u root -proot -e 'CREATE DATABASE cakephp;'
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: ${{ matrix.php-version }}
-        extensions: mbstring, intl, pdo_${{ matrix.db-type }}
-        coverage: pcov
-
-    - name: Composer install
-      run: |
-        composer --version
-        if ${{ matrix.prefer-lowest == 'prefer-lowest' }}; then
-          composer update --prefer-lowest --prefer-stable
-        else
-          composer install
-        fi
-
-    - name: Run PHPUnit
-      run: |
-        if [[ ${{ matrix.db-type }} == 'sqlite' ]]; then export DB_URL='sqlite:///:memory:'; fi
-        if [[ ${{ matrix.db-type }} == 'mysql' ]]; then export DB_URL='mysql://root:root@127.0.0.1/cakephp'; fi
-        if [[ ${{ matrix.db-type }} == 'pgsql' ]]; then export DB_URL='postgres://postgres:postgres@127.0.0.1/postgres'; fi
-
-        if [[ ${{ matrix.php-version }} == '7.4' && ${{ matrix.db-type }} == 'mysql' ]]; then
-          vendor/bin/phpunit --coverage-clover=coverage.xml
-        else
-          vendor/bin/phpunit
-        fi
-
-    - name: Code Coverage Report
-      if: success() && matrix.php-version == '7.4' && matrix.db-type == 'mysql'
-      uses: codecov/codecov-action@v2
+    uses: ADmad/.github/.github/workflows/testsuite-with-db.yml@master
+    secrets: inherit
 
   cs-stan:
-    name: Coding Standard & Static Analysis
-    runs-on: ubuntu-18.04
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: '7.4'
-        extensions: mbstring, intl
-        coverage: none
-        tools: vimeo/psalm:4.21, phpstan:1.4
-
-    - name: Composer Install
-      run: composer require cakephp/cakephp-codesniffer:^4.2
-
-    - name: Run phpcs
-      run: vendor/bin/phpcs --standard=CakePHP src/ tests/
-
-    - name: Run psalm
-      if: success() || failure()
-      run: psalm --output-format=github
-
-    - name: Run phpstan
-      if: success() || failure()
-      run: phpstan analyse
+    uses: ADmad/.github/.github/workflows/cs-stan.yml@master
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 /composer.lock
 /plugins
 /vendor
+.phpunit.cache
 .phpunit.result.cache
 .idea
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Footprint
 
-[![Build Status](https://img.shields.io/travis/UseMuffin/Footprint/master.svg?style=flat-square)](https://github.com/UseMuffin/Footprint/actions?query=workflow%3ACI+branch%3Amaster)
-[![Coverage](https://img.shields.io/github/workflow/status/UseMuffin/Footprint/CI/master?style=flat-square)](https://codecov.io/github/UseMuffin/Footprint)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/UseMuffin/Footprint/ci.yml?style=flat-square)](https://github.com/UseMuffin/Footprint/actions?query=workflow%3ACI+branch%3Amaster)
+[![Coverage](https://img.shields.io/codecov/c/github/UseMuffin/Footprint/master?style=flat-square)](https://codecov.io/github/UseMuffin/Footprint)
 [![Total Downloads](https://img.shields.io/packagist/dt/muffin/footprint.svg?style=flat-square)](https://packagist.org/packages/muffin/footprint)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
 
@@ -26,19 +26,7 @@ bin/cake plugin load Muffin/Footprint
 ```
 
 The Footprint plugin must be loaded **before** the [Authentication](https://github.com/cakephp/authentication) plugin,
-so you should move the
-
-```php
-$this->addPlugin('Muffin/Footprint');
-```
-
-statement above the
-
-```php
-$this->addPlugin('Authentication');
-```
-
-in your `Application::bootstrap()` manually if required.
+so you should updated your `config/plugins.php` or `Application::bootstrap()` accordingly.
 
 ## Usage
 
diff --git a/composer.json b/composer.json
@@ -30,16 +30,15 @@
         "source": "https://github.com/usemuffin/footprint"
     },
     "require": {
-        "cakephp/cakephp": "^4.0"
+        "cakephp/cakephp": "^5.0"
     },
     "require-dev": {
-        "cakephp/cakephp-codesniffer": "^4.0",
-        "phpunit/phpunit": "~8.5.0",
-        "cakephp/authentication": "^2.3"
+        "cakephp/cakephp-codesniffer": "^5.0",
+        "phpunit/phpunit": "^10.1"
     },
     "scripts": {
-        "cs-check": "phpcs --colors -p --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
-        "cs-fix": "phpcbf --colors --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/"
+        "cs-check": "phpcs --colors --parallel=16 -p src/ tests/",
+        "cs-fix": "phpcbf --colors --parallel=16 -p src/ tests/"
     },
     "autoload": {
         "psr-4": {
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset name="CakePHP Core">
+    <config name="installed_paths" value="../../cakephp/cakephp-codesniffer" />
+
+    <rule ref="CakePHP" />
+
+    <arg value="s"/>
+</ruleset>
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,5 +1,5 @@
 parameters:
-	level: 7
+	level: 8
 	checkGenericClassInNonGenericObjectType: false
 	checkMissingIterableValueType: false
 	treatPhpDocTypesAsCertain: false
@@ -9,4 +9,4 @@ parameters:
 		-
 			message: "#^Call to an undefined method object\\:\\:getEventManager\\(\\)\\.$#"
 			count: 1
-			path: src/Plugin.php
+			path: src/FootprintPlugin.php
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,30 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-    bootstrap="./tests/bootstrap.php"
-    colors="true"
-    stopOnFailure="false"
-    >
-
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="./tests/bootstrap.php" colors="true" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd" cacheDirectory=".phpunit.cache">
     <testsuites>
         <testsuite name="Slug Test Cases">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
-
-    <!-- Setup a listener for fixtures -->
-    <listeners>
-        <listener
-        class="\Cake\TestSuite\Fixture\FixtureInjector"
-        file="./vendor/cakephp/cakephp/src/TestSuite/Fixture/FixtureInjector.php">
-            <arguments>
-                <object class="\Cake\TestSuite\Fixture\FixtureManager" />
-            </arguments>
-        </listener>
-    </listeners>
-
-    <filter>
-       <whitelist>
+    <extensions>
+        <bootstrap class="Cake\TestSuite\Fixture\Extension\PHPUnitExtension"/>
+    </extensions>
+    <php>
+        <ini name="memory_limit" value="-1"/>
+        <env name="FIXTURE_SCHEMA_METADATA" value="./tests/schema.php"/>
+    </php>
+    <source>
+        <include>
             <directory suffix=".php">./src/</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </source>
 </phpunit>
diff --git a/psalm.xml b/psalm.xml
@@ -5,6 +5,8 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedCode="false"
+    findUnusedBaselineEntry="true"
 >
     <projectFiles>
         <directory name="src" />
diff --git a/src/Event/FootprintListener.php b/src/Event/FootprintListener.php
@@ -3,10 +3,12 @@
 
 namespace Muffin\Footprint\Event;
 
+use ArrayObject;
 use Cake\Core\InstanceConfigTrait;
 use Cake\Datasource\EntityInterface;
 use Cake\Event\EventInterface;
 use Cake\Event\EventListenerInterface;
+use Cake\ORM\Query\SelectQuery;
 
 class FootprintListener implements EventListenerInterface
 {
@@ -17,7 +19,7 @@ class FootprintListener implements EventListenerInterface
      *
      * @var array<string, mixed>
      */
-    protected $_defaultConfig = [
+    protected array $_defaultConfig = [
         'events' => [
             'Model.beforeFind' => -100,
             'Model.beforeRules' => -100,
@@ -32,7 +34,7 @@ class FootprintListener implements EventListenerInterface
      *
      * @var \Cake\Datasource\EntityInterface|null
      */
-    protected $_currentUser;
+    protected ?EntityInterface $_currentUser;
 
     /**
      * Constructor.
@@ -85,12 +87,15 @@ public function getUser(): ?EntityInterface
      * Universal callback.
      *
      * @param \Cake\Event\EventInterface $event Event.
-     * @param \Cake\ORM\Query|\Cake\Datasource\EntityInterface $ormObject Query or Entity.
+     * @param \Cake\Datasource\EntityInterface|\Cake\ORM\Query\SelectQuery $ormObject Query or Entity.
      * @param \ArrayObject $options Options.
      * @return void
      */
-    public function handleEvent(EventInterface $event, $ormObject, $options): void
-    {
+    public function handleEvent(
+        EventInterface $event,
+        EntityInterface|SelectQuery $ormObject,
+        ArrayObject $options
+    ): void {
         $key = $this->getConfig('optionKey');
         if ($this->_currentUser && empty($options[$key])) {
             $options[$key] = $this->_currentUser;
diff --git a/src/FootprintPlugin.php b/src/FootprintPlugin.php
@@ -8,17 +8,19 @@
 use Cake\Event\EventInterface;
 use Muffin\Footprint\Event\FootprintListener;
 
-class Plugin extends BasePlugin
+class FootprintPlugin extends BasePlugin
 {
+    protected ?string $name = 'Footprint';
+
     /**
      * @var bool
      */
-    protected $routesEnabled = false;
+    protected bool $routesEnabled = false;
 
     /**
      * @var \Muffin\Footprint\Event\FootprintListener|null
      */
-    protected static $listener;
+    protected static ?FootprintListener $listener = null;
 
     /**
      * Bootstrap hook
@@ -30,7 +32,8 @@ public function bootstrap(PluginApplicationInterface $app): void
     {
         $app->getEventManager()->on(
             'Model.initialize',
-            function (EventInterface $event) {
+            /** @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event */
+            function (EventInterface $event): void {
                 $event->getSubject()->getEventManager()->on(static::getListener());
             }
         );
@@ -43,10 +46,6 @@ function (EventInterface $event) {
      */
     public static function getListener(): FootprintListener
     {
-        if (!static::$listener) {
-            static::$listener = new FootprintListener();
-        }
-
-        return static::$listener;
+        return static::$listener ??= new FootprintListener();
     }
 }
diff --git a/src/Middleware/FootprintMiddleware.php b/src/Middleware/FootprintMiddleware.php
@@ -4,7 +4,7 @@
 namespace Muffin\Footprint\Middleware;
 
 use Cake\Datasource\EntityInterface;
-use Muffin\Footprint\Plugin;
+use Muffin\Footprint\FootprintPlugin;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
@@ -17,7 +17,7 @@ class FootprintMiddleware implements MiddlewareInterface
      *
      * @var array<string, mixed>
      */
-    protected $config = [
+    protected array $config = [
         'identityAttribute' => 'identity',
     ];
 
@@ -44,7 +44,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
                 $footprint = $footprint->getOriginalData();
             }
 
-            Plugin::getListener()->setUser($footprint);
+            FootprintPlugin::getListener()->setUser($footprint);
         }
 
         return $handler->handle($request);
diff --git a/src/Model/Behavior/FootprintBehavior.php b/src/Model/Behavior/FootprintBehavior.php
diff --git a/tests/Fixture/ArticlesFixture.php b/tests/Fixture/ArticlesFixture.php
diff --git a/tests/TestCase/Event/FootprintListenerTest.php b/tests/TestCase/Event/FootprintListenerTest.php
diff --git a/tests/TestCase/Model/Behavior/FootprintBehaviorTest.php b/tests/TestCase/Model/Behavior/FootprintBehaviorTest.php
diff --git a/tests/schema.php b/tests/schema.php

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`	`xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`
`6`	`6`	`xmlns="https://getpsalm.org/schema/config"`
`7`	`7`	`xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"`
	`8`	`+ findUnusedCode="false"`
	`9`	`+ findUnusedBaselineEntry="true"`
`8`	`10`	`>`
`9`	`11`	`<projectFiles>`
`10`	`12`	`<directory name="src" />`