[9.x] Fix enum casts arrayable behaviour (#40885)

* Fix enum casts toArray behaviour

* CI Style fix

* Update HasAttributes.php

Co-authored-by: Taylor Otwell <[email protected]>

Author: diegotibi

src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php

@@ -297,7 +297,7 @@ protected function addCastAttributesToArray(array $attributes, array $mutatedAtt
                 $attributes[$key] = $this->serializeClassCastableAttribute($key, $attributes[$key]);
             }
 
-            if ($this->isEnumCastable($key)) {
+            if ($this->isEnumCastable($key) && (! ($attributes[$key] ?? null) instanceof Arrayable)) {
                 $attributes[$key] = isset($attributes[$key]) ? $attributes[$key]->value : null;
             }
 

tests/Integration/Database/EloquentModelEnumCastingTest.php

@@ -22,6 +22,7 @@ protected function defineDatabaseMigrationsAfterDatabaseRefreshed()
             $table->increments('id');
             $table->string('string_status', 100)->nullable();
             $table->integer('integer_status')->nullable();
+            $table->string('arrayable_status')->nullable();
         });
     }
 
@@ -30,37 +31,47 @@ public function testEnumsAreCastable()
         DB::table('enum_casts')->insert([
             'string_status' => 'pending',
             'integer_status' => 1,
+            'arrayable_status' => 'pending',
         ]);
 
         $model = EloquentModelEnumCastingTestModel::first();
 
         $this->assertEquals(StringStatus::pending, $model->string_status);
         $this->assertEquals(IntegerStatus::pending, $model->integer_status);
+        $this->assertEquals(ArrayableStatus::pending, $model->arrayable_status);
     }
 
     public function testEnumsReturnNullWhenNull()
     {
         DB::table('enum_casts')->insert([
             'string_status' => null,
             'integer_status' => null,
+            'arrayable_status' => null,
         ]);
 
         $model = EloquentModelEnumCastingTestModel::first();
 
         $this->assertEquals(null, $model->string_status);
         $this->assertEquals(null, $model->integer_status);
+        $this->assertEquals(null, $model->arrayable_status);
     }
 
     public function testEnumsAreCastableToArray()
     {
         $model = new EloquentModelEnumCastingTestModel([
             'string_status' => StringStatus::pending,
             'integer_status' => IntegerStatus::pending,
+            'arrayable_status' => ArrayableStatus::pending,
         ]);
 
         $this->assertEquals([
             'string_status' => 'pending',
             'integer_status' => 1,
+            'arrayable_status' => [
+                'name' => 'pending',
+                'value' => 'pending',
+                'description' => 'pending status description',
+            ],
         ], $model->toArray());
     }
 
@@ -69,11 +80,13 @@ public function testEnumsAreCastableToArrayWhenNull()
         $model = new EloquentModelEnumCastingTestModel([
             'string_status' => null,
             'integer_status' => null,
+            'arrayable_status' => null,
         ]);
 
         $this->assertEquals([
             'string_status' => null,
             'integer_status' => null,
+            'arrayable_status' => null,
         ], $model->toArray());
     }
 
@@ -82,6 +95,7 @@ public function testEnumsAreConvertedOnSave()
         $model = new EloquentModelEnumCastingTestModel([
             'string_status' => StringStatus::pending,
             'integer_status' => IntegerStatus::pending,
+            'arrayable_status' => ArrayableStatus::pending,
         ]);
 
         $model->save();
@@ -90,6 +104,7 @@ public function testEnumsAreConvertedOnSave()
             'id' => $model->id,
             'string_status' => 'pending',
             'integer_status' => 1,
+            'arrayable_status' => 'pending',
         ], DB::table('enum_casts')->where('id', $model->id)->first());
     }
 
@@ -98,6 +113,7 @@ public function testEnumsAcceptNullOnSave()
         $model = new EloquentModelEnumCastingTestModel([
             'string_status' => null,
             'integer_status' => null,
+            'arrayable_status' => null,
         ]);
 
         $model->save();
@@ -106,6 +122,7 @@ public function testEnumsAcceptNullOnSave()
             'id' => $model->id,
             'string_status' => null,
             'integer_status' => null,
+            'arrayable_status' => null,
         ], DB::table('enum_casts')->where('id', $model->id)->first());
     }
 
@@ -114,6 +131,7 @@ public function testEnumsAcceptBackedValueOnSave()
         $model = new EloquentModelEnumCastingTestModel([
             'string_status' => 'pending',
             'integer_status' => 1,
+            'arrayable_status' => 'pending',
         ]);
 
         $model->save();
@@ -122,13 +140,15 @@ public function testEnumsAcceptBackedValueOnSave()
 
         $this->assertEquals(StringStatus::pending, $model->string_status);
         $this->assertEquals(IntegerStatus::pending, $model->integer_status);
+        $this->assertEquals(ArrayableStatus::pending, $model->arrayable_status);
     }
 
     public function testFirstOrNew()
     {
         DB::table('enum_casts')->insert([
             'string_status' => 'pending',
             'integer_status' => 1,
+            'arrayable_status' => 'pending',
         ]);
 
         $model = EloquentModelEnumCastingTestModel::firstOrNew([
@@ -176,5 +196,6 @@ class EloquentModelEnumCastingTestModel extends Model
     public $casts = [
         'string_status' => StringStatus::class,
         'integer_status' => IntegerStatus::class,
+        'arrayable_status' => ArrayableStatus::class,
     ];
 }

tests/Integration/Database/Enums.php

@@ -2,6 +2,8 @@
 
 namespace Illuminate\Tests\Integration\Database;
 
+use Illuminate\Contracts\Support\Arrayable;
+
 enum StringStatus: string
 {
     case pending = 'pending';
@@ -13,3 +15,26 @@ enum IntegerStatus: int
     case pending = 1;
     case done = 2;
 }
+
+enum ArrayableStatus: string implements Arrayable
+{
+    case pending = 'pending';
+    case done = 'done';
+
+    public function description(): string
+    {
+        return match ($this) {
+            self::pending => 'pending status description',
+            self::done => 'done status description'
+        };
+    }
+
+    public function toArray()
+    {
+        return [
+            'name' => $this->name,
+            'value' => $this->value,
+            'description' => $this->description(),
+        ];
+    }
+}