Merge pull request #265 from jonjakoblich/main

freekmurze · web-flow · commit 2ca065ef483d · 2024-12-11T10:58:12.000+01:00
Make using allowAllTransitions() less cumbersome
diff --git a/composer.json b/composer.json
@@ -22,7 +22,8 @@
         "illuminate/contracts": "^8.73 | ^9.0 | ^10.0 | ^11.0",
         "illuminate/database": "^8.73 | ^9.0 | ^10.0 | ^11.0",
         "illuminate/support": "^8.73 | ^9.0 | ^10.0 | ^11.0",
-        "spatie/laravel-package-tools": "^1.9"
+        "spatie/laravel-package-tools": "^1.9",
+        "spatie/php-structure-discoverer": "^2.2"
     },
     "require-dev": {
         "orchestra/testbench": "^6.23 | ^7.0 | ^8.0 | ^9.0",
diff --git a/docs/working-with-transitions/01-configuring-transitions.md b/docs/working-with-transitions/01-configuring-transitions.md
@@ -23,7 +23,7 @@ abstract class PaymentState extends State
 }
 ```
 
-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:
+In this example we're using both a simple transition, and a custom one. You can also allow all transitions for all registered states. Concrete states extending the abstract state class that are located in the same directory as the abstract state class will be automatically registered:
 
 ```php
 abstract class PaymentState extends State
diff --git a/src/StateConfig.php b/src/StateConfig.php
@@ -2,8 +2,10 @@
 
 namespace Spatie\ModelStates;
 
+use ReflectionClass;
 use Spatie\ModelStates\Events\StateChanged;
 use Spatie\ModelStates\Exceptions\InvalidConfig;
