[10.x] Update ensure() collection method to correctly work with Inter…

…faces and object inheritance (#47934) * Update ensure() collection method to correctly work with Interfaces and object inheritance. * corrections to style
laravel · Aug 2, 2023 · 119840d · 119840d
1 parent 56d59a7
commit 119840d
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 8 deletions.
diff --git a/src/Illuminate/Collections/Traits/EnumeratesValues.php b/src/Illuminate/Collections/Traits/EnumeratesValues.php
@@ -315,10 +315,10 @@ public function value($key, $default = null)
     /**
      * Ensure that every item in the collection is of the expected type.
      *
-     * @template TEnforceIntoValue
+     * @template TEnsureOfType
      *
-     * @param  class-string<TEnforceIntoValue>  $type
-     * @return static<mixed, TEnforceIntoValue>
+     * @param  class-string<TEnsureOfType>  $type
+     * @return static<mixed, TEnsureOfType>
      *
      * @throws \UnexpectedValueException
      */
@@ -327,8 +327,10 @@ public function ensure($type)
         return $this->each(function ($item) use ($type) {
             $itemType = get_debug_type($item);
 
-            if ($itemType !== $type) {
-                throw new UnexpectedValueException("Collection should only include '{$type}' items, but '{$itemType}' found.");
+            if ($itemType !== $type && ! $item instanceof $type) {
+                throw new UnexpectedValueException(
+                    sprintf("Collection should only include '%s' items, but '%s' found.", $type, $itemType)
+                );
             }
         });
     }

diff --git a/tests/Support/SupportCollectionTest.php b/tests/Support/SupportCollectionTest.php
@@ -5598,17 +5598,40 @@ public function testDot($collection)
     /**
      * @dataProvider collectionClassProvider
      */
-    public function testEnsure($collection)
+    public function testEnsureForScalar($collection)
     {
         $data = $collection::make([1, 2, 3]);
-
         $data->ensure('int');
 
         $data = $collection::make([1, 2, 3, 'foo']);
+        $this->expectException(UnexpectedValueException::class);
+        $data->ensure('int');
+    }
+
+    /**
+     * @dataProvider collectionClassProvider
+     */
+    public function testEnsureForObjects($collection)
+    {
+        $data = $collection::make([new stdClass, new stdClass, new stdClass]);
+        $data->ensure(stdClass::class);
 
+        $data = $collection::make([new stdClass, new stdClass, new stdClass, $collection]);
         $this->expectException(UnexpectedValueException::class);
+        $data->ensure(stdClass::class);
+    }
 
-        $data->ensure('int');
+    /**
+     * @dataProvider collectionClassProvider
+     */
+    public function testEnsureForInheritance($collection)
+    {
+        $data = $collection::make([new \Error, new \Error]);
+        $data->ensure(\Throwable::class);
+
+        $data = $collection::make([new \Error, new \Error, new $collection]);
+        $this->expectException(UnexpectedValueException::class);
+        $data->ensure(\Throwable::class);
     }
 
     /**