Changed information output from migrations to actions

Andrey Helldar · Andrey Helldar · commit 6a50665c2c5d · 2020-12-09T14:21:00.000+03:00
diff --git a/composer.json b/composer.json
@@ -18,7 +18,8 @@
         "php": "^7.3|^8.0",
         "illuminate/console": "^6.0|^7.0|^8.0",
         "illuminate/database": "^6.0|^7.0|^8.0",
-        "illuminate/support": "^6.0|^7.0|^8.0"
+        "illuminate/support": "^6.0|^7.0|^8.0",
+        "symfony/console": "^4.3.4|^5.0"
     },
     "require-dev": {
         "mockery/mockery": "^1.3.1",
diff --git a/src/Console/Install.php b/src/Console/Install.php
@@ -4,11 +4,13 @@
 
 use Helldar\LaravelActions\Constants\Names;
 use Helldar\LaravelActions\Traits\Database;
+use Helldar\LaravelActions\Traits\Infoable;
 use Illuminate\Database\Console\Migrations\InstallCommand as BaseCommand;
 
 final class Install extends BaseCommand
 {
     use Database;
+    use Infoable;
 
     /**
      * The console command name.
diff --git a/src/Console/Make.php b/src/Console/Make.php
@@ -4,6 +4,7 @@
 
 use Helldar\LaravelActions\Constants\Names;
 use Helldar\LaravelActions\Traits\Database;
+use Helldar\LaravelActions\Traits\Infoable;
 use Illuminate\Database\Console\Migrations\BaseCommand;
 use Illuminate\Database\Migrations\MigrationCreator;
 use Illuminate\Support\Composer;
@@ -12,6 +13,7 @@
 final class Make extends BaseCommand
 {
     use Database;
+    use Infoable;
 
     /**
      * The console command name.
@@ -86,6 +88,6 @@ protected function writeMigration(string $name)
 
         $path = pathinfo($file, PATHINFO_FILENAME);
 
-        $this->line("<info>Created Migration:</info> {$path}");
+        $this->line("<info>Created Action:</info> {$path}");
     }
 }
diff --git a/src/Console/Migrate.php b/src/Console/Migrate.php
@@ -4,12 +4,14 @@
 
 use Helldar\LaravelActions\Constants\Names;
 use Helldar\LaravelActions\Traits\Database;
+use Helldar\LaravelActions\Traits\Infoable;
 use Helldar\LaravelActions\Traits\Optionable;
 use Illuminate\Database\Console\Migrations\MigrateCommand as BaseCommand;
 
 final class Migrate extends BaseCommand
 {
     use Database;
+    use Infoable;
     use Optionable;
 
     /**
@@ -20,7 +22,7 @@ final class Migrate extends BaseCommand
     protected $signature = Names::MIGRATE
     . ' {--database= : The database connection to use}'
     . ' {--force : Force the operation to run when in production}'
-    . ' {--step : Force the migrations to be run so they can be rolled back individually}';
+    . ' {--step : Force the actions to be run so they can be rolled back individually}';
 
     /**
      * The console command description.
diff --git a/src/Console/Refresh.php b/src/Console/Refresh.php
@@ -4,6 +4,7 @@
 
 use Helldar\LaravelActions\Constants\Names;
 use Helldar\LaravelActions\Traits\Database;
+use Helldar\LaravelActions\Traits\Infoable;
 use Helldar\LaravelActions\Traits\Optionable;
 use Illuminate\Console\Command as BaseCommand;
 use Illuminate\Console\ConfirmableTrait;
@@ -15,6 +16,7 @@ final class Refresh extends BaseCommand
 {
     use ConfirmableTrait;
     use Database;
+    use Infoable;
     use Optionable;
 
     /**
diff --git a/src/Console/Reset.php b/src/Console/Reset.php
@@ -4,6 +4,7 @@
 
 use Helldar\LaravelActions\Constants\Names;
 use Helldar\LaravelActions\Traits\Database;
+use Helldar\LaravelActions\Traits\Infoable;
 use Helldar\LaravelActions\Traits\Optionable;
 use Illuminate\Console\ConfirmableTrait;
 use Illuminate\Database\Console\Migrations\BaseCommand;
@@ -14,6 +15,7 @@ final class Reset extends BaseCommand
 {
     use ConfirmableTrait;
     use Database;
+    use Infoable;
     use Optionable;
 
     /**
@@ -49,6 +51,11 @@ public function __construct(Migrator $migrator)
         $this->migrator = $migrator;
     }
 
+    /**
+     * Execute the console command.
+     *
+     * @return int|void
+     */
     public function handle()
     {
         if (! $this->confirmToProceed()) {
@@ -57,12 +64,16 @@ public function handle()
 
         return $this->migrator->usingConnection($this->optionDatabase(), function () {
             if (! $this->migrator->repositoryExists()) {
-                return $this->comment('Migration table not found.');
+                $this->comment('Actions table not found.');
+
+                return 1;
             }
 
             $this->migrator->setOutput($this->output)->reset(
                 $this->getMigrationPaths()
             );
+
+            return 0;
         });
     }
 
diff --git a/src/Console/Rollback.php b/src/Console/Rollback.php
@@ -4,13 +4,15 @@
 
 use Helldar\LaravelActions\Constants\Names;
 use Helldar\LaravelActions\Traits\Database;
+use Helldar\LaravelActions\Traits\Infoable;
 use Helldar\LaravelActions\Traits\Optionable;
 use Illuminate\Database\Console\Migrations\RollbackCommand;
 use Symfony\Component\Console\Input\InputOption;
 
 final class Rollback extends RollbackCommand
 {
     use Database;
+    use Infoable;
     use Optionable;
 
     /**
@@ -41,9 +43,7 @@ public function handle()
         $this->migrator->usingConnection($this->optionDatabase(), function () {
             $this->migrator->setOutput($this->output)->rollback(
                 $this->getMigrationPaths(),
-                [
-                    'step' => $this->optionStep(),
-                ]
+                ['step' => $this->optionStep()]
             );
         });
 
@@ -62,7 +62,7 @@ protected function getOptions()
 
             ['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production'],
 
-            ['step', null, InputOption::VALUE_OPTIONAL, 'The number of migrations to be reverted'],
+            ['step', null, InputOption::VALUE_OPTIONAL, 'The number of actions to be reverted'],
         ];
     }
 }
diff --git a/src/Console/Status.php b/src/Console/Status.php
@@ -4,11 +4,13 @@
 
 use Helldar\LaravelActions\Constants\Names;
 use Helldar\LaravelActions\Traits\Database;
+use Helldar\LaravelActions\Traits\Infoable;
 use Illuminate\Database\Console\Migrations\StatusCommand as BaseCommand;
 
 final class Status extends BaseCommand
 {
     use Database;
+    use Infoable;
 
     /**
      * The console command name.
diff --git a/src/Facades/Information.php b/src/Facades/Information.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Helldar\LaravelActions\Facades;
+
+use Helldar\LaravelActions\Support\Information as Support;
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @method static string replace(string $value)
+ */
+final class Information extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return Support::class;
+    }
+}
diff --git a/src/Support/Information.php b/src/Support/Information.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Helldar\LaravelActions\Support;
+
+use Illuminate\Support\Str;
+
+final class Information
+{
+    protected $available = [
+        'Migrating:'                           => 'Running:',
+        'Migrated:'                            => 'Done:',
+        'Nothing to migrate'                   => 'Nothing to do',
+        'Migration table created successfully' => 'Action table created successfully',
+        'Migration table not found'            => 'Actions table not found',
+        'No migrations found'                  => 'No actions found',
+        'Migration not found'                  => 'Action not found',
+    ];
+
+    public function replace(string $value): string
+    {
+        foreach ($this->available as $search => $replace) {
+            if (Str::contains($value, $search)) {
+                return str_replace($search, $replace, $value);
+            }
+        }
+
+        return $value;
+    }
+}
diff --git a/src/Support/Migrator.php b/src/Support/Migrator.php
@@ -2,10 +2,13 @@
 
 namespace Helldar\LaravelActions\Support;
 
+use Helldar\LaravelActions\Traits\Infoable;
 use Illuminate\Database\Migrations\Migrator as BaseMigrator;
 
 final class Migrator extends BaseMigrator
 {
+    use Infoable;
+
     public function usingConnection($name, callable $callback)
     {
         $prev = $this->resolver->getDefaultConnection();
diff --git a/src/Traits/Infoable.php b/src/Traits/Infoable.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Helldar\LaravelActions\Traits;
+
+use Helldar\LaravelActions\Facades\Information;
+use Symfony\Component\Console\Output\OutputInterface;
+
+trait Infoable
+{
+    /**
+     * Write a string as standard output.
+     *
+     * @param  string  $string
+     * @param  string|null  $style
+     * @param  int|string|null  $verbosity
+     *
+     * @return void
+     */
+    public function line($string, $style = null, $verbosity = null)
+    {
+        if ($this->output) {
+            $string = Information::replace($string);
+
+            $styled = $style ? "<$style>$string</$style>" : $string;
+
+            $this->output->writeln($styled, $this->parsedVerbosity($verbosity));
+        }
+    }
+
+    protected function note($message)
+    {
+        $this->line($message);
+    }
+
+    protected function parsedVerbosity($verbosity = null)
+    {
+        return method_exists($this, 'parseVerbosity')
+            ? $this->parseVerbosity($verbosity)
+            : OutputInterface::VERBOSITY_NORMAL;
+    }
+}
diff --git a/tests/Commands/InstallTest.php b/tests/Commands/InstallTest.php
@@ -14,7 +14,7 @@ public function testRepositoryNotFound()
         );
 
         $this->artisan('migrate:actions:status')
-            ->expectsOutput('Migration table not found.');
+            ->expectsOutput('Actions table not found.');
     }
 
     public function testRepository()
diff --git a/tests/Commands/MigrateTest.php b/tests/Commands/MigrateTest.php
@@ -44,6 +44,6 @@ public function testMigrationNotFound()
         );
 
         $this->artisan('migrate:actions:status')
-            ->expectsOutput('No migrations found');
+            ->expectsOutput('No actions found');
     }
 }
