Merge pull request #4 from robotusers/0.3

Cake 5 support

Author: robertpustulka

.github/workflows/php.yml

@@ -39,4 +39,4 @@ jobs:
       run: vendor/bin/phpstan analyse
 
     - name: Run tests
-      run: vendor/bin/phpunit --coverage-clover=coverage.xml
+      run: vendor/bin/phpunit

.gitignore

@@ -3,6 +3,6 @@
 /vendor
 /composer.lock
 /nbproject
-/phpunit.xml
 /coverage.xml
 .phpunit.*
+test.sqlite

composer.json

@@ -5,12 +5,12 @@
 	"type": "cakephp-plugin",
 	"license": "MIT",
 	"require": {
-		"cakephp/orm": "~4.0"
+		"cakephp/orm": "~5.0"
 	},
 	"require-dev": {
-		"cakephp/cakephp": "~4.0",
-		"cakephp/cakephp-codesniffer": "^4.0",
-		"phpunit/phpunit": "^9.5",
+		"cakephp/cakephp": "~5.0",
+		"cakephp/cakephp-codesniffer": "^5.0",
+		"phpunit/phpunit": "^10.0",
 		"phpstan/phpstan": "^2.0"
 	},
 	"autoload": {

phpstan.neon

@@ -1,7 +1,9 @@
 parameters:
-    level: 4
-#    reportUnmatchedIgnoredErrors: false
-#    treatPhpDocTypesAsCertain: false
+    level: 8
     paths:
-        - src/ 
-        - tests/ 
+        - src/
+    ignoreErrors:
+        - 
+            identifier: missingType.generics
+        - 
+            identifier: missingType.iterableValue

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit
+    colors="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    bootstrap="./tests/bootstrap.php"
+>
+    <testsuites>
+        <testsuite name="Chunk Plugin Test Suite">
+            <directory>./tests/TestCase/</directory>
+        </testsuite>
+    </testsuites>
+    <extensions>
+        <bootstrap class="Cake\TestSuite\Fixture\Extension\PHPUnitExtension"/>
+    </extensions>
+</phpunit>

phpunit.xml.dist

@@ -27,19 +27,19 @@
 namespace Robotusers\Chunk\Model\Behavior;
 
 use Cake\ORM\Behavior;
-use Cake\ORM\Query;
+use Cake\ORM\Query\SelectQuery;
 use Robotusers\Chunk\ORM\ResultSet;
 
 class ChunkBehavior extends Behavior
 {
     /**
      * Returns chunked result set.
      *
-     * @param \Cake\ORM\Query $query Query instance.
+     * @param \Cake\ORM\Query\SelectQuery $query Query instance.
      * @param array $config Config.
      * @return \Robotusers\Chunk\ORM\ResultSet
      */
-    public function chunk(Query $query, array $config = [])
+    public function chunk(SelectQuery $query, array $config = []): ResultSet
     {
         return new ResultSet($query, $config);
     }

src/Model/Behavior/ChunkBehavior.php

@@ -29,7 +29,8 @@
 use Cake\Collection\CollectionTrait;
 use Cake\Core\InstanceConfigTrait;
 use Cake\Datasource\ResultSetInterface;
-use Cake\ORM\Query;
+use Cake\ORM\Query\SelectQuery;
+use ReturnTypeWillChange;
 use RuntimeException;
 
 class ResultSet implements ResultSetInterface
@@ -42,70 +43,70 @@ class ResultSet implements ResultSetInterface
      *
      * @var mixed
      */
-    protected $current;
+    protected mixed $current;
 
     /**
      * Query instance.
      *
-     * @var \Cake\ORM\Query
+     * @var \Cake\ORM\Query\SelectQuery
      */
-    protected $query;
+    protected SelectQuery $query;
 
     /**
      * Current chunk size.
      *
      * @var int
      */
-    protected $chunkSize = 0;
+    protected int $chunkSize = 0;
 
     /**
      * Current chunk index.
      *
      * @var int
      */
-    protected $chunkIndex = 0;
+    protected int $chunkIndex = 0;
 
     /**
      * Current chunk content.
      *
-     * @var array
+     * @var array<int, mixed>
      */
-    protected $chunk;
+    protected array $chunk;
 
     /**
      * Current element index.
      *
      * @var int
      */
-    protected $index = 0;
+    protected int $index = 0;
 
     /**
      * Current page.
      *
      * @var int
      */
-    protected $page = 0;
+    protected int $page = 0;
 
     /**
      * Original query offset.
      *
-     * @var int
+     * @var ?int
      */
-    protected $offset;
+    protected ?int $offset;
 
     /**
      * Original query limit.
      *
-     * @var int
+     * @var ?int
      */
-    protected $limit;
+    protected ?int $limit;
 
     /**
      * Total count.
      *
      * @var int
      */
-    protected $count;
+    protected int $count;
 
     /**
      * Default config.
@@ -114,18 +115,18 @@ class ResultSet implements ResultSetInterface
      *
      * @var array
      */
-    protected $_defaultConfig = [
+    protected array $_defaultConfig = [
         'size' => 1000,
     ];
 
     /**
      * Constructor.
      *
-     * @param \Cake\ORM\Query $query Query object.
+     * @param \Cake\ORM\Query\SelectQuery $query Query object.
      * @param array $config Configuration.
      * @throws \RuntimeException When query is not supported.
      */
-    public function __construct(Query $query, array $config = [])
+    public function __construct(SelectQuery $query, array $config = [])
     {
         $type = $query->type();
         if ($type !== 'select') {
@@ -144,17 +145,17 @@ public function __construct(Query $query, array $config = [])
     /**
      * @inheritDoc
      */
-    #[\ReturnTypeWillChange]
-    public function current()
+    #[ReturnTypeWillChange]
+    public function current(): mixed
     {
         return $this->current;
     }
 
     /**
      * @inheritDoc
      */
-    #[\ReturnTypeWillChange]
-    public function key()
+    #[ReturnTypeWillChange]
+    public function key(): mixed
     {
         return $this->index;
     }
@@ -215,7 +216,7 @@ public function valid(): bool
      *
      * @return void
      */
-    protected function fetchChunk()
+    protected function fetchChunk(): void
     {
         $size = $this->getConfig('size');
 
@@ -251,12 +252,12 @@ public function count(): int
      *
      * Serialization is not supported (yet).     *
      */
-    public function serialize()
+    public function serialize(): never
     {
         throw new RuntimeException('You cannot serialize this result set.');
     }
 
-    public function __serialize(): array
+    public function __serialize(): never
     {
         throw new RuntimeException('You cannot serialize this result set.');
     }
@@ -266,12 +267,12 @@ public function __serialize(): array
      *
      * Serialization is not supported (yet).     *
      */
-    public function unserialize($serialized)
+    public function unserialize(string $serialized): never
     {
         throw new RuntimeException('You cannot unserialize this result set.');
     }
 
-    public function __unserialize(array $data): void
+    public function __unserialize(array $data): never
     {
         throw new RuntimeException('You cannot unserialize this result set.');
     }

src/ORM/ResultSet.php

@@ -26,7 +26,6 @@
  */
 namespace Robotusers\Chunk\Test\TestCase\Model\Behavior;
 
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use Robotusers\Chunk\Model\Behavior\ChunkBehavior;
 use Robotusers\Chunk\ORM\ResultSet;
@@ -38,13 +37,13 @@
  */
 class ChunkBehaviorTest extends TestCase
 {
-    public $fixtures = [
+    public array $fixtures = [
         'core.Authors',
     ];
 
     public function testChunk()
     {
-        $table = TableRegistry::get('Authors');
+        $table = $this->getTableLocator()->get('Authors');
         $query = $table->find();
 
         $behavior = new ChunkBehavior($table);