Update to override og make enum command still need to update readme

Author: Jim-Webfox

.github/workflows/run-tests.yml

@@ -2,20 +2,20 @@ name: run-tests
 
 on:
   push:
-    branches: [main]
+    branches: [ main ]
   pull_request:
-    branches: [main]
+    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 }}
 

composer.json

@@ -17,20 +17,21 @@
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^10.0|^11.0"
+        "spatie/laravel-package-tools": "^1.18",
+        "illuminate/contracts": "^11.0",
+        "illuminate/console": "^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": "^8.5",
+        "larastan/larastan": "^3.0",
+        "orchestra/testbench": "^9.9",
+        "pestphp/pest": "^3.7",
+        "pestphp/pest-plugin-laravel": "^3.0",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan-deprecation-rules": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpunit/phpunit": "^11.5"
     },
     "autoload": {
         "psr-4": {
@@ -83,4 +84,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

src/LaravelBackedEnumMakeCommand.php

@@ -3,63 +3,26 @@
 namespace Webfox\LaravelBackedEnums;
 
 use InvalidArgumentException;
-use Illuminate\Console\GeneratorCommand;
-use Symfony\Component\Console\Attribute\AsCommand;
+use Illuminate\Foundation\Console\EnumMakeCommand;
 
 
-#[AsCommand(name: 'make:laravel-backed-enum')]
-class LaravelBackedEnumMakeCommand extends GeneratorCommand
+class LaravelBackedEnumMakeCommand extends EnumMakeCommand
 {
-    protected $signature = 'make:laravel-backed-enum {name} {enumType}';
-
     protected $description = 'Create a new laravel backed enum';
 
-    protected $type = 'Enum';
-
     protected function getStub(): string
     {
-        return $this->resolveStubPath('/stubs/laravel-backed-enum.stub');
+        if ($this->option('string') || $this->option('int')) {
+            return $this->resolveStubPath('/stubs/laravel-backed-enum.stub');
+        }
+        return parent::getStub();
     }
 
     protected function resolveStubPath($stub): string
     {
         return file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))
             ? $customPath
-            : __DIR__ . $stub;
-    }
-
-    protected function getDefaultNamespace($rootNamespace): string
-    {
-        return $rootNamespace . '\Enums';
-    }
-
-    protected function buildClass($name): array|string
-    {
-        $replace = [
-            '{{ name }}'     => class_basename($name),
-            '{{ enumType }}' => $this->argument('enumType'),
-        ];
-
-        return str_replace(
-            array_keys($replace),
-            array_values($replace),
-            parent::buildClass($name)
-        );
-    }
-
-    protected function promptForMissingArgumentsUsing(): array
-    {
-        return [
-            'enumType' => [
-                'What is the type of the enum?',
-                match (strtolower($this->argument('enumType'))) {
-                    'int', 'integer' => 'int',
-                    'str', 'string'  => 'string',
-                    default          => throw new InvalidArgumentException('Enum type must be either "int" or "string"'),
-                },
-            ],
-            ...parent::promptForMissingArgumentsUsing(),
-        ];
+            : __DIR__ . "/../" . $stub;
     }
 
     protected function getNameInput(): string
@@ -68,6 +31,11 @@ protected function getNameInput(): string
         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

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

src/stubs/laravel-backed-enum.stub renamed to stubs/laravel-backed-enum.stub

@@ -5,7 +5,7 @@ namespace {{ namespace }};
 use Webfox\LaravelBackedEnums\BackedEnum;
 use Webfox\LaravelBackedEnums\IsBackedEnum;
 
-enum {{ name }}: {{ enumType }} implements BackedEnum
+enum {{ class }}: {{ type }} implements BackedEnum
 {
     use IsBackedEnum;
 
@@ -14,5 +14,4 @@ enum {{ name }}: {{ enumType }} implements BackedEnum
      * e.g. case Standard = 'standard';
      */
 
-
 }

tests/Fixtures/ExpectedIntEnum.php

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

tests/Fixtures/ExpectedPureEnum.php

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

tests/Fixtures/ExpectedStringEnum.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App;
+
+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';
+     */
+
+}

tests/MakeEnumCommandTest.php

@@ -0,0 +1,49 @@
+<?php
+
+use Illuminate\Support\Facades\File;
+use function Pest\Laravel\artisan;
+
+it('can create an enum', function () {
+    artisan('make:enum TestEnum -s')
+        ->execute();
+    expect(base_path('app/TestEnum.php'))->toBeFile();
+});
+
+it('can make pure enum', function () {
+    artisan('make:enum PureEnum')
+        ->execute();
+
+    expect(base_path('app/PureEnum.php'))->toBeFile();
+
+    $expectedContents = File::get(__DIR__ . '/Fixtures/ExpectedPureEnum.php');
+    $actualContents   = File::get(base_path('app/PureEnum.php'));
+
+    expect($actualContents)->toEqual($expectedContents);
+});
+
+it('can make string enum', function () {
+
+    artisan('make:enum StringEnum --string --force')
+        ->execute();
+
+
+    expect(base_path('app/StringEnum.php'))->toBeFile();
+
+    $expectedContents = File::get(__DIR__ . '/Fixtures/ExpectedStringEnum.php');
+    $actualContents   = File::get(base_path('app/StringEnum.php'));
+
+    expect($actualContents)->toEqual($expectedContents);
+});
+
+it('can make int enum', function () {
+
+    artisan('make:enum IntEnum --int --force')
+        ->execute();
+
+    expect(base_path('app/IntEnum.php'))->toBeFile();
+
+    $expectedContents = File::get(__DIR__ . '/Fixtures/ExpectedIntEnum.php');
+    $actualContents   = File::get(base_path('app/IntEnum.php'));
+
+    expect($actualContents)->toEqual($expectedContents);
+});

tests/TestCase.php

@@ -18,9 +18,4 @@ protected function getPackageProviders($app)
             LaravelBackedEnumsServiceProvider::class,
         ];
     }
-
-    public static function applicationBasePath(): string
-    {
-        return __DIR__.'/../workbench';
-    }
 }