Merge pull request #13 from gameeapp/fully_supported_generics_in_unique_obj_collection

Added full support of generics to UniqueObjectCollection

Author: TomPavelec

src/Collection/UniqueObjectCollection.php

@@ -4,19 +4,21 @@
 
 namespace Gamee\Collections\Collection;
 
-use Gamee\Collections\Iterator\ObjectIterator;
-
 /**
  * @template IdentifiableObject of object
  */
 abstract class UniqueObjectCollection implements \Countable, \IteratorAggregate
 {
 
 	/**
-	 * @var array|mixed[]
+	 * @var array<IdentifiableObject>
 	 */
 	protected array $data = [];
 
+
+	/**
+	 * @deprecated
+	 */
 	abstract protected function getItemType(): string;
 
 
@@ -29,16 +31,13 @@ abstract protected function getIdentifier(object $item);
 
 	/**
 	 * Skips items with duplicate key
-	 * @param array<mixed> $data
+	 * @param array<IdentifiableObject> $data
 	 */
 	public function __construct(array $data)
 	{
-		$classItemName = $this->getItemType();
 		$uniqueItems = [];
 
 		foreach ($data as $item) {
-			$this->assertItemType($item, $classItemName);
-
 			$identifier = $this->getIdentifier($item);
 
 			if (!$this->exists($identifier)) {
@@ -52,6 +51,7 @@ public function __construct(array $data)
 
 	/**
 	 * @return static
+	 * @deprecated
 	 */
 	public static function createFromImmutableObjectCollection(
 		ImmutableObjectCollection $immutableObjectCollection
@@ -69,9 +69,12 @@ static function (ImmutableObjectCollection $immutableObjectCollection): array {
 	}
 
 
-	public function getIterator(): ObjectIterator
+	/**
+	 * @return \ArrayIterator<IdentifiableObject>
+	 */
+	public function getIterator(): \ArrayIterator
 	{
-		return new ObjectIterator($this->data);
+		return new \ArrayIterator($this->data);
 	}
 
 
@@ -81,7 +84,7 @@ public function getIterator(): ObjectIterator
 	 */
 	public function mergeWith(UniqueObjectCollection $collection)
 	{
-		if ($this->getItemType() !== $collection->getItemType()) {
+		if (get_class($collection) !== static::class) {
 			throw new \RuntimeException('Can not merge collections with different item type');
 		}
 
@@ -147,8 +150,6 @@ public function getScalarIds(): array
 	 */
 	public function addItem(object $item)
 	{
-		$this->assertItemType($item, $this->getItemType());
-
 		$identifier = $this->getIdentifier($item);
 
 		if ($this->exists($identifier)) {
@@ -230,15 +231,4 @@ protected function getItems(): array
 	{
 		return $this->data;
 	}
-
-
-	/**
-	 * @param IdentifiableObject $item
-	 */
-	private function assertItemType(object $item, string $type): void
-	{
-		if (!$item instanceof $type) {
-			throw new \InvalidArgumentException(static::class . ' only accepts ' . $type);
-		}
-	}
 }

tests/Collections/Collection/UniqueObjectCollectionTest.phpt

@@ -57,20 +57,6 @@ class UniqueObjectCollectionTest extends TestCase
 	}
 
 
-	public function testExceptionOnWrongItemTypeDuringCreation(): void
-	{
-		Assert::exception(function (): void {
-			$this->createTestCollection(
-				[
-					new ItemClass(1),
-					new AnotherClass(2),
-					new ItemClass(3),
-				]
-			);
-		}, \InvalidArgumentException::class);
-	}
-
-
 	public function testMergeWith(): void
 	{
 		$items = [
@@ -351,16 +337,6 @@ class UniqueObjectCollectionTest extends TestCase
 	}
 
 
-	public function testExceptionOnWrongItemTypeInAddItem(): void
-	{
-		$collection = $this->createTestCollection();
-
-		Assert::exception(function () use ($collection): void {
-			$collection->addItem(new AnotherClass(3));
-		}, \InvalidArgumentException::class);
-	}
-
-
 	protected function collectionDataProvider(): array
 	{
 		return [