Migrate commands to the new format

Ref: #190

Author: williamdes

src/Shell/CleanOldNotifsShell.php src/Command/CleanOldNotifsCommand.phpsrc/Shell/CleanOldNotifsShell.php renamed to src/Command/CleanOldNotifsCommand.php

@@ -1,8 +1,6 @@
 <?php
 
 /**
- * Clean Old Notifications Shell.
- *
  * phpMyAdmin Error reporting server
  * Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
  *
@@ -16,7 +14,7 @@
  * @see      https://www.phpmyadmin.net/
  */
 
-namespace App\Shell;
+namespace App\Command;
 
 use App\Model\Table\NotificationsTable;
 use Cake\Command\Command;
@@ -28,23 +26,18 @@
 use function date;
 use function time;
 
-/**
- * Clean old Notifications shell.
- */
-class CleanOldNotifsShell extends Command
+class CleanOldNotifsCommand extends Command
 {
-    protected const NAME = 'clean_old_notifs';
-
-    /**
-     * The name of this command.
-     */
-    protected string $name = self::NAME;
-
     protected NotificationsTable $Notifications;
 
     public static function defaultName(): string
     {
-        return self::NAME;
+        return 'clean_old_notifs';
+    }
+
+    public static function getDescription(): string
+    {
+        return 'Clean old Notifications';
     }
 
     protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser

src/Shell/ConsoleShell.php src/Command/ConsoleCommand.phpsrc/Shell/ConsoleShell.php renamed to src/Command/ConsoleCommand.php

@@ -15,7 +15,7 @@
  * @since     3.0.0
  */
 
-namespace App\Shell;
+namespace App\Command;
 
 use Cake\Command\Command;
 use Cake\Console\Arguments;
@@ -28,21 +28,16 @@
 use function restore_error_handler;
 use function restore_exception_handler;
 
-/**
- * Simple console wrapper around Psy\Shell.
- */
-class ConsoleShell extends Command
+class ConsoleCommand extends Command
 {
-    protected const NAME = 'console';
-
-    /**
-     * The name of this command.
-     */
-    protected string $name = self::NAME;
-
     public static function defaultName(): string
     {
-        return self::NAME;
+        return 'console';
+    }
+
+    public static function getDescription(): string
+    {
+        return 'Simple console wrapper around Psy\Shell';
     }
 
     protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
@@ -70,7 +65,7 @@ public function execute(Arguments $args, ConsoleIo $io)
             $io->err('<info>$ php composer.phar require --dev psy/psysh</info>');
             $io->err('');
 
-            return 1;
+            return self::CODE_SUCCESS;
         }
 
         $io->out('You can exit with <info>`CTRL-C`</info> or <info>`exit`</info>');

src/Shell/StatsShell.php src/Command/StatsCommand.phpsrc/Shell/StatsShell.php renamed to src/Command/StatsCommand.php

@@ -1,8 +1,6 @@
 <?php
 
 /**
- * Stats Shell.
- *
  * phpMyAdmin Error reporting server
  * Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
  *
@@ -16,7 +14,7 @@
  * @see      https://www.phpmyadmin.net/
  */
 
-namespace App\Shell;
+namespace App\Command;
 
 use App\Model\Table\IncidentsTable;
 use App\Model\Table\ReportsTable;
@@ -29,23 +27,21 @@
 use function json_encode;
 
 /**
- * Stats shell.
+ * Stats command.
  */
-class StatsShell extends Command
+class StatsCommand extends Command
 {
     protected IncidentsTable $Incidents;
     protected ReportsTable $Reports;
 
-    protected const NAME = 'stats';
-
-    /**
-     * The name of this command.
-     */
-    protected string $name = self::NAME;
-
     public static function defaultName(): string
     {
-        return self::NAME;
+        return 'stats';
+    }
+
+    public static function getDescription(): string
+    {
+        return 'Build statistics';
     }
 
     protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser

src/Shell/SyncGithubIssueStatesShell.php …Command/SyncGithubIssueStatesCommand.phpsrc/Shell/SyncGithubIssueStatesShell.php renamed to src/Command/SyncGithubIssueStatesCommand.php src/Shell/SyncGithubIssueStatesShell.php renamed to src/Command/SyncGithubIssueStatesCommand.php

@@ -1,8 +1,6 @@
 <?php
 
 /**
- * Sync Github issue states Shell.
- *
  * phpMyAdmin Error reporting server
  * Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
  *
@@ -16,7 +14,7 @@
  * @see      https://www.phpmyadmin.net/
  */
 
-namespace App\Shell;
+namespace App\Command;
 
 use App\Application;
 use Cake\Command\Command;
@@ -32,21 +30,16 @@
 
 use const PHP_SAPI;
 
-/**
- * Sync Github issue states Shell.
- */
-class SyncGithubIssueStatesShell extends Command
+class SyncGithubIssueStatesCommand extends Command
 {
-    protected const NAME = 'sync_github_issue_states';
-
-    /**
-     * The name of this command.
-     */
-    protected string $name = self::NAME;
-
     public static function defaultName(): string
     {
-        return self::NAME;
+        return 'sync_github_issue_states';
+    }
+
+    public static function getDescription(): string
+    {
+        return 'Sync Github issue states';
     }
 
     protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
@@ -96,7 +89,7 @@ public function execute(Arguments $args, ConsoleIo $io)
                 ['scope' => 'cron_jobs']
             );
 
-            return 0;
+            return self::CODE_ERROR;
         }
 
         Log::error(
@@ -108,6 +101,6 @@ public function execute(Arguments $args, ConsoleIo $io)
             ['scope' => 'cron_jobs']
         );
 
-        return 1;
+        return self::CODE_SUCCESS;
     }
 }

tests/TestCase/Shell/CleanOldNotifsShellTest.php

@@ -39,12 +39,6 @@ public function getFixtures(): array
         ];
     }
 
-    public function setUp(): void
-    {
-        parent::setUp();
-        $this->useCommandRunner();
-    }
-
     /**
      * Test execute method
      */

tests/TestCase/Shell/StatsShellTest.php

@@ -30,12 +30,6 @@ class StatsShellTest extends TestCase
 {
     use ConsoleIntegrationTestTrait;
 
-    public function setUp(): void
-    {
-        parent::setUp();
-        $this->useCommandRunner();
-    }
-
     /**
      * Test execute method
      */

tests/TestCase/Shell/SyncGithubIssueStatesShellTest.php

@@ -33,12 +33,6 @@ public function getFixtures(): array
         ];
     }
 
-    public function setUp(): void
-    {
-        parent::setUp();
-        $this->useCommandRunner();
-    }
-
     /**
      * Test execute method
      */