some fixes. Ready for php 8.0. Some useless @uses tags have been removed

mirko-pagliai · mirko-pagliai · commit a087f6b7ab15 · 2021-04-29T17:10:35.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -4,6 +4,7 @@ php:
   - 7.2
   - 7.3
   - 7.4
+  - 8.0
 
 matrix:
   fast_finish: true
@@ -15,6 +16,8 @@ matrix:
       env: dependencies=lowest
     - php: 7.4
       env: dependencies=lowest
+    - php: 8.0
+      env: dependencies=lowest
     - php: 7.2
       env: PHPCS=1
     - php: 7.2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # 2.x branch
 ## 2.8 branch
 ### 2.8.5
+* ready for php `8.0`;
 * extensive improvement of function descriptions and tags.
 
 ### 2.8.4
diff --git a/composer.json b/composer.json
@@ -16,7 +16,7 @@
         "mirko-pagliai/php-tools": "^1.4.7"
     },
     "require-dev": {
-        "cakephp/cakephp-codesniffer": "^4.0",
+        "cakephp/cakephp-codesniffer": "^4.4",
         "mirko-pagliai/me-tools": "^2.19",
         "phpunit/phpunit": "^8.0|^9.0"
     },
@@ -52,7 +52,7 @@
             "@phpstan",
             "@psalm"
         ],
-        "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:^0.12 psalm/phar:^3.18 && mv composer.backup composer.json",
+        "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:^0.12 psalm/phar:\"^3.18|^4\" && mv composer.backup composer.json",
         "update-lowest": "@composer update --prefer-lowest"
     }
 }
diff --git a/src/BackupTrait.php b/src/BackupTrait.php
@@ -48,9 +48,7 @@ public static function getAbsolutePath(string $path): string
     /**
      * Returns the compression type from a filename
      * @param string $filename Filename
-     * @return string|null Compression type as string or `null`
-     * @uses getExtension()
-     * @uses getValidCompressions()
+     * @return string|null Compression type or `null`
      */
     public static function getCompression(string $filename): ?string
     {
diff --git a/src/Command/IndexCommand.php b/src/Command/IndexCommand.php
@@ -64,7 +64,7 @@ public function execute(Arguments $args, ConsoleIo $io): void
             __d('database_backup', 'Size'),
             __d('database_backup', 'Datetime'),
         ];
