Merge pull request #238 from fmeccanici/feature/allow-all-state-trans…

…itions

Feature/Method to allow all state transitions

docs/working-with-transitions/01-configuring-transitions.md

@@ -23,7 +23,22 @@ abstract class PaymentState extends State
 }
 ```
 
-In this example we're using both a simple transition, and a custom one. Transitions can be used like so:
+In this example we're using both a simple transition, and a custom one. You can also allow all transitions if your states are already properly registered:
+
+```php
+abstract class PaymentState extends State
+{
+    // …
+
+    public static function config(): StateConfig
+    {
+        return parent::config()
+            ->allowAllTransitions();
+    }
+}
+```
+
+Transitions can then be used like so:
 
 ```php
 $payment->state->transitionTo(Paid::class);

src/StateConfig.php

@@ -127,6 +127,20 @@ public function stateChangedEvent(string $event): StateConfig
         return $this;
     }
 
+    /**
+     * @throws InvalidConfig
+     */
+    public function allowAllTransitions(): StateConfig
+    {
+        if (empty($this->registeredStates)) {
+            throw new InvalidConfig('No states registered for ' . $this->baseStateClass);
+        }
+
+        $this->allowTransitions(collect($this->registeredStates)->crossJoin($this->registeredStates)->toArray());
+
+        return $this;
+    }
+
     /**
      * @param string|\Spatie\ModelStates\State $from
      * @param string|\Spatie\ModelStates\State $to

tests/Dummy/AllowAllTransitionsState/AllowAllTransitionsState.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState;
+
+use Spatie\ModelStates\State;
+use Spatie\ModelStates\StateConfig;
+
+abstract class AllowAllTransitionsState extends State
+{
+    public static function config(): StateConfig
+    {
+        return parent::config()
+            ->default(StateA::class)
+            ->registerState(StateA::class)
+            ->registerState(StateB::class)
+            ->registerState(StateC::class)
+            ->allowAllTransitions();
+    }
+}

tests/Dummy/AllowAllTransitionsState/StateA.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState;
+
+class StateA extends AllowAllTransitionsState
+{
+
+}

tests/Dummy/AllowAllTransitionsState/StateB.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState;
+
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\AllowAllTransitionsState;
+
+class StateB extends AllowAllTransitionsState
+{
+
+}

tests/Dummy/AllowAllTransitionsState/StateC.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState;
+
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\AllowAllTransitionsState;
+
+class StateC extends AllowAllTransitionsState
+{
+
+}

tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/AllowAllTransitionsStateWithNoRegisteredStates.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
+
+use Spatie\ModelStates\State;
+use Spatie\ModelStates\StateConfig;
+
+abstract class AllowAllTransitionsStateWithNoRegisteredStates extends State
+{
+    public static function config(): StateConfig
+    {
+        return parent::config()
+            ->default(StateAWithNoRegisteredStates::class)
+            ->allowAllTransitions();
+    }
+}

tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateAWithNoRegisteredStates.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
+
+class StateAWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates
+{
+
+}

tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateBWithNoRegisteredStates.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
+
+class StateBWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates
+{
+
+}

tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateCWithNoRegisteredStates.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
+
+class StateCWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates
+{
+
+}

tests/Dummy/TestModelAllowAllTransitions.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy;
+
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\AllowAllTransitionsState;
+
+class TestModelAllowAllTransitions extends TestModel
+{
+    protected $casts = [
+        'state' => AllowAllTransitionsState::class,
+    ];
+}

tests/Dummy/TestModelAllowAllTransitionsWithNoRegisteredStates.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy;
+
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates\AllowAllTransitionsStateWithNoRegisteredStates;
+
+class TestModelAllowAllTransitionsWithNoRegisteredStates extends TestModel
+{
+    protected $casts = [
+        'state' => AllowAllTransitionsStateWithNoRegisteredStates::class,
+    ];
+}

tests/StateTest.php

@@ -1,6 +1,8 @@
 <?php
 
 use Illuminate\Support\Facades\Event;
+use Spatie\ModelStates\Exceptions\InvalidConfig;
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates\AllowAllTransitionsStateWithNoRegisteredStates;
 use Spatie\ModelStates\Events\StateChanged;
 use Spatie\ModelStates\Exceptions\ClassDoesNotExtendBaseClass;
 use Spatie\ModelStates\Tests\Dummy\CustomEventModelState\CustomEventModelStateB;
@@ -19,6 +21,8 @@
 use Spatie\ModelStates\Tests\Dummy\OtherModelStates\StateX;
 use Spatie\ModelStates\Tests\Dummy\OtherModelStates\StateY;
 use Spatie\ModelStates\Tests\Dummy\TestModel;
+use Spatie\ModelStates\Tests\Dummy\TestModelAllowAllTransitions;
+use Spatie\ModelStates\Tests\Dummy\TestModelAllowAllTransitionsWithNoRegisteredStates;
 use Spatie\ModelStates\Tests\Dummy\TestModelCustomEvent;
 use Spatie\ModelStates\Tests\Dummy\TestModelCustomInvalidEvent;
 use Spatie\ModelStates\Tests\Dummy\TestModelUpdatingEvent;
@@ -247,3 +251,31 @@
 
     $model->state->transitionTo(CustomInvalidEventModelStateB::class);
 });
+
+it('should allow all transitions', function () {
+    $model = TestModelAllowAllTransitions::create();
+
+    expect($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateA::class))->toBeTrue()
+        ->and($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateB::class))->toBeTrue()
+        ->and($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateC::class))->toBeTrue();
+
+    $model->state->transitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateB::class);
+
+    expect($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateA::class))->toBeTrue()
+        ->and($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateB::class))->toBeTrue()
+        ->and($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateC::class))->toBeTrue();
+
+    $model->state->transitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateC::class);
+
+    expect($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateA::class))->toBeTrue()
+        ->and($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateB::class))->toBeTrue()
+        ->and($model->state->canTransitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateC::class))->toBeTrue();
+
+});
+
+it('should throw exception when allowing all transitions when there are no registered states', function () {
+    $this->expectException(InvalidConfig::class);
+    $this->expectExceptionMessage('No states registered for ' . AllowAllTransitionsStateWithNoRegisteredStates::class);
+
+    TestModelAllowAllTransitionsWithNoRegisteredStates::create();
+});