Merge pull request #89 from TheDragonCode/3.x

andrey-helldar · web-flow · commit be7aea8b68fc · 2022-10-13T22:45:32.000+03:00
Added silent mode for commands
diff --git a/src/Concerns/Artisan.php b/src/Concerns/Artisan.php
@@ -4,8 +4,8 @@
 
 namespace DragonCode\LaravelActions\Concerns;
 
+use Illuminate\Console\OutputStyle;
 use Illuminate\Support\Facades\Artisan as Command;
-use Symfony\Component\Console\Output\OutputInterface;
 
 trait Artisan
 {
@@ -14,11 +14,11 @@ trait Artisan
      *
      * @param string $command
      * @param array $parameters
-     * @param \Symfony\Component\Console\Output\OutputInterface|null $outputBuffer
+     * @param \Illuminate\Console\OutputStyle|null $outputBuffer
      *
      * @return void
      */
-    protected function artisan(string $command, array $parameters = [], ?OutputInterface $outputBuffer = null): void
+    protected function artisan(string $command, array $parameters = [], ?OutputStyle $outputBuffer = null): void
     {
         Command::call($command, $parameters, $outputBuffer);
     }
diff --git a/src/Concerns/Optionable.php b/src/Concerns/Optionable.php
@@ -17,6 +17,7 @@ trait Optionable
     protected array $options = [
         Options::CONNECTION,
         Options::FORCE,
+        Options::SILENT,
     ];
 
     protected function configure(): void
@@ -47,6 +48,7 @@ protected function availableOptions(): array
             [Options::PATH, null, InputOption::VALUE_OPTIONAL, 'The path to the actions files to be executed'],
             [Options::REALPATH, null, InputOption::VALUE_NONE, 'Indicate any provided action file paths are pre-resolved absolute path'],
             [Options::STEP, null, InputOption::VALUE_OPTIONAL, 'Force the actions to be run so they can be rolled back individually'],
+            [Options::SILENT, null, InputOption::VALUE_NONE, 'Turns off the output of informational messages'],
         ];
     }
 
diff --git a/src/Console/Fresh.php b/src/Console/Fresh.php
@@ -22,5 +22,6 @@ class Fresh extends Command
         Options::FORCE,
         Options::PATH,
         Options::REALPATH,
+        Options::SILENT,
     ];
 }
diff --git a/src/Console/Install.php b/src/Console/Install.php
@@ -3,7 +3,6 @@
 namespace DragonCode\LaravelActions\Console;
 
 use DragonCode\LaravelActions\Constants\Names;
-use DragonCode\LaravelActions\Constants\Options;
 use DragonCode\LaravelActions\Processors\Install as InstallProcessor;
 use DragonCode\LaravelActions\Processors\Processor;
 
@@ -14,9 +13,4 @@ class Install extends Command
     protected $description = 'Create the actions repository';
 
     protected Processor|string $processor = InstallProcessor::class;
-
-    protected array $options = [
-        Options::CONNECTION,
-        Options::FORCE,
-    ];
 }
diff --git a/src/Console/Make.php b/src/Console/Make.php
@@ -24,5 +24,6 @@ class Make extends Command
         Options::FORCE,
         Options::PATH,
         Options::REALPATH,
+        Options::SILENT,
     ];
 }
diff --git a/src/Console/Migrate.php b/src/Console/Migrate.php
@@ -22,5 +22,6 @@ class Migrate extends Command
         Options::CONNECTION,
         Options::PATH,
         Options::REALPATH,
+        Options::SILENT,
     ];
 }
diff --git a/src/Console/Refresh.php b/src/Console/Refresh.php
@@ -20,5 +20,6 @@ class Refresh extends Command
         Options::FORCE,
         Options::PATH,
         Options::REALPATH,
+        Options::SILENT,
     ];
 }
diff --git a/src/Console/Reset.php b/src/Console/Reset.php
@@ -20,5 +20,6 @@ class Reset extends Command
         Options::FORCE,
         Options::PATH,
         Options::REALPATH,
+        Options::SILENT,
     ];
 }
diff --git a/src/Console/Rollback.php b/src/Console/Rollback.php
@@ -21,5 +21,6 @@ class Rollback extends Command
         Options::PATH,
         Options::REALPATH,
         Options::STEP,
+        Options::SILENT,
     ];
 }