-        $cells = $backups->map(function (Entity $backup) {
+        $cells = $backups->map(function (Entity $backup): array {
             return $backup->set('compression', $backup->get('compression') ?: '')
                 ->set('datetime', $backup->get('datetime')->nice())
                 ->set('size', Number::toReadableSize($backup->get('size')))
diff --git a/src/Driver/Driver.php b/src/Driver/Driver.php
@@ -39,7 +39,6 @@ abstract class Driver implements EventListenerInterface
     /**
      * Construct
      * @param \Cake\Datasource\ConnectionInterface $connection A connection object
-     * @uses $connection
      */
     public function __construct($connection)
     {
@@ -122,8 +121,6 @@ public function beforeImport(): bool
      * Gets the executable command to export the database, with compression
      * @param string $filename Filename where you want to export the database
      * @return string
-     * @uses _exportExecutable()
-     * @uses getBinary()
      */
     protected function _exportExecutableWithCompression(string $filename): string
     {
@@ -146,8 +143,6 @@ protected function _exportExecutableWithCompression(string $filename): string
      * Gets the executable command to import the database, with compression
      * @param string $filename Filename from which you want to import the database
      * @return string
-     * @uses _importExecutable()
-     * @uses getBinary()
      */
     protected function _importExecutableWithCompression(string $filename): string
     {
@@ -174,9 +169,8 @@ protected function _importExecutableWithCompression(string $filename): string
      * - Backup.beforeExport: will be triggered before export
      * - Backup.afterExport: will be triggered after export
      * @param string $filename Filename where you want to export the database
-     * @return bool true on success
+     * @return bool `true` on success
      * @throws \Exception
-     * @uses _exportExecutableWithCompression()
      */
     final public function export(string $filename): bool
     {
@@ -212,7 +206,6 @@ public function getBinary(string $name): string
      * @return mixed Config value, `null` if the key doesn't exist
      *  or all config values if no key was specified
      * @since 2.3.0
-     * @uses $connection
      */
     final public function getConfig(?string $key = null)
     {
@@ -231,7 +224,6 @@ final public function getConfig(?string $key = null)
      * @param string $filename Filename from which you want to import the database
      * @return bool true on success
      * @throws \Exception
-     * @uses _importExecutableWithCompression()
      */
     final public function import(string $filename): bool
     {
diff --git a/src/Driver/Mysql.php b/src/Driver/Mysql.php
@@ -33,9 +33,6 @@ class Mysql extends Driver
     /**
      * Gets the executable command to export the database
      * @return string
-     * @uses getBinary()
-     * @uses getConfig()
-     * @uses $auth
      */
     protected function _exportExecutable(): string
     {
@@ -50,9 +47,6 @@ protected function _exportExecutable(): string
     /**
      * Gets the executable command to import the database
      * @return string
-     * @uses getBinary()
-     * @uses getConfig()
-     * @uses $auth
      */
     protected function _importExecutable(): string
     {
@@ -69,8 +63,6 @@ protected function _importExecutable(): string
      * @param string $content Content
      * @return bool
      * @since 2.3.0
-     * @uses getConfig()
-     * @uses $auth
      */
     protected function writeAuthFile(string $content): bool
     {
@@ -89,7 +81,6 @@ protected function writeAuthFile(string $content): bool
      * Called after export
      * @return void
      * @since 2.1.0
-     * @uses deleteAuthFile()
      */
     public function afterExport(): void
     {
@@ -100,7 +91,6 @@ public function afterExport(): void
      * Called after import
      * @return void
      * @since 2.1.0
-     * @uses deleteAuthFile()
      */
     public function afterImport(): void
     {
@@ -119,7 +109,6 @@ public function afterImport(): void
      * So it creates a temporary file to store the configuration options
      * @return bool
      * @since 2.1.0
-     * @uses writeAuthFile()
      */
     public function beforeExport(): bool
     {
@@ -141,7 +130,6 @@ public function beforeExport(): bool
      *  So it creates a temporary file to store the configuration options
      * @return bool
      * @since 2.1.0
-     * @uses writeAuthFile()
      */
     public function beforeImport(): bool
     {
@@ -155,7 +143,6 @@ public function beforeImport(): bool
      * Deletes the temporary file with the database authentication data
      * @return bool `true` on success
      * @since 2.1.0
-     * @uses $auth
      */
     protected function deleteAuthFile(): bool
     {
diff --git a/src/Driver/Postgres.php b/src/Driver/Postgres.php
@@ -32,7 +32,6 @@ class Postgres extends Driver
      * postgresql://postgres@localhost/travis_ci_test
      * </code>
      * @return string
-     * @uses getConfig()
      */
     protected function getDbnameAsString(): string
     {
@@ -48,8 +47,6 @@ protected function getDbnameAsString(): string
     /**
      * Gets the executable command to export the database
      * @return string
-     * @uses getBinary()
-     * @uses getDbnameAsString()
      */
     protected function _exportExecutable(): string
     {
@@ -59,8 +56,6 @@ protected function _exportExecutable(): string
     /**
      * Gets the executable command to import the database
      * @return string
-     * @uses getBinary()
-     * @uses getDbnameAsString()
      */
     protected function _importExecutable(): string
     {
diff --git a/src/Driver/Sqlite.php b/src/Driver/Sqlite.php
@@ -25,8 +25,6 @@ class Sqlite extends Driver
     /**
      * Gets the executable command to export the database
      * @return string
-     * @uses getBinary()
-     * @uses getConfig()
      */
     protected function _exportExecutable(): string
     {
@@ -36,8 +34,6 @@ protected function _exportExecutable(): string
     /**
      * Gets the executable command to import the database
      * @return string
-     * @uses getBinary()
-     * @uses getConfig()
      */
     protected function _importExecutable(): string
     {
@@ -48,7 +44,6 @@ protected function _importExecutable(): string
      * Called before import
      * @return bool
      * @since 2.1.0
-     * @uses $connection
      */
     public function beforeImport(): bool
     {
diff --git a/src/TestSuite/TestCase.php b/src/TestSuite/TestCase.php
@@ -41,9 +41,9 @@ abstract class TestCase extends BaseTestCase
      */
     public function setUp(): void
     {
-        parent::setUp();
+        @parent::setUp();
 
-        $this->BackupExport = $this->BackupExport ?? new BackupExport();
+        $this->BackupExport = $this->BackupExport ?: new BackupExport();
     }
 
     /**
@@ -71,7 +71,6 @@ protected function createBackup(string $filename = 'backup.sql'): string
     /**
      * Internal method to creates some backup files
      * @return array
-     * @uses createBackup()
      */
     protected function createSomeBackups(): array
     {
@@ -94,7 +93,7 @@ protected function createSomeBackups(): array
      */
     protected function getMockForDriver(string $className, ?array $methods = []): object
     {
-        return $this->getMockBuilder($className)
+        return @$this->getMockBuilder($className)
             ->setMethods($methods)
             ->setConstructorArgs([$this->getConnection('test')])
             ->getMock();
diff --git a/src/Utility/BackupExport.php b/src/Utility/BackupExport.php
@@ -87,9 +87,6 @@ class BackupExport
 
     /**
      * Construct
-     * @uses $BackupManager
-     * @uses $config
-     * @uses $driver
      */
     public function __construct()
     {
@@ -106,10 +103,6 @@ public function __construct()
      * @return $this
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupExport-utility#compression
      * @throws \InvalidArgumentException
-     * @uses getValidCompressions()
-     * @uses $compression
-     * @uses $defaultExtension
-     * @uses $extension
      */
     public function compression(?string $compression)
     {
@@ -135,9 +128,6 @@ public function compression(?string $compression)
      * @throws \Exception
      * @throws \InvalidArgumentException
      * @throws \Tools\Exception\NotWritableException
-     * @uses compression()
-     * @uses $config
-     * @uses $filename
      */
     public function filename(string $filename)
     {
@@ -170,7 +160,6 @@ public function filename(string $filename)
      * @param int $rotate Number of backups you want to keep
      * @return $this
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupExport-utility#rotate
-     * @uses $rotate
      */
     public function rotate(int $rotate)
     {
@@ -184,7 +173,6 @@ public function rotate(int $rotate)
      * @param string|null $recipient Recipient's email address or `null` to disable
      * @return $this
      * @since 1.1.0
-     * @uses $emailRecipient
      */
     public function send(?string $recipient = null)
     {
@@ -197,18 +185,11 @@ public function send(?string $recipient = null)
      * Exports the database
      * @return string Filename path
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupExport-utility#export
-     * @uses filename()
-     * @uses $BackupManager;
-     * @uses $defaultExtension
-     * @uses $emailRecipient
-     * @uses $filename
-     * @uses $extension
-     * @uses $rotate
      */
     public function export(): string
     {
         if (empty($this->filename)) {
-            $this->extension = $this->extension ?? $this->defaultExtension;
+            $this->extension = $this->extension ?: $this->defaultExtension;
             $this->filename(sprintf('backup_{$DATABASE}_{$DATETIME}.%s', $this->extension));
         }
 
diff --git a/src/Utility/BackupImport.php b/src/Utility/BackupImport.php
@@ -42,7 +42,6 @@ class BackupImport
 
     /**
      * Construct
-     * @uses $driver
      */
     public function __construct()
     {
@@ -56,12 +55,10 @@ public function __construct()
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupImport-utility#filename
      * @throws \InvalidArgumentException
      * @throws \Tools\Exception\NotReadableException
-     * @uses $filename
      */
     public function filename(string $filename)
     {
-        $filename = $this->getAbsolutePath($filename);
-        Exceptionist::isReadable($filename);
+        $filename = Exceptionist::isReadable($this->getAbsolutePath($filename));
 
         //Checks for extension
         Exceptionist::isTrue($this->getExtension($filename), __d('database_backup', 'Invalid file extension'), InvalidArgumentException::class);
@@ -76,8 +73,6 @@ public function filename(string $filename)
      * @return string Filename path
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupImport-utility#import
      * @throws \InvalidArgumentException
-     * @uses $driver
-     * @uses $filename
      */
     public function import(): string
     {
diff --git a/src/Utility/BackupManager.php b/src/Utility/BackupManager.php
diff --git a/tests/TestCase/BackupTraitTest.php b/tests/TestCase/BackupTraitTest.php
diff --git a/tests/TestCase/Utility/BackupExportTest.php b/tests/TestCase/Utility/BackupExportTest.php
