Merge pull request #62 from mirko-pagliai/develop

Develop

Author: mirko-pagliai

CHANGELOG.md

@@ -1,5 +1,12 @@
 # 2.x branch
 ## 2.8 branch
+### 2.8.4
+* `BackupManager::delete()` returns the full path;
+* all methods provided by `BackupManager` can now be called statically, except
+    for the `send()` method;
+* extensive improvement of function descriptions and tags;
+* ready for `phpunit` 9.
+
 ### 2.8.3
 * updated for `php-tools` 1.4.5;
 * added `phpstan`, so fixed some code.

README.md

@@ -22,8 +22,10 @@ You can install the plugin via composer:
 $ composer require --prefer-dist mirko-pagliai/cakephp-database-backup
 ```
 
+The current release requires at least CakePHP 4.0, PHP 7.2 and `phpunit` 8.0.
+
 Instead, the [cakephp3](//github.com/mirko-pagliai/cakephp-database-backup/tree/cakephp3)
-branch is compatible with all previous versions of CakePHP from version 3.5.1.
+branch requires at least CakePHP 3.5.1, PHP 5.6 and `phpunit` 5.7.14.
 In this case, you can install the package as well:
 
 ```bash

appveyor.yml

@@ -27,12 +27,13 @@ before_test:
 
 install:
   - cd c:\
-  - curl -fsS -o php.zip https://windows.php.net/downloads/releases/latest/php-7.2-nts-Win32-VC15-x86-latest.zip
+  - curl -fsS -o php.zip https://windows.php.net/downloads/releases/latest/php-7.3-nts-Win32-VC15-x86-latest.zip
   - 7z x php.zip -oc:\php > nul
   - cd c:\php
   - copy php.ini-production php.ini
   - echo date.timezone="UTC" >> php.ini
   - echo extension_dir=ext >> php.ini
+  - echo extension=php_curl.dll >> php.ini
   - echo extension=php_openssl.dll >> php.ini
   - echo extension=php_intl.dll >> php.ini
   - echo extension=php_mbstring.dll >> php.ini

composer.json

