Merge pull request #61 from mirko-pagliai/develop

Develop

Author: mirko-pagliai

CHANGELOG.md

@@ -1,5 +1,9 @@
 # 2.x branch
 ## 2.8 branch
+### 2.8.3
+* updated for `php-tools` 1.4.5;
+* added `phpstan`, so fixed some code.
+
 ### 2.8.2
 * updated for `php-tools` 1.4.1.
 

composer.json

@@ -13,7 +13,7 @@
     "require": {
         "php": ">=7.2",
         "cakephp/cakephp": "^4.0",
-        "mirko-pagliai/php-tools": "^1.4.1"
+        "mirko-pagliai/php-tools": "^1.4.5"
     },
     "require-dev": {
         "cakephp/cakephp-codesniffer": "^4.0",
@@ -31,5 +31,28 @@
             "Cake\\Test\\": "vendor/cakephp/cakephp/tests",
             "DatabaseBackup\\Test\\": "tests"
         }
+    },
+    "scripts": {
+        "check": [
+            "@cs-check",
+            "@update-lowest",
+            "@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",
+        "phpstan": "phpstan.phar analyse",
+        "psalm": "psalm.phar",
+        "stan": [
+            "@phpstan",
+            "@psalm"
+        ],
+        "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:^0.12 psalm/phar:^3.18 && mv composer.backup composer.json",
+        "update-lowest": "@composer update --prefer-lowest"
     }
 }

config/bootstrap.php

@@ -15,6 +15,7 @@
  */
 
 use Cake\Core\Configure;
