Merge pull request #63 from mirko-pagliai/develop

Develop

Author: mirko-pagliai

.travis.yml

@@ -3,6 +3,8 @@ language: php
 php:
   - 7.2
   - 7.3
+  - 7.4
+  - 8.0
 
 matrix:
   fast_finish: true
@@ -12,6 +14,10 @@ matrix:
       env: dependencies=lowest
     - php: 7.3
       env: dependencies=lowest
+    - php: 7.4
+      env: dependencies=lowest
+    - php: 8.0
+      env: dependencies=lowest
     - php: 7.2
       env: PHPCS=1
     - php: 7.2

CHANGELOG.md

@@ -1,5 +1,9 @@
 # 2.x branch
 ## 2.8 branch
+### 2.8.5
+* ready for php `8.0`;
+* extensive improvement of function descriptions and tags.
+
 ### 2.8.4
 * `BackupManager::delete()` returns the full path;
 * all methods provided by `BackupManager` can now be called statically, except

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"
     }
 }

phpstan.neon

@@ -21,12 +21,8 @@ parameters:
         - "#^Constant REDIRECT_TO_DEV_NULL not found\\.$#"
         - '#^Parameter \#1 \$callback of function array_map expects \(callable\(\): mixed\)\|null#'
         - "#^Static call to instance method Tools\\\\Exceptionist#"
-        - "#^Parameter \\#2 \\$eventManager of method Cake\\\\TestSuite\\\\TestCase\\:\\:assertEventFired\\(\\) expects Cake\\\\Event\\\\EventManager\\|null, Cake\\\\Event\\\\EventManagerInterface given\\.$#"
-        - "#^Parameter \\#1 \\$connection of method Cake\\\\Database\\\\Schema\\\\TableSchema\\:\\:dropSql\\(\\) expects Cake\\\\Database\\\\Connection, Cake\\\\Datasource\\\\ConnectionInterface given\\.$#"
-
-        -
-            message: "#^Call to an undefined method Cake\\\\Datasource\\\\ConnectionInterface#"
-            path: src/Driver/Sqlite.php
+        - '#^Parameter \#\d \$\w+ of method Cake\\[\w\:\\]+\(\) expects#'
+        - '#^Call to an undefined method Cake\\#'
 
         -
             message: '#^Call to an undefined method [\w\|\\]+MockObject::\w+\(\)\.$#'

psalm.xml

@@ -55,6 +55,7 @@
         <UndefinedInterfaceMethod>
             <errorLevel type="suppress">
                 <file name="src/Driver/Sqlite.php" />
+                <file name="src/TestSuite/DriverTestCase.php" />
             </errorLevel>
         </UndefinedInterfaceMethod>
     </issueHandlers>

src/BackupTrait.php

@@ -18,6 +18,7 @@
 use Cake\Core\Configure;
 use Cake\Datasource\ConnectionInterface;
 use Cake\Datasource\ConnectionManager;
+use DatabaseBackup\Driver\Driver;
 use InvalidArgumentException;
 use Tools\Exceptionist;
 use Tools\Filesystem;
@@ -30,7 +31,7 @@ trait BackupTrait
     /**
      * Valid extensions. Names as keys and compressions as values
      * @since 2.4.0
-     * @var array
+     * @var array<string, string|bool>
      */
     protected static $validExtensions = ['sql.bz2' => 'bzip2', 'sql.gz' => 'gzip', 'sql' => false];
 
