Merge pull request #38 from mirko-pagliai/develop

Develop

Author: mirko-pagliai

.gitignore

@@ -1,4 +1,5 @@
 .directory
+.phpunit.result.cache
 *_old
 *.old.*
 composer.lock

CHANGELOG.md

@@ -1,6 +1,16 @@
 # 2.x branch
 ## 2.6 branch
 ### 2.6.2
+* added `BackupTrait::getDriverName()` method;
+* `BackupExport::compression()` takes a compression type name as string or
+    `null` to disable compression;
+* `BackupExport::send()` takes a recipient's email address as string or `null`
+    to disable sending backup;
+* `BackupTrait::getCompression()` returns `null` with no compression;
+* the `DriverTestCase` class now implements `testExportOnFailure()` and
+    `testImportOnFailure()` test methods;
+* improved printing of the backup table for the `IndexCommand`;
+* updated for `php-tools` 1.2 and `me-tools` 2.18.7.
 * added [API](//mirko-pagliai.github.io/cakephp-database-backup).
 
 ### 2.6.1

appveyor.yml

@@ -27,7 +27,7 @@ before_test:
 
 install:
   - cd c:\
-  - curl -fsS -o php.zip https://windows.php.net/downloads/releases/php-5.6.40-nts-Win32-VC11-x86.zip
+  - curl -fsS -o php.zip https://windows.php.net/downloads/releases/php-7.2.18-nts-Win32-VC15-x86.zip
   - 7z x php.zip -oc:\php > nul
   - cd c:\php
   - copy php.ini-production php.ini

composer.json

@@ -11,11 +11,11 @@
     "require": {
         "php": ">=5.5.9",
         "cakephp/cakephp": "^3.7",
-        "mirko-pagliai/php-tools": "^1.1.12"
+        "mirko-pagliai/php-tools": "^1.2"
     },
     "require-dev": {
         "cakephp/cakephp-codesniffer": "^3.0",
-        "mirko-pagliai/me-tools": "^2.18.3",
+        "mirko-pagliai/me-tools": "^2.18.7",
         "phpunit/phpunit": "^5.7|^6.0"
     },
     "autoload": {

config/bootstrap.php

@@ -11,6 +11,7 @@
  * @license     https://opensource.org/licenses/mit-license.php MIT License
  * @see         https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Configuration
  */
+
 use Cake\Core\Configure;
 
 //Sets the redirect to `/dev/null`. This string can be concatenated to shell commands

src/BackupTrait.php

@@ -56,16 +56,17 @@ public function getBinary($name)
     /**
      * Returns the compression type from a filename
      * @param string $filename Filename
-     * @return string|bool Compression type as string or `false`
+     * @return string|null Compression type as string or `null`
      * @uses getExtension()
      * @uses getValidCompressions()
      */
     public function getCompression($filename)
     {
         //Gets the extension from the filename
         $extension = $this->getExtension($filename);
+        $keyExists = array_key_exists($extension, $this->getValidCompressions());
 
-        return array_key_exists($extension, $this->getValidCompressions()) ? $this->getValidCompressions()[$extension] : false;
+        return $keyExists ? $this->getValidCompressions()[$extension] : null;
     }
 
     /**
@@ -79,24 +80,43 @@ public function getConnection($name = null)
     }
 
     /**
-     * Gets the driver containing all methods to export/import database backups
-     *  according to the database engine
+     * 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 A driver instance
+     * @return object The driver instance
      * @since 2.0.0
-     * @throws InvalidArgumentException
+     * @throws \InvalidArgumentException
      * @uses getConnection()
+     * @uses getDriverName()
      */
     public function getDriver(ConnectionInterface $connection = null)
     {
         $connection = $connection ?: $this->getConnection();
-        $className = get_class_short_name($connection->getDriver());
+        $className = $this->getDriverName($connection);
         $driver = App::classname(sprintf('%s.%s', 'DatabaseBackup', $className), 'Driver');
-        is_true_or_fail($driver, __d('database_backup', 'The `{0}` driver does not exist', $className), InvalidArgumentException::class);
+        is_true_or_fail(
+            $driver,
+            __d('database_backup', 'The `{0}` driver does not exist', $className),
+            InvalidArgumentException::class
+        );
 
         return new $driver($connection);
     }
 
+    /**
+     * Gets the driver name, according to the database engine
+     * @param \Cake\Datasource\ConnectionInterface|null $connection A connection object
+     * @return string The driver name
+     * @since 2.6.2
+     * @uses getConnection()
+     */
+    public function getDriverName(ConnectionInterface $connection = null)
+    {
+        $connection = $connection ?: $this->getConnection();
+
+        return get_class_short_name(get_class($connection->getDriver()));
+    }
+
     /**
      * Returns the extension from a filename
      * @param string $filename Filename

src/Command/DeleteAllCommand.php

@@ -26,8 +26,8 @@ class DeleteAllCommand extends Command
 {
     /**
      * Hook method for defining this command's option parser
-     * @param ConsoleOptionParser $parser The parser to be defined
-     * @return ConsoleOptionParser
+     * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
+     * @return \Cake\Console\ConsoleOptionParser
      */
     protected function buildOptionParser(ConsoleOptionParser $parser)
     {
@@ -36,8 +36,8 @@ protected function buildOptionParser(ConsoleOptionParser $parser)
 
     /**
      * Deletes all backup files
-     * @param Arguments $args The command arguments
-     * @param ConsoleIo $io The console io
+     * @param \Cake\Console\Arguments $args The command arguments
+     * @param \Cake\Console\ConsoleIo $io The console io
      * @return null|int The exit code or null for success
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#delete_all
      * @uses DatabaseBackup\Utility\BackupManager::deleteAll()
@@ -46,7 +46,7 @@ public function execute(Arguments $args, ConsoleIo $io)
     {
         parent::execute($args, $io);
 
-        $files = (new BackupManager)->deleteAll();
+        $files = (new BackupManager())->deleteAll();
 
         if (!$files) {
             $io->verbose(__d('database_backup', 'No backup has been deleted'));

src/Command/ExportCommand.php

@@ -29,8 +29,8 @@ class ExportCommand extends Command
 {
     /**
      * Hook method for defining this command's option parser
-     * @param ConsoleOptionParser $parser The parser to be defined
-     * @return ConsoleOptionParser
+     * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
+     * @return \Cake\Console\ConsoleOptionParser
      */
     protected function buildOptionParser(ConsoleOptionParser $parser)
     {
@@ -47,8 +47,9 @@ protected function buildOptionParser(ConsoleOptionParser $parser)
                     'short' => 'f',
                 ],
                 'rotate' => [
-                    'help' => __d('database_backup', 'Rotates backups. You have to indicate the number of backups you ' .
-                        'want to keep. So, it will delete all backups that are older. By default, no backup will be deleted'),
+                    'help' => __d('database_backup', 'Rotates backups. You have to indicate the number of backups' .
+                        'you ìwant to keep. So, it will delete all backups that are older. By default, no backup' .
+                        'will be deleted'),
                     'short' => 'r',
                 ],
                 'send' => [
@@ -63,8 +64,8 @@ protected function buildOptionParser(ConsoleOptionParser $parser)
      * Exports a database backup.
      *
      * This command uses `RotateCommand` and `SendCommand`.
-     * @param Arguments $args The command arguments
-     * @param ConsoleIo $io The console io
+     * @param \Cake\Console\Arguments $args The command arguments
+     * @param \Cake\Console\ConsoleIo $io The console io
      * @return null|int The exit code or null for success
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#export
      * @uses DatabaseBackup\Command\RotateCommand::execute()
@@ -78,13 +79,13 @@ public function execute(Arguments $args, ConsoleIo $io)
         parent::execute($args, $io);
 
         try {
-            $instance = new BackupExport;
+            $instance = new BackupExport();
             //Sets the output filename or the compression type.
             //Regarding the `rotate` option, the `BackupShell::rotate()` method
             //  will be called at the end, instead of `BackupExport::rotate()`
-            if ($args->hasOption('filename')) {
+            if ($args->getOption('filename')) {
                 $instance->filename($args->getOption('filename'));
-            } elseif ($args->hasOption('compression')) {
+            } elseif ($args->getOption('compression')) {
                 $instance->compression($args->getOption('compression'));
             }
 
@@ -95,8 +96,8 @@ public function execute(Arguments $args, ConsoleIo $io)
             $quiet = $args->getOption('quiet');
 
             //Sends via email
-            if ($args->hasOption('send')) {
-                $SendCommand = new SendCommand;
+            if ($args->getOption('send')) {
+                $SendCommand = new SendCommand();
                 $SendCommand->execute(new Arguments(
                     [$file, $args->getOption('send')],
                     compact('verbose', 'quiet'),
@@ -105,8 +106,8 @@ public function execute(Arguments $args, ConsoleIo $io)
             }
 
             //Rotates
-            if ($args->hasOption('rotate')) {
-                $RotateCommand = new RotateCommand;
+            if ($args->getOption('rotate')) {
+                $RotateCommand = new RotateCommand();
                 $RotateCommand->execute(new Arguments(
                     [$args->getOption('rotate')],
                     compact('verbose', 'quiet'),

src/Command/ImportCommand.php

@@ -27,8 +27,8 @@ class ImportCommand extends Command
 {
     /**
      * Hook method for defining this command's option parser
-     * @param ConsoleOptionParser $parser The parser to be defined
-     * @return ConsoleOptionParser
+     * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
+     * @return \Cake\Console\ConsoleOptionParser
      */
     protected function buildOptionParser(ConsoleOptionParser $parser)
     {
@@ -41,8 +41,8 @@ protected function buildOptionParser(ConsoleOptionParser $parser)
 
     /**
      * Imports a database backup
-     * @param Arguments $args The command arguments
-     * @param ConsoleIo $io The console io
+     * @param \Cake\Console\Arguments $args The command arguments
+     * @param \Cake\Console\ConsoleIo $io The console io
      * @return null|int The exit code or null for success
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#import
      * @uses DatabaseBackup\Utility\BackupImport::filename()
@@ -53,7 +53,7 @@ public function execute(Arguments $args, ConsoleIo $io)
         parent::execute($args, $io);
 
         try {
-            $file = (new BackupImport)->filename($args->getArgument('filename'))->import();
+            $file = (new BackupImport())->filename($args->getArgument('filename'))->import();
             $io->success(__d('database_backup', 'Backup `{0}` has been imported', rtr($file)));
         } catch (Exception $e) {
             $io->error($e->getMessage());

src/Command/IndexCommand.php

@@ -28,8 +28,8 @@ class IndexCommand extends Command
 {
     /**
      * Hook method for defining this command's option parser
-     * @param ConsoleOptionParser $parser The parser to be defined
-     * @return ConsoleOptionParser
+     * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
+     * @return \Cake\Console\ConsoleOptionParser
      */
     protected function buildOptionParser(ConsoleOptionParser $parser)
     {
@@ -38,8 +38,8 @@ protected function buildOptionParser(ConsoleOptionParser $parser)
 
     /**
      * Lists database backups
-     * @param Arguments $args The command arguments
-     * @param ConsoleIo $io The console io
+     * @param \Cake\Console\Arguments $args The command arguments
+     * @param \Cake\Console\ConsoleIo $io The console io
      * @return null|int The exit code or null for success
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#index
      * @uses DatabaseBackup\Utility\BackupManager::index()
@@ -49,7 +49,7 @@ public function execute(Arguments $args, ConsoleIo $io)
         parent::execute($args, $io);
 
         //Gets all backups
-        $backups = (new BackupManager)->index();
+        $backups = (new BackupManager())->index();
         $io->out(__d('database_backup', 'Backup files found: {0}', $backups->count()));
 
         if ($backups->isEmpty()) {
@@ -64,7 +64,10 @@ public function execute(Arguments $args, ConsoleIo $io)
             __d('database_backup', 'Datetime'),
         ];
         $cells = $backups->map(function (Entity $backup) {
-            return $backup->set('size', Number::toReadableSize($backup->size))->toArray();
+            return $backup->set('compression', $backup->compression ?: '')
+                ->set('datetime', $backup->datetime->nice())
+                ->set('size', Number::toReadableSize($backup->size))
+                ->toArray();
         });
         $io->helper('table')->output(array_merge([$headers], $cells->toList()));