updated for php-tools 1.4.1

Author: mirko-pagliai

CHANGELOG.md

@@ -1,5 +1,8 @@
 # 2.x branch
 ## 2.8 branch
+### 2.8.2
+* updated for `php-tools` 1.4.1.
+
 ### 2.8.1
 * fixed I18n translations;
 * fixed [bug for `Command` class](https://github.com/mirko-pagliai/cakephp-database-backup/pull/54).

composer.json

@@ -4,14 +4,16 @@
     "homepage": "https://github.com/mirko-pagliai/cakephp-database-backup",
     "type": "cakephp-plugin",
     "license": "MIT",
-    "authors": [{
+    "authors": [
+        {
             "name": "Mirko Pagliai",
             "email": "mirko.pagliai@gmail.com"
-        }],
+        }
+    ],
     "require": {
         "php": ">=7.2",
         "cakephp/cakephp": "^4.0",
-        "mirko-pagliai/php-tools": "^1.3"
+        "mirko-pagliai/php-tools": "^1.4.1"
     },
     "require-dev": {
         "cakephp/cakephp-codesniffer": "^4.0",

src/BackupTrait.php

@@ -20,6 +20,7 @@
 use Cake\Datasource\ConnectionManager;
 use InvalidArgumentException;
 use Symfony\Component\Filesystem\Filesystem;
+use Tools\Exceptionist;
 
 /**
  * A trait that provides some methods used by all other classes
@@ -87,7 +88,7 @@ public function getDriver(?ConnectionInterface $connection = null): object
         $connection = $connection ?: $this->getConnection();
         $className = get_class_short_name($connection->getDriver());
         $driver = App::classname(sprintf('%s.%s', 'DatabaseBackup', $className), 'Driver');
-        is_true_or_fail(
+        Exceptionist::isTrue(
             $driver,
             __d('database_backup', 'The `{0}` driver does not exist', $className),
             InvalidArgumentException::class

src/Driver/Driver.php

@@ -20,6 +20,7 @@
 use Cake\Event\EventListenerInterface;
 use DatabaseBackup\BackupTrait;
 use RuntimeException;
+use Tools\Exceptionist;
 
 /**
  * Represents a driver containing all methods to export/import database backups
@@ -187,7 +188,7 @@ final public function export(string $filename): bool
         }
 
         exec($this->_exportExecutableWithCompression($filename), $output, $returnVar);
-        is_true_or_fail($returnVar === 0, __d('database_backup', 'Failed with exit code `{0}`', $returnVar));
+        Exceptionist::isTrue($returnVar === 0, __d('database_backup', 'Failed with exit code `{0}`', $returnVar));
 
         $this->dispatchEvent('Backup.afterExport');
 
@@ -203,7 +204,7 @@ final public function export(string $filename): bool
     public function getBinary($name)
     {
         $binary = Configure::read('DatabaseBackup.binaries.' . $name);
-        is_true_or_fail($binary, sprintf('Binary for `%s` could not be found. You have to set its path manually', $name), RuntimeException::class);
+        Exceptionist::isTrue($binary, sprintf('Binary for `%s` could not be found. You have to set its path manually', $name), RuntimeException::class);
 
         return $binary;
     }
@@ -244,7 +245,7 @@ final public function import(string $filename): bool
         }
 
         exec($this->_importExecutableWithCompression($filename), $output, $returnVar);
-        is_true_or_fail($returnVar === 0, __d('database_backup', 'Failed with exit code `{0}`', $returnVar));
+        Exceptionist::isTrue($returnVar === 0, __d('database_backup', 'Failed with exit code `{0}`', $returnVar));
 
         $this->dispatchEvent('Backup.afterImport');
 

src/Utility/BackupExport.php

@@ -19,6 +19,7 @@
 use DatabaseBackup\BackupTrait;
 use InvalidArgumentException;
 use Symfony\Component\Filesystem\Filesystem;
+use Tools\Exceptionist;
 
 /**
  * Utility to export databases
@@ -116,7 +117,7 @@ public function compression(?string $compression)
 
         if ($compression) {
             $this->extension = array_search($compression, $this->getValidCompressions());
-            is_true_or_fail(
+            Exceptionist::isTrue(
                 $this->extension,
                 __d('database_backup', 'Invalid compression type'),
                 InvalidArgumentException::class
@@ -153,11 +154,11 @@ public function filename(string $filename)
         ], $filename);
 
         $filename = $this->getAbsolutePath($filename);
-        is_writable_or_fail(dirname($filename));
-        is_true_or_fail(!file_exists($filename), __d('database_backup', 'File `{0}` already exists', $filename));
+        Exceptionist::isWritable(dirname($filename));
+        Exceptionist::isTrue(!file_exists($filename), __d('database_backup', 'File `{0}` already exists', $filename));
 
         //Checks for extension
-        is_true_or_fail(
+        Exceptionist::isTrue(
             $this->getExtension($filename),
             __d('database_backup', 'Invalid file extension'),
             InvalidArgumentException::class

src/Utility/BackupImport.php

@@ -17,6 +17,7 @@
 
 use DatabaseBackup\BackupTrait;
 use InvalidArgumentException;
+use Tools\Exceptionist;
 
 /**
  * Utility to import databases
@@ -60,10 +61,10 @@ public function __construct()
     public function filename(string $filename)
     {
         $filename = $this->getAbsolutePath($filename);
-        is_readable_or_fail($filename);
+        Exceptionist::isReadable($filename);
 
         //Checks for extension
-        is_true_or_fail(
+        Exceptionist::isTrue(
             $this->getExtension($filename),
             __d('database_backup', 'Invalid file extension'),
             InvalidArgumentException::class
@@ -84,7 +85,7 @@ public function filename(string $filename)
      */
     public function import(): string
     {
-        is_true_or_fail(
+        Exceptionist::isTrue(
             !empty($this->filename),
             __d('database_backup', 'You must first set the filename'),
             InvalidArgumentException::class

src/Utility/BackupManager.php

@@ -24,6 +24,7 @@
 use InvalidArgumentException;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
+use Tools\Exceptionist;
 
 /**
  * Utility to manage database backups
@@ -38,12 +39,13 @@ class BackupManager
      *  The path can be relative to the backup directory
      * @return bool
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupManager-utility#delete
+     * @throws \Tools\Exception\FileNotExistsException
      * @throws \Tools\Exception\NotWritableException
      */
     public function delete(string $filename): bool
     {
         $filename = $this->getAbsolutePath($filename);
-        is_writable_or_fail($filename);
+        Exceptionist::isWritable($filename);
 
         return unlink($filename);
     }
@@ -98,7 +100,7 @@ public function index(): Collection
      */
     public function rotate(int $rotate): array
     {
-        is_true_or_fail(
+        Exceptionist::isTrue(
             is_positive($rotate),
             __d('database_backup', 'Invalid rotate value'),
             InvalidArgumentException::class
@@ -121,7 +123,7 @@ public function rotate(int $rotate): array
     protected function getEmailInstance(string $backup, string $recipient): Email
     {
         $file = $this->getAbsolutePath($backup);
-        is_readable_or_fail($file);
+        Exceptionist::isReadable($file);
         $basename = basename($file);
         $server = env('SERVER_NAME', 'localhost');
 

tests/TestCase/Utility/BackupImportTest.php

@@ -86,7 +86,7 @@ public function testFilename()
 
         //With an invalid directory
         $this->expectException(NotReadableException::class);
-        $this->expectExceptionMessage('File or directory `' . $this->BackupExport->getAbsolutePath('noExistingDir' . DS . 'backup.sql') . '` is not readable');
+        $this->expectExceptionMessage('File or directory `' . $this->BackupExport->getAbsolutePath('noExistingDir' . DS . 'backup.sql') . '` does not exist');
         $this->BackupImport->filename('noExistingDir' . DS . 'backup.sql');
 
         //With invalid extension

tests/TestCase/Utility/BackupManagerTest.php

@@ -23,7 +23,6 @@
 use DatabaseBackup\Utility\BackupManager;
 use InvalidArgumentException;
 use Tools\Exception\NotReadableException;
-use Tools\Exception\NotWritableException;
 
 /**
  * BackupManagerTest class
@@ -83,8 +82,8 @@ public function testDeleteAll()
         $this->assertEmpty($this->BackupManager->index()->toList());
 
         //With a no existing file
-        $this->expectException(NotWritableException::class);
-        $this->expectExceptionMessage('File or directory `' . $this->getAbsolutePath('noExistingFile') . '` is not writable');
+        $this->expectException(NotReadableException::class);
+        $this->expectExceptionMessage('File or directory `' . $this->getAbsolutePath('noExistingFile') . '` does not exist');
         $this->BackupManager->delete('noExistingFile');
     }
 
@@ -187,7 +186,7 @@ public function testSend()
     public function testSendInvalidFile()
     {
         $this->expectException(NotReadableException::class);
-        $this->expectExceptionMessage('File or directory `' . Configure::read('DatabaseBackup.target') . DS . 'noExistingFile` is not readable');
+        $this->expectExceptionMessage('File or directory `' . Configure::read('DatabaseBackup.target') . DS . 'noExistingFile` does not exist');
         $this->BackupManager->send('noExistingFile', 'recipient@example.com');
     }
 }

version

@@ -1 +1 @@
-2.8.1
+2.8.2