@@ -47,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
     {
@@ -77,7 +76,7 @@ public function getConnection(?string $name = null): ConnectionInterface
      * @throws \InvalidArgumentException
      * @uses getConnection()
      */
-    public function getDriver(?ConnectionInterface $connection = null): object
+    public function getDriver(?ConnectionInterface $connection = null): Driver
     {
         $connection = $connection ?: $this->getConnection();
         $className = get_class_short_name($connection->getDriver());
@@ -103,7 +102,7 @@ public static function getExtension(string $filename): ?string
 
     /**
      * Returns all valid compressions
-     * @return array<string, string>
+     * @return array
      * @since 2.4.0
      * @uses $validExtensions
      */

src/Command/DeleteAllCommand.php

@@ -20,6 +20,7 @@
 use Cake\Console\ConsoleOptionParser;
 use DatabaseBackup\Console\Command;
 use DatabaseBackup\Utility\BackupManager;
+use Tools\Filesystem;
 
 /**
  * Deletes all backup files
@@ -40,28 +41,25 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * Deletes all backup files
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#delete_all
      * @uses \DatabaseBackup\Utility\BackupManager::deleteAll()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
-        $files = (new BackupManager())->deleteAll();
-
+        $files = BackupManager::deleteAll();
         if (!$files) {
             $io->verbose(__d('database_backup', 'No backup has been deleted'));
 
-            return null;
+            return;
         }
 
         foreach ($files as $file) {
-            $io->verbose(__d('database_backup', 'Backup `{0}` has been deleted', $this->Filesystem->rtr($file)));
+            $io->verbose(__d('database_backup', 'Backup `{0}` has been deleted', Filesystem::instance()->rtr($file)));
         }
 
         $io->success(__d('database_backup', 'Deleted backup files: {0}', count($files)));
-
-        return null;
     }
 }

src/Command/ExportCommand.php

@@ -23,6 +23,7 @@
 use DatabaseBackup\Console\Command;
 use DatabaseBackup\Utility\BackupExport;
 use Exception;
+use Tools\Filesystem;
 
 /**
  * Exports a database backup
@@ -68,15 +69,16 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * This command uses `RotateCommand` and `SendCommand`.
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#export
+     * @throws \Cake\Console\Exception\StopException
      * @uses \DatabaseBackup\Command\RotateCommand::execute()
      * @uses \DatabaseBackup\Command\SendCommand::execute()
      * @uses \DatabaseBackup\Utility\BackupExport::compression()
      * @uses \DatabaseBackup\Utility\BackupExport::export()
      * @uses \DatabaseBackup\Utility\BackupExport::filename()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
@@ -93,7 +95,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
 
             //Exports
             $file = $instance->export();
-            $io->success(__d('database_backup', 'Backup `{0}` has been exported', $this->Filesystem->rtr($file)));
+            $io->success(__d('database_backup', 'Backup `{0}` has been exported', Filesystem::instance()->rtr($file)));
             $verbose = $args->getOption('verbose');
             $quiet = $args->getOption('quiet');
 
@@ -120,7 +122,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             $io->error($e->getMessage());
             $this->abort();
         }
-
-        return null;
     }
 }

src/Command/ImportCommand.php

@@ -21,6 +21,7 @@
 use DatabaseBackup\Console\Command;
 use DatabaseBackup\Utility\BackupImport;
 use Exception;
+use Tools\Filesystem;
 
 /**
  * Imports a database backup
@@ -45,23 +46,22 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * Imports a database backup
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#import
+     * @throws \Cake\Console\Exception\StopException
      * @uses \DatabaseBackup\Utility\BackupImport::filename()
      * @uses \DatabaseBackup\Utility\BackupImport::import()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
         try {
             $file = (new BackupImport())->filename($args->getArgument('filename'))->import();
-            $io->success(__d('database_backup', 'Backup `{0}` has been imported', $this->Filesystem->rtr($file)));
+            $io->success(__d('database_backup', 'Backup `{0}` has been imported', Filesystem::instance()->rtr($file)));
         } catch (Exception $e) {
             $io->error($e->getMessage());
             $this->abort();
         }
-
-        return null;
     }
 }

src/Command/IndexCommand.php

@@ -42,20 +42,19 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * Lists database backups
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#index
      * @uses \DatabaseBackup\Utility\BackupManager::index()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
         //Gets all backups
-        $backups = (new BackupManager())->index();
+        $backups = BackupManager::index();
         $io->out(__d('database_backup', 'Backup files found: {0}', $backups->count()));
-
         if ($backups->isEmpty()) {
-            return null;
+            return;
         }
 
         $headers = [
@@ -65,14 +64,12 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             __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')))
                 ->toArray();
         });
         $io->helper('table')->output(array_merge([$headers], $cells->toList()));
-
-        return null;
     }
 }