Add make command

.github/workflows/run-tests.yml

@@ -2,21 +2,20 @@ name: run-tests
 
 on:
   push:
-    branches: [main]
+    branches: [ main ]
   pull_request:
-    branches: [main]
-  workflow_dispatch:
+    branches: [ main ]
 
 jobs:
   test:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: true
       matrix:
-        os: [ubuntu-latest]
-        php: [8.2]
-        laravel: [11.*]
-        stability: [prefer-lowest, prefer-stable]
+        os: [ ubuntu-latest ]
+        php: [ 8.2 ]
+        laravel: [ 10.*,11.* ]
+        stability: [ prefer-lowest, prefer-stable ]
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
@@ -38,6 +37,7 @@ jobs:
 
       - name: Install dependencies
         run: |
+          composer require "laravel/framework:${{ matrix.laravel }}" --no-interaction --no-update
           composer install
 
       - name: Execute tests

README.md

@@ -13,7 +13,45 @@ composer require webfox/laravel-backed-enums
 
 ## Usage
 
-### Setup your enum
+### Make Command
+
+Conveniently create a new laravel backed enum using the existing enum make command.
+
+#### Command:
+
+```Bash
+php artisan make:enum {name} {type?} 
+```
+
+#### Arguments:
+
+* `{name}`: The name of the enum class to be created (e.g., OrderStatus). The command will automatically append "Enum" to the name (e.g., OrderStatusEnum).
+* `{type?}`: The underlying data type for the enum. Can be either --int --string or if not specified it will be a pure enum.
+* `{--force}`: Overwrite the enum if it already exists.
+  Example Usage:
+
+To create an enum named OrderStatusEnum backed by integers:
+
+``` Bash
+php artisan make:enum OrderStatus --int
+```
+
+To create an enum named OrderStatusEnum backed by strings:
+
+``` Bash
+php artisan make:enum OrderStatus --string
+```
+
+To create a pure enum named OrderStatusEnum:
+
+``` Bash
+php artisan make:enum OrderStatus
+
+```
+
+This will generate an OrderStatusEnums in the `app/Enums` directory.
+
+### Upgrade your existing enums
 
 The enum you create must implement the `BackedEnum` interface and also use the `IsBackedEnum` trait.
 The interface is required for Laravel to cast your enum correctly and the trait is what gives your enum its superpowers.
@@ -316,6 +354,7 @@ The backed enums may be validated using Laravel's standard Enum validation rule
 This method a shortcut for the validation rule.
 
 #### Usage
+
 ```
 public function rules(): array
 {
@@ -328,34 +367,41 @@ public function rules(): array
 ## Other Classes
 
 ### AsFullEnumCollection
-This cast is similar to the Laravel built in `AsEnumCollection` cast but unlike the built-in  will maintain the full `toArray` structure
+
+This cast is similar to the Laravel built in `AsEnumCollection` cast but unlike the built-in will maintain the full `toArray` structure
 when converting to json.
 
 E.g. the Laravel built in `AsEnumCollection` cast will return the following json:
+
 ```json
