Develop (#43)

* improved exception message when no binary file is found

* no longer uses the `Folder` class

* updated

* fixed

* Develop dependencies (#42)

added tests for lower dependencies

* updated

* come back

* fixed

* fixed

* updated

* little fixes for `BackupManager` and `BackupExport` classes

* test

* fixed typo

* little fixes

* fixed

Author: mirko-pagliai

.travis.yml

@@ -11,15 +11,21 @@ matrix:
   fast_finish: true
 
   include:
+    - php: 5.6
+      env: dependencies=lowest
+    - php: 7.0
+      env: dependencies=lowest
+    - php: 7.1
+      env: dependencies=lowest
+    - php: 7.2
+      env: dependencies=lowest
+    - php: 7.3
+      env: dependencies=lowest
     - php: 7.0
       env: PHPCS=1
-
     - php: 7.0
       env: COVERAGE=1
 
-    - php: 7.0
-      env: CAKEPHP_VERSION="3.7.*"
-
 services:
   - mysql
   - postgresql
@@ -28,9 +34,10 @@ addons:
   postgresql: "9.4"
 
 install:
-  - composer self-update
+  - composer self-update -q
   - composer install --prefer-dist --no-interaction
-  - if [[ ! -z "$CAKEPHP_VERSION" ]]; then composer require --update-with-dependencies cakephp/cakephp:${CAKEPHP_VERSION}; fi
+  - if [ "$dependencies" = "lowest" ]; then composer update --prefer-lowest -n; fi;
+  - composer show -i
 
 before_script:
   - mysql -e 'create database test;'

CHANGELOG.md

@@ -1,5 +1,11 @@
 # 2.x branch
 ## 2.6 branch
+### 2.6.4
+* little fixes for `BackupManager` and `BackupExport` classes;
+* added tests for lower dependencies;
+* improved exception message when no binary file is found;
+* no longer uses the `Folder` class.
+
 ### 2.6.3
 * little fixes.
 

appveyor.yml

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

composer.json

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

src/BackupTrait.php

@@ -16,8 +16,8 @@
 use Cake\Core\Configure;
 use Cake\Datasource\ConnectionInterface;
 use Cake\Datasource\ConnectionManager;
-use Cake\Filesystem\Folder;
 use InvalidArgumentException;
+use RuntimeException;
 
 /**
  * A trait that provides some methods used by all other classes
@@ -39,18 +39,22 @@ trait BackupTrait
      */
     public function getAbsolutePath($path)
     {
-        return Folder::isAbsolute($path) ? $path : $this->getTarget() . DS . $path;
+        return is_absolute($path) ? $path : $this->getTarget() . DS . $path;
     }
 
     /**
      * Gets a binary path
      * @param string $name Binary name
      * @return string
      * @since 2.0.0
+     * @throws \RuntimeException
      */
     public function getBinary($name)
     {
-        return Configure::readOrFail('DatabaseBackup.binaries.' . $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);
+
+        return $binary;
     }
 
     /**
@@ -144,7 +148,7 @@ public function getTarget()
      * Returns all valid compressions
      * @return array
      * @since 2.4.0
-     * @uses $$validExtensions
+     * @uses $validExtensions
      */
     public function getValidCompressions()
     {

src/Plugin.php

@@ -33,13 +33,11 @@ class Plugin extends BasePlugin
      */
     public function console($commands)
     {
-        $commands->add('database_backup.delete_all', DeleteAllCommand::class);
-        $commands->add('database_backup.export', ExportCommand::class);
-        $commands->add('database_backup.import', ImportCommand::class);
-        $commands->add('database_backup.index', IndexCommand::class);
-        $commands->add('database_backup.rotate', RotateCommand::class);
-        $commands->add('database_backup.send', SendCommand::class);
-
-        return $commands;
+        return $commands->add('database_backup.delete_all', DeleteAllCommand::class)
+            ->add('database_backup.export', ExportCommand::class)
+            ->add('database_backup.import', ImportCommand::class)
+            ->add('database_backup.index', IndexCommand::class)
+            ->add('database_backup.rotate', RotateCommand::class)
+            ->add('database_backup.send', SendCommand::class);
     }
 }

src/TestSuite/DriverTestCase.php

@@ -16,7 +16,6 @@
 use Cake\Core\Configure;
 use Cake\Database\Connection;
 use Cake\Event\EventList;
-use Cake\ORM\TableRegistry;
 use DatabaseBackup\TestSuite\TestCase;
 use ErrorException;
 
@@ -38,13 +37,13 @@ abstract class DriverTestCase extends TestCase
     protected $Comments;
 
     /**
-     * @var object
+     * @var \DatabaseBackup\Driver\Driver
      */
     protected $Driver;
 
     /**
      * @since 2.5.1
-     * @var object
+     * @var string
      */
     protected $DriverClass;
 
@@ -75,12 +74,11 @@ public function setUp()
 
         Configure::write('DatabaseBackup.connection', $this->connection);
         $connection = $this->getConnection();
-        TableRegistry::clear();
-        $this->Articles = TableRegistry::get('Articles', compact('connection'));
-        $this->Comments = TableRegistry::get('Comments', compact('connection'));
+        $this->Articles = $this->getTable('Articles', compact('connection'));
+        $this->Comments = $this->getTable('Comments', compact('connection'));
 
         //Enable event tracking
-        $this->Driver = new $this->DriverClass($this->getConnection());
+        $this->Driver = new $this->DriverClass($connection);
         $this->Driver->getEventManager()->setEventList(new EventList());
     }
 
@@ -324,9 +322,10 @@ public function testImportExecutableWithCompression()
      */
     public function testImportOnFailure()
     {
+        $backup = $this->getAbsolutePath('example.sql');
+
         $this->expectException(ErrorException::class);
         $this->expectExceptionMessageRegExp('/^Failed with exit code `\d`$/');
-        $backup = $this->getAbsolutePath('example.sql');
         $this->Driver->export($backup);
 
         //Sets a no existing database

src/TestSuite/TestCase.php

@@ -47,10 +47,10 @@ public function setUp()
      */
     public function tearDown()
     {
-        parent::tearDown();
-
         //Deletes all backup files
-        @unlink_recursive(Configure::read('DatabaseBackup.target'));
+        unlink_recursive(Configure::read('DatabaseBackup.target'));
+
+        parent::tearDown();
     }
 
     /**

src/Utility/BackupExport.php

@@ -16,6 +16,7 @@
 use Cake\Core\Configure;
 use DatabaseBackup\BackupTrait;
 use InvalidArgumentException;
+use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * Utility to export databases
@@ -211,32 +212,19 @@ public function send($recipient = null)
     public function export()
     {
         if (empty($this->filename)) {
-            if (empty($this->extension)) {
-                $this->extension = $this->defaultExtension;
-            }
-
+            $this->extension = $this->extension ?: $this->defaultExtension;
             $this->filename(sprintf('backup_{$DATABASE}_{$DATETIME}.%s', $this->extension));
         }
 
-        //This allows the filename to be set again with a next call of this
-        //  method
+        //This allows the filename to be set again with a next call of this method
         $filename = $this->filename;
         unset($this->filename);
 
         $this->driver->export($filename);
+        (new Filesystem())->chmod($filename, Configure::read('DatabaseBackup.chmod'));
 
-        if (!IS_WIN) {
-            chmod($filename, Configure::read('DatabaseBackup.chmod'));
-        }
-
-        if ($this->emailRecipient) {
-            $this->BackupManager->send($filename, $this->emailRecipient);
-        }
-
-        //Rotates backups
-        if ($this->rotate) {
-            $this->BackupManager->rotate($this->rotate);
-        }
+        $this->emailRecipient ? $this->BackupManager->send($filename, $this->emailRecipient) : null;
+        $this->rotate ? $this->BackupManager->rotate($this->rotate) : null;
 
         return $filename;
     }

src/Utility/BackupManager.php

@@ -14,12 +14,13 @@
 namespace DatabaseBackup\Utility;
 
 use Cake\Core\Configure;
-use Cake\Filesystem\Folder;
 use Cake\I18n\FrozenTime;
 use Cake\Mailer\Email;
 use Cake\ORM\Entity;
 use DatabaseBackup\BackupTrait;
 use InvalidArgumentException;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\SplFileInfo;
 
 /**
  * Utility to manage database backups
@@ -54,9 +55,9 @@ public function delete($filename)
      */
     public function deleteAll()
     {
-        return array_filter(array_map(function ($file) {
-            return !$this->delete($file->filename) ?: $file->filename;
-        }, $this->index()->toList()));
+        return array_filter(array_map(function ($filename) {
+            return !$this->delete($filename) ?: $filename;
+        }, $this->index()->extract('filename')->toList()));
     }
 
     /**
@@ -67,19 +68,17 @@ public function deleteAll()
      */
     public function index()
     {
-        $target = $this->getTarget();
+        $finder = (new Finder())->files()->name('/\.sql(\.(gz|bz2))?$/')->in($this->getTarget());
 
-        return collection((new Folder($target))->find('.+\.sql(\.(gz|bz2))?'))
-            ->map(function ($filename) use ($target) {
-                return new Entity([
-                    'filename' => $filename,
-                    'extension' => $this->getExtension($filename),
-                    'compression' => $this->getCompression($filename),
-                    'size' => filesize($target . DS . $filename),
-                    'datetime' => new FrozenTime(date('Y-m-d H:i:s', filemtime($target . DS . $filename))),
-                ]);
-            })
-            ->sortBy('datetime');
+        return collection($finder)->map(function (SplFileInfo $file) {
+            return new Entity([
+                'filename' => $file->getFilename(),
+                'extension' => $this->getExtension($file->getFilename()),
+                'compression' => $this->getCompression($file->getFilename()),
+                'size' => $file->getSize(),
+                'datetime' => FrozenTime::createFromTimestamp($file->getMTime()),
+            ]);
+        })->sortBy('datetime');
     }
 
     /**
@@ -102,13 +101,9 @@ public function rotate($rotate)
             InvalidArgumentException::class
         );
         $backupsToBeDeleted = $this->index()->skip((int)$rotate);
+        array_map([$this, 'delete'], $backupsToBeDeleted->extract('filename')->toList());
 
-        //Deletes
-        foreach ($backupsToBeDeleted as $backup) {
-            $this->delete($backup->filename);
-        }
-
-        return $backupsToBeDeleted->toArray();
+        return $backupsToBeDeleted->toList();
     }
 
     /**