Merge branch 'develop' into cakephp4

Author: mirko-pagliai

CHANGELOG.md

@@ -1,7 +1,13 @@
 # 2.x branch
+## 2.8 branch
+### 2.8.0
+* updated for `cakephp` 4 and `phpunit` 8.
+
 ## 2.7 branch
 ### 2.7.0
-* updated for `cakephp` 4 and `phpunit` 8.
+* `BackupTrait::getBinary()` method has been moved to `Driver` abstract class;
+* `BackupTrait::getTarget()`, `BackupTrait::getDriverName()` and
+    `BackupTrait::getValidExtensions()` methods have been removed.
 
 ## 2.6 branch
 ### 2.6.6

phpcs.xml.dist

@@ -4,4 +4,8 @@
     <file>.</file>
 
     <rule ref="./vendor/mirko-pagliai/php-tools/sniffer-ruleset.xml"/>
+
+    <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace.UseFromSameNamespace">
+        <severity>0</severity>
+    </rule>
 </ruleset>

src/BackupTrait.php

@@ -18,7 +18,6 @@
 use Cake\Datasource\ConnectionInterface;
 use Cake\Datasource\ConnectionManager;
 use InvalidArgumentException;
-use RuntimeException;
 use Symfony\Component\Filesystem\Filesystem;
 
 /**
@@ -31,32 +30,20 @@ trait BackupTrait
      * @since 2.4.0
      * @var array
      */
-    private static $validExtensions = ['sql.bz2' => 'bzip2', 'sql.gz' => 'gzip', 'sql' => false];
+    protected static $validExtensions = ['sql.bz2' => 'bzip2', 'sql.gz' => 'gzip', 'sql' => false];
 
     /**
      * Returns an absolute path
      * @param string $path Relative or absolute path
      * @return string
-     * @uses getTarget()
      */
     public function getAbsolutePath(string $path): string
     {
-        return (new Filesystem())->isAbsolutePath($path) ? $path : add_slash_term($this->getTarget()) . $path;
-    }
-
-    /**
-     * Gets a binary path
-     * @param string $name Binary name
-     * @return string
-     * @since 2.0.0
-     * @throws \RuntimeException
-     */
-    public function getBinary(string $name): string
-    {
-        $binary = Configure::read('DatabaseBackup.binaries.' . $name);
-        is_true_or_fail($binary, __d('database_backup', 'Binary for `{0}` could not be found. You have to set its path manually', $name), RuntimeException::class);
+        if (!(new Filesystem())->isAbsolutePath($path)) {
+            return add_slash_term(Configure::read('DatabaseBackup.target')) . $path;
+        }
 
-        return $binary;
+        return $path;
     }
 
     /**
@@ -93,12 +80,11 @@ public function getConnection(?string $name = null): ConnectionInterface
      * @since 2.0.0
      * @throws \InvalidArgumentException
      * @uses getConnection()
-     * @uses getDriverName()
      */
     public function getDriver(?ConnectionInterface $connection = null): object
     {
         $connection = $connection ?: $this->getConnection();
-        $className = $this->getDriverName($connection);
+        $className = get_class_short_name($connection->getDriver());
         $driver = App::classname(sprintf('%s.%s', 'DatabaseBackup', $className), 'Driver');
         is_true_or_fail(
             $driver,
@@ -109,41 +95,18 @@ public function getDriver(?ConnectionInterface $connection = null): object
         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): string
-    {
-        $connection = $connection ?: $this->getConnection();
-
-        return get_class_short_name($connection->getDriver());
-    }
-
     /**
      * Returns the extension from a filename
      * @param string $filename Filename
      * @return string|null Extension or `null` if the extension is not found or
      *  if is an invalid extension
-     * @uses getValidExtensions()
+     * @uses $validExtensions
      */
     public function getExtension(string $filename): ?string
     {
         $extension = get_extension($filename);
 
-        return in_array($extension, $this->getValidExtensions()) ? $extension : null;
-    }
-
-    /**
-     * Returns the target path
-     * @return string
-     */
-    public function getTarget(): string
-    {
-        return Configure::read('DatabaseBackup.target');
+        return in_array($extension, array_keys(self::$validExtensions)) ? $extension : null;
     }
 
     /**
@@ -156,15 +119,4 @@ public function getValidCompressions(): array
     {
         return array_filter(self::$validExtensions);
     }
-
-    /**
-     * Returns all valid extensions
-     * @return array
-     * @since 2.4.0
-     * @uses $validExtensions
-     */
-    public function getValidExtensions(): array
-    {
-        return array_keys(self::$validExtensions);
-    }
 }

src/Console/Command.php

@@ -37,7 +37,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
         $config = $this->getConnection()->config();
 
         $io->out(__d('database_backup', 'Connection: {0}', $config['name']));