+use Tools\Filesystem;
 
 //Sets the redirect to `/dev/null`. This string can be concatenated to shell commands
 if (!defined('REDIRECT_TO_DEV_NULL')) {
@@ -46,13 +47,12 @@
 
 //Default target directory
 if (!Configure::check('DatabaseBackup.target')) {
-    Configure::write('DatabaseBackup.target', ROOT . DS . 'backups');
+    Configure::write('DatabaseBackup.target', (new Filesystem())->addSlashTerm(ROOT) . 'backups');
 }
 
 //Checks for the target directory
 $target = Configure::read('DatabaseBackup.target');
-@mkdir($target);
-
+@mkdir($target, 0777);
 if (!is_writeable($target)) {
     trigger_error(sprintf('Directory %s not writeable', $target), E_USER_ERROR);
 }

phpstan.neon

@@ -0,0 +1,41 @@
+parameters:
+    level: 6
+
+    paths:
+        - config
+        - src
+        - tests
+
+    bootstrapFiles:
+        - tests/bootstrap.php
+
+    checkGenericClassInNonGenericObjectType: false
+    checkMissingIterableValueType: false
+    treatPhpDocTypesAsCertain: false
+
+    excludes_analyse:
+        -  tests/test_app/
+
+    ignoreErrors:
+        - '#(Ternary operator condition|Negated boolean expression) is always (true|false)\.$#'
+        - "#^Constant REDIRECT_TO_DEV_NULL not found\\.$#"
+        - "#^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\\.$#"
+
+        -
+            message: "#^Call to an undefined method Cake\\\\Datasource\\\\ConnectionInterface#"
+            path: src/Driver/Sqlite.php
+
+        -
+            message: "#^Unable to resolve the template type RealInstanceType#"
+            path: src/TestSuite/TestCase.php
+
+        -
+            message: '#has no return typehint specified\.$#'
+            path: tests/TestCase
+
+        -
+            message: "#^Binary operation \"\\+\" between#"
+            count: 3
+            path: tests/TestCase/Driver

psalm.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="4"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    autoloader="tests/bootstrap.php"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <UndefinedConstant>
+            <errorLevel type="suppress">
+                <file name="src/Driver/Driver.php" />
+                <file name="src/TestSuite/DriverTestCase.php" />
+            </errorLevel>
+        </UndefinedConstant>
+
+        <RedundantCondition>
+            <errorLevel type="suppress">
+                <file name="src/Driver/Mysql.php" />
+            </errorLevel>
+        </RedundantCondition>
+
+        <UndefinedInterfaceMethod>
+            <errorLevel type="suppress">
+                <file name="src/Driver/Sqlite.php" />
+            </errorLevel>
+        </UndefinedInterfaceMethod>
+
+        <UndefinedClass>
+            <errorLevel type="suppress">
+                <file name="src/BackupTrait.php" />
+            </errorLevel>
+        </UndefinedClass>
+
+        <InvalidArgument>
+            <errorLevel type="suppress">
+                <file name="src/Driver/Sqlite.php" />
+            </errorLevel>
+        </InvalidArgument>
+    </issueHandlers>
+</psalm>

src/BackupTrait.php

@@ -19,8 +19,8 @@
 use Cake\Datasource\ConnectionInterface;
 use Cake\Datasource\ConnectionManager;
 use InvalidArgumentException;
-use Symfony\Component\Filesystem\Filesystem;
 use Tools\Exceptionist;
+use Tools\Filesystem;
 
 /**
  * A trait that provides some methods used by all other classes
@@ -41,8 +41,9 @@ trait BackupTrait
      */
     public function getAbsolutePath(string $path): string
     {
-        if (!(new Filesystem())->isAbsolutePath($path)) {
-            return add_slash_term(Configure::read('DatabaseBackup.target')) . $path;
+        $Filesystem = new Filesystem();
+        if (!$Filesystem->isAbsolutePath($path)) {
+            return $Filesystem->addSlashTerm(Configure::read('DatabaseBackup.target')) . $path;
         }
 
         return $path;
@@ -88,11 +89,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');
-        Exceptionist::isTrue(
-            $driver,
-            __d('database_backup', 'The `{0}` driver does not exist', $className),
-            InvalidArgumentException::class
-        );
+        Exceptionist::isTrue($driver, __d('database_backup', 'The `{0}` driver does not exist', $className), InvalidArgumentException::class);
 
         return new $driver($connection);
     }
@@ -106,7 +103,7 @@ public function getDriver(?ConnectionInterface $connection = null): object
      */
     public function getExtension(string $filename): ?string
     {
-        $extension = get_extension($filename);
+        $extension = (new Filesystem())->getExtension($filename);
 
         return in_array($extension, array_keys(self::$validExtensions)) ? $extension : null;
     }

src/Command/DeleteAllCommand.php

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

src/Command/ExportCommand.php

@@ -93,15 +93,15 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
 
             //Exports
             $file = $instance->export();
-            $io->success(__d('database_backup', 'Backup `{0}` has been exported', rtr($file)));
+            $io->success(__d('database_backup', 'Backup `{0}` has been exported', $this->Filesystem->rtr($file)));
             $verbose = $args->getOption('verbose');
             $quiet = $args->getOption('quiet');
 
             //Sends via email
             if ($args->getOption('send')) {
                 $SendCommand = new SendCommand();
                 $SendCommand->execute(new Arguments(
-                    [$file, $args->getOption('send')],
+                    [$file, (string)$args->getOption('send')],
                     compact('verbose', 'quiet'),
                     $SendCommand->getOptionParser()->argumentNames()
                 ), $io);
@@ -111,7 +111,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             if ($args->getOption('rotate')) {
                 $RotateCommand = new RotateCommand();
                 $RotateCommand->execute(new Arguments(
-                    [$args->getOption('rotate')],
+                    [(string)$args->getOption('rotate')],
                     compact('verbose', 'quiet'),
                     $RotateCommand->getOptionParser()->argumentNames()
                 ), $io);

src/Command/ImportCommand.php

@@ -56,7 +56,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
 
         try {
             $file = (new BackupImport())->filename($args->getArgument('filename'))->import();
-            $io->success(__d('database_backup', 'Backup `{0}` has been imported', rtr($file)));
+            $io->success(__d('database_backup', 'Backup `{0}` has been imported', $this->Filesystem->rtr($file)));
         } catch (Exception $e) {
             $io->error($e->getMessage());
             $this->abort();

src/Command/IndexCommand.php

@@ -66,9 +66,9 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             __d('database_backup', 'Datetime'),
         ];
         $cells = $backups->map(function (Entity $backup) {
-            return $backup->set('compression', $backup->compression ?: '')
-                ->set('datetime', $backup->datetime->nice())
-                ->set('size', Number::toReadableSize($backup->size))
+            return $backup->set('compression', $backup->get('compression') ?: '')
+                ->set('datetime', $backup->get('datetime')->nice())
+                ->set('size', Number::toReadableSize($backup->get('size')))
                 ->toArray();
         });
         $io->helper('table')->output(array_merge([$headers], $cells->toList()));