adjusted getNext/PreviousStep

Author: Tobias Wojtylak

spec/Context/FlowContextSpec.php

@@ -15,6 +15,7 @@
 use solutionDrive\MultiStepBundle\Context\FlowContextInterface;
 use solutionDrive\MultiStepBundle\Model\MultiStepFlowInterface;
 use solutionDrive\MultiStepBundle\Model\MultiStepInterface;
+use solutionDrive\MultiStepBundle\StepChecker\StepRequiredCheckerInterface;
 
 class FlowContextSpec extends ObjectBehavior
 {
@@ -39,26 +40,82 @@ public function it_returns_current_step(MultiStepInterface $currentStep): void
         $this->getCurrentStep()->shouldBe($currentStep);
     }
 
-    public function it_returns_next_step(MultiStepFlowInterface $flow, MultiStepInterface $nextStep): void
-    {
+    public function it_returns_direct_successor_as_next_step(
+        MultiStepFlowInterface $flow,
+        MultiStepInterface $nextStep,
+        StepRequiredCheckerInterface $stepRequiredChecker
+    ): void {
+        $stepRequiredChecker->check()->shouldBeCalled()->willReturn(true);
+        $nextStep->getStepRequiredChecker()->willReturn($stepRequiredChecker);
         $flow->getStepAfter(Argument::any())->shouldBeCalled()->willReturn($nextStep);
         $this->getNextStep()->shouldBe($nextStep);
     }
 
-    public function it_returns_previous_step(MultiStepFlowInterface $flow, MultiStepInterface $previousStep): void
+    public function it_returns_step_after_successor_as_next_step(
+        MultiStepFlowInterface $flow,
+        MultiStepInterface $currentStep,
+        MultiStepInterface $nextStep,
+        MultiStepInterface $nextStepAfter,
+        StepRequiredCheckerInterface $stepRequiredCheckerNext,
+        StepRequiredCheckerInterface $stepRequiredCheckerAfterNext
+    ): void {
+
+        $stepRequiredCheckerNext->check()->shouldBeCalled()->willReturn(false);
+        $nextStep->getStepRequiredChecker()->willReturn($stepRequiredCheckerNext);
+
+        $stepRequiredCheckerAfterNext->check()->shouldBeCalled()->willReturn(true);
+        $nextStepAfter->getStepRequiredChecker()->willReturn($stepRequiredCheckerAfterNext);
+
+        $flow->getStepAfter($currentStep)->shouldBeCalled()->willReturn($nextStep);
+        $flow->getStepAfter($nextStep)->shouldBeCalled()->willReturn($nextStepAfter);
+        $this->getNextStep()->shouldBe($nextStepAfter);
+    }
+
+    public function it_returns_direct_predecessor_previous_step(
+        MultiStepFlowInterface $flow,
+        MultiStepInterface $previousStep,
+        StepRequiredCheckerInterface $stepRequiredChecker
+    ): void
     {
+        $stepRequiredChecker->check()->shouldBeCalled()->willReturn(true);
+        $previousStep->getStepRequiredChecker()->willReturn($stepRequiredChecker);
         $flow->getStepBefore(Argument::any())->shouldBeCalled()->willReturn($previousStep);
         $this->getPreviousStep()->shouldBe($previousStep);
     }
 
+    public function it_returns_step_before_predecessor_as_previous_step(
+        MultiStepFlowInterface $flow,
+        MultiStepInterface $currentStep,
+        MultiStepInterface $previousStep,
+        MultiStepInterface $prviousStepBefore,
+        StepRequiredCheckerInterface $stepRequiredCheckerPrevious,
+        StepRequiredCheckerInterface $stepRequiredCheckerBeforePrevious
+    ): void {
+
+        $stepRequiredCheckerPrevious->check()->shouldBeCalled()->willReturn(false);
+        $previousStep->getStepRequiredChecker()->willReturn($stepRequiredCheckerPrevious);
+
+        $stepRequiredCheckerBeforePrevious->check()->shouldBeCalled()->willReturn(true);
+        $prviousStepBefore->getStepRequiredChecker()->willReturn($stepRequiredCheckerBeforePrevious);
+
+        $flow->getStepBefore($currentStep)->shouldBeCalled()->willReturn($previousStep);
+        $flow->getStepBefore($previousStep)->shouldBeCalled()->willReturn($prviousStepBefore);
+        $this->getPreviousStep()->shouldBe($prviousStepBefore);
+    }
+
     public function it_returns_false_for_has_next_step(MultiStepFlowInterface $flow): void
     {
         $flow->getStepAfter(Argument::any())->willReturn(null);
         $this->hasNextStep()->shouldBe(false);
     }
 
-    public function it_returns_true_for_has_next_step(MultiStepFlowInterface $flow, MultiStepInterface $nextStep): void
-    {
+    public function it_returns_true_for_has_next_step(
+        MultiStepFlowInterface $flow,
+        MultiStepInterface $nextStep,
+        StepRequiredCheckerInterface $stepRequiredChecker
+    ): void {
+        $stepRequiredChecker->check()->shouldBeCalled()->willReturn(true);
+        $nextStep->getStepRequiredChecker()->willReturn($stepRequiredChecker);
         $flow->getStepAfter(Argument::any())->willReturn($nextStep);
         $this->hasNextStep()->shouldBe(true);
     }
@@ -69,9 +126,14 @@ public function it_returns_false_for_has_previous_step(MultiStepFlowInterface $f
         $this->hasPreviousStep()->shouldBe(false);
     }
 
-    public function it_returns_true_for_has_previous_step(MultiStepFlowInterface $flow, MultiStepInterface $nextStep): void
-    {
-        $flow->getStepBefore(Argument::any())->willReturn($nextStep);
+    public function it_returns_true_for_has_previous_step(
+        MultiStepFlowInterface $flow,
+        MultiStepInterface $previousStep,
+        StepRequiredCheckerInterface $stepRequiredChecker
+    ): void {
+        $stepRequiredChecker->check()->shouldBeCalled()->willReturn(true);
+        $previousStep->getStepRequiredChecker()->willReturn($stepRequiredChecker);
+        $flow->getStepBefore(Argument::any())->willReturn($previousStep);
         $this->hasPreviousStep()->shouldBe(true);
     }
 

src/Context/FlowContext.php

@@ -34,13 +34,23 @@ public function getCurrentStep(): MultiStepInterface
     public function getNextStep(): ?MultiStepInterface
     {
         $currentStep = $this->getCurrentStep();
-        return $this->flow->getStepAfter($currentStep);
+        do {
+            $nextStep = $this->flow->getStepAfter($currentStep);
+            $currentStep = $nextStep;
+        } while (null !== $nextStep && $nextStep->getStepRequiredChecker()->check() === false);
+
+        return $nextStep;
     }
 
     public function getPreviousStep(): ?MultiStepInterface
     {
         $currentStep = $this->getCurrentStep();
-        return $this->flow->getStepBefore($currentStep);
+        do {
+            $previousStep = $this->flow->getStepBefore($currentStep);
+            $currentStep = $previousStep;
+        } while (null !== $previousStep && $previousStep->getStepRequiredChecker()->check() === false);
+
+        return $previousStep;
     }
 
     public function hasNextStep(): bool