diff --git a/src/Console/Status.php b/src/Console/Status.php
@@ -21,5 +21,6 @@ class Status extends Command
         Options::CONNECTION,
         Options::PATH,
         Options::REALPATH,
+        Options::SILENT,
     ];
 }
diff --git a/src/Constants/Options.php b/src/Constants/Options.php
@@ -18,5 +18,7 @@ class Options
 
     public const REALPATH = 'realpath';
 
+    public const SILENT = 'silent';
+
     public const STEP = 'step';
 }
diff --git a/src/Contracts/Notification.php b/src/Contracts/Notification.php
@@ -5,15 +5,15 @@
 namespace DragonCode\LaravelActions\Contracts;
 
 use Closure;
-use Symfony\Component\Console\Output\OutputInterface;
+use Illuminate\Console\OutputStyle;
 
 interface Notification
 {
     public function info(string $string): void;
 
     public function line(string $string, ?string $style = null): void;
 
-    public function setOutput(OutputInterface $output): self;
+    public function setOutput(OutputStyle $output, bool $silent = false): self;
 
     public function task(string $description, Closure $task): void;
 
diff --git a/src/Notifications/Basic.php b/src/Notifications/Basic.php
@@ -10,9 +10,11 @@ class Basic extends Notification
 {
     public function line(string $string, ?string $style = null): void
     {
-        $styled = $style ? "<$style>$string</$style>" : $string;
+        if ($this->canSpeak()) {
+            $styled = $style ? "<$style>$string</$style>" : $string;
 
-        $this->output->writeln($styled, $this->verbosity);
+            $this->output->writeln($styled, $this->verbosity);
+        }
     }
 
     public function info(string $string): void
@@ -35,7 +37,7 @@ public function task(string $description, Closure $task): void
 
         $run_time = number_format((microtime(true) - $start) * 1000, 2);
 
-        $this->info("Migrated: {$run_time}ms");
+        $this->info("Done in {$run_time}ms");
     }
 
     public function twoColumn(string $first, string $second): void
diff --git a/src/Notifications/Beautiful.php b/src/Notifications/Beautiful.php
@@ -42,6 +42,6 @@ protected function components(): Factory
             return $this->components;
         }
 
-        return $this->component = new Factory($this->output);
+        return $this->component = $this->canSpeak() ? new Factory($this->output) : optional();
     }
 }
diff --git a/src/Notifications/Notification.php b/src/Notifications/Notification.php
@@ -6,11 +6,14 @@
 
 use Closure;
 use DragonCode\LaravelActions\Contracts\Notification as NotificationContract;
+use Illuminate\Console\OutputStyle;
 use Symfony\Component\Console\Output\OutputInterface;
 
 abstract class Notification implements NotificationContract
 {
-    protected ?OutputInterface $output = null;
+    protected ?OutputStyle $output = null;
+
+    protected bool $silent = false;
 
     protected int $verbosity = OutputInterface::VERBOSITY_NORMAL;
 
@@ -24,10 +27,16 @@ abstract public function task(string $description, Closure $task): void;
 
     abstract public function twoColumn(string $first, string $second): void;
 
-    public function setOutput(OutputInterface $output): NotificationContract
+    public function setOutput(OutputStyle $output, bool $silent = false): NotificationContract
     {
         $this->output = $output;
+        $this->silent = $silent;
 
         return $this;
     }
+
+    protected function canSpeak(): bool
+    {
+        return ! $this->silent;
+    }
 }
diff --git a/src/Processors/Processor.php b/src/Processors/Processor.php
@@ -16,9 +16,9 @@
 use DragonCode\Support\Facades\Helpers\Arr;
 use DragonCode\Support\Facades\Helpers\Str;
 use DragonCode\Support\Filesystem\File;
