refactoring conditions and readme

Author: QuentinGab

README.md

@@ -1,4 +1,4 @@
-# Scheduler based
+# Scheduler based Workflow for Laravel
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/elegantly/laravel-workflow.svg?style=flat-square)](https://packagist.org/packages/elegantly/laravel-workflow)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/elegantengineeringtech/laravel-workflow/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/elegantengineeringtech/laravel-workflow/actions?query=workflow%3Arun-tests+branch%3Amain)
@@ -16,34 +16,97 @@ composer require elegantly/laravel-workflow
 You can publish and run the migrations with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-workflow-migrations"
+php artisan vendor:publish --tag="workflow-migrations"
 php artisan migrate
 ```
 
 You can publish the config file with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-workflow-config"
+php artisan vendor:publish --tag="workflow-config"
 ```
 
 This is the contents of the published config file:
 
 ```php
 return [
+
+    'queue' => env('WORKFLOW_QUEUE'),
+
+    'queue_connection' => env('WORKFLOW_QUEUE_CONNECTION'),
+
 ];
 ```
 
-Optionally, you can publish the views using
+## Usage
 
-```bash
-php artisan vendor:publish --tag="laravel-workflow-views"
+### Defining your workflows
+
+Define a workflow in a class like this one:
+
+```php
+namespace App\Workflows;
+
+use Carbon\CarbonInterval;
+use Elegantly\Workflow\Models\Workflow;
+use Elegantly\Workflow\WorkflowDefinition;
+use Elegantly\Workflow\WorkflowStep;
+use Illuminate\Support\Collection;
+
+class WelcomeUserWorkflow extends WorkflowDefinition
+{
+    public function __construct(
+        public User $user
+    ) {
+        //
+    }
+
+    public function steps(Workflow $workflow): Collection
+    {
+        return collect()
+            ->put(
+                'welcome-email',
+                WorkflowStep::make($workflow)
+                    ->action(function (): void {
+                        // send an email to the user
+                    })
+            )
+            ->put(
+                'export-user',
+                WorkflowStep::make($workflow)
+                    ->action(new ExportUserToCrmJob($this->user))
+            )
+            ->put(
+                'product-tour-email',
+                WorkflowStep::make($workflow)
+                    ->after([
+                        'welcome-email' => CarbonInterval::days(3)
+                    ])
+                    ->action(function (): void {
+                        // Send another email to your user
+                    })
+            )
+            ->put(
+                'send-promo-code',
+                WorkflowStep::make($workflow)
+                    ->after([
+                        'product-tour-email' => CarbonInterval::days(7),
+                    ])
+                    ->when(fn() => $this->user->hasNotPurchased())
+                    ->action(function (): void {
+                        //
+                    })
+            );
+    }
+}
 ```
 
-## Usage
+### Running your workflow
 
 ```php
-$laravelWorkflow = new Elegantly\Workflow();
-echo $laravelWorkflow->echoPhrase('Hello, Elegantly!');
+use Elegantly\Workflow\Commands\RunWorkflowsCommand;
+
+$schedule->command(RunWorkflowsCommand::class)->everyMinutes();
 ```
 
 ## Testing

src/WorkflowDefinition.php

@@ -3,10 +3,13 @@
 namespace Elegantly\Workflow;
 
 use Elegantly\Workflow\Models\Workflow;
+use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
 
 abstract class WorkflowDefinition
 {
+    use SerializesModels;
+
     /**
      * @return Collection<string, WorkflowStep>
      */

src/WorkflowStep.php

@@ -12,23 +12,29 @@ class WorkflowStep
 {
     /**
      * @param  null|ShouldQueue|(Closure():void)  $action
-     * @param  null|bool|(Closure():bool)  $condition
+     * @param  array<int, bool|(Closure():bool)>  $conditions
      */
     final public function __construct(
         public Workflow $workflow,
         public null|ShouldQueue|Closure $action = null,
-        public null|bool|Closure $condition = null,
+        public array $conditions = [],
     ) {
         //
     }
 
     public function isReady(): bool
     {
-        if (is_null($this->condition)) {
+        if (empty($this->conditions)) {
             return true;
         }
 
-        return (bool) value($this->condition);
+        foreach ($this->conditions as $condition) {
+            if (! value($condition)) {
+                return false;
+            }
+        }
+
+        return true;
     }
 
     public static function make(Workflow $workflow): static
@@ -51,44 +57,60 @@ public function action(ShouldQueue|Closure $action): static
     public function when(
         bool|Closure $value
     ): static {
-        $this->condition = $value;
+        $this->conditions[] = $value;
 
         return $this;
     }
 
     /**
-     * @param  string|array<string|int, string|CarbonInterval>  $steps
+     * @param  string|array<string|int, string|CarbonInterval|bool|(Closure():bool)>  $steps
      */
     public function after(
         string|array $steps,
     ): static {
 
-        return $this->when(
-            fn () => collect(Arr::wrap($steps))
-                ->map(function ($delay, $step) {
-
-                    if (is_string($delay)) {
-                        return (bool) $this
-                            ->workflow
-                            ->getItem($delay)
-                            ?->isFinished();
-                    }
-
-                    if (
-                        is_string($step) &&
-                        $delay instanceof CarbonInterval
-                    ) {
-                        return (bool) $this
-                            ->workflow
-                            ->getItem($step)
-                            ?->finished_at
-                            ?->add($delay)
-                            ?->isPast();
-                    }
-
-                    return false;
-                })
-                ->every(fn ($value) => $value === true)
-        );
+        foreach (Arr::wrap($steps) as $step => $delay) {
+            if (
+                is_int($step) &&
+                is_bool($delay)
+            ) {
+                $this->when($delay);
+            }
+
+            if (
+                is_int($step) &&
+                $delay instanceof Closure
+            ) {
+                $this->when($delay);
+            }
+
+            if (
+                is_int($step) &&
+                is_string($delay)
+            ) {
+                $this->when(
+                    fn () => (bool) $this
+                        ->workflow
+                        ->getItem($delay)
+                        ?->isFinished()
+                );
+            }
+
+            if (
+                is_string($step) &&
+                $delay instanceof CarbonInterval
+            ) {
+                $this->when(
+                    fn () => (bool) $this
+                        ->workflow
+                        ->getItem($step)
+                        ?->finished_at
+                        ?->add($delay)
+                        ?->isPast()
+                );
+            }
+        }
+
+        return $this;
     }
 }

tests/TestWorkflowDefinition.php

@@ -43,8 +43,8 @@ public function steps(Workflow $workflow): Collection
                 WorkflowStep::make($workflow)
                     ->after([
                         'welcome' => CarbonInterval::minutes(10),
-                        'welcome-bis',
                     ])
+                    ->after('welcome-bis')
                     ->action(function (): void {
                         //
                     })