@@ -13,12 +13,12 @@
     "require": {
         "php": ">=7.2",
         "cakephp/cakephp": "^4.0",
-        "mirko-pagliai/php-tools": "^1.4.5"
+        "mirko-pagliai/php-tools": "^1.4.7"
     },
     "require-dev": {
         "cakephp/cakephp-codesniffer": "^4.0",
         "mirko-pagliai/me-tools": "^2.19",
-        "phpunit/phpunit": "^8.0"
+        "phpunit/phpunit": "^8.0|^9.0"
     },
     "autoload": {
         "psr-4": {
@@ -39,16 +39,16 @@
             "@test",
             "@composer update",
             "@test",
-            "@stan-setup",
             "@stan"
         ],
         "cs-check": "phpcs --standard=phpcs.xml.dist",
         "cs-fix": "phpcbf --standard=phpcs.xml.dist",
         "test": "phpunit",
-        "test-coverage": "phpunit --coverage-html coverage",
+        "coverage": "XDEBUG_MODE=coverage phpunit --coverage-html=coverage",
         "phpstan": "phpstan.phar analyse",
         "psalm": "psalm.phar",
         "stan": [
+            "@stan-setup",
             "@phpstan",
             "@psalm"
         ],

config/bootstrap.php

@@ -17,20 +17,19 @@
 use Cake\Core\Configure;
 use Tools\Filesystem;
 
-//Sets the redirect to `/dev/null`. This string can be concatenated to shell commands
+//Sets the redirect to `/dev/null`. This string will be concatenated to shell commands
 if (!defined('REDIRECT_TO_DEV_NULL')) {
     define('REDIRECT_TO_DEV_NULL', IS_WIN ? ' 2>nul' : ' 2>/dev/null');
 }
 
-//Binaries
+//Auto-discovers binaries
 foreach (['bzip2', 'gzip', 'mysql', 'mysqldump', 'pg_dump', 'pg_restore', 'sqlite3'] as $binary) {
     if (!Configure::check('DatabaseBackup.binaries.' . $binary)) {
         Configure::write('DatabaseBackup.binaries.' . $binary, which($binary));
     }
 }
 
-//Chmod for backups.
-//This works only on Unix
+//Default chmod for backups. This works only on Unix
 if (!Configure::check('DatabaseBackup.chmod')) {
     Configure::write('DatabaseBackup.chmod', 0664);
 }
@@ -47,7 +46,7 @@
 
 //Default target directory
 if (!Configure::check('DatabaseBackup.target')) {
-    Configure::write('DatabaseBackup.target', (new Filesystem())->addSlashTerm(ROOT) . 'backups');
+    Configure::write('DatabaseBackup.target', Filesystem::instance()->concatenate(ROOT, 'backups'));
 }
 
 //Checks for the target directory

phpstan.neon

@@ -1,5 +1,5 @@
 parameters:
-    level: 6
+    level: 7
 
     paths:
         - config
@@ -19,6 +19,7 @@ parameters:
     ignoreErrors:
         - '#(Ternary operator condition|Negated boolean expression) is always (true|false)\.$#'
         - "#^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\\.$#"
@@ -28,14 +29,9 @@ parameters:
             path: src/Driver/Sqlite.php
 
         -
-            message: "#^Unable to resolve the template type RealInstanceType#"
-            path: src/TestSuite/TestCase.php
+            message: '#^Call to an undefined method [\w\|\\]+MockObject::\w+\(\)\.$#'
+            path: tests/TestCase
 
         -
             message: '#has no return typehint specified\.$#'
             path: tests/TestCase
-
-        -
-            message: "#^Binary operation \"\\+\" between#"
-            count: 3
-            path: tests/TestCase/Driver

psalm.xml

@@ -15,35 +15,47 @@
     </projectFiles>
 
     <issueHandlers>
-        <UndefinedConstant>
+        <InvalidArgument>
             <errorLevel type="suppress">
-                <file name="src/Driver/Driver.php" />
-                <file name="src/TestSuite/DriverTestCase.php" />
+                <file name="src/Driver/Sqlite.php" />
             </errorLevel>
-        </UndefinedConstant>
+        </InvalidArgument>
+
+        <InvalidDocblock>
+            <errorLevel type="suppress">
+                <file name="src/TestSuite/TestCase.php" />
+            </errorLevel>
+        </InvalidDocblock>
 
         <RedundantCondition>
             <errorLevel type="suppress">
                 <file name="src/Driver/Mysql.php" />
             </errorLevel>
         </RedundantCondition>
 
-        <UndefinedInterfaceMethod>
+        <TooManyTemplateParams>
             <errorLevel type="suppress">
-                <file name="src/Driver/Sqlite.php" />
+                <file name="src/Utility/BackupManager.php" />
             </errorLevel>
-        </UndefinedInterfaceMethod>
+        </TooManyTemplateParams>
 
         <UndefinedClass>
             <errorLevel type="suppress">
                 <file name="src/BackupTrait.php" />
             </errorLevel>
         </UndefinedClass>
 
-        <InvalidArgument>
+        <UndefinedConstant>
+            <errorLevel type="suppress">
+                <file name="src/Driver/Driver.php" />
+                <file name="src/TestSuite/DriverTestCase.php" />
+            </errorLevel>
+        </UndefinedConstant>
+
+        <UndefinedInterfaceMethod>
             <errorLevel type="suppress">
                 <file name="src/Driver/Sqlite.php" />
             </errorLevel>
-        </InvalidArgument>
+        </UndefinedInterfaceMethod>
     </issueHandlers>
 </psalm>

src/BackupTrait.php

@@ -35,18 +35,13 @@ trait BackupTrait
     protected static $validExtensions = ['sql.bz2' => 'bzip2', 'sql.gz' => 'gzip', 'sql' => false];
 
     /**
-     * Returns an absolute path
+     * Returns the absolute path for a backup file
      * @param string $path Relative or absolute path
      * @return string
      */
-    public function getAbsolutePath(string $path): string
+    public static function getAbsolutePath(string $path): string
     {
-        $Filesystem = new Filesystem();
-        if (!$Filesystem->isAbsolutePath($path)) {
-            return $Filesystem->addSlashTerm(Configure::read('DatabaseBackup.target')) . $path;
-        }
-
-        return $path;
+        return Filesystem::instance()->makePathAbsolute($path, Configure::read('DatabaseBackup.target'));
     }
 
     /**
@@ -56,13 +51,11 @@ public function getAbsolutePath(string $path): string
      * @uses getExtension()
      * @uses getValidCompressions()
      */
-    public function getCompression(string $filename): ?string
+    public static function getCompression(string $filename): ?string
     {
-        //Gets the extension from the filename
-        $extension = $this->getExtension($filename);
-        $keyExists = array_key_exists($extension, $this->getValidCompressions());
+        $extension = self::getExtension($filename);
 
-        return $keyExists ? $this->getValidCompressions()[$extension] : null;
+        return self::getValidCompressions()[$extension] ?? null;
     }
 
     /**
@@ -79,7 +72,7 @@ public function getConnection(?string $name = null): ConnectionInterface
      * Gets the driver instance containing all methods to export/import database
      *  backups, according to the database engine
      * @param \Cake\Datasource\ConnectionInterface|null $connection A connection object
-     * @return object The driver instance
+     * @return \DatabaseBackup\Driver\Driver A driver instance
      * @since 2.0.0
      * @throws \InvalidArgumentException
      * @uses getConnection()
@@ -101,20 +94,20 @@ public function getDriver(?ConnectionInterface $connection = null): object
      *  if is an invalid extension
      * @uses $validExtensions
      */
-    public function getExtension(string $filename): ?string
+    public static function getExtension(string $filename): ?string
     {
-        $extension = (new Filesystem())->getExtension($filename);
+        $extension = Filesystem::instance()->getExtension($filename);
 
         return in_array($extension, array_keys(self::$validExtensions)) ? $extension : null;
     }
 
     /**
      * Returns all valid compressions
-     * @return array
+     * @return array<string, string>
      * @since 2.4.0
      * @uses $validExtensions
      */
-    public function getValidCompressions(): array
+    public static function getValidCompressions(): array
     {
         return array_filter(self::$validExtensions);
     }

src/Command/ExportCommand.php

@@ -86,9 +86,9 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             //Regarding the `rotate` option, the `BackupShell::rotate()` method
             //  will be called at the end, instead of `BackupExport::rotate()`
             if ($args->getOption('filename')) {
-                $instance->filename($args->getOption('filename'));
+                $instance->filename((string)$args->getOption('filename'));
             } elseif ($args->getOption('compression')) {
-                $instance->compression($args->getOption('compression'));
+                $instance->compression((string)$args->getOption('compression'));
             }
 
             //Exports

src/Command/RotateCommand.php

@@ -67,7 +67,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             }
 
             foreach ($files as $file) {
-                $io->verbose(__d('database_backup', 'Backup `{0}` has been deleted', $file->filename));
+                $io->verbose(__d('database_backup', 'Backup `{0}` has been deleted', $file->get('filename')));
             }
 
             $io->success(__d('database_backup', 'Deleted backup files: {0}', count($files)));