+use Illuminate\Console\OutputStyle;
 use Illuminate\Contracts\Events\Dispatcher;
 use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
 
 abstract class Processor
 {
@@ -29,7 +29,7 @@ abstract public function handle(): void;
     public function __construct(
         protected Options $options,
         protected InputInterface $input,
-        protected OutputInterface $output,
+        protected OutputStyle $output,
         protected Config $config,
         protected ActionRepository $repository,
         protected Git $git,
@@ -39,7 +39,7 @@ public function __construct(
         protected Dispatcher $events,
         protected Sorter $sorter
     ) {
-        $this->notification->setOutput($this->output);
+        $this->notification->setOutput($this->output, $this->options->silent);
         $this->repository->setConnection($this->options->connection);
         $this->migrator->setConnection($this->options->connection)->setOutput($this->output);
     }
diff --git a/src/Services/Migrator.php b/src/Services/Migrator.php
@@ -12,9 +12,9 @@
 use DragonCode\Support\Exceptions\FileNotFoundException;
 use DragonCode\Support\Facades\Helpers\Str;
 use DragonCode\Support\Filesystem\File;
+use Illuminate\Console\OutputStyle;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Support\Facades\DB;
-use Symfony\Component\Console\Output\OutputInterface;
 use Throwable;
 
 class Migrator
@@ -35,7 +35,7 @@ public function setConnection(?string $connection): self
         return $this;
     }
 
-    public function setOutput(OutputInterface $output): self
+    public function setOutput(OutputStyle $output): self
     {
         $this->notification->setOutput($output);
 
diff --git a/src/Values/Options.php b/src/Values/Options.php
@@ -26,6 +26,8 @@ class Options extends DataTransferObject
 
     public ?int $step = null;
 
+    public bool $silent = false;
+
     public function resolvePath(): self
     {
         $this->path = $this->realpath

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace DragonCode\LaravelActions\Concerns;`
`6`	`6`
	`7`	`+use Illuminate\Console\OutputStyle;`
`7`	`8`	`use Illuminate\Support\Facades\Artisan as Command;`
`8`		`-use Symfony\Component\Console\Output\OutputInterface;`
`9`	`9`
`10`	`10`	`trait Artisan`
`11`	`11`	`{`
`@@ -14,11 +14,11 @@ trait Artisan`
`14`	`14`	`*`
`15`	`15`	`* @param string $command`
`16`	`16`	`* @param array $parameters`
`17`		`- * @param \Symfony\Component\Console\Output\OutputInterface\|null $outputBuffer`
	`17`	`+ * @param \Illuminate\Console\OutputStyle\|null $outputBuffer`
`18`	`18`	`*`
`19`	`19`	`* @return void`
`20`	`20`	`*/`
`21`		`- protected function artisan(string $command, array $parameters = [], ?OutputInterface $outputBuffer = null): void`
	`21`	`+ protected function artisan(string $command, array $parameters = [], ?OutputStyle $outputBuffer = null): void`
`22`	`22`	`{`
`23`	`23`	`Command::call($command, $parameters, $outputBuffer);`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,5 +22,6 @@ class Fresh extends Command`
`22`	`22`	`Options::FORCE,`
`23`	`23`	`Options::PATH,`
`24`	`24`	`Options::REALPATH,`
	`25`	`+ Options::SILENT,`
`25`	`26`	`];`
`26`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,6 @@ class Make extends Command`
`24`	`24`	`Options::FORCE,`
`25`	`25`	`Options::PATH,`
`26`	`26`	`Options::REALPATH,`
	`27`	`+ Options::SILENT,`
`27`	`28`	`];`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,5 +22,6 @@ class Migrate extends Command`
`22`	`22`	`Options::CONNECTION,`
`23`	`23`	`Options::PATH,`
`24`	`24`	`Options::REALPATH,`
	`25`	`+ Options::SILENT,`
`25`	`26`	`];`
`26`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,6 @@ class Refresh extends Command`
`20`	`20`	`Options::FORCE,`
`21`	`21`	`Options::PATH,`
`22`	`22`	`Options::REALPATH,`
	`23`	`+ Options::SILENT,`
`23`	`24`	`];`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,6 @@ class Reset extends Command`
`20`	`20`	`Options::FORCE,`
`21`	`21`	`Options::PATH,`
`22`	`22`	`Options::REALPATH,`
	`23`	`+ Options::SILENT,`
`23`	`24`	`];`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,6 @@ class Rollback extends Command`
`21`	`21`	`Options::PATH,`
`22`	`22`	`Options::REALPATH,`
`23`	`23`	`Options::STEP,`
	`24`	`+ Options::SILENT,`
`24`	`25`	`];`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,6 @@ class Status extends Command`
`21`	`21`	`Options::CONNECTION,`
`22`	`22`	`Options::PATH,`
`23`	`23`	`Options::REALPATH,`
	`24`	`+ Options::SILENT,`
`24`	`25`	`];`
`25`	`26`	`}`