Merge pull request #4 from robertpustulka/cake-4

CakePHP 4 support

Author: robertpustulka

.travis.yml

@@ -2,10 +2,10 @@ language: php
 dist: trusty
 
 php:
-  - 5.6
-  - 7.0
-  - 7.1
   - 7.2
+  - 7.3
+  - 7.4
+  - 8.0
 
 sudo: false
 
@@ -17,9 +17,9 @@ env:
 
 matrix:
   include:
-    - php: 7.1
+    - php: 7.2
       env: PHPCS=1 DEFAULT=0
-    - php: 7.1
+    - php: 7.2
       env: COVERALLS=1 DEFAULT=0 DB=mysql db_dsn='mysql://[email protected]/searchable_test'
 
 before_script:

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## :package: [3.0.0](https://packagist.org/packages/chris48s/cakephp-searchable#3.0.0) - TODO
+
+* Adds compatibility with CakePHP 4, drops compatibility with CakePHP 3
+* New maintainer: @robertpustulka
+
 ## :package: [2.0.0](https://packagist.org/packages/chris48s/cakephp-searchable#2.0.0) - 2018-05-10
 
 * Remove deprecated CakePHP calls

composer.json

@@ -12,13 +12,13 @@
         }
     ],
     "require": {
-        "cakephp/cakephp": "^3.5",
+        "cakephp/cakephp": "4.*",
         "php": ">=5.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7",
         "cakephp/cakephp-codesniffer": "dev-master",
-        "php-coveralls/php-coveralls": "^2.0.0"
+        "php-coveralls/php-coveralls": "^2.0.0",
+        "phpunit/phpunit": "8.*"
     },
     "autoload": {
         "psr-4": {

src/Model/Behavior/SearchableBehavior.php

@@ -27,7 +27,7 @@ class SearchableBehavior extends Behavior
      * @throws SearchableFatalException If database engine is not MySQL
      * @return void
      */
-    public function initialize(array $config)
+    public function initialize(array $config): void
     {
         $connection = $this->_table->getConnection();
 
@@ -58,7 +58,7 @@ public function initialize(array $config)
      * @throws SearchableException If columns are invalid
      * @return \Cake\ORM\Query
      */
-    public function findMatches(Query $query, array $options)
+    public function findMatches(Query $query, array $options): Query
     {
         $conditions = [];
         $options = array_values($options);
@@ -98,7 +98,7 @@ public function findMatches(Query $query, array $options)
      * @throws SearchableException If columns are invalid
      * @return bool
      */
-    private function _validateColumns($columnList)
+    private function _validateColumns(string $columnList): bool
     {
         $columns = explode(',', $columnList);
         foreach ($columns as $column) {

tests/TestCase/Model/Behavior/SearchableBehaviorTest.php

@@ -3,28 +3,26 @@
 namespace Chris48s\Searchable\Test\TestCase\Model\Behavior;
 
 use Cake\Datasource\ConnectionManager;
-use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use Chris48s\Searchable\Exception\SearchableException;
 use Chris48s\Searchable\Exception\SearchableFatalException;
-use Chris48s\Searchable\Model\Behavior\SearchableBehavior;
 
 class SearchableBehaviorTest extends TestCase
 {
     public $fixtures = [
-        'plugin.Chris48s\Searchable.foo'
+        'plugin.Chris48s\Searchable.Foo'
     ];
 
-    public function tearDown()
+    public function tearDown(): void
     {
         parent::tearDown();
-        TableRegistry::clear();
+        $this->getTableLocator()->clear();
     }
 
     // set up a table to use for testing
     private function getTable()
     {
-        $table = TableRegistry::get('Foo');
+        $table = $this->getTableLocator()->get('Foo');
         $table->addBehavior('Chris48s/Searchable.Searchable');
 
         return $table;
@@ -34,7 +32,7 @@ private function getTable()
        and ensure SearchableException is thrown */
     public function testNonStringColumn()
     {
-        $this->setExpectedException('Chris48s\Searchable\Exception\SearchableException');
+        $this->expectException(SearchableException::class);
         $table = $this->getTable();
         $table->find('matches', [
             [
@@ -48,7 +46,7 @@ public function testNonStringColumn()
        and ensure SearchableException is thrown */
     public function testInvalidColumn()
     {
-        $this->setExpectedException('Chris48s\Searchable\Exception\SearchableException');
+        $this->expectException(SearchableException::class);
         $table = $this->getTable();
         $table->find('matches', [
             [
@@ -77,7 +75,7 @@ public function testInvalidMode()
     // omit 'match' key and ensure SearchableException is thrown
     public function testMissingMatchKey()
     {
-        $this->setExpectedException('Chris48s\Searchable\Exception\SearchableException');
+        $this->expectException(SearchableException::class);
         $table = $this->getTable();
         $table->find('matches', [
             [
@@ -89,7 +87,7 @@ public function testMissingMatchKey()
     // omit 'against' key and ensure SearchableException is thrown
     public function testMissingAgainstKey()
     {
-        $this->setExpectedException('Chris48s\Searchable\Exception\SearchableException');
+        $this->expectException(SearchableException::class);
         $table = $this->getTable();
         $table->find('matches', [
             [
@@ -103,7 +101,7 @@ public function testMissingAgainstKey()
        and ensure correct exception is thrown */
     public function testInvalidDB()
     {
-        $this->setExpectedException('Chris48s\Searchable\Exception\SearchableFatalException');
+        $this->expectException(SearchableFatalException::class);
 
         //set up a SQLite DB connection - SQLite is not supported
         ConnectionManager::setConfig('invalid', [
@@ -118,7 +116,7 @@ public function testInvalidDB()
             `textcol` VARCHAR(255),
             PRIMARY KEY (`id`)
         );");
-        $table = TableRegistry::get('Foo', ['connection' => $conn]);
+        $table = $this->getTableLocator()->get('Foo', ['connection' => $conn]);
         $table->addBehavior('Chris48s/Searchable.Searchable');
 
         //tidy up

tests/bootstrap.php

@@ -1,4 +1,11 @@
 <?php
+
+use Cake\Cache\Cache;
+use Cake\Core\BasePlugin;
+use Cake\Core\Configure;
+use Cake\Core\Plugin;
+use Cake\Datasource\ConnectionManager;
+use Cake\Filesystem\Folder;
 // @codingStandardsIgnoreFile
 
 $findRoot = function () {
@@ -38,10 +45,10 @@
 require ROOT . '/vendor/autoload.php';
 require CORE_PATH . 'config/bootstrap.php';
 
-Cake\Core\Configure::write('App', ['namespace' => 'App']);
-Cake\Core\Configure::write('debug', true);
+Configure::write('App', ['namespace' => 'App']);
+Configure::write('debug', true);
 
-$TMP = new \Cake\Filesystem\Folder(TMP);
+$TMP = new Folder(TMP);
 $TMP->create(TMP . 'cache/models', 0777);
 $TMP->create(TMP . 'cache/persistent', 0777);
 $TMP->create(TMP . 'cache/views', 0777);
@@ -66,19 +73,19 @@
     ]
 ];
 
-Cake\Cache\Cache::setConfig($cache);
-Cake\Core\Configure::write('Session', [
+Cache::setConfig($cache);
+Configure::write('Session', [
     'defaults' => 'php'
 ]);
 
-Cake\Core\Plugin::load('Chris48s/Searchable', ['path' => ROOT . DS, 'autoload' => true]);
+Plugin::getCollection()->add(new BasePlugin(['name' => 'Chris48s/Searchable', 'path' => ROOT . DS, 'autoload' => true]));
 
 // Ensure default test connection is defined
 if (!getenv('db_dsn')) {
     putenv('db_dsn=sqlite:///:memory:');
 }
 
-Cake\Datasource\ConnectionManager::setConfig('test', [
+ConnectionManager::setConfig('test', [
     'url' => getenv('db_dsn'),
     'timezone' => 'UTC'
 ]);