Merge pull request #29 from itosho/25-cakephp4

#25 Compatible with CakePHP4.x

Author: itosho

.travis.yml

@@ -4,7 +4,6 @@ services:
   - mysql
 
 php:
-  - 7.1
   - 7.2
   - 7.3
   - 7.4
@@ -31,7 +30,6 @@ matrix:
     - php: 7.4
       env: PHPSTAN=1 DEFAULT=0 PREFER_LOWEST=""
 
-
 cache:
   directories:
     - vendor

README.md

@@ -1,5 +1,4 @@
 # Easy Query
-
 CakePHP behavior plugin for easily generating some complicated queries like (bulk) insert/upsert etc.
 
 [![Build Status](https://travis-ci.org/itosho/easy-query.svg?branch=master)](https://travis-ci.org/itosho/easy-query)
@@ -9,21 +8,20 @@ CakePHP behavior plugin for easily generating some complicated queries like (bul
 [![License](https://poser.pugx.org/itosho/easy-query/license)](https://packagist.org/packages/itosho/easy-query)
 
 ## Requirements
-
-- PHP 7.1+
-- CakePHP 3.6+
+- PHP 7.2+
+- CakePHP 4.0+
 - MySQL 5.6+
 
-## Installation
+:warning: For CakePHP3.x, use 1.x branch.
 
+## Installation
 ```bash
 composer require itosho/easy-query
 ```
 
 ## Usage
 
 ### Upsert
-
 ```php
 $this->Tags = TableRegistry::getTableLocator()->get('Tags');
 $this->Tags->addBehavior('Itosho/EasyQuery.Upsert', [
@@ -40,7 +38,6 @@ $this->Tags->upsert($entity);
 ```
 
 ### Bulk Upsert
-
 ```php
 $this->Tags = TableRegistry::getTableLocator()->get('Tags');
 $this->Tags->addBehavior('Itosho/EasyQuery.Upsert', [
@@ -62,7 +59,6 @@ $this->Tags->bulkUpsert($entities);
 ```
 
 ### Bulk Insert
-
 ```php
 $this->Articles = TableRegistry::getTableLocator()->get('Articles');
 $this->Articles->addBehavior('Itosho/EasyQuery.Insert');
@@ -149,9 +145,7 @@ $this->Articles->addBehavior('Itosho/EasyQuery.Insert', [
 ```
 
 ## Contributing
-
 Bug reports and pull requests are welcome on GitHub at https://github.com/itosho/easy-query.
 
 ## License
-
 The plugin is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

composer.json

@@ -26,12 +26,12 @@
     "source": "https://github.com/itosho/easy-query"
   },
   "require": {
-    "php": ">=7.1.0",
-    "cakephp/orm": "^3.6"
+    "php": ">=7.2.0",
+    "cakephp/orm": "^4.0"
   },
   "require-dev": {
-    "cakephp/cakephp": "^3.6",
-    "phpunit/phpunit": "^5.7.14|^6.0"
+    "cakephp/cakephp": "^4.0",
+    "phpunit/phpunit": "^8.5"
   },
   "autoload": {
     "psr-4": {

phpunit.xml.dist

@@ -3,7 +3,6 @@
         colors="true"
         processIsolation="false"
         stopOnFailure="false"
-        syntaxCheck="false"
         bootstrap="./tests/bootstrap.php"
 >
     <php>

src/Model/Behavior/InsertBehavior.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Itosho\EasyQuery\Model\Behavior;
 
@@ -32,15 +33,15 @@ class InsertBehavior extends Behavior
      * @throws LogicException no save data
      * @return StatementInterface query result
      */
-    public function bulkInsert(array $entities)
+    public function bulkInsert(array $entities): StatementInterface
     {
         $saveData = [];
         foreach ($entities as $entity) {
             if ($this->_config['event']['beforeSave']) {
                 $this->_table->dispatchEvent('Model.beforeSave', compact('entity'));
             }
             $entity->setVirtual([]);
-            $saveData[] = $entity->toArray();
+            array_push($saveData, $entity->toArray());
         }
 
         if (!isset($saveData[0])) {
@@ -63,7 +64,7 @@ public function bulkInsert(array $entities)
      * @param array|null $conditions search conditions
      * @return StatementInterface query result
      */
-    public function insertOnce(Entity $entity, array $conditions = null)
+    public function insertOnce(Entity $entity, array $conditions = null): StatementInterface
     {
         if ($this->_config['event']['beforeSave']) {
             $this->_table->dispatchEvent('Model.beforeSave', compact('entity'));
@@ -83,22 +84,19 @@ public function insertOnce(Entity $entity, array $conditions = null)
         if (is_null($existsConditions)) {
             $existsConditions = $this->getExistsConditions($insertData);
         }
-
-        $query = $this->_table
-            ->query()
-            ->insert($fields)
-            ->epilog(
-                $this
-                    ->buildTmpTableSelectQuery($insertData)
-                    ->where(function (QueryExpression $exp) use ($existsConditions) {
-                        $query = $this->_table
-                            ->find()
-                            ->where($existsConditions);
-
-                        return $exp->notExists($query);
-                    })
-                    ->limit(1)
-            );
+        $query = $this->_table->query()->insert($fields);
+        $subQuery = $this
+            ->buildTmpTableSelectQuery($insertData)
+            ->where(function (QueryExpression $exp) use ($existsConditions) {
+                $query = $this->_table
+                    ->find()
+                    ->where($existsConditions);
+
+                return $exp->notExists($query);
+            })
+            ->limit(1);
+        /* @phpstan-ignore-next-line */
+        $query = $query->epilog($subQuery);
 
         return $query->execute();
     }
@@ -110,7 +108,7 @@ public function insertOnce(Entity $entity, array $conditions = null)
      * @throws LogicException select query is invalid
      * @return Query tmp table's select query
      */
-    private function buildTmpTableSelectQuery($insertData)
+    private function buildTmpTableSelectQuery($insertData): Query
     {
         $driver = $this->_table
             ->getConnection()
@@ -137,7 +135,6 @@ private function buildTmpTableSelectQuery($insertData)
             ->from(
                 sprintf('(SELECT %s) as tmp', implode(',', $schema))
             );
-        /** @var Query $selectQuery */
         $selectQuery = $query;
         foreach ($binds as $key => $value) {
             $selectQuery->bind($key, $value);
@@ -152,7 +149,7 @@ private function buildTmpTableSelectQuery($insertData)
      * @param array $insertData insert data
      * @return array conditions
      */
-    private function getExistsConditions($insertData)
+    private function getExistsConditions(array $insertData): array
     {
         $autoFillFields = ['created', 'modified'];
         $existsConditions = [];

src/Model/Behavior/UpsertBehavior.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Itosho\EasyQuery\Model\Behavior;
 
@@ -70,12 +71,10 @@ public function upsert(Entity $entity)
             $conditions[$column] = $upsertData[$column];
         }
 
-        $upsertEntity = $this->_table
+        return $this->_table
             ->find()
             ->where($conditions)
             ->first();
-
-        return $upsertEntity;
     }
 
     /**
@@ -85,7 +84,7 @@ public function upsert(Entity $entity)
      * @return StatementInterface query result
      * @throws LogicException invalid config or no save data
      */
-    public function bulkUpsert(array $entities)
+    public function bulkUpsert(array $entities): StatementInterface
     {
         if (!$this->isValidArrayConfig('updateColumns')) {
             throw new LogicException('config updateColumns is invalid.');
@@ -129,7 +128,7 @@ public function bulkUpsert(array $entities)
      *
      * @return bool valid or invalid
      */
-    private function isValidArrayConfig($configName)
+    private function isValidArrayConfig(string $configName): bool
     {
         $config = $this->_config[$configName];
 

tests/Fixture/ArticlesFixture.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Itosho\EasyQuery\Test\Fixture;
 

tests/Fixture/TagsFixture.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Itosho\EasyQuery\Test\Fixture;
 

tests/TestCase/Model/Behavior/InsertBehaviorTest.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Itosho\EasyQuery\Test\TestCase\Model\Behavior;
 
@@ -29,7 +30,7 @@ class InsertBehaviorTest extends TestCase
     /**
      * {@inheritDoc}
      */
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
         $this->Articles = TableRegistry::getTableLocator()->get('Itosho/EasyQuery.Articles');
@@ -39,7 +40,7 @@ public function setUp()
     /**
      * {@inheritDoc}
      */
-    public function tearDown()
+    public function tearDown(): void
     {
         parent::tearDown();
         TableRegistry::getTableLocator()->clear();
@@ -140,12 +141,13 @@ public function testBulkInsertNoBeforeSave()
     /**
      * bulkInsert() test by no data
      *
-     * @expectedException \LogicException
-     * @expectedExceptionMessage entities has no save data.
      * @return void
      */
     public function testBulkInsertNoSaveData()
     {
+        $this->expectExceptionMessage("entities has no save data.");
+        $this->expectException(\LogicException::class);
+
         $this->Articles->bulkInsert([]);
     }
 
@@ -317,7 +319,7 @@ public function testInsertOnceWhenDuplicatedWithConditions()
      *
      * @return array
      */
-    private function getBaseInsertRecords()
+    private function getBaseInsertRecords(): array
     {
         return [
             [

tests/TestCase/Model/Behavior/UpsertBehaviorTest.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Itosho\EasyQuery\Test\TestCase\Model\Behavior;
 
@@ -28,7 +29,7 @@ class UpsertBehaviorTest extends TestCase
     /**
      * {@inheritDoc}
      */
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
         $this->Tags = TableRegistry::getTableLocator()->get('Itosho/EasyQuery.Tags');
@@ -41,7 +42,7 @@ public function setUp()
     /**
      * {@inheritDoc}
      */
-    public function tearDown()
+    public function tearDown(): void
     {
         parent::tearDown();
         TableRegistry::getTableLocator()->clear();
@@ -237,12 +238,13 @@ public function testUpsertNoBeforeSave()
     /**
      * upsert() test when invalid update columns
      *
-     * @expectedException \LogicException
-     * @expectedExceptionMessage config updateColumns is invalid.
      * @return void
      */
     public function testUpsertInvalidUpdateColumnsConfig()
     {
+        $this->expectExceptionMessage("config updateColumns is invalid.");
+        $this->expectException(\LogicException::class);
+
         $this->Tags->removeBehavior('Upsert');
         $this->Tags->addBehavior('Itosho/EasyQuery.Upsert', [
             'uniqueColumns' => ['name'],
@@ -261,12 +263,13 @@ public function testUpsertInvalidUpdateColumnsConfig()
     /**
      * upsert() test when invalid unique columns
      *
-     * @expectedException \LogicException
-     * @expectedExceptionMessage config uniqueColumns is invalid.
      * @return void
      */
     public function testUpsertInvalidUniqueColumnsConfig()
     {
+        $this->expectExceptionMessage("config uniqueColumns is invalid.");
+        $this->expectException(\LogicException::class);
+
         $this->Tags->removeBehavior('Upsert');
         $this->Tags->addBehavior('Itosho/EasyQuery.Upsert', [
             'updateColumns' => ['description', 'modified'],
@@ -434,12 +437,13 @@ public function testBulkUpsertNoBeforeSave()
     /**
      * bulkUpsert() test when invalid update columns
      *
-     * @expectedException \LogicException
-     * @expectedExceptionMessage config updateColumns is invalid.
      * @return void
      */
     public function testBulkUpsertInvalidUpdateColumnsConfig()
     {
+        $this->expectExceptionMessage("config updateColumns is invalid.");
+        $this->expectException(\LogicException::class);
+
         $this->Tags->removeBehavior('Upsert');
         $this->Tags->addBehavior('Itosho/EasyQuery.Upsert');
 
@@ -457,12 +461,13 @@ public function testBulkUpsertInvalidUpdateColumnsConfig()
     /**
      * bulkUpsert() test by no data
      *
-     * @expectedException \LogicException
-     * @expectedExceptionMessage entities has no save data.
      * @return void
      */
     public function testBulkUpsertNoSaveData()
     {
+        $this->expectExceptionMessage("entities has no save data.");
+        $this->expectException(\LogicException::class);
+
         $this->Tags->removeBehavior('Upsert');
         $this->Tags->addBehavior('Itosho/EasyQuery.Upsert', [
             'updateColumns' => ['description', 'modified'],
@@ -476,7 +481,7 @@ public function testBulkUpsertNoSaveData()
      *
      * @return array
      */
-    private function getBaseInsertRecords()
+    private function getBaseInsertRecords(): array
     {
         return [
             [
@@ -499,7 +504,7 @@ private function getBaseInsertRecords()
      *
      * @return array
      */
-    private function getBaseUpdateRecords()
+    private function getBaseUpdateRecords(): array
     {
         return [
             [