Merge pull request #169 from TheDragonCode/6.x

Changed typing of the `method` property for events

Author: andrey-helldar

docs/helpers/events.md

@@ -40,13 +40,14 @@ class EventServiceProvider extends ServiceProvider
 ```php
 namespace App\Listeners;
 
+use DragonCode\LaravelDeployOperations\Enums\MethodEnum;
 use DragonCode\LaravelDeployOperations\Events\BaseEvent;
 
 class SomeOperationsListener
 {
     public function handle(BaseEvent $event): void
     {
-        $method   = $event->method; // `up` or `down` string value
+        $method   = $event->method; // MethodEnum object value
         $isBefore = $event->before; // boolean
     }
 }

docs/upgrade-guide/6.x.md

@@ -15,6 +15,7 @@
 - [Database transactions](#database-transactions)
 - [Removed `$async` property](#removed-async-property)
 - [Removed `operations:stub` command](#removed-operationsstub-command)
+- [Changed property typing for events](#changed-property-typing-for-events)
 
 ## Low-Impact Changes
 
@@ -102,6 +103,30 @@ You should replace `DragonCode\LaravelActions\Action` namespace with `DragonCode
 Don't forget to also change the namespace from `DragonCode\LaravelActions\Events`
 to `DragonCode\LaravelDeployOperations\Events`.
 
+## Changed property typing for events
+
+The type of the `method` property for events has been changed.
+
+Before:
+
+```php
+use DragonCode\LaravelActions\Events\ActionEnded;
+use DragonCode\LaravelDeployOperations\Enums\MethodEnum;
+
+/** @var ActionEnded */
+$event->method; // is string
+```
+
+After:
+
+```php
+use DragonCode\LaravelDeployOperations\Enums\MethodEnum;
+use DragonCode\LaravelDeployOperations\Events\DeployOperationEnded;
+
+/** @var DeployOperationEnded */
+$event->method; // is MethodEnum
+```
+
 ## Configuration file name changed
 
 We recommend that you delete the old configuration file `config/actions.php` and publish a new one.

src/Enums/MethodEnum.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelDeployOperations\Enums;
+
+enum MethodEnum: string
+{
+    case Up   = 'up';
+    case Down = 'down';
+}

src/Events/BaseEvent.php

@@ -4,10 +4,12 @@
 
 namespace DragonCode\LaravelDeployOperations\Events;
 
+use DragonCode\LaravelDeployOperations\Enums\MethodEnum;
+
 abstract class BaseEvent
 {
     public function __construct(
-        public string $method,
+        public MethodEnum $method,
         public bool $before
     ) {}
 }

src/Processors/Operations.php

@@ -6,6 +6,7 @@
 
 use DragonCode\LaravelDeployOperations\Constants\Names;
 use DragonCode\LaravelDeployOperations\Constants\Options;
+use DragonCode\LaravelDeployOperations\Enums\MethodEnum;
 use DragonCode\LaravelDeployOperations\Events\DeployOperationEnded;
 use DragonCode\LaravelDeployOperations\Events\DeployOperationFailed;
 use DragonCode\LaravelDeployOperations\Events\DeployOperationStarted;
@@ -40,19 +41,19 @@ protected function runOperations(array $completed): void
     {
         try {
             if ($files = $this->getNewFiles($completed)) {
-                $this->fireEvent(DeployOperationStarted::class, 'up');
+                $this->fireEvent(DeployOperationStarted::class, MethodEnum::Up);
 
                 $this->runEach($files, $this->getBatch());
 
-                $this->fireEvent(DeployOperationEnded::class, 'up');
+                $this->fireEvent(DeployOperationEnded::class, MethodEnum::Up);
 
                 return;
             }
 
-            $this->fireEvent(NoPendingDeployOperations::class, 'up');
+            $this->fireEvent(NoPendingDeployOperations::class, MethodEnum::Up);
         }
         catch (Throwable $e) {
-            $this->fireEvent(DeployOperationFailed::class, 'up');
+            $this->fireEvent(DeployOperationFailed::class, MethodEnum::Up);
 
             throw $e;
         }

src/Processors/Processor.php

@@ -6,6 +6,7 @@
 
 use Closure;
 use DragonCode\LaravelDeployOperations\Concerns\Artisan;
+use DragonCode\LaravelDeployOperations\Enums\MethodEnum;
 use DragonCode\LaravelDeployOperations\Helpers\Config;
 use DragonCode\LaravelDeployOperations\Helpers\Git;
 use DragonCode\LaravelDeployOperations\Helpers\Sorter;
@@ -78,7 +79,7 @@ protected function tableNotFound(): bool
         return false;
     }
 
-    protected function fireEvent(string $event, string $method): void
+    protected function fireEvent(string $event, MethodEnum $method): void
     {
         $this->events->dispatch(new $event($method, $this->options->before));
     }

src/Processors/Rollback.php

@@ -4,6 +4,7 @@
 
 namespace DragonCode\LaravelDeployOperations\Processors;
 
+use DragonCode\LaravelDeployOperations\Enums\MethodEnum;
 use DragonCode\LaravelDeployOperations\Events\DeployOperationEnded;
 use DragonCode\LaravelDeployOperations\Events\DeployOperationStarted;
 use DragonCode\LaravelDeployOperations\Events\NoPendingDeployOperations;
@@ -13,23 +14,23 @@ class Rollback extends Processor
     public function handle(): void
     {
         if ($this->tableNotFound() || $this->nothingToRollback()) {
-            $this->fireEvent(NoPendingDeployOperations::class, 'down');
+            $this->fireEvent(NoPendingDeployOperations::class, MethodEnum::Down);
 
             return;
         }
 
         if ($items = $this->getOperations($this->options->step)) {
-            $this->fireEvent(DeployOperationStarted::class, 'down');
+            $this->fireEvent(DeployOperationStarted::class, MethodEnum::Down);
 
             $this->showCaption();
             $this->run($items);
 
-            $this->fireEvent(DeployOperationEnded::class, 'down');
+            $this->fireEvent(DeployOperationEnded::class, MethodEnum::Down);
 
             return;
         }
 
-        $this->fireEvent(NoPendingDeployOperations::class, 'down');
+        $this->fireEvent(NoPendingDeployOperations::class, MethodEnum::Down);
     }
 
     protected function showCaption(): void