Merge pull request #66 from aeviiq/add-unhandled-form-status

Added the unhandled form status and only allow multiple backwards tra…
aeviiq · Jul 15, 2021 · 225e228 · 225e228
2 parents 15b0a25 + 693466e
commit 225e228
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 6 deletions.
diff --git a/src/Enum/Transition/Status.php b/src/Enum/Transition/Status.php
@@ -21,6 +21,8 @@ final class Status extends AbstractFlag
 
     public const INVALID_FORM = 64;
 
+    public const UNHANDLED_FORM = 128;
+
     /**
      * @throws InvalidArgumentException When the given value contains an invalid flag combination.
      */
@@ -50,6 +52,13 @@ public function __construct(int $value)
             throw new InvalidArgumentException('A transition status can not be valid form and invalid form at the same time.');
         }
 
+        if ($this->isFlagSet($value, self::VALID_FORM) && $this->isFlagSet($value, self::UNHANDLED_FORM)) {
+            throw new InvalidArgumentException('A transition status can not be valid form and unhandled form at the same time.');
+        }
+
+        if ($this->isFlagSet($value, self::INVALID_FORM) && $this->isFlagSet($value, self::UNHANDLED_FORM)) {
+            throw new InvalidArgumentException('A transition status can not be invalid form and unhandled form at the same time.');
+        }
 
         parent::__construct($value);
     }
@@ -83,4 +92,9 @@ public function isFormValid(): bool
     {
         return $this->contains(new self(self::VALID_FORM));
     }
+
+    public function isUnhandledForm(): bool
+    {
+        return $this->contains(new self(self::UNHANDLED_FORM));
+    }
 }
diff --git a/src/Transitioner.php b/src/Transitioner.php
@@ -68,8 +68,10 @@ public function transition(FormFlowInterface $flow): Status
                     throw new TransitionException($flow, \sprintf('"%s" is an invalid requested step number in the current context.', $requestedStepNumber));
                 }
 
+                $handleForm = true;
                 while ($flow->getCurrentStepNumber() > $requestedStepNumber) {
-                    $status = $this->backwards($flow);
+                    $status = $this->backwards($flow, $handleForm);
+                    $handleForm = false;
                     if (!$status->isSuccessful()) {
                         break;
                     }
@@ -148,16 +150,19 @@ public function forwards(FormFlowInterface $flow): Status
     /**
      * {@inheritDoc}
      */
-    public function backwards(FormFlowInterface $flow): Status
+    public function backwards(FormFlowInterface $flow, bool $handleForm = true): Status
     {
         $currentStep = $flow->getCurrentStep();
         if ($flow->getCurrentStep() === $flow->getFirstStep()) {
             throw new TransitionException($flow, 'The flow is on the first step and can not transition backwards.');
         }
 
-        $form = $flow->getCurrentStepForm();
-        $this->submitForm($form);
-        $status = !$form->isSubmitted() || !$form->isValid() ? Status::INVALID_FORM : Status::VALID_FORM;
+        $status = Status::UNHANDLED_FORM;
+        if ($handleForm) {
+            $form = $flow->getCurrentStepForm();
+            $this->submitForm($form);
+            $status = !$form->isSubmitted() || !$form->isValid() ? Status::INVALID_FORM : Status::VALID_FORM;
+        }
 
         $currentStepNumber = $currentStep->getNumber();
         $event = new TransitionEvent($flow);

diff --git a/src/TransitionerInterface.php b/src/TransitionerInterface.php
@@ -90,7 +90,7 @@ public function forwards(FormFlowInterface $flow): Status;
      *
      * @throws TransitionException When the current step is the first step.
      */
-    public function backwards(FormFlowInterface $flow): Status;
+    public function backwards(FormFlowInterface $flow, bool $handleForm = true): Status;
 
     /**
      * Attempts to complete the given flow.

diff --git a/tests/Enum/Transition/StatusTest.php b/tests/Enum/Transition/StatusTest.php
@@ -50,6 +50,14 @@ public function invalidStatusCombinationProvider(): array
                 Status::VALID_FORM | Status::INVALID_FORM,
                 'A transition status can not be valid form and invalid form at the same time.',
             ],
+            'valid_form and unhandled_form' => [
+                Status::VALID_FORM | Status::UNHANDLED_FORM,
+                'A transition status can not be valid form and unhandled form at the same time.',
+            ],
+            'invalid_form and unhandled_form' => [
+                Status::INVALID_FORM | Status::UNHANDLED_FORM,
+                'A transition status can not be invalid form and unhandled form at the same time.',
+            ],
         ];
     }