add perpetual indicator in status command

Author: muhajirinlpu

.gitignore

@@ -2,3 +2,4 @@
 .idea
 composer.lock
 .phpunit.result.cache
+.phpunit.cache

composer.json

@@ -10,9 +10,8 @@
     "require-dev": {
         "roave/security-advisories": "dev-latest",
         "mockery/mockery": "^1.4.2",
-        "phpunit/phpunit": "^9.3.3",
-        "laravel/framework": "^9.0",
-        "orchestra/testbench": "^7.1"
+        "phpunit/phpunit": "^10.0",
+        "orchestra/testbench": "^8.0.10"
     },
     "license": "MIT",
     "authors": [

phpunit.xml.dist

@@ -1,25 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         beStrictAboutTestsThatDoNotTestAnything="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-    <coverage>
-        <include>
-            <directory suffix=".php">src/</directory>
-        </include>
-    </coverage>
-    <testsuites>
-        <testsuite name="Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" beStrictAboutTestsThatDoNotTestAnything="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

src/Console/StatusCommand.php

@@ -2,14 +2,21 @@
 
 namespace Dentro\Patcher\Console;
 
+use Dentro\Patcher\Patcher;
 use Illuminate\Database\Console\Migrations\StatusCommand as MigrationStatusCommand;
+use Illuminate\Support\Collection;
 
 class StatusCommand extends MigrationStatusCommand
 {
     protected $name = 'patcher:status';
 
     protected $description = 'Show the status of each patches.';
 
+    /**
+     * @var Patcher
+     */
+    protected $migrator;
+
     public function handle()
     {
         return $this->migrator->usingConnection($this->option('database'), function () {
@@ -23,15 +30,57 @@ public function handle()
             $batches = $this->migrator->getRepository()->getMigrationBatches();
 
             if (count($patches = $this->getStatusFor($ran, $batches)) > 0) {
-                $this->table(['Ran?', 'Patch', 'Batch'], $patches);
+                $this->newLine();
+
+                $this->components->twoColumnDetail('<fg=gray>Patcher name</>', '<fg=gray>Batch / Status</>');
+
+                $patches
+                    ->when($this->option('pending'), fn ($collection) => $collection->filter(function ($migration) {
+                        return str($migration[1])->contains('Pending');
+                    }))
+                    ->each(
+                        fn ($migration) => $this->components->twoColumnDetail($migration[0], $migration[1])
+                    );
+
+                $this->newLine();
             } else {
-                $this->error('No patch found');
+                $this->components->info('No patch found');
             }
         });
     }
 
+    protected function getStatusFor(array $ran, array $batches)
+    {
+        return Collection::make($this->getAllMigrationFiles())
+            ->map(function ($migration) use ($ran, $batches) {
+                $migrationName = $this->migrator->getMigrationName($migration);
+
+                $defaultStatus = '<fg=yellow;options=bold>Pending</>';
+
+                $status = $defaultStatus;
+
+                if (in_array($migrationName, $ran)) {
+                    $status = '<fg=green;options=bold>Ran</>';
+                }
+
+                if (in_array($migrationName, $ran)) {
+                    $status = '['.$batches[$migrationName].'] '.$status;
+                }
+
+                if ($status === $defaultStatus) {
+                    $patch = $this->migrator->getPatcherObject($migration);
+
+                    if ($patch->isPerpetual) {
+                        $status = '<fg=yellow;options=bold>Perpetual</>';
+                    }
+                }
+
+                return [$migrationName, $status];
+            });
+    }
+
     /**
-     * Get migration path (either specified by '--path' option or default location).
+     * Get a migration path (either specified by '--path' option or default location).
      *
      * @return string
      */

src/Patcher.php

@@ -5,10 +5,9 @@
 use Dentro\Patcher\Events\PatchEnded;
 use Dentro\Patcher\Events\PatchStarted;
 use Illuminate\Console\View\Components\Info;
-use Illuminate\Console\View\Components\Task;
 use Illuminate\Console\View\Components\TwoColumnDetail;
-use Illuminate\Console\View\Components\Warn;
 use Illuminate\Database\Migrations\Migrator;
+use InvalidArgumentException;
 
 class Patcher extends Migrator
 {
@@ -52,7 +51,7 @@ public function runPending(array $migrations, array $options = []): void
      */
     protected function patch(string $file, int $batch): void
     {
-        $patch = $this->resolvePath($file);
+        $patch = $this->getPatcherObject($file);
 
         $name = $this->getMigrationName($file);
 
@@ -68,7 +67,7 @@ protected function patch(string $file, int $batch): void
 
         $startTime = microtime(true);
 
-        if ($patch instanceof Patch && $this->isEligible($patch)) {
+        if ($this->isEligible($patch)) {
             $patch
                 ->setContainer(app())
                 ->setCommand(app('command.patcher'))
@@ -149,4 +148,15 @@ protected function runPatch(Patch $patch): void
 
         $callback();
     }
+
+    public function getPatcherObject(string $path): Patch
+    {
+        $object = $this->resolvePath($path);
+
+        if (! $object instanceof Patch) {
+            throw new InvalidArgumentException("Patch [{$path}] must extends ".Patch::class);
+        }
+
+        return $object;
+    }
 }