-["MILLIGRAMS", "GRAMS"]
+[
+    "MILLIGRAMS",
+    "GRAMS"
+]
 ```
+
 This cast will return
+
 ```json
 [
-  {
-    "name": "MILLIGRAMS",
-    "value": "MILLIGRAMS",
-    "label": "mg",
-    "meta": {
-      "background_color": "bg-green-100",
-      "text_color": "text-green-800"
-    }
-  },
-  {
-    "name": "GRAMS",
-    "value": "GRAMS",
-    "label": "g",
-    "meta": {
-      "background_color": "bg-red-100",
-      "text_color": "text-red-800"
+    {
+        "name": "MILLIGRAMS",
+        "value": "MILLIGRAMS",
+        "label": "mg",
+        "meta": {
+            "background_color": "bg-green-100",
+            "text_color": "text-green-800"
+        }
+    },
+    {
+        "name": "GRAMS",
+        "value": "GRAMS",
+        "label": "g",
+        "meta": {
+            "background_color": "bg-red-100",
+            "text_color": "text-red-800"
+        }
     }
-  }
 ]
 ```
 

composer.json

@@ -17,20 +17,21 @@
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^10.0|^11.0"
+        "illuminate/console": "^10.0 | ^11.0",
+        "spatie/laravel-package-tools": "^1.18",
+        "illuminate/contracts": "^10.0 | ^11.0"
     },
     "require-dev": {
-        "laravel/pint": "^1.0",
-        "nunomaduro/collision": "^6.1",
-        "larastan/larastan": "^v2.9.2",
-        "orchestra/testbench": "^8.0",
-        "pestphp/pest": "^1.21",
-        "pestphp/pest-plugin-laravel": "^1.1",
-        "phpstan/extension-installer": "^1.1",
-        "phpstan/phpstan-deprecation-rules": "^1.0",
-        "phpstan/phpstan-phpunit": "^1.0",
-        "phpunit/phpunit": "^9.6"
+        "laravel/pint": "^1.20",
+        "nunomaduro/collision": "^7.11 | ^8.5",
+        "pestphp/pest": "^2.36 | ^3.7",
+        "pestphp/pest-plugin-laravel": "^2.4 | ^3.0",
+        "orchestra/testbench": "^8.31 | ^9.9",
+        "phpunit/phpunit": "^10.5 | ^11.5",
+        "phpstan/extension-installer": "^1.4",
+        "larastan/larastan": "^2.9 | ^3.0",
+        "phpstan/phpstan-phpunit": "^1.4 | ^2.0",
+        "phpstan/phpstan-deprecation-rules": "^1.2 | ^2.0"
     },
     "autoload": {
         "psr-4": {
@@ -83,4 +84,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

phpstan.neon.dist

@@ -9,5 +9,4 @@ parameters:
     tmpDir: build/phpstan
     checkOctaneCompatibility: true
     checkModelProperties: true
-    checkMissingIterableValueType: false
 

src/IsBackedEnum.php

@@ -13,6 +13,7 @@
 /**
  * @implements \Webfox\LaravelBackedEnums\BackedEnum<string,string>
  * @mixin \BackedEnum<string,string>
+ * @phpstan-ignore trait.unused
  */
 trait IsBackedEnum
 {

src/LaravelBackedEnumMakeCommand.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Webfox\LaravelBackedEnums;
+
+use InvalidArgumentException;
+use Illuminate\Foundation\Console\EnumMakeCommand;
+
+
+class LaravelBackedEnumMakeCommand extends EnumMakeCommand
+{
+    protected $description = 'Create a new laravel backed enum';
+
+    protected function getStub(): string
+    {
+        if ($this->option('string') || $this->option('int')) {
+            return $this->resolveStubPath('/stubs/laravel-backed-enum.stub');
+        }
+        return parent::getStub();
+    }
+
+    protected function buildClass($name): array|string
+    {
+        if ($this->option('string') || $this->option('int')) {
+            return str_replace(
+                ['{{ value }}'],
+                $this->option('string') ? '\'standard\'' : '0',
+                parent::buildClass($name)
+            );
+        }
+        return parent::buildClass($name);
+    }
+
+
+    protected function resolveStubPath($stub): string
+    {
+
+        if (file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))) {
+            return $customPath;
+        }
+
+        if (file_exists(__DIR__ . "/../" . $stub)) {
+            return __DIR__ . "/../" . $stub;
+        }
+
+        return parent::resolveStubPath($stub);
+    }
+
+    protected function getNameInput(): string
+    {
+        $name = trim($this->argument('name'));
+        if (!preg_match('/^[A-Za-z_\x7f-\xff][A-Za-z0-9_\x7f-\xff]*$/', $name)) {
+            throw new InvalidArgumentException('Invalid enum name format');
+        }
+
+        if (str_ends_with($name, 'Enum')) {
+            return $name;
+        }
+
+        return $name . 'Enum';
+    }
+}

src/LaravelBackedEnumsServiceProvider.php

@@ -17,5 +17,11 @@ public function configurePackage(Package $package): void
         $package
             ->name('laravel-backed-enums')
             ->hasConfigFile();
+
+
+        /** @noinspection PhpFullyQualifiedNameUsageInspection */
+        if (class_exists(\Illuminate\Foundation\Console\EnumMakeCommand::class)) {
+            $package->hasConsoleCommand(LaravelBackedEnumMakeCommand::class);
+        }
     }
 }

stubs/laravel-backed-enum.stub

@@ -0,0 +1,17 @@
+<?php
+
+namespace {{ namespace }};
+
+use Webfox\LaravelBackedEnums\BackedEnum;
+use Webfox\LaravelBackedEnums\IsBackedEnum;
+
+enum {{ class }}: {{ type }} implements BackedEnum
+{
+    use IsBackedEnum;
+
+    /**
+     * Add your Enums below using.
+     * e.g. case Standard = {{ value }};
+     */
+
+}

tests/Fixtures/ExpectedIntEnum.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Workbench\App\Enums;
+
+use Webfox\LaravelBackedEnums\BackedEnum;
+use Webfox\LaravelBackedEnums\IsBackedEnum;
+
+enum IntEnum: int implements BackedEnum
+{
+    use IsBackedEnum;
+
+    /**
+     * Add your Enums below using.
+     * e.g. case Standard = 0;
+     */
+
+}

tests/Fixtures/ExpectedPureEnum.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Workbench\App\Enums;
+
+enum PureEnum
+{
+    //
+}

tests/Fixtures/ExpectedStringEnum.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Workbench\App\Enums;
+
+use Webfox\LaravelBackedEnums\BackedEnum;
+use Webfox\LaravelBackedEnums\IsBackedEnum;
+
+enum StringEnum: string implements BackedEnum
+{
+    use IsBackedEnum;
+
+    /**
+     * Add your Enums below using.
+     * e.g. case Standard = 'standard';
+     */
+
+}