Merge pull request #3 from digital-entropy/patch

Patchwork

Author: muhajirinlpu

README.md

@@ -7,17 +7,7 @@ LARAVEL PATCHER
 
 #### Requirements:
 * PHP : 8.\*
-* Laravel: 9.\* 
-
-##### Background : 
-Once upon a time, our team do a stupid thing that affect our production database. 
-It was happens many times, and we are usually go tinkering or direct edit on a 
-database to fix those problems.
-Then, our team leader [Rifki Alhuraibi](https://github.com/veelasky/) comes up with
-the idea about the package that handle history change of our patch activity (like the 
-one in database migration), so we made this package. 
-Also, we commonly need to bulk insert data to our application, this package also help
-us in those activity.
+* Laravel: 9.\*
 
 ### INSTALLATION
 do either of this methods below.
@@ -29,7 +19,6 @@ composer require dentro/laravel-patcher
 ```json
 {
   "require": {
-    ...
     "dentro/laravel-patcher": "^1.0"
   }
 }
@@ -53,16 +42,10 @@ Those file will be like:
 ```php
 <?php
 
-use Jalameta\Patcher\Patch;
+use Dentro\Patcher\Patch;
 
 class WhatDoYouWantToPatch extends Patch
 {
-    /**
-     * Run patch script.
-     *
-     * @return void
-     * @throws \Exception
-     */
     public function patch()
     {
         // 
@@ -126,3 +109,37 @@ Patching: 2020_10_09_124616_add_attachment_beep
 Patched:  2020_10_09_124616_add_attachment_beep (0.06 seconds)
 ```
 
+#### SKIPPING THE PATCH
+You might need to skip single patch when run ```php artisan patcher:run```. 
+Due to patch is unnecessary or patch is not eligible to run in your environment. 
+Here you can add the ```eligible``` method to your patch class to evaluate the condition 
+before running the ```patch``` method.   
+
+```php
+<?php
+
+use Dentro\Patcher\Patch;
+use App\Models\User;
+
+class WhatDoYouWantToPatch extends Patch
+{
+    public function eligible(): bool
+    {
+        return User::query()->where('id', 331)->exists();
+    }
+    
+    public function patch()
+    {
+        $user = User::query()->find(331);
+        // do something with user.
+    }
+}
+```
+then the output of ```php artisan patcher:run``` will be:
+```shell script
+➜ php artisan patcher:run
+Patching: 2020_09_29_190531_fix_double_sections
+Skipped:  2020_09_29_190531_fix_double_sections is not eligible to run in current condition.
+Patching: 2020_10_09_124616_add_attachment_beep
+Patched:  2020_10_09_124616_add_attachment_beep (0.06 seconds)
+```

src/Console/PatchCommand.php

@@ -3,9 +3,6 @@
 namespace Dentro\Patcher\Console;
 
 use Illuminate\Console\ConfirmableTrait;
-use Illuminate\Database\SQLiteConnection;
-use Illuminate\Database\Events\SchemaLoaded;
-use Illuminate\Database\SqlServerConnection;
 use Illuminate\Database\Console\Migrations\MigrateCommand;
 
 class PatchCommand extends MigrateCommand

src/Patch.php

@@ -5,6 +5,7 @@
 use Illuminate\Console\Command;
 use Illuminate\Container\Container;
 use Illuminate\Database\Migrations\Migration;
+use Illuminate\Log\Logger;
 
 abstract class Patch extends Migration
 {
@@ -13,29 +14,28 @@ abstract class Patch extends Migration
      *
      * @var \Illuminate\Console\Command
      */
-    protected $command;
+    protected Command $command;
 
     /**
      * The container instance.
      *
      * @var \Illuminate\Container\Container
      */
-    protected $container;
+    protected Container $container;
 
     /**
      * Logger.
      *
      * @var \Illuminate\Log\Logger
      */
-    protected $logger;
+    protected Logger $logger;
 
     /**
-     * Patch constructor.
+     * Enables, if supported, wrapping the patch within a transaction.
+     *
+     * @var bool
      */
-    public function __construct()
-    {
-        $this->logger = app('log')->driver(PatcherServiceProvider::$LOG_CHANNEL);
-    }
+    public $withinTransaction = false;
 
     /**
      * Run patch script.
@@ -69,4 +69,14 @@ public function setContainer(Container $container): Patch
 
         return $this;
     }
+
+    /**
+     * Set Logger instance.
+     *
+     * @param \Illuminate\Log\Logger $logger
+     */
+    public function setLogger(Logger $logger): void
+    {
+        $this->logger = $logger;
+    }
 }

src/Patcher.php

@@ -27,12 +27,10 @@ public function runPending(array $migrations, array $options = []): void
 
         $batch = $this->repository->getNextBatchNumber();
 
-        $pretend = $options['pretend'] ?? false;
-
         $step = $options['step'] ?? false;
 
         foreach ($migrations as $file) {
-            $this->patch($file, $batch, $pretend);
+            $this->patch($file, $batch);
 
             if ($step) {
                 $batch++;
@@ -45,40 +43,60 @@ public function runPending(array $migrations, array $options = []): void
      *
      * @param string $file
      * @param int $batch
-     * @param bool $pretend
-     *
      * @return void
      * @throws \Throwable
      */
-    protected function patch(string $file, int $batch, bool $pretend): void
+    protected function patch(string $file, int $batch): void
     {
-        $migration = $this->resolvePath($file);
+        $patch = $this->resolvePath($file);
 
         $name = $this->getMigrationName($file);
 
-        $migration->setContainer(app())->setCommand(app('command.patcher'));
-
-        $this->note("<comment>Patching:</comment> {$name}");
+        $this->note("<comment>Patching:</comment> $name");
 
         $startTime = microtime(true);
 
-        $this->runPatch($migration);
+        if ($patch instanceof Patch && $this->isEligible($patch)) {
+            $patch
+                ->setContainer(app())
+                ->setCommand(app('command.patcher'))
+                ->setLogger(app('log')->driver(PatcherServiceProvider::$LOG_CHANNEL));
+
+            $this->runPatch($patch);
 
-        $runTime = round(microtime(true) - $startTime, 2);
+            $runTime = round(microtime(true) - $startTime, 2);
+
+            $this->repository->log($name, $batch);
+
+            $this->note("<info>Patched:</info>  $name ($runTime seconds).");
+        } else {
+            $this->note("<comment>Skipped:</comment> $name is not eligible to run in current condition.");
+        }
+    }
 
-        $this->repository->log($name, $batch);
+    /**
+     * Determine if patcher should run.
+     *
+     * @param \Dentro\Patcher\Patch $patch
+     * @return bool
+     */
+    public function isEligible(Patch $patch): bool
+    {
+        if (method_exists($patch, 'eligible')) {
+            return $patch->eligible();
+        }
 
-        $this->note("<info>Patched:</info>  {$name} ({$runTime} seconds)");
+        return true;
     }
 
     /**
      * Run a migration inside a transaction if the database supports it.
      *
-     * @param object $patch
+     * @param \Dentro\Patcher\Patch $patch
      * @return void
      * @throws \Throwable
      */
-    protected function runPatch(object $patch): void
+    protected function runPatch(Patch $patch): void
     {
         $connection = $this->resolveConnection(
             $patch->getConnection()
@@ -102,9 +120,11 @@ protected function runPatch(object $patch): void
             }
         };
 
-        $this->getSchemaGrammar($connection)->supportsSchemaTransactions()
-        && $patch->withinTransaction
-            ? $connection->transaction($callback)
-            : $callback();
+        if ($patch->withinTransaction && $this->getSchemaGrammar($connection)->supportsSchemaTransactions()) {
+            $connection->transaction($callback);
+            return;
+        }
+
+        $callback();
     }
 }