[11.x] Improves Collection support for enums using firstWhere() a…

…nd `value()` (#53777) * [11.x] Improves `Collection` support for enums using `firstWhere()` and `value()` Fixes #53676 Signed-off-by: Mior Muhammad Zaki <[email protected]> * Apply fixes from StyleCI * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> --------- Signed-off-by: Mior Muhammad Zaki <[email protected]> Co-authored-by: StyleCI Bot <[email protected]>
laravel · Dec 6, 2024 · b8bb5e9 · b8bb5e9
1 parent 8b889c7
commit b8bb5e9
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 26 deletions.
diff --git a/composer.json b/composer.json
@@ -132,6 +132,7 @@
     },
     "autoload": {
         "files": [
+            "src/Illuminate/Collections/functions.php",
             "src/Illuminate/Collections/helpers.php",
             "src/Illuminate/Events/functions.php",
             "src/Illuminate/Filesystem/functions.php",

diff --git a/src/Illuminate/Collections/Traits/EnumeratesValues.php b/src/Illuminate/Collections/Traits/EnumeratesValues.php
@@ -19,6 +19,8 @@
 use UnitEnum;
 use WeakMap;
 
+use function Illuminate\Support\enum_value;
+
 /**
  * @template TKey of array-key
  *
@@ -1092,10 +1094,15 @@ protected function operatorForWhere($key, $operator = null, $value = null)
         }
 
         return function ($item) use ($key, $operator, $value) {
-            $retrieved = data_get($item, $key);
+            $retrieved = enum_value(data_get($item, $key));
+            $value = enum_value($value);
 
             $strings = array_filter([$retrieved, $value], function ($value) {
-                return is_string($value) || (is_object($value) && method_exists($value, '__toString'));
+                return match (true) {
+                    is_string($value) => true,
+                    $value instanceof \Stringable => true,
+                    default => false,
+                };
             });
 
             if (count($strings) < 2 && count(array_filter([$retrieved, $value], 'is_object')) == 1) {

diff --git a/src/Illuminate/Collections/composer.json b/src/Illuminate/Collections/composer.json
@@ -24,6 +24,7 @@
             "Illuminate\\Support\\": ""
         },
         "files": [
+            "functions.php",
             "helpers.php"
         ]
     },

diff --git a/src/Illuminate/Collections/functions.php b/src/Illuminate/Collections/functions.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Illuminate\Support;
+
+if (! function_exists('Illuminate\Support\enum_value')) {
+    /**
+     * Return a scalar value for the given value that might be an enum.
+     *
+     * @internal
+     *
+     * @template TValue
+     * @template TDefault
+     *
+     * @param  TValue  $value
+     * @param  TDefault|callable(TValue): TDefault  $default
+     * @return ($value is empty ? TDefault : mixed)
+     */
+    function enum_value($value, $default = null)
+    {
+        return transform($value, fn ($value) => match (true) {
+            $value instanceof \BackedEnum => $value->value,
+            $value instanceof \UnitEnum => $value->name,
+
+            default => $value,
+        }, $default ?? $value);
+    }
+}
diff --git a/src/Illuminate/Support/functions.php b/src/Illuminate/Support/functions.php
@@ -28,30 +28,6 @@ function defer(?callable $callback = null, ?string $name = null, bool $always =
     }
 }
 
-if (! function_exists('Illuminate\Support\enum_value')) {
-    /**
-     * Return a scalar value for the given value that might be an enum.
-     *
-     * @internal
-     *
-     * @template TValue
-     * @template TDefault
-     *
-     * @param  TValue  $value
-     * @param  TDefault|callable(TValue): TDefault  $default
-     * @return ($value is empty ? TDefault : mixed)
-     */
-    function enum_value($value, $default = null)
-    {
-        return transform($value, fn ($value) => match (true) {
-            $value instanceof \BackedEnum => $value->value,
-            $value instanceof \UnitEnum => $value->name,
-
-            default => $value,
-        }, $default ?? $value);
-    }
-}
-
 if (! function_exists('Illuminate\Support\php_binary')) {
     /**
      * Determine the PHP Binary.

diff --git a/tests/Support/SupportCollectionTest.php b/tests/Support/SupportCollectionTest.php
@@ -257,6 +257,20 @@ public function testFirstWhere($collection)
         $this->assertNull($data->firstWhere(fn ($value) => ($value['nonexistent'] ?? null) === 'key'));
     }
 
+    #[DataProvider('collectionClassProvider')]
+    public function testFirstWhereUsingEnum($collection)
+    {
+        $data = new $collection([
+            ['id' => 1, 'name' => StaffEnum::Taylor],
+            ['id' => 2, 'name' => StaffEnum::Joe],
+            ['id' => 3, 'name' => StaffEnum::James],
+        ]);
+
+        $this->assertSame(1, $data->firstWhere('name', 'Taylor')['id']);
+        $this->assertSame(2, $data->firstWhere('name', StaffEnum::Joe)['id']);
+        $this->assertSame(3, $data->firstWhere('name', StaffEnum::James)['id']);
+    }
+
     #[DataProvider('collectionClassProvider')]
     public function testLastReturnsLastItemInCollection($collection)
     {
@@ -1130,6 +1144,15 @@ public function testValue($collection)
         $this->assertEquals('bar', $c->where('id', 2)->value('pivot.value'));
     }
 
+    #[DataProvider('collectionClassProvider')]
+    public function testValueUsingEnum($collection)
+    {
+        $c = new $collection([['id' => 1, 'name' => StaffEnum::Taylor], ['id' => 2, 'name' => StaffEnum::Joe]]);
+
+        $this->assertSame(StaffEnum::Taylor, $c->value('name'));
+        $this->assertEquals(StaffEnum::Joe, $c->where('id', 2)->value('name'));
+    }
+
     #[DataProvider('collectionClassProvider')]
     public function testBetween($collection)
     {
@@ -5737,3 +5760,10 @@ class TestCollectionSubclass extends Collection
 {
     //
 }
+
+enum StaffEnum
+{
+    case Taylor;
+    case Joe;
+    case James;
+}