diff --git a/tests/fixtures/stubs/make_example.stub b/tests/fixtures/stubs/make_example.stub
@@ -4,11 +4,21 @@ use Helldar\LaravelActions\Support\Actionable;
 
 final class MakeExample extends Actionable
 {
+    /**
+     * Run the actions.
+     *
+     * @return void
+     */
     public function up(): void
     {
         //
     }
 
+    /**
+     * Reverse the actions.
+     *
+     * @return void
+     */
     public function down(): void
     {
         //

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`use Helldar\LaravelActions\Constants\Names;`
`6`	`6`	`use Helldar\LaravelActions\Traits\Database;`
	`7`	`+use Helldar\LaravelActions\Traits\Infoable;`
`7`	`8`	`use Illuminate\Database\Console\Migrations\BaseCommand;`
`8`	`9`	`use Illuminate\Database\Migrations\MigrationCreator;`
`9`	`10`	`use Illuminate\Support\Composer;`
`@@ -12,6 +13,7 @@`
`12`	`13`	`final class Make extends BaseCommand`
`13`	`14`	`{`
`14`	`15`	`use Database;`
	`16`	`+ use Infoable;`
`15`	`17`
`16`	`18`	`/**`
`17`	`19`	`* The console command name.`
`@@ -86,6 +88,6 @@ protected function writeMigration(string $name)`
`86`	`88`
`87`	`89`	`$path = pathinfo($file, PATHINFO_FILENAME);`
`88`	`90`
`89`		`- $this->line("<info>Created Migration:</info> {$path}");`
	`91`	`+ $this->line("<info>Created Action:</info> {$path}");`
`90`	`92`	`}`
`91`	`93`	`}`