-        $io->out(__d('database_backup', 'Driver: {0}', $this->getDriverName($this->getConnection())));
+        $io->out(__d('database_backup', 'Driver: {0}', get_class_short_name($this->getConnection()->getDriver())));
         $io->hr();
 
         return null;

src/Driver/Driver.php

@@ -18,6 +18,7 @@
 use Cake\Event\EventDispatcherTrait;
 use Cake\Event\EventListenerInterface;
 use DatabaseBackup\BackupTrait;
+use RuntimeException;
 
 /**
  * Represents a driver containing all methods to export/import database backups
@@ -121,6 +122,7 @@ public function beforeImport(): bool
      * @param string $filename Filename where you want to export the database
      * @return string
      * @uses _exportExecutable()
+     * @uses getBinary()
      */
     protected function _exportExecutableWithCompression(string $filename): string
     {
@@ -144,6 +146,7 @@ protected function _exportExecutableWithCompression(string $filename): string
      * @param string $filename Filename from which you want to import the database
      * @return string
      * @uses _importExecutable()
+     * @uses getBinary()
      */
     protected function _importExecutableWithCompression(string $filename): string
     {
@@ -190,6 +193,20 @@ final public function export(string $filename): bool
         return file_exists($filename);
     }
 
+    /**
+     * Gets a binary path
+     * @param string $name Binary name
+     * @return string
+     * @throws \RuntimeException
+     */
+    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);
+
+        return $binary;
+    }
+
     /**
      * Gets a config value or the whole configuration
      * @param string|null $key Config key or `null` to get all config values

src/Driver/Mysql.php

@@ -31,6 +31,7 @@ class Mysql extends Driver
     /**
      * Gets the executable command to export the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      * @uses $auth
      */
@@ -47,6 +48,7 @@ protected function _exportExecutable(): string
     /**
      * Gets the executable command to import the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      * @uses $auth
      */

src/Driver/Postgres.php

@@ -47,6 +47,7 @@ protected function getDbnameAsString(): string
     /**
      * Gets the executable command to export the database
      * @return string
+     * @uses getBinary()
      * @uses getDbnameAsString()
      */
     protected function _exportExecutable(): string
@@ -57,6 +58,7 @@ protected function _exportExecutable(): string
     /**
      * Gets the executable command to import the database
      * @return string
+     * @uses getBinary()
      * @uses getDbnameAsString()
      */
     protected function _importExecutable(): string

src/Driver/Sqlite.php

@@ -24,6 +24,7 @@ class Sqlite extends Driver
     /**
      * Gets the executable command to export the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      */
     protected function _exportExecutable(): string
@@ -34,6 +35,7 @@ protected function _exportExecutable(): string
     /**
      * Gets the executable command to import the database
      * @return string
+     * @uses getBinary()
      * @uses getConfig()
      */
     protected function _importExecutable(): string

src/TestSuite/DriverTestCase.php

@@ -122,9 +122,10 @@ public function testExport()
      */
     public function testExportAndImport()
     {
-        foreach ($this->getValidExtensions() as $extension) {
+        foreach (self::$validExtensions as $extension) {
             $this->loadFixtures();
-            $backup = $this->getAbsolutePath(sprintf('example.%s', $extension));
+            $backup = uniqid('example_');
+            $backup = $this->getAbsolutePath($extension ? $backup . '.' . $extension : $backup);
 
             //Initial records. 3 articles and 6 comments
             $initial = $this->getAllRecords();
@@ -193,7 +194,7 @@ public function testExportExecutableWithCompression()
             $expected = sprintf(
                 '%s | %s > %s%s',
                 $basicExecutable,
-                $this->getBinary($compression),
+                $this->Driver->getBinary($compression),
                 escapeshellarg($filename),
                 REDIRECT_TO_DEV_NULL
             );
@@ -240,7 +241,7 @@ public function testImportExecutableWithCompression()
             $result = $this->invokeMethod($this->Driver, '_importExecutableWithCompression', [$filename]);
             $expected = sprintf(
                 '%s -dc %s | %s%s',
-                $this->getBinary($compression),
+                $this->Driver->getBinary($compression),
                 escapeshellarg($filename),
                 $basicExecutable,
                 REDIRECT_TO_DEV_NULL

src/Utility/BackupManager.php

@@ -70,7 +70,7 @@ public function deleteAll(): array
      */
     public function index(): Collection
     {
-        $finder = (new Finder())->files()->name('/\.sql(\.(gz|bz2))?$/')->in($this->getTarget());
+        $finder = (new Finder())->files()->name('/\.sql(\.(gz|bz2))?$/')->in(Configure::read('DatabaseBackup.target'));
 
         return collection($finder)->map(function (SplFileInfo $file) {
             return new Entity([