feat: add support for snake and kebab cased states

Author: julian-farbcode

src/Concerns/ResolvesState.php

@@ -4,6 +4,7 @@
 
 use Farbcode\StatefulResources\Contracts\ResourceState;
 use Farbcode\StatefulResources\StateRegistry;
+use Illuminate\Support\Str;
 
 trait ResolvesState
 {
@@ -22,4 +23,27 @@ private function resolveState(ResourceState|string $state): string
 
         return $stateString;
     }
+
+    /**
+     * Resolve a state from a method name using various case conversions.
+     */
+    protected static function resolveStateFromMethodName(string $state): ?string
+    {
+        $registry = app(StateRegistry::class);
+
+        $attempts = [
+            strtolower($state),
+            Str::snake($state),
+            Str::kebab($state),
+        ];
+
+        foreach ($attempts as $attempt) {
+            $stateInstance = $registry->tryFrom($attempt);
+            if ($stateInstance !== null) {
+                return $stateInstance;
+            }
+        }
+
+        return null;
+    }
 }

src/Concerns/StatefullyLoadsAttributes.php

@@ -3,7 +3,6 @@
 namespace Farbcode\StatefulResources\Concerns;
 
 use Farbcode\StatefulResources\Contracts\ResourceState;
-use Farbcode\StatefulResources\StateRegistry;
 use Illuminate\Http\Resources\ConditionallyLoadsAttributes;
 
 /**
@@ -148,12 +147,14 @@ public function __call($method, $parameters)
 
         foreach ($singleStateMethods as $singleStateMethod) {
             if (str_starts_with($method, $singleStateMethod)) {
-                $state = strtolower(substr($method, strlen($singleStateMethod)));
+
+                $state = substr($method, strlen($singleStateMethod));
+
                 if (empty($state)) {
                     continue;
                 }
 
-                $stateInstance = app(StateRegistry::class)->tryFrom($state);
+                $stateInstance = $this->resolveStateFromMethodName($state);
 
                 if ($stateInstance === null) {
                     continue;

src/StatefulJsonResource.php

@@ -2,14 +2,15 @@
 
 namespace Farbcode\StatefulResources;
 
+use Farbcode\StatefulResources\Concerns\ResolvesState;
 use Farbcode\StatefulResources\Concerns\StatefullyLoadsAttributes;
 use Farbcode\StatefulResources\Contracts\ResourceState;
 use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Support\Facades\Context;
 
 abstract class StatefulJsonResource extends JsonResource
 {
-    use StatefullyLoadsAttributes;
+    use ResolvesState, StatefullyLoadsAttributes;
 
     private string $state;
 
@@ -53,7 +54,7 @@ public function __construct($resource)
      */
     public static function __callStatic($method, $parameters)
     {
-        $state = app(StateRegistry::class)->tryFrom($method);
+        $state = self::resolveStateFromMethodName($method);
 
         if ($state === null) {
             return parent::__callStatic($method, $parameters);

tests/Feature/CustomStatesTest.php

@@ -8,7 +8,7 @@
     CatFactory::new()->createOne();
 });
 
-it('can use a custom user-defined state', function () {
+it('can use a custom state', function () {
     /** @var TestCase $this */
     $cat = Cat::firstOrFail();
 
@@ -23,6 +23,48 @@
     ]);
 });
 
+it('can use a custom state with a magic method', function () {
+    $cat = Cat::firstOrFail();
+
+    $resource = CatResource::custom()->make($cat)->toJson();
+
+    expect($resource)->toBeJson();
+
+    expect($resource)->json()->toEqual([
+        'id' => $cat->id,
+        'name' => $cat->name,
+        'custom_field' => 'custom_value',
+    ]);
+});
+
+it('can use a snake_cased state as camelCase when using the magic method', function () {
+    $cat = Cat::firstOrFail();
+
+    $resource = CatResource::snakeCustom()->make($cat)->toJson();
+
+    expect($resource)->toBeJson();
+
+    expect($resource)->json()->toEqual([
+        'id' => $cat->id,
+        'name' => $cat->name,
+        'snake_custom_field' => 'snake_custom_value',
+    ]);
+});
+
+it('can use a kebab-cased state as camelCase when using the magic method', function () {
+    $cat = Cat::firstOrFail();
+
+    $resource = CatResource::kebabCustom()->make($cat)->toJson();
+
+    expect($resource)->toBeJson();
+
+    expect($resource)->json()->toEqual([
+        'id' => $cat->id,
+        'name' => $cat->name,
+        'kebab_custom_field' => 'kebab_custom_value',
+    ]);
+});
+
 it('cannot use an unregistered state', function () {
     /** @var TestCase $this */
     $cat = Cat::firstOrFail();

tests/TestCase.php

@@ -31,6 +31,8 @@ protected function getEnvironmentSetUp($app)
         $app['config']->set('stateful-resources.states', [
             ...State::cases(),
             'custom',
+            'snake_custom',
+            'kebab-custom',
         ]);
     }
 

workbench/app/Http/Resources/CatResource.php

@@ -22,6 +22,8 @@ public function toArray(Request $request): array
             'fluffyness' => $this->whenStateIn([State::Full], $this->fluffyness),
             'color' => $this->whenStateIn([State::Full], $this->color),
             'custom_field' => $this->whenState('custom', 'custom_value'),
+            'snake_custom_field' => $this->whenStateSnakeCustom('snake_custom_value'),
+            'kebab_custom_field' => $this->whenStateKebabCustom('kebab_custom_value'),
         ];
     }
 }