Merge pull request #6 from UseMuffin/cake-5

Cake 5

.editorconfig

@@ -15,4 +15,7 @@ end_of_line = crlf
 
 [*.yml]
 indent_style = space
-indent_size = 2
+indent_size = 2
+
+[*.neon]
+indent_style = tab

.gitattributes

@@ -2,9 +2,9 @@
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.semver export-ignore
+.github export-ignore
 phpunit.xml.dist export-ignore
-.travis.yml export-ignore
 tests export-ignore
 psalm.xml export-ignore
 psalm-baseline.xml export-ignore
+phpstan.neon export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '*'
+
+permissions:
+  contents: read
+
+jobs:
+  testsuite:
+    uses: ADmad/.github/.github/workflows/testsuite-with-db.yml@master
+    secrets: inherit
+
+  cs-stan:
+    uses: ADmad/.github/.github/workflows/cs-stan.yml@master
+    secrets: inherit

.gitignore

@@ -1,4 +1,5 @@
 /composer.lock
 /plugins
 /vendor
+.phpunit.cache
 .phpunit.result.cache

README.md

@@ -1,7 +1,9 @@
 # Orderly
 
-[![Build Status](https://img.shields.io/travis/UseMuffin/Orderly/master.svg?style=flat-square)](https://travis-ci.org/UseMuffin/Orderly)
-[![Coverage](https://img.shields.io/coveralls/github/UseMuffin/Orderly?style=flat-square)](https://coveralls.io/github/UseMuffin/Orderly)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/UseMuffin/Orderly/ci.yml?style=flat-square
+&branch=master)](https://github.com/UseMuffin/Orderly/actions/workflows/ci.yml?query=branch%3Amaster)
+[![Coverage](https://img.shields.io/codecov/c/github/UseMuffin/Orderly/master?style=flat-square
+)](https://app.codecov.io/gh/UseMuffin/Orderly)
 [![Total Downloads](https://img.shields.io/packagist/dt/muffin/orderly.svg?style=flat-square)](https://packagist.org/packages/muffin/orderly)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
 
@@ -23,8 +25,7 @@ bin/cake plugin load Muffin/Orderly
 
 ## What is does
 
-Orderly allow you to set default `ORDER` clause for your table queries, similar
-to the functionality provided by `Model::$order` property of CakePHP 2.x.
+Orderly allow you to set default `ORDER` clause for your table's `SELECT` queries.
 
 ## Usage
 
@@ -38,7 +39,7 @@ $this->addBehavior('Muffin/Orderly.Orderly');
 $this->addBehavior('Muffin/Orderly.Orderly', ['order' => $this->aliasField('field_name')]);
 ```
 
-Value for `order` key can any valid value that `\Cake\ORM\Query::order()` takes.
+Value for `order` key can any valid value that `\Cake\ORM\Query::orderBy()` takes.
 The default order clause will only be applied to the primary query and when no
 custom order clause has already been set for the query.
 
@@ -97,4 +98,4 @@ Copyright (c) 2015-Present, [Use Muffin][muffin] and licensed under [The MIT Lic
 [composer]:http://getcomposer.org
 [mit]:http://www.opensource.org/licenses/mit-license.php
 [muffin]:http://usemuffin.com
-[standards]:http://book.cakephp.org/3/en/contributing/cakephp-coding-conventions.html
+[standards]:http://book.cakephp.org/5/en/contributing/cakephp-coding-conventions.html

composer.json

@@ -30,11 +30,11 @@
         "source": "https://github.com/usemuffin/orderly"
     },
     "require": {
-        "cakephp/orm": "^4.0"
+        "cakephp/orm": "^5.0"
     },
     "require-dev": {
-        "cakephp/cakephp": "^4.0",
-        "phpunit/phpunit": "~8.5.0"
+        "cakephp/cakephp": "^5.0",
+        "phpunit/phpunit": "^10.1"
     },
     "autoload": {
         "psr-4": {
@@ -46,5 +46,11 @@
             "Muffin\\Orderly\\Test\\": "tests",
             "Cake\\Test\\Fixture\\": "vendor/cakephp/cakephp/tests/Fixture"
         }
+    },
+    "config": {
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+	level: 7
+	checkMissingIterableValueType: false
+	checkGenericClassInNonGenericObjectType: false
+	treatPhpDocTypesAsCertain: false
+	bootstrapFiles:
+		- tests/bootstrap.php
+	paths:
+		- src

phpunit.xml.dist

@@ -1,30 +1,19 @@
 <?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="Orderly 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>
+        <env name="FIXTURE_SCHEMA_METADATA" value="./tests/schema.php"/>
+    </php>
+    <source>
+        <include>
             <directory suffix=".php">./src/</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </source>
 </phpunit>

psalm.xml

@@ -4,7 +4,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"
-    errorBaseline="psalm-baseline.xml"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src" />

src/Model/Behavior/OrderlyBehavior.php

@@ -6,14 +6,14 @@
 use ArrayObject;
 use Cake\Event\EventInterface;
 use Cake\ORM\Behavior;
-use Cake\ORM\Query;
+use Cake\ORM\Query\SelectQuery;
 
 class OrderlyBehavior extends Behavior
 {
     /**
      * Initialize behavior
      *
-     * @param array $config Config
+     * @param array<string, mixed> $config Config
      * @return void
      */
     public function initialize(array $config): void
@@ -24,15 +24,15 @@ public function initialize(array $config): void
     }
 
     /**
-     * Add default order clause to query as necessary.
+     * Add the default order clause to the query as necessary.
      *
      * @param \Cake\Event\EventInterface $event Event
-     * @param \Cake\ORM\Query $query Query
+     * @param \Cake\ORM\Query\SelectQuery $query Query
      * @param \ArrayObject $options Options
      * @param bool $primary Boolean indicating whether it's primary query.
      * @return void
      */
-    public function beforeFind(EventInterface $event, Query $query, ArrayObject $options, bool $primary)
+    public function beforeFind(EventInterface $event, SelectQuery $query, ArrayObject $options, bool $primary): void
     {
         if ($query->clause('order')) {
             return;
@@ -44,15 +44,15 @@ public function beforeFind(EventInterface $event, Query $query, ArrayObject $opt
                 empty($config['callback'])
                 || call_user_func($config['callback'], $query, $options, $primary)
             ) {
-                $query->order($config['order']);
+                $query->orderBy($config['order']);
             }
         }
     }
 
     /**
      * Normalize configuration.
      *
-     * @param array $orders Orders config
+     * @param array<string, mixed> $orders Orders config
      * @return void
      */
     protected function _normalizeConfig(array $orders): void
@@ -64,7 +64,10 @@ protected function _normalizeConfig(array $orders): void
         }
 
         $default = [
-            'order' => $this->_table->aliasField($this->_table->getDisplayField()),
+            'order' => array_map(
+                $this->_table->aliasField(...),
+                (array)$this->_table->getDisplayField()
+            ),
             'callback' => null,
         ];
 

src/Plugin.php → src/OrderlyPlugin.php

@@ -5,33 +5,33 @@
 
 use Cake\Core\BasePlugin;
 
-class Plugin extends BasePlugin
+class OrderlyPlugin extends BasePlugin
 {
     /**
      * The name of this plugin
      *
-     * @var string
+     * @var string|null
      */
-    protected $name = 'Orderly';
+    protected ?string $name = 'Orderly';
 
     /**
      * Do bootstrapping or not
      *
      * @var bool
      */
-    protected $bootstrapEnabled = false;
+    protected bool $bootstrapEnabled = false;
 
     /**
      * Load routes or not
      *
      * @var bool
      */
-    protected $routesEnabled = false;
+    protected bool $routesEnabled = false;
 
     /**
      * Console middleware
      *
      * @var bool
      */
-    protected $consoleEnabled = false;
+    protected bool $consoleEnabled = false;
 }