refactor: rename Variant enum to State

Author: julian-farbcode

config/stateful-resources.php

@@ -1,6 +1,6 @@
 <?php
 
-use Farbcode\StatefulResources\Enums\Variant;
+use Farbcode\StatefulResources\Enums\State;
 
 return [
     /*
@@ -14,7 +14,7 @@
     |
     */
     'states' => [
-        ...Variant::cases(),
+        ...State::cases(),
         //
     ],
 
@@ -27,5 +27,5 @@
     | If not set, the first state in the states array will be used.
     |
     */
-    'default_state' => Variant::Full,
+    'default_state' => State::Full,
 ];

docs/pages/basic-usage.md

@@ -36,7 +36,7 @@ class UserResource extends StatefulJsonResource
 
 ## Built-in States
 
-The package comes with three built-in states defined in the `Variant` enum:
+The package comes with three built-in states defined in the `State` enum:
 
 -   **`Full`** - For all available attributes
 -   **`Table`** - For attributes suitable for table/listing views
@@ -53,7 +53,7 @@ Inside your stateful resource, you can use conditional methods to control which
 
 namespace App\Http\Resources;
 
-use Farbcode\StatefulResources\Enums\Variant;
+use Farbcode\StatefulResources\Enums\State;
 use Farbcode\StatefulResources\StatefulJsonResource;
 use Illuminate\Http\Request;
 
@@ -64,14 +64,14 @@ class UserResource extends StatefulJsonResource
         return [
             'id' => $this->id,
             'name' => $this->name,
-            'email' => $this->whenState(Variant::Full, $this->email),
-            'profile' => $this->whenStateIn([Variant::Full], [
+            'email' => $this->whenState(State::Full, $this->email),
+            'profile' => $this->whenStateIn([State::Full], [
                 'bio' => $this->bio,
                 'avatar' => $this->avatar,
                 'created_at' => $this->created_at,
             ]),
-            'role' => $this->whenStateIn([Variant::Full, Variant::Table], $this->role),
-            'last_login' => $this->unlessState(Variant::Minimal, $this->last_login_at),
+            'role' => $this->whenStateIn([State::Full, State::Table], $this->role),
+            'last_login' => $this->unlessState(State::Minimal, $this->last_login_at),
         ];
     }
 }
@@ -93,24 +93,24 @@ The package provides several methods to conditionally include attributes:
 Include a value only when the current state matches the specified state:
 
 ```php
-'email' => $this->whenState(Variant::Full, $this->email),
-'admin_notes' => $this->whenState(Variant::Full, $this->admin_notes, 'N/A'),
+'email' => $this->whenState(State::Full, $this->email),
+'admin_notes' => $this->whenState(State::Full, $this->admin_notes, 'N/A'),
 ```
 
 ### `unlessState`
 
 Include a value unless the current state matches the specified state:
 
 ```php
-'public_info' => $this->unlessState(Variant::Minimal, $this->public_information),
+'public_info' => $this->unlessState(State::Minimal, $this->public_information),
 ```
 
 ### `whenStateIn`
 
 Include a value when the current state is one of the specified states:
 
 ```php
-'detailed_info' => $this->whenStateIn([Variant::Full, Variant::Table], [
+'detailed_info' => $this->whenStateIn([State::Full, State::Table], [
     'department' => $this->department,
     'position' => $this->position,
 ]),
@@ -121,7 +121,7 @@ Include a value when the current state is one of the specified states:
 Include a value unless the current state is one of the specified states:
 
 ```php
-'sensitive_data' => $this->unlessStateIn([Variant::Minimal, Variant::Table], $this->sensitive_info),
+'sensitive_data' => $this->unlessStateIn([State::Minimal, State::Table], $this->sensitive_info),
 ```
 
 ### Magic Conditionals
@@ -140,15 +140,15 @@ You can also use magic methods with for cleaner syntax:
 Use the static `state()` method to create a resource with a specific state:
 
 ```php
-$user = UserResource::state(Variant::Minimal)->make($user);
+$user = UserResource::state(State::Minimal)->make($user);
 ```
 
 ### Using Magic Methods
 
 You can also use magic methods for a more fluent syntax:
 
 ```php
