Merge pull request #1996 from alissn/prohibiteCommands

Add `prohibitDestructiveCommands` Method to Prevent Running Destructive Commands in Production
nWidart · Dec 3, 2024 · 79cdb18 · 79cdb18
2 parents e37afcf + dffd26f
commit 79cdb18
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 7 deletions.
diff --git a/src/Commands/Actions/ModuleDeleteCommand.php b/src/Commands/Actions/ModuleDeleteCommand.php
@@ -28,4 +28,9 @@ public function getConfirmableLabel(): string
     {
         return 'Warning: Do you want to remove the module?';
     }
+
+    public function getConfirmableCallback(): \Closure|bool|null
+    {
+        return true;
+    }
 }
diff --git a/src/Commands/BaseCommand.php b/src/Commands/BaseCommand.php
@@ -61,7 +61,12 @@ public function getInfo(): ?string
 
     public function getConfirmableLabel(): ?string
     {
-        return 'Warning';
+        return 'Application In Production';
+    }
+
+    public function getConfirmableCallback(): \Closure|bool|null
+    {
+        return null;
     }
 
     /**
@@ -71,8 +76,8 @@ public function handle()
     {
         if ($this instanceof ConfirmableCommand) {
             if ($this->isProhibited() ||
-                ! $this->confirmToProceed($this->getConfirmableLabel(), fn () => true)) {
-                return 1;
+                ! $this->confirmToProceed($this->getConfirmableLabel(), $this->getConfirmableCallback())) {
+                return Command::FAILURE;
             }
         }
 

diff --git a/src/Commands/Database/MigrateFreshCommand.php b/src/Commands/Database/MigrateFreshCommand.php
@@ -5,9 +5,10 @@
 use Illuminate\Database\Migrations\Migrator;
 use Illuminate\Support\Collection;
 use Nwidart\Modules\Commands\BaseCommand;
+use Nwidart\Modules\Contracts\ConfirmableCommand;
 use Symfony\Component\Console\Input\InputOption;
 
-class MigrateFreshCommand extends BaseCommand
+class MigrateFreshCommand extends BaseCommand implements ConfirmableCommand
 {
     /**
      * The console command name.

diff --git a/src/Commands/Database/MigrateRefreshCommand.php b/src/Commands/Database/MigrateRefreshCommand.php
@@ -3,9 +3,10 @@
 namespace Nwidart\Modules\Commands\Database;
 
 use Nwidart\Modules\Commands\BaseCommand;
+use Nwidart\Modules\Contracts\ConfirmableCommand;
 use Symfony\Component\Console\Input\InputOption;
 
-class MigrateRefreshCommand extends BaseCommand
+class MigrateRefreshCommand extends BaseCommand implements ConfirmableCommand
 {
     /**
      * The console command name.

diff --git a/src/Commands/Database/MigrateResetCommand.php b/src/Commands/Database/MigrateResetCommand.php
@@ -3,11 +3,12 @@
 namespace Nwidart\Modules\Commands\Database;
 
 use Nwidart\Modules\Commands\BaseCommand;
+use Nwidart\Modules\Contracts\ConfirmableCommand;
 use Nwidart\Modules\Migrations\Migrator;
 use Nwidart\Modules\Traits\MigrationLoaderTrait;
 use Symfony\Component\Console\Input\InputOption;
 
-class MigrateResetCommand extends BaseCommand
+class MigrateResetCommand extends BaseCommand implements ConfirmableCommand
 {
     use MigrationLoaderTrait;
 

diff --git a/src/Facades/Module.php b/src/Facades/Module.php
@@ -3,6 +3,9 @@
 namespace Nwidart\Modules\Facades;
 
 use Illuminate\Support\Facades\Facade;
+use Nwidart\Modules\Commands\Database\MigrateFreshCommand;
+use Nwidart\Modules\Commands\Database\MigrateRefreshCommand;
+use Nwidart\Modules\Commands\Database\MigrateResetCommand;
 
 /**
  * @method static array all()
@@ -19,7 +22,7 @@
  * @method static \Nwidart\Modules\Module findOrFail(string $name)
  * @method static string getModulePath($moduleName)
  * @method static \Illuminate\Filesystem\Filesystem getFiles()
- * @method static mixed config(string $key, $default = NULL)
+ * @method static mixed config(string $key, $default = null)
  * @method static string getPath()
  * @method static void boot()
  * @method static void register(): void
@@ -30,6 +33,21 @@
  */
 class Module extends Facade
 {
+    /**
+     * Indicate if destructive Artisan commands should be prohibited.
+     *
+     * Prohibits: module:migrate-fresh, module:migrate-refresh, and module:migrate-reset
+     *
+     * @param  bool  $prohibit
+     * @return void
+     */
+    public static function prohibitDestructiveCommands(bool $prohibit = true): void
+    {
+        MigrateFreshCommand::prohibit($prohibit);
+        MigrateRefreshCommand::prohibit($prohibit);
+        MigrateResetCommand::prohibit($prohibit);
+    }
+
     protected static function getFacadeAccessor(): string
     {
         return 'modules';