Add support for enum default arguments using enum cases (#1464)

* add case when default value is of type enum

* Update CHANGELOG.md

* add tests for enum arguments default values

* ignore psalm issue (built-in `\UnitEnum` class does not exists in PHP7)

* Update run-static-analysis.yml to use PHP8.1

---------

Co-authored-by: Barry vd. Heuvel <[email protected]>
Co-authored-by: Barry vd. Heuvel <[email protected]>

.github/workflows/run-static-analysis.yml

@@ -17,7 +17,7 @@ jobs:
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
-                php-version: 8.0
+                php-version: 8.1
                 coverage: none
                 extensions: pdo_sqlite
 

CHANGELOG.md

@@ -8,6 +8,10 @@ All notable changes to this project will be documented in this file.
 ### Changed
 - Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504)
 
+
+### Added
+- Add support for enum default arguments using enum cases. [#1464 / d8vjork](https://github.com/barryvdh/laravel-ide-helper/pull/1464)
+
 2024-02-05, 2.14.0
 ------------------
 

psalm-baseline.xml

@@ -16,4 +16,9 @@
       <code>\Storage</code>
     </UndefinedClass>
   </file>
+  <file src="src/Console/ModelsCommand.php">
+    <UndefinedClass occurrences="1">
+      <code>\UnitEnum</code>
+    </UndefinedClass>
+  </file>
 </files>

src/Console/ModelsCommand.php

@@ -1099,6 +1099,8 @@ class ModelsCommand extends Command
                     $default = 'null';
                 } elseif (is_int($default)) {
                     //$default = $default;
+                } elseif ($default instanceof \UnitEnum) {
+                    $default = '\\' . get_class($default) . '::' . $default->name;
                 } else {
                     $default = "'" . trim($default) . "'";
                 }

tests/Console/ModelsCommand/GenerateBasicPhpDocWithEnumDefaults/Enums/PostStatus.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums;
+
+enum PostStatus
+{
+    case Published;
+
+    case Unpublished;
+
+    case Archived;
+}

tests/Console/ModelsCommand/GenerateBasicPhpDocWithEnumDefaults/Models/Post.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Builder;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus;
+
+class Post extends Model
+{
+    public function scopeHasStatus(Builder $query, ?PostStatus $status = PostStatus::Published)
+    {
+        // 
+    }
+}

tests/Console/ModelsCommand/GenerateBasicPhpDocWithEnumDefaults/Test.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    public function test(): void
+    {
+        if (!version_compare(PHP_VERSION, '8.1', '>=')) {
+            $this->markTestSkipped(
+                'This test only works in PHP >= 8.1'
+            );
+        }
+
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+}

tests/Console/ModelsCommand/GenerateBasicPhpDocWithEnumDefaults/__snapshots__/Test__test__1.php