-// This is equivalent to the explicit state() call
+// This is equivalent to the explicit state(State::Minimal) call
 $user = UserResource::minimal()->make($user);
 ```
 

docs/pages/extending-states.md

@@ -1,6 +1,6 @@
 # Extending States
 
-You may find yourself being too limited with the three Variant states included in the package's `Variant` enum.
+You may find yourself being too limited with the three State states included in the package's `State` enum.
 This package allows you to register custom states that you can then use in your resources.
 
 ## Registering Custom States
@@ -9,10 +9,11 @@ Before using a custom state, register it in the package's `stateful-resources.st
 
 ```php
 <?php
+use Farbcode\StatefulResources\Enums\State;
 
 return [
     'states' => [
-        ...Variant::cases(), // The built-in states
+        ...State::cases(), // The built-in states
         'custom', // Your custom state as a string
         ...CustomResourceState::cases(), // Or as cases of a custom enum
     ],

src/Enums/Variant.php renamed to src/Enums/State.php

@@ -4,7 +4,7 @@
 
 use Farbcode\StatefulResources\Contracts\ResourceState;
 
-enum Variant: string implements ResourceState
+enum State: string implements ResourceState
 {
     case Full = 'full';
     case Table = 'table';

tests/Feature/DefaultStatesTest.php

@@ -1,6 +1,6 @@
 <?php
 
-use Farbcode\StatefulResources\Enums\Variant;
+use Farbcode\StatefulResources\Enums\State;
 use Farbcode\StatefulResources\Tests\TestCase;
 use Workbench\App\Http\Resources\CatResource;
 use Workbench\App\Models\Cat;
@@ -32,7 +32,7 @@
     /** @var TestCase $this */
     $cat = Cat::firstOrFail();
 
-    $resource = CatResource::state(Variant::Full)->make($cat)->toJson();
+    $resource = CatResource::state(State::Full)->make($cat)->toJson();
 
     expect($resource)->toBeJson();
 
@@ -49,7 +49,7 @@
     /** @var TestCase $this */
     $cat = Cat::firstOrFail();
 
-    $resource = CatResource::state(Variant::Minimal)->make($cat)->toJson();
+    $resource = CatResource::state(State::Minimal)->make($cat)->toJson();
 
     expect($resource)->toBeJson();
 
@@ -63,7 +63,7 @@
     /** @var TestCase $this */
     $cat = Cat::firstOrFail();
 
-    $resource = CatResource::state(Variant::Table)->make($cat)->toJson();
+    $resource = CatResource::state(State::Table)->make($cat)->toJson();
 
     expect($resource)->toBeJson();
 

tests/TestCase.php

@@ -2,7 +2,7 @@
 
 namespace Farbcode\StatefulResources\Tests;
 
-use Farbcode\StatefulResources\Enums\Variant;
+use Farbcode\StatefulResources\Enums\State;
 use Farbcode\StatefulResources\StatefulResourcesServiceProvider;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Orchestra\Testbench\Concerns\WithWorkbench;
@@ -29,7 +29,7 @@ protected function getPackageProviders($app)
     protected function getEnvironmentSetUp($app)
     {
         $app['config']->set('stateful-resources.states', [
-            ...Variant::cases(),
+            ...State::cases(),
             'custom',
         ]);
     }

workbench/app/Http/Resources/CatResource.php

@@ -2,7 +2,7 @@
 
 namespace Workbench\App\Http\Resources;
 
-use Farbcode\StatefulResources\Enums\Variant;
+use Farbcode\StatefulResources\Enums\State;
 use Farbcode\StatefulResources\StatefulJsonResource;
 use Illuminate\Http\Request;
 
@@ -18,9 +18,9 @@ public function toArray(Request $request): array
         return [
             'id' => $this->id,
             'name' => $this->name,
-            'breed' => $this->whenStateIn([Variant::Full, Variant::Table], $this->breed),
-            'fluffyness' => $this->whenStateIn([Variant::Full], $this->fluffyness),
-            'color' => $this->whenStateIn([Variant::Full], $this->color),
+            'breed' => $this->whenStateIn([State::Full, State::Table], $this->breed),
+            'fluffyness' => $this->whenStateIn([State::Full], $this->fluffyness),
+            'color' => $this->whenStateIn([State::Full], $this->color),
             'custom_field' => $this->whenState('custom', 'custom_value'),
         ];
     }