Closes #33

Author: sebastianbergmann

ChangeLog.md

@@ -2,6 +2,12 @@
 
 All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## [5.1.1] - 2025-MM-DD
+
+### Fixed
+
+* [#33](https://github.com/sebastianbergmann/type/issues/33): `ReflectionMapper` does not handle unions that contain `iterable` correctly
+
 ## [5.1.0] - 2024-09-17
 
 ### Added
@@ -171,6 +177,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 
 * Initial release based on [code contributed by Michel Hartmann to PHPUnit](https://github.com/sebastianbergmann/phpunit/pull/3673)
 
+[5.1.1]: https://github.com/sebastianbergmann/type/compare/5.1.0...5.1
 [5.1.0]: https://github.com/sebastianbergmann/type/compare/5.0.1...5.1.0
 [5.0.1]: https://github.com/sebastianbergmann/type/compare/5.0.0...5.0.1
 [5.0.0]: https://github.com/sebastianbergmann/type/compare/4.0...5.0.0

src/ReflectionMapper.php

@@ -10,6 +10,7 @@
 namespace SebastianBergmann\Type;
 
 use function assert;
+use function count;
 use ReflectionFunction;
 use ReflectionIntersectionType;
 use ReflectionMethod;
@@ -156,18 +157,32 @@ private function mapNamedType(ReflectionNamedType $type, ReflectionFunction|Refl
 
     private function mapUnionType(ReflectionUnionType $type, ReflectionFunction|ReflectionMethod|ReflectionProperty $reflector): Type
     {
-        $types = [];
+        $types             = [];
+        $objectType        = false;
+        $genericObjectType = false;
 
         foreach ($type->getTypes() as $_type) {
             if ($_type instanceof ReflectionNamedType) {
-                $types[] = $this->mapNamedType($_type, $reflector);
+                $namedType = $this->mapNamedType($_type, $reflector);
+
+                if ($namedType instanceof GenericObjectType) {
+                    $genericObjectType = count($types);
+                } elseif ($namedType instanceof ObjectType) {
+                    $objectType = true;
+                }
+
+                $types[] = $namedType;
 
                 continue;
             }
 
             $types[] = $this->mapIntersectionType($_type, $reflector);
         }
 
+        if ($objectType && $genericObjectType !== false) {
+            unset($types[$genericObjectType]);
+        }
+
         return new UnionType(...$types);
     }
 

tests/_fixture/InterfaceWithMethodThatReturnsObjectOrIterable.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/type.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\Type\TestFixture;
+
+interface InterfaceWithMethodThatReturnsObjectOrIterable
+{
+    public function doSomething(): object|iterable;
+}

tests/unit/ReflectionMapperTest.php

@@ -13,6 +13,7 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\RequiresPhp;
 use PHPUnit\Framework\Attributes\Small;
+use PHPUnit\Framework\Attributes\Ticket;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 use ReflectionFunction;
@@ -35,6 +36,7 @@
 use SebastianBergmann\Type\TestFixture\ClassWithMethodThatDeclaresNullReturnType;
 use SebastianBergmann\Type\TestFixture\ClassWithMethodThatDeclaresTrueReturnType;
 use SebastianBergmann\Type\TestFixture\ClassWithProperties;
+use SebastianBergmann\Type\TestFixture\InterfaceWithMethodThatReturnsObjectOrIterable;
 use SebastianBergmann\Type\TestFixture\ParentClass;
 
 #[CoversClass(ReflectionMapper::class)]
@@ -341,4 +343,19 @@ public function testMapsFromPropertyType(string $expectedTypeClass, string $expe
         $this->assertInstanceOf($expectedTypeClass, $type);
         $this->assertSame($expectedString, $type->asString());
     }
+
+    #[Ticket('https://github.com/sebastianbergmann/type/issues/33')]
+    public function testGenericObjectTypeIsRemovedFromUnionWhenUnionContainsClassType(): void
+    {
+        $type = (new ReflectionMapper)->fromReturnType(
+            new ReflectionMethod(
+                InterfaceWithMethodThatReturnsObjectOrIterable::class,
+                'doSomething',
+            ),
+        );
+
+        $this->assertTrue($type->isUnion());
+        $this->assertSame('Traversable|array', $type->name());
+        $this->assertSame('Traversable|array', $type->asString());
+    }
 }