@@ -0,0 +1,172 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Builder;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus;
+
+/**
+ * Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models\Post
+ *
+ * @property integer $id
+ * @property string|null $char_nullable
+ * @property string $char_not_nullable
+ * @property string|null $string_nullable
+ * @property string $string_not_nullable
+ * @property string|null $text_nullable
+ * @property string $text_not_nullable
+ * @property string|null $medium_text_nullable
+ * @property string $medium_text_not_nullable
+ * @property string|null $long_text_nullable
+ * @property string $long_text_not_nullable
+ * @property integer|null $integer_nullable
+ * @property integer $integer_not_nullable
+ * @property integer|null $tiny_integer_nullable
+ * @property integer $tiny_integer_not_nullable
+ * @property integer|null $small_integer_nullable
+ * @property integer $small_integer_not_nullable
+ * @property integer|null $medium_integer_nullable
+ * @property integer $medium_integer_not_nullable
+ * @property integer|null $big_integer_nullable
+ * @property integer $big_integer_not_nullable
+ * @property integer|null $unsigned_integer_nullable
+ * @property integer $unsigned_integer_not_nullable
+ * @property integer|null $unsigned_tiny_integer_nullable
+ * @property integer $unsigned_tiny_integer_not_nullable
+ * @property integer|null $unsigned_small_integer_nullable
+ * @property integer $unsigned_small_integer_not_nullable
+ * @property integer|null $unsigned_medium_integer_nullable
+ * @property integer $unsigned_medium_integer_not_nullable
+ * @property integer|null $unsigned_big_integer_nullable
+ * @property integer $unsigned_big_integer_not_nullable
+ * @property float|null $float_nullable
+ * @property float $float_not_nullable
+ * @property float|null $double_nullable
+ * @property float $double_not_nullable
+ * @property string|null $decimal_nullable
+ * @property string $decimal_not_nullable
+ * @property string|null $unsigned_decimal_nullable
+ * @property string $unsigned_decimal_not_nullable
+ * @property integer|null $boolean_nullable
+ * @property integer $boolean_not_nullable
+ * @property string|null $enum_nullable
+ * @property string $enum_not_nullable
+ * @property string|null $json_nullable
+ * @property string $json_not_nullable
+ * @property string|null $jsonb_nullable
+ * @property string $jsonb_not_nullable
+ * @property string|null $date_nullable
+ * @property string $date_not_nullable
+ * @property string|null $datetime_nullable
+ * @property string $datetime_not_nullable
+ * @property string|null $datetimetz_nullable
+ * @property string $datetimetz_not_nullable
+ * @property string|null $time_nullable
+ * @property string $time_not_nullable
+ * @property string|null $timetz_nullable
+ * @property string $timetz_not_nullable
+ * @property string|null $timestamp_nullable
+ * @property string $timestamp_not_nullable
+ * @property string|null $timestamptz_nullable
+ * @property string $timestamptz_not_nullable
+ * @property integer|null $year_nullable
+ * @property integer $year_not_nullable
+ * @property mixed|null $binary_nullable
+ * @property mixed $binary_not_nullable
+ * @property string|null $uuid_nullable
+ * @property string $uuid_not_nullable
+ * @property string|null $ipaddress_nullable
+ * @property string $ipaddress_not_nullable
+ * @property string|null $macaddress_nullable
+ * @property string $macaddress_not_nullable
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @method static Builder|Post hasStatus(?\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus $status = \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus::Published)
+ * @method static Builder|Post newModelQuery()
+ * @method static Builder|Post newQuery()
+ * @method static Builder|Post query()
+ * @method static Builder|Post whereBigIntegerNotNullable($value)
+ * @method static Builder|Post whereBigIntegerNullable($value)
+ * @method static Builder|Post whereBinaryNotNullable($value)
+ * @method static Builder|Post whereBinaryNullable($value)
+ * @method static Builder|Post whereBooleanNotNullable($value)
+ * @method static Builder|Post whereBooleanNullable($value)
+ * @method static Builder|Post whereCharNotNullable($value)
+ * @method static Builder|Post whereCharNullable($value)
+ * @method static Builder|Post whereCreatedAt($value)
+ * @method static Builder|Post whereDateNotNullable($value)
+ * @method static Builder|Post whereDateNullable($value)
+ * @method static Builder|Post whereDatetimeNotNullable($value)
+ * @method static Builder|Post whereDatetimeNullable($value)
+ * @method static Builder|Post whereDatetimetzNotNullable($value)
+ * @method static Builder|Post whereDatetimetzNullable($value)
+ * @method static Builder|Post whereDecimalNotNullable($value)
+ * @method static Builder|Post whereDecimalNullable($value)
+ * @method static Builder|Post whereDoubleNotNullable($value)
+ * @method static Builder|Post whereDoubleNullable($value)
+ * @method static Builder|Post whereEnumNotNullable($value)
+ * @method static Builder|Post whereEnumNullable($value)
+ * @method static Builder|Post whereFloatNotNullable($value)
+ * @method static Builder|Post whereFloatNullable($value)
+ * @method static Builder|Post whereId($value)
+ * @method static Builder|Post whereIntegerNotNullable($value)
+ * @method static Builder|Post whereIntegerNullable($value)
+ * @method static Builder|Post whereIpaddressNotNullable($value)
+ * @method static Builder|Post whereIpaddressNullable($value)
+ * @method static Builder|Post whereJsonNotNullable($value)
+ * @method static Builder|Post whereJsonNullable($value)
+ * @method static Builder|Post whereJsonbNotNullable($value)
+ * @method static Builder|Post whereJsonbNullable($value)
+ * @method static Builder|Post whereLongTextNotNullable($value)
+ * @method static Builder|Post whereLongTextNullable($value)
+ * @method static Builder|Post whereMacaddressNotNullable($value)
+ * @method static Builder|Post whereMacaddressNullable($value)
+ * @method static Builder|Post whereMediumIntegerNotNullable($value)
+ * @method static Builder|Post whereMediumIntegerNullable($value)
+ * @method static Builder|Post whereMediumTextNotNullable($value)
+ * @method static Builder|Post whereMediumTextNullable($value)
+ * @method static Builder|Post whereSmallIntegerNotNullable($value)
+ * @method static Builder|Post whereSmallIntegerNullable($value)
+ * @method static Builder|Post whereStringNotNullable($value)
+ * @method static Builder|Post whereStringNullable($value)
+ * @method static Builder|Post whereTextNotNullable($value)
+ * @method static Builder|Post whereTextNullable($value)
+ * @method static Builder|Post whereTimeNotNullable($value)
+ * @method static Builder|Post whereTimeNullable($value)
+ * @method static Builder|Post whereTimestampNotNullable($value)
+ * @method static Builder|Post whereTimestampNullable($value)
+ * @method static Builder|Post whereTimestamptzNotNullable($value)
+ * @method static Builder|Post whereTimestamptzNullable($value)
+ * @method static Builder|Post whereTimetzNotNullable($value)
+ * @method static Builder|Post whereTimetzNullable($value)
+ * @method static Builder|Post whereTinyIntegerNotNullable($value)
+ * @method static Builder|Post whereTinyIntegerNullable($value)
+ * @method static Builder|Post whereUnsignedBigIntegerNotNullable($value)
+ * @method static Builder|Post whereUnsignedBigIntegerNullable($value)
+ * @method static Builder|Post whereUnsignedDecimalNotNullable($value)
+ * @method static Builder|Post whereUnsignedDecimalNullable($value)
+ * @method static Builder|Post whereUnsignedIntegerNotNullable($value)
+ * @method static Builder|Post whereUnsignedIntegerNullable($value)
+ * @method static Builder|Post whereUnsignedMediumIntegerNotNullable($value)
+ * @method static Builder|Post whereUnsignedMediumIntegerNullable($value)
+ * @method static Builder|Post whereUnsignedSmallIntegerNotNullable($value)
+ * @method static Builder|Post whereUnsignedSmallIntegerNullable($value)
+ * @method static Builder|Post whereUnsignedTinyIntegerNotNullable($value)
+ * @method static Builder|Post whereUnsignedTinyIntegerNullable($value)
+ * @method static Builder|Post whereUpdatedAt($value)
+ * @method static Builder|Post whereUuidNotNullable($value)
+ * @method static Builder|Post whereUuidNullable($value)
+ * @method static Builder|Post whereYearNotNullable($value)
+ * @method static Builder|Post whereYearNullable($value)
+ * @mixin \Eloquent
+ */
+class Post extends Model
+{
+    public function scopeHasStatus(Builder $query, ?PostStatus $status = PostStatus::Published)
+    {
+        // 
+    }
+}