Merge pull request #485 from raul338/cakephp-deprecations

josegonzalez · web-flow · commit dd91ff86321e · 2018-04-26T17:49:45.000-04:00
Prepare for CakePHP 3.6
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,10 @@
 language: php
 
 php:
-  - 5.5
   - 5.6
   - 7.0
+  - 7.1
+  - 7.2
 
 sudo: false
 
@@ -22,10 +23,10 @@ matrix:
   fast_finish: true
 
   include:
-    - php: 5.5
+    - php: 5.6
       env: PHPCS=1 DEFAULT=0
 
-    - php: 5.5
+    - php: 5.6
       env: COVERALLS=1 DEFAULT=0
 
     - php: hhvm
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-[![Build Status](https://img.shields.io/travis/FriendsOfCake/cakephp-upload/master.svg?style=flat-square)](https://travis-ci.org/FriendsOfCake/cakephp-upload) 
-[![Coverage Status](https://img.shields.io/coveralls/FriendsOfCake/cakephp-upload.svg?style=flat-square)](https://coveralls.io/r/FriendsOfCake/cakephp-upload?branch=master) 
-[![Total Downloads](https://img.shields.io/packagist/dt/FriendsOfCake/cakephp-upload.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/cakephp-upload) 
-[![Latest Stable Version](https://img.shields.io/packagist/v/FriendsOfCake/cakephp-upload.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/cakephp-upload) 
+[![Build Status](https://img.shields.io/travis/FriendsOfCake/cakephp-upload/master.svg?style=flat-square)](https://travis-ci.org/FriendsOfCake/cakephp-upload)
+[![Coverage Status](https://img.shields.io/coveralls/FriendsOfCake/cakephp-upload.svg?style=flat-square)](https://coveralls.io/r/FriendsOfCake/cakephp-upload?branch=master)
+[![Total Downloads](https://img.shields.io/packagist/dt/FriendsOfCake/cakephp-upload.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/cakephp-upload)
+[![Latest Stable Version](https://img.shields.io/packagist/v/FriendsOfCake/cakephp-upload.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/cakephp-upload)
 [![Documentation Status](https://readthedocs.org/projects/cakephp-upload/badge/?version=latest&style=flat-square)](https://readthedocs.org/projects/cakephp-upload/?badge=latest)
 [![Gratipay](https://img.shields.io/gratipay/josegonzalez.svg?style=flat-square)](https://gratipay.com/~josegonzalez/)
 
@@ -15,8 +15,8 @@ See [this blog post](http://josediazgonzalez.com/2015/12/05/uploading-files-and-
 
 ## Requirements
 
-* CakePHP 3.x
-* PHP 5.4+
+* CakePHP 3.4+
+* PHP 5.6+
 
 ## Documentation
 For documentation, please see [the docs](http://cakephp-upload.readthedocs.org/en/latest/).
diff --git a/composer.json b/composer.json
@@ -13,11 +13,11 @@
     ],
     "require": {
         "cakephp/orm": "3.*",
-        "php": ">=5.5",
+        "php": ">=5.6",
         "league/flysystem": "*"
     },
     "require-dev": {
-        "cakephp/cakephp": "~3.0",
+        "cakephp/cakephp": "~3.4",
         "phpunit/phpunit": "<6.0",
         "league/flysystem-vfs": "*",
         "cakephp/cakephp-codesniffer": "dev-master",
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -63,14 +63,17 @@ Basic example
     */
     ?>
     <?php echo $this->Form->create($user, ['type' => 'file']); ?>
-        <?php echo $this->Form->input('username'); ?>
-        <?php echo $this->Form->input('photo', ['type' => 'file']); ?>
+        <?php echo $this->Form->control('username'); ?>
+        <?php echo $this->Form->control('photo', ['type' => 'file']); ?>
+        // for CakePHP 3.0.x-3.3.x, use the following lines instead of the previous:
+        // <?php echo $this->Form->input('username'); ?>
+        // <?php echo $this->Form->input('photo', ['type' => 'file']); ?>
     <?php echo $this->Form->end(); ?>
-    
-    Note: If you used *bake* to generate MVC structure after creating 
+
+    Note: If you used *bake* to generate MVC structure after creating
     the users table, you will need to remove the default scalar validation
-    for the photos field. 
-    
+    for the photos field.
+
 .. code:: php
     public function validationDefault(Validator $validator)
     {
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -18,12 +18,9 @@
     </testsuites>
 
     <filter>
-        <blacklist>
-            <directory suffix=".php">./docs</directory>
-            <directory suffix=".php">./vendor</directory>
-            <directory suffix=".php">./tests</directory>
-            <file>./tests/bootstrap.php</file>
-        </blacklist>
+        <whitelist>
+            <directory suffix=".php">./src</directory>
+        </whitelist>
     </filter>
 
     <!-- Setup a listener for fixtures -->
diff --git a/src/Database/Type/FileType.php b/src/Database/Type/FileType.php
@@ -1,6 +1,7 @@
 <?php
 namespace Josegonzalez\Upload\Database\Type;
 
+use Cake\Database\Driver;
 use Cake\Database\Type;
 
 class FileType extends Type
@@ -18,4 +19,20 @@ public function marshal($value)
     {
         return $value;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toDatabase($value, Driver $driver)
+    {
+        return $value;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toPHP($value, Driver $driver)
+    {
+        return $value;
+    }
 }
diff --git a/src/File/Path/Basepath/DefaultTrait.php b/src/File/Path/Basepath/DefaultTrait.php
@@ -22,15 +22,15 @@ public function basepath()
             if ($this->entity->isNew()) {
                 throw new LogicException('{primaryKey} substitution not allowed for new entities');
             }
-            if (is_array($this->table->primaryKey())) {
+            if (is_array($this->table->getPrimaryKey())) {
                 throw new LogicException('{primaryKey} substitution not valid for composite primary keys');
             }
         }
 
         $replacements = [
-            '{primaryKey}' => $this->entity->get($this->table->primaryKey()),
-            '{model}' => $this->table->alias(),
-            '{table}' => $this->table->table(),
+            '{primaryKey}' => $this->entity->get($this->table->getPrimaryKey()),
+            '{model}' => $this->table->getAlias(),
+            '{table}' => $this->table->getTable(),
             '{field}' => $this->field,
             '{year}' => date("Y"),
             '{month}' => date("m"),
diff --git a/src/File/Transformer/SlugTransformer.php b/src/File/Transformer/SlugTransformer.php
@@ -1,15 +1,15 @@
 <?php
 namespace Josegonzalez\Upload\File\Transformer;
 
-use Cake\Utility\Inflector;
+use Cake\Utility\Text;
 use Josegonzalez\Upload\File\Transformer\DefaultTransformer;
 
 class SlugTransformer extends DefaultTransformer
 {
     /**
      * Creates a set of files from the initial data and returns them as key/value
      * pairs, where the path on disk maps to name which each file should have.
-     * The file name will be sluggified (using Inflector::slug()) and lowercased.
+     * The file name will be sluggified (using Text::slug()) and lowercased.
      *
      * Example:
      *
@@ -25,7 +25,7 @@ class SlugTransformer extends DefaultTransformer
     public function transform()
     {
         $filename = pathinfo($this->data['name'], PATHINFO_FILENAME);
-        $filename = Inflector::slug($filename, '-');
+        $filename = Text::slug($filename, '-');
 
         $ext = pathinfo($this->data['name'], PATHINFO_EXTENSION);
         if (!empty($ext)) {
diff --git a/src/Model/Behavior/UploadBehavior.php b/src/Model/Behavior/UploadBehavior.php
@@ -37,15 +37,15 @@ public function initialize(array $config)
             }
         }
 
-        $this->config($configs);
-        $this->config('className', null);
+        $this->setConfig($configs);
+        $this->setConfig('className', null);
 
         Type::map('upload.file', 'Josegonzalez\Upload\Database\Type\FileType');
-        $schema = $this->_table->schema();
-        foreach (array_keys($this->config()) as $field) {
-            $schema->columnType($field, 'upload.file');
+        $schema = $this->_table->getSchema();
+        foreach (array_keys($this->getConfig()) as $field) {
+            $schema->setColumnType($field, 'upload.file');
         }
-        $this->_table->schema($schema);
+        $this->_table->setSchema($schema);
     }
 
     /**
@@ -58,9 +58,9 @@ public function initialize(array $config)
      */
     public function beforeMarshal(Event $event, ArrayObject $data, ArrayObject $options)
     {
-        $validator = $this->_table->validator();
+        $validator = $this->_table->getValidator();
         $dataArray = $data->getArrayCopy();
-        foreach (array_keys($this->config()) as $field) {
+        foreach (array_keys($this->getConfig(null, [])) as $field) {
             if (!$validator->isEmptyAllowed($field, false)) {
                 continue;
             }
@@ -82,15 +82,15 @@ public function beforeMarshal(Event $event, ArrayObject $data, ArrayObject $opti
      */
     public function beforeSave(Event $event, Entity $entity, ArrayObject $options)
     {
-        foreach ($this->config() as $field => $settings) {
+        foreach ($this->getConfig(null, []) as $field => $settings) {
             if (in_array($field, $this->protectedFieldNames)) {
                 continue;
             }
 
             if (Hash::get((array)$entity->get($field), 'error') !== UPLOAD_ERR_OK) {
                 if (Hash::get($settings, 'restoreValueOnFailure', true)) {
                     $entity->set($field, $entity->getOriginal($field));
-                    $entity->dirty($field, false);
+                    $entity->setDirty($field, false);
                 }
                 continue;
             }
@@ -128,7 +128,7 @@ public function afterDelete(Event $event, Entity $entity, ArrayObject $options)
     {
         $result = true;
 
-        foreach ($this->config() as $field => $settings) {
+        foreach ($this->getConfig(null, []) as $field => $settings) {
             if (in_array($field, $this->protectedFieldNames) || Hash::get($settings, 'keepFilesOnDelete', true)) {
                 continue;
             }
diff --git a/tests/TestCase/File/Path/Basepath/DefaultTraitTest.php b/tests/TestCase/File/Path/Basepath/DefaultTraitTest.php
@@ -17,8 +17,8 @@ public function testNoSpecialConfiguration()
         $mock->data = ['name' => 'filename'];
         $mock->field = 'field';
         $mock->entity->expects($this->once())->method('get')->will($this->returnValue(1));
-        $mock->table->expects($this->once())->method('alias')->will($this->returnValue('Table'));
-        $mock->table->expects($this->once())->method('primaryKey')->will($this->returnValue('id'));
+        $mock->table->expects($this->once())->method('getAlias')->will($this->returnValue('Table'));
+        $mock->table->expects($this->once())->method('getPrimaryKey')->will($this->returnValue('id'));
         $this->assertEquals('webroot/files/Table/field/', $mock->basepath());
     }
 
@@ -31,8 +31,8 @@ public function testCustomPath()
         $mock->data = ['name' => 'filename'];
         $mock->field = 'field';
         $mock->entity->expects($this->once())->method('get')->will($this->returnValue(1));
-        $mock->table->expects($this->once())->method('alias')->will($this->returnValue('Table'));
-        $mock->table->expects($this->once())->method('primaryKey')->will($this->returnValue('id'));
+        $mock->table->expects($this->once())->method('getAlias')->will($this->returnValue('Table'));
+        $mock->table->expects($this->once())->method('getPrimaryKey')->will($this->returnValue('id'));
         $this->assertEquals('webroot/files/Table-field/', $mock->basepath());
     }
 
@@ -45,8 +45,8 @@ public function testExistingEntityWithPrimaryKey()
         $mock->data = ['name' => 'filename'];
         $mock->field = 'field';
         $mock->entity->expects($this->once())->method('get')->will($this->returnValue(1));
-        $mock->table->expects($this->once())->method('alias')->will($this->returnValue('Table'));
-        $mock->table->expects($this->exactly(2))->method('primaryKey')->will($this->returnValue('id'));
+        $mock->table->expects($this->once())->method('getAlias')->will($this->returnValue('Table'));
+        $mock->table->expects($this->exactly(2))->method('getPrimaryKey')->will($this->returnValue('id'));
         $this->assertEquals('webroot/files/Table-field/1/', $mock->basepath());
     }
 
@@ -75,7 +75,7 @@ public function testExitingEntityWithCompositePrimaryKey()
         $mock->data = ['name' => 'filename'];
         $mock->field = 'field';
         $mock->entity->expects($this->once())->method('isNew')->will($this->returnValue(false));
-        $mock->table->expects($this->once())->method('primaryKey')->will($this->returnValue(['id', 'other_id']));
+        $mock->table->expects($this->once())->method('getPrimaryKey')->will($this->returnValue(['id', 'other_id']));
         $mock->basepath();
     }
 
@@ -113,7 +113,7 @@ public function testModelFieldYearWithMonthAndDayPath()
         $mock->data = ['name' => 'filename'];
         $mock->field = 'field';
         $mock->entity->expects($this->once())->method('get')->will($this->returnValue(1));
-        $mock->table->expects($this->once())->method('alias')->will($this->returnValue('Table'));
+        $mock->table->expects($this->once())->method('getAlias')->will($this->returnValue('Table'));
 
         $this->assertEquals('webroot/files/Table/field/' . date("Y") . '/' . date("m") . '/' . date("d") . '/', $mock->basepath());
     }
@@ -169,7 +169,7 @@ public function testFieldValue()
         $mock->data = ['name' => 'filename'];
         $mock->field = 'field';
         $mock->entity->expects($this->any())->method('get')->will($this->returnValue('value'));
-        $mock->table->expects($this->once())->method('alias')->will($this->returnValue('Table'));
+        $mock->table->expects($this->once())->method('getAlias')->will($this->returnValue('Table'));
         $this->assertEquals('webroot/files/Table/value/', $mock->basepath());
     }
 }
diff --git a/tests/TestCase/Model/Behavior/UploadBehaviorTest.php b/tests/TestCase/Model/Behavior/UploadBehaviorTest.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php

Original file line number	Diff line number	Diff line change
`@@ -22,15 +22,15 @@ public function basepath()`
`22`	`22`	`if ($this->entity->isNew()) {`
`23`	`23`	`throw new LogicException('{primaryKey} substitution not allowed for new entities');`
`24`	`24`	`}`
`25`		`- if (is_array($this->table->primaryKey())) {`
	`25`	`+ if (is_array($this->table->getPrimaryKey())) {`
`26`	`26`	`throw new LogicException('{primaryKey} substitution not valid for composite primary keys');`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`$replacements = [`
`31`		`- '{primaryKey}' => $this->entity->get($this->table->primaryKey()),`
`32`		`- '{model}' => $this->table->alias(),`
`33`		`- '{table}' => $this->table->table(),`
	`31`	`+ '{primaryKey}' => $this->entity->get($this->table->getPrimaryKey()),`
	`32`	`+ '{model}' => $this->table->getAlias(),`
	`33`	`+ '{table}' => $this->table->getTable(),`
`34`	`34`	`'{field}' => $this->field,`
`35`	`35`	`'{year}' => date("Y"),`
`36`	`36`	`'{month}' => date("m"),`
Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,15 @@`
`1`	`1`	`<?php`
`2`	`2`	`namespace Josegonzalez\Upload\File\Transformer;`
`3`	`3`
`4`		`-use Cake\Utility\Inflector;`
	`4`	`+use Cake\Utility\Text;`
`5`	`5`	`use Josegonzalez\Upload\File\Transformer\DefaultTransformer;`
`6`	`6`
`7`	`7`	`class SlugTransformer extends DefaultTransformer`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`	`10`	`* Creates a set of files from the initial data and returns them as key/value`
`11`	`11`	`* pairs, where the path on disk maps to name which each file should have.`
`12`		`- * The file name will be sluggified (using Inflector::slug()) and lowercased.`
	`12`	`+ * The file name will be sluggified (using Text::slug()) and lowercased.`
`13`	`13`	`*`
`14`	`14`	`* Example:`
`15`	`15`	`*`
`@@ -25,7 +25,7 @@ class SlugTransformer extends DefaultTransformer`
`25`	`25`	`public function transform()`
`26`	`26`	`{`
`27`	`27`	`$filename = pathinfo($this->data['name'], PATHINFO_FILENAME);`
`28`		`- $filename = Inflector::slug($filename, '-');`
	`28`	`+ $filename = Text::slug($filename, '-');`
`29`	`29`
`30`	`30`	`$ext = pathinfo($this->data['name'], PATHINFO_EXTENSION);`
`31`	`31`	`if (!empty($ext)) {`
Original file line number	Diff line number	Diff line change
`@@ -37,15 +37,15 @@ public function initialize(array $config)`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`		`- $this->config($configs);`
`41`		`- $this->config('className', null);`
	`40`	`+ $this->setConfig($configs);`
	`41`	`+ $this->setConfig('className', null);`
`42`	`42`
`43`	`43`	`Type::map('upload.file', 'Josegonzalez\Upload\Database\Type\FileType');`
`44`		`- $schema = $this->_table->schema();`
`45`		`- foreach (array_keys($this->config()) as $field) {`
`46`		`- $schema->columnType($field, 'upload.file');`
	`44`	`+ $schema = $this->_table->getSchema();`
	`45`	`+ foreach (array_keys($this->getConfig()) as $field) {`
	`46`	`+ $schema->setColumnType($field, 'upload.file');`
`47`	`47`	`}`
`48`		`- $this->_table->schema($schema);`
	`48`	`+ $this->_table->setSchema($schema);`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/**`
`@@ -58,9 +58,9 @@ public function initialize(array $config)`
`58`	`58`	`*/`
`59`	`59`	`public function beforeMarshal(Event $event, ArrayObject $data, ArrayObject $options)`
`60`	`60`	`{`
`61`		`- $validator = $this->_table->validator();`
	`61`	`+ $validator = $this->_table->getValidator();`
`62`	`62`	`$dataArray = $data->getArrayCopy();`
`63`		`- foreach (array_keys($this->config()) as $field) {`
	`63`	`+ foreach (array_keys($this->getConfig(null, [])) as $field) {`
`64`	`64`	`if (!$validator->isEmptyAllowed($field, false)) {`
`65`	`65`	`continue;`
`66`	`66`	`}`
`@@ -82,15 +82,15 @@ public function beforeMarshal(Event $event, ArrayObject $data, ArrayObject $opti`
`82`	`82`	`*/`
`83`	`83`	`public function beforeSave(Event $event, Entity $entity, ArrayObject $options)`
`84`	`84`	`{`
`85`		`- foreach ($this->config() as $field => $settings) {`
	`85`	`+ foreach ($this->getConfig(null, []) as $field => $settings) {`
`86`	`86`	`if (in_array($field, $this->protectedFieldNames)) {`
`87`	`87`	`continue;`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`if (Hash::get((array)$entity->get($field), 'error') !== UPLOAD_ERR_OK) {`
`91`	`91`	`if (Hash::get($settings, 'restoreValueOnFailure', true)) {`
`92`	`92`	`$entity->set($field, $entity->getOriginal($field));`
`93`		`- $entity->dirty($field, false);`
	`93`	`+ $entity->setDirty($field, false);`
`94`	`94`	`}`
`95`	`95`	`continue;`
`96`	`96`	`}`
`@@ -128,7 +128,7 @@ public function afterDelete(Event $event, Entity $entity, ArrayObject $options)`
`128`	`128`	`{`
`129`	`129`	`$result = true;`
`130`	`130`
`131`		`- foreach ($this->config() as $field => $settings) {`
	`131`	`+ foreach ($this->getConfig(null, []) as $field => $settings) {`
`132`	`132`	`if (in_array($field, $this->protectedFieldNames) \|\| Hash::get($settings, 'keepFilesOnDelete', true)) {`
`133`	`133`	`continue;`
`134`	`134`	`}`