+use Spatie\StructureDiscoverer\Discover;
 
 class StateConfig
 {
@@ -132,6 +134,8 @@ public function stateChangedEvent(string $event): StateConfig
      */
     public function allowAllTransitions(): StateConfig
     {
+        $this->registerBaseStateClassDirectoryStates();
+
         if (empty($this->registeredStates)) {
             throw new InvalidConfig('No states registered for ' . $this->baseStateClass);
         }
@@ -141,6 +145,20 @@ public function allowAllTransitions(): StateConfig
         return $this;
     }
 
+    private function registerBaseStateClassDirectoryStates(): void
+    {
+        $reflector = new ReflectionClass($this->baseStateClass);
+        $filename = $reflector->getFileName();
+        $baseStateClassDirectory = dirname($filename);
+
+        $stateClasses = Discover::in($baseStateClassDirectory)
+                            ->classes()
+                            ->extending($this->baseStateClass)
+                            ->get();
+
+        $this->registerState($stateClasses);
+    }
+
     /**
      * @param string|\Spatie\ModelStates\State $from
      * @param string|\Spatie\ModelStates\State $to
diff --git a/tests/Dummy/AllowAllTransitionsState/AllowAllTransitionsState.php b/tests/Dummy/AllowAllTransitionsState/AllowAllTransitionsState.php
@@ -11,9 +11,6 @@ public static function config(): StateConfig
     {
         return parent::config()
             ->default(StateA::class)
-            ->registerState(StateA::class)
-            ->registerState(StateB::class)
-            ->registerState(StateC::class)
             ->allowAllTransitions();
     }
 }
diff --git a/tests/Dummy/AllowAllTransitionsStateWithExplicitlyRegisteredStates/AllowAllTransitionsStateWithExplicitlyRegisteredStates.php b/tests/Dummy/AllowAllTransitionsStateWithExplicitlyRegisteredStates/AllowAllTransitionsStateWithExplicitlyRegisteredStates.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates;
+
+use Spatie\ModelStates\State;
+use Spatie\ModelStates\StateConfig;
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates\StateAWithNoRegisteredStates;
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates\StateBWithNoRegisteredStates;
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates\StateCWithNoRegisteredStates;
+
+abstract class AllowAllTransitionsStateWithExplicitlyRegisteredStates extends State
+{
+    public static function config(): StateConfig
+    {
+        return parent::config()
+            ->registerState(StateAWithNoRegisteredStates::class)
+            ->registerState(StateBWithNoRegisteredStates::class)
+            ->registerState(StateCWithNoRegisteredStates::class)
+            ->default(StateAWithNoRegisteredStates::class)
+            ->allowAllTransitions();
+    }
+}
diff --git a/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/AllowAllTransitionsStateWithNoRegisteredStates.php b/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/AllowAllTransitionsStateWithNoRegisteredStates.php
@@ -4,13 +4,14 @@
 
 use Spatie\ModelStates\State;
 use Spatie\ModelStates\StateConfig;
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateA;
 
 abstract class AllowAllTransitionsStateWithNoRegisteredStates extends State
 {
     public static function config(): StateConfig
     {
         return parent::config()
-            ->default(StateAWithNoRegisteredStates::class)
+            ->default(StateA::class)
             ->allowAllTransitions();
     }
 }
diff --git a/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateAWithNoRegisteredStates.php b/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateAWithNoRegisteredStates.php
@@ -2,7 +2,9 @@
 
 namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
 
-class StateAWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates\AllowAllTransitionsStateWithExplicitlyRegisteredStates;
+
+class StateAWithNoRegisteredStates extends AllowAllTransitionsStateWithExplicitlyRegisteredStates
 {
 
 }
diff --git a/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateBWithNoRegisteredStates.php b/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateBWithNoRegisteredStates.php
@@ -2,7 +2,9 @@
 
 namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
 
-class StateBWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates\AllowAllTransitionsStateWithExplicitlyRegisteredStates;
+
+class StateBWithNoRegisteredStates extends AllowAllTransitionsStateWithExplicitlyRegisteredStates
 {
 
 }
diff --git a/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateCWithNoRegisteredStates.php b/tests/Dummy/AllowAllTransitionsStateWithNoRegisteredStates/StateCWithNoRegisteredStates.php
@@ -2,7 +2,9 @@
 
 namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
 
-class StateCWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates\AllowAllTransitionsStateWithExplicitlyRegisteredStates;
+
+class StateCWithNoRegisteredStates extends AllowAllTransitionsStateWithExplicitlyRegisteredStates
 {
 
 }
diff --git a/tests/Dummy/TestModelAllowAllTransitionsWithExplicitlyRegisteredStates.php b/tests/Dummy/TestModelAllowAllTransitionsWithExplicitlyRegisteredStates.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Spatie\ModelStates\Tests\Dummy;
+
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates\AllowAllTransitionsStateWithExplicitlyRegisteredStates;
+
+class TestModelAllowAllTransitionsWithExplicitlyRegisteredStates extends TestModel
+{
+    protected $casts = [
+        'state' => AllowAllTransitionsStateWithExplicitlyRegisteredStates::class,
+    ];
+}
diff --git a/tests/StateTest.php b/tests/StateTest.php
@@ -2,7 +2,7 @@
 
 use Illuminate\Support\Facades\Event;
 use Spatie\ModelStates\Exceptions\InvalidConfig;
-use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates\AllowAllTransitionsStateWithNoRegisteredStates;
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;
 use Spatie\ModelStates\Events\StateChanged;
 use Spatie\ModelStates\Exceptions\ClassDoesNotExtendBaseClass;
 use Spatie\ModelStates\Tests\Dummy\CustomEventModelState\CustomEventModelStateB;
@@ -22,12 +22,14 @@
 use Spatie\ModelStates\Tests\Dummy\OtherModelStates\StateY;
 use Spatie\ModelStates\Tests\Dummy\TestModel;
 use Spatie\ModelStates\Tests\Dummy\TestModelAllowAllTransitions;
+use Spatie\ModelStates\Tests\Dummy\TestModelAllowAllTransitionsWithExplicitlyRegisteredStates;
 use Spatie\ModelStates\Tests\Dummy\TestModelAllowAllTransitionsWithNoRegisteredStates;
 use Spatie\ModelStates\Tests\Dummy\TestModelCustomEvent;
 use Spatie\ModelStates\Tests\Dummy\TestModelCustomInvalidEvent;
 use Spatie\ModelStates\Tests\Dummy\TestModelUpdatingEvent;
 use Spatie\ModelStates\Tests\Dummy\TestModelWithCustomTransition;
 use Spatie\ModelStates\Tests\Dummy\TestModelWithDefault;
+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState;
 
 it('resolve state class', function () {
     expect(ModelState::resolveStateClass(StateA::class))->toEqual(StateA::class);
@@ -255,27 +257,52 @@
 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();
+    expect($model->state)
+        ->canTransitionTo(AllowAllTransitionsState\StateA::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsState\StateB::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsState\StateC::class)->toBeTrue();
 
-    $model->state->transitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateB::class);
+    $model->state->transitionTo(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();
+    expect($model->state)
+        ->canTransitionTo(AllowAllTransitionsState\StateA::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsState\StateB::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsState\StateC::class)->toBeTrue();
 
-    $model->state->transitionTo(\Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateC::class);
+    $model->state->transitionTo(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();
+    expect($model->state)
+        ->canTransitionTo(AllowAllTransitionsState\StateA::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsState\StateB::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsState\StateC::class)->toBeTrue();
+});
+
+it('should allow all transitions for explicitly registered states', function () {
+    $model = TestModelAllowAllTransitionsWithExplicitlyRegisteredStates::create();
+
+    expect($model->state)
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateAWithNoRegisteredStates::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateBWithNoRegisteredStates::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateCWithNoRegisteredStates::class)->toBeTrue();
+
+    $model->state->transitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateBWithNoRegisteredStates::class);
+
+    expect($model->state)
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateAWithNoRegisteredStates::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateBWithNoRegisteredStates::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateCWithNoRegisteredStates::class)->toBeTrue();
+
+    $model->state->transitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateCWithNoRegisteredStates::class);
 
+    expect($model->state)
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateAWithNoRegisteredStates::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateBWithNoRegisteredStates::class)->toBeTrue()
+        ->canTransitionTo(AllowAllTransitionsStateWithNoRegisteredStates\StateCWithNoRegisteredStates::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);
+    $this->expectExceptionMessage('No states registered for ' . AllowAllTransitionsStateWithNoRegisteredStates\AllowAllTransitionsStateWithNoRegisteredStates::class);
 
     TestModelAllowAllTransitionsWithNoRegisteredStates::create();
 });

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ abstract class PaymentState extends State`
`23`	`23`	`}`
`24`	`24`	```
`25`	`25`
`26`		`-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:`
	`26`	`+In this example we're using both a simple transition, and a custom one. You can also allow all transitions for all registered states. Concrete states extending the abstract state class that are located in the same directory as the abstract state class will be automatically registered:`
`27`	`27`
`28`	`28`	```php
`29`	`29`	`abstract class PaymentState extends State`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,6 @@ public static function config(): StateConfig`
`11`	`11`	`{`
`12`	`12`	`return parent::config()`
`13`	`13`	`->default(StateA::class)`
`14`		`- ->registerState(StateA::class)`
`15`		`- ->registerState(StateB::class)`
`16`		`- ->registerState(StateC::class)`
`17`	`14`	`->allowAllTransitions();`
`18`	`15`	`}`
`19`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,14 @@`
`4`	`4`
`5`	`5`	`use Spatie\ModelStates\State;`
`6`	`6`	`use Spatie\ModelStates\StateConfig;`
	`7`	`+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsState\StateA;`
`7`	`8`
`8`	`9`	`abstract class AllowAllTransitionsStateWithNoRegisteredStates extends State`
`9`	`10`	`{`
`10`	`11`	`public static function config(): StateConfig`
`11`	`12`	`{`
`12`	`13`	`return parent::config()`
`13`		`- ->default(StateAWithNoRegisteredStates::class)`
	`14`	`+ ->default(StateA::class)`
`14`	`15`	`->allowAllTransitions();`
`15`	`16`	`}`
`16`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;`
`4`	`4`
`5`		`-class StateAWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates`
	`5`	`+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates\AllowAllTransitionsStateWithExplicitlyRegisteredStates;`
	`6`	`+`
	`7`	`+class StateAWithNoRegisteredStates extends AllowAllTransitionsStateWithExplicitlyRegisteredStates`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;`
`4`	`4`
`5`		`-class StateBWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates`
	`5`	`+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates\AllowAllTransitionsStateWithExplicitlyRegisteredStates;`
	`6`	`+`
	`7`	`+class StateBWithNoRegisteredStates extends AllowAllTransitionsStateWithExplicitlyRegisteredStates`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithNoRegisteredStates;`
`4`	`4`
`5`		`-class StateCWithNoRegisteredStates extends AllowAllTransitionsStateWithNoRegisteredStates`
	`5`	`+use Spatie\ModelStates\Tests\Dummy\AllowAllTransitionsStateWithExplicitlyRegisteredStates\AllowAllTransitionsStateWithExplicitlyRegisteredStates;`
	`6`	`+`
	`7`	`+class StateCWithNoRegisteredStates extends AllowAllTransitionsStateWithExplicitlyRegisteredStates`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`}`