Merge pull request #3 from robotusers/0.2

Update to Cake 4

Author: robertpustulka

.github/workflows/php.yml

@@ -33,10 +33,10 @@ jobs:
       run: composer install --prefer-dist --no-progress
 
     - name: Run CS
-      run: vendor/bin/phpcs -p --extensions=php ./src ./tests
+      run: vendor/bin/phpcs
 
     - name: Run stan
-      run: vendor/bin/phpstan analyse ./src --level 4
+      run: vendor/bin/phpstan analyse
 
     - name: Run tests
       run: vendor/bin/phpunit --coverage-clover=coverage.xml

.gitignore

@@ -5,3 +5,4 @@
 /nbproject
 /phpunit.xml
 /coverage.xml
+.phpunit.*

.travis.yml

@@ -5,13 +5,13 @@
 	"type": "cakephp-plugin",
 	"license": "MIT",
 	"require": {
-		"php": ">=5.6",
-		"cakephp/orm": "^3.4"
+		"cakephp/orm": "~4.0"
 	},
 	"require-dev": {
-		"cakephp/cakephp": "~3.4.0",
-		"cakephp/cakephp-codesniffer": "^3.0",
-		"phpunit/phpunit": "^5.6|^6"
+		"cakephp/cakephp": "~4.0",
+		"cakephp/cakephp-codesniffer": "^4.0",
+		"phpunit/phpunit": "^9.5",
+		"phpstan/phpstan": "^2.0"
 	},
 	"autoload": {
 		"psr-4": {
@@ -23,5 +23,10 @@
 			"Cake\\Test\\": "vendor/cakephp/cakephp/tests",
 			"Robotusers\\Chunk\\Test\\": "tests"
 		}
+	},
+	"config": {
+		"allow-plugins": {
+			"dealerdirect/phpcodesniffer-composer-installer": true
+		}
 	}
 }

composer.json

@@ -1,4 +1,16 @@
 <?xml version="1.0"?>
-<ruleset name="CakePHP Core">
- <rule ref="./vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml"/>
+<ruleset name="Robotusers">
+    <rule ref="CakePHP">
+        <exclude name="CakePHP.Commenting.FunctionComment.Missing"/>
+        <exclude name="CakePHP.Commenting.FunctionComment.MissingParamComment"/>
+        <exclude name="CakePHP.Commenting.FunctionComment.MissingParamTag"/>
+        <exclude name="CakePHP.NamingConventions.ValidTraitName"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>        
+        <exclude name="Generic.Files.LineLength"/>
+    </rule>
+    <file>src/</file> 
+    <file>tests/</file> 
 </ruleset>

phpcs.xml.dist

@@ -0,0 +1,7 @@
+parameters:
+    level: 4
+#    reportUnmatchedIgnoredErrors: false
+#    treatPhpDocTypesAsCertain: false
+    paths:
+        - src/ 
+        - tests/ 

phpstan.neon

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /*
  * The MIT License
  *
@@ -30,13 +32,12 @@
 
 class ChunkBehavior extends Behavior
 {
-
     /**
      * Returns chunked result set.
      *
-     * @param Query $query Query instance.
+     * @param \Cake\ORM\Query $query Query instance.
      * @param array $config Config.
-     * @return ResultSet
+     * @return \Robotusers\Chunk\ORM\ResultSet
      */
     public function chunk(Query $query, array $config = [])
     {

src/Model/Behavior/ChunkBehavior.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /*
  * The MIT License
  *
@@ -45,7 +47,7 @@ class ResultSet implements ResultSetInterface
     /**
      * Query instance.
      *
-     * @var Query
+     * @var \Cake\ORM\Query
      */
     protected $query;
 
@@ -113,15 +115,15 @@ class ResultSet implements ResultSetInterface
      * @var array
      */
     protected $_defaultConfig = [
-        'size' => 1000
+        'size' => 1000,
     ];
 
     /**
      * Constructor.
      *
-     * @param Query $query Query object.
+     * @param \Cake\ORM\Query $query Query object.
      * @param array $config Configuration.
-     * @throws RuntimeException When query is not supported.
+     * @throws \RuntimeException When query is not supported.
      */
     public function __construct(Query $query, array $config = [])
     {
@@ -140,34 +142,36 @@ public function __construct(Query $query, array $config = [])
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->current;
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->index;
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
-    public function next()
+    public function next(): void
     {
         $this->index++;
         $this->chunkIndex++;
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->index = 0;
         $this->page = 1;
@@ -176,9 +180,9 @@ public function rewind()
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
-    public function valid()
+    public function valid(): bool
     {
         if ($this->limit && $this->index >= $this->limit) {
             return false;
@@ -235,30 +239,40 @@ protected function fetchChunk()
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
-    public function count()
+    public function count(): int
     {
         throw new RuntimeException('Count is not supported yet.');
     }
 
     /**
-     * Serialization is not supported (yet).
-     *
      * {@inheritDoc}
+     *
+     * Serialization is not supported (yet).     *
      */
     public function serialize()
     {
         throw new RuntimeException('You cannot serialize this result set.');
     }
 
+    public function __serialize(): array
+    {
+        throw new RuntimeException('You cannot serialize this result set.');
+    }
+
     /**
-     * Serialization is not supported (yet).
-     *
      * {@inheritDoc}
+     *
+     * Serialization is not supported (yet).     *
      */
     public function unserialize($serialized)
     {
         throw new RuntimeException('You cannot unserialize this result set.');
     }
+
+    public function __unserialize(array $data): void
+    {
+        throw new RuntimeException('You cannot unserialize this result set.');
+    }
 }

src/ORM/ResultSet.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /*
  * The MIT License
  *
@@ -37,7 +39,7 @@
 class ChunkBehaviorTest extends TestCase
 {
     public $fixtures = [
-        'core.authors'
+        'core.Authors',
     ];
 
     public function testChunk()
@@ -47,7 +49,7 @@ public function testChunk()
 
         $behavior = new ChunkBehavior($table);
         $chunk = $behavior->chunk($query, [
-            'size' => 100
+            'size' => 100,
         ]);
 
         $this->assertInstanceOf(ResultSet::class, $chunk);