Merge pull request #3 from MohmmedAshraf/exclude-a-step

Excluding steps based on condition

README.md

@@ -163,6 +163,15 @@ $onboarding->steps()->each(function($step) {
 });
 ```
 
+Excluding steps based on condition:
+
+```php
+Onboard::addStep('Excluded Step')
+    ->excludeIf(function (User $model) {
+        return $model->isAdmin();
+    });
+```
+
 Definining custom attributes and accessing them:
 
 ```php

src/OnboardingManager.php

@@ -29,6 +29,7 @@ public function finished(): bool
     {
         return $this->steps
             ->filter(fn (OnboardingStep $step) => $step->incomplete())
+            ->filter(fn (OnboardingStep $step) => $step->notExcluded())
             ->isEmpty();
     }
 

src/OnboardingStep.php

@@ -9,6 +9,9 @@ class OnboardingStep
 {
     protected array $attributes = [];
 
+    /** @var callable|null */
+    protected $excludeIf;
+
     /** @var callable|null */
     protected $completeIf;
 
@@ -33,6 +36,13 @@ public function link(string $link): self
         return $this;
     }
 
+    public function excludeIf(callable $callback): self
+    {
+        $this->excludeIf = $callback;
+
+        return $this;
+    }
+
     public function completeIf(callable $callback): self
     {
         $this->completeIf = $callback;
@@ -47,6 +57,20 @@ public function setModel(Onboardable $model): self
         return $this;
     }
 
+    public function excluded(): bool
+    {
+        if ($this->excludeIf && $this->model) {
+            return once(fn () => app()->call($this->excludeIf, ['model' => $this->model]));
+        }
+
+        return false;
+    }
+
+    public function notExcluded(): bool
+    {
+        return ! $this->excluded();
+    }
+
     public function complete(): bool
     {
         if ($this->completeIf && $this->model) {

src/OnboardingSteps.php

@@ -19,6 +19,8 @@ public function addStep(string $title): OnboardingStep
 
     public function steps(Onboardable $model): Collection
     {
-        return collect($this->steps)->map(fn (OnboardingStep $step) => $step->setModel($model));
+        return collect($this->steps)
+            ->map(fn (OnboardingStep $step) => $step->setModel($model))
+            ->filter(fn (OnboardingStep $step) => $step->notExcluded());
     }
 }

tests/OnboardTest.php

@@ -48,6 +48,14 @@
             return true;
         });
 
+    $onboardingSteps->addStep('Excluded Step')
+        ->excludeIf(function () {
+            return true;
+        })
+        ->completeIf(function () {
+            return false;
+        });
+
     $onboarding = new OnboardingManager($this->user, $onboardingSteps);
 
     expect($onboarding->finished())->toBeTrue()