add skip step functionality

satoved · Sep 26, 2024 · 00a8d68 · 00a8d68
1 parent 51ce010
commit 00a8d68
Show file tree

Hide file tree

Showing 4 changed files with 96 additions and 9 deletions.
diff --git a/src/Livewire/Forms/StepForm.php b/src/Livewire/Forms/StepForm.php
@@ -2,11 +2,14 @@
 
 namespace Satoved\LivewireSteps\Livewire\Forms;
 
+use Closure;
 use Livewire\Form;
 use Satoved\LivewireSteps\Livewire\WizardComponent;
 
 abstract class StepForm extends Form
 {
+    protected ?Closure $skipCondition = null;
+
     abstract public function render();
 
     public static function id(): string
@@ -47,6 +50,20 @@ public function isFirst(): bool
         return $this->index() === 0;
     }
 
+    public function shouldBeSkipped(): bool
+    {
+        if ($this->skipCondition !== null) {
+            return ($this->skipCondition)();
+        }
+
+        return false;
+    }
+
+    public function skipIf(Closure $skipCondition): void
+    {
+        $this->skipCondition = $skipCondition;
+    }
+
     public function isLast(): bool
     {
         return $this->index() === ($this->getComponent()->totalSteps() - 1);

diff --git a/src/Livewire/WizardComponent.php b/src/Livewire/WizardComponent.php
@@ -41,16 +41,20 @@ protected function currentStep(): StepForm
      */
     public function nextStep(): void
     {
-        if ($this->currentStepIndex === $this->totalSteps() - 1) {
-            throw NoNextStep::make(self::class, get_class($this->currentStep()));
-        }
+        do {
+            if ($this->currentStepIndex === $this->totalSteps() - 1) {
+                throw NoNextStep::make(self::class, get_class($this->currentStep()));
+            }
 
-        $this->currentStepIndex++;
+            $this->currentStepIndex++;
+        } while ($this->currentStep()->shouldBeSkipped());
     }
 
     public function previousStep(): void
     {
-        $this->currentStepIndex = max(0, $this->currentStepIndex - 1);
+        do {
+            $this->currentStepIndex = max(0, $this->currentStepIndex - 1);
+        } while ($this->currentStepIndex !== 0 && $this->currentStep()->shouldBeSkipped());
     }
 
     protected function isFirstStep(): bool

diff --git a/tests/TestSupport/Steps/SkipStepForm.php b/tests/TestSupport/Steps/SkipStepForm.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Satoved\LivewireSteps\Tests\TestSupport\Steps;
+
+use Satoved\LivewireSteps\Livewire\Forms\StepForm;
+
+class SkipStepForm extends StepForm
+{
+    public function shouldBeSkipped(): bool
+    {
+        return true;
+    }
+
+    public function render()
+    {
+        return '__SKIP_STEP_BODY__';
+    }
+}
diff --git a/tests/WizardTest.php b/tests/WizardTest.php
@@ -6,6 +6,7 @@
 use Satoved\LivewireSteps\Tests\TestSupport\MyWizardComponent;
 use Satoved\LivewireSteps\Tests\TestSupport\Steps\FirstStepForm;
 use Satoved\LivewireSteps\Tests\TestSupport\Steps\SecondStepForm;
+use Satoved\LivewireSteps\Tests\TestSupport\Steps\SkipStepForm;
 use Satoved\LivewireSteps\Tests\TestSupport\Steps\SomeIntricateNameStepForm;
 
 $it = it('can render a wizard component', function () {
@@ -22,7 +23,7 @@
         ->assertSee('__SECOND_STEP_BODY__');
 });
 
-it('can render the next and previous step', function () {
+it('can go to the next and previous steps', function () {
     Livewire::test(MyWizardComponent::class)
         ->assertSee('__FIRST_STEP_BODY__')
         ->call('nextStep')
@@ -31,6 +32,54 @@
         ->assertSee('__FIRST_STEP_BODY__');
 });
 
+it('can skip steps', function () {
+    $class = new class extends WizardComponent {
+        public FirstStepForm $firstStepForm;
+        public SkipStepForm $skipTestForm;
+        public SecondStepForm $secondStepForm;
+
+        public function render()
+        {
+            return '<div>{{ $this->renderStep() }}</div>';
+        }
+    };
+
+    Livewire::test($class)
+        ->assertSee('__FIRST_STEP_BODY__')
+        ->call('nextStep')
+        ->assertSee('__SECOND_STEP_BODY__')
+        ->call('previousStep')
+        ->assertSee('__FIRST_STEP_BODY__');
+});
+
+
+it('can skip steps via closure', function () {
+    $class = new class extends WizardComponent {
+        public FirstStepForm $firstStepForm;
+        public SomeIntricateNameStepForm $toSkipStepForm;
+        public SecondStepForm $secondStepForm;
+
+        public function booted()
+        {
+            $this->toSkipStepForm->skipIf(function () {
+                return true;
+            });
+        }
+
+        public function render()
+        {
+            return '<div>{{ $this->renderStep() }}</div>';
+        }
+    };
+
+    Livewire::test($class)
+        ->assertSee('__FIRST_STEP_BODY__')
+        ->call('nextStep')
+        ->assertSee('__SECOND_STEP_BODY__')
+        ->call('previousStep')
+        ->assertSee('__FIRST_STEP_BODY__');
+});
+
 it('throws an exception when going to the next step on the last step', function () {
     Livewire::test(MyWizardComponent::class, ['currentStepIndex' => 1])
         ->call('nextStep');
@@ -66,8 +115,7 @@
 });
 
 it('has default labels for steps', function () {
-    $class = new class extends WizardComponent
-    {
+    $class = new class extends WizardComponent {
         public SomeIntricateNameStepForm $someIntricateNameStepForm;
 
         public function render()
@@ -119,4 +167,4 @@ public function render()
 
             return true;
         });
-});
+});