refactor: associative array should use mixed for values, like generic…

… array
ramsey · Dec 31, 2022 · b084714 · b084714
1 parent fbd3bc1
commit b084714
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 30 deletions.
diff --git a/src/Map/AssociativeArrayMap.php b/src/Map/AssociativeArrayMap.php
@@ -17,8 +17,7 @@
 /**
  * `AssociativeArrayMap` represents a standard associative array object.
  *
- * @template T
- * @extends AbstractMap<string, T>
+ * @extends AbstractMap<string, mixed>
  */
 class AssociativeArrayMap extends AbstractMap
 {

diff --git a/tests/Map/AssociativeArrayMapTest.php b/tests/Map/AssociativeArrayMapTest.php
@@ -21,7 +21,6 @@ class AssociativeArrayMapTest extends TestCase
 {
     public function testOffsetSetWithEmptyOffsetThrowsException(): void
     {
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap();
 
         $this->expectException(InvalidArgumentException::class);
@@ -36,7 +35,6 @@ public function testOffsetSetWithEmptyOffsetThrowsException(): void
 
     public function testOffsetSetWithValidKey(): void
     {
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap();
         $associativeArrayMapObject['foo'] = 123;
 
@@ -45,7 +43,6 @@ public function testOffsetSetWithValidKey(): void
 
     public function testContainsKey(): void
     {
-        /** @var AssociativeArrayMap<int | null> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap();
         $associativeArrayMapObject['foo'] = null;
         $associativeArrayMapObject['bar'] = 123;
@@ -58,7 +55,6 @@ public function testContainsKey(): void
 
     public function testKeys(): void
     {
-        /** @var AssociativeArrayMap<int | null> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap();
 
         // empty map returns empty array
@@ -74,7 +70,6 @@ public function testContainsValue(): void
     {
         $foo = new Foo();
 
-        /** @var AssociativeArrayMap<int | Foo | null> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap();
         $associativeArrayMapObject['foo'] = null;
         $associativeArrayMapObject['bar'] = 123;
@@ -89,7 +84,6 @@ public function testContainsValue(): void
     public function testGet(): void
     {
         $data = ['foo' => 123];
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap($data);
 
         $this->assertSame($data['foo'], $associativeArrayMapObject->get('foo'));
@@ -98,7 +92,6 @@ public function testGet(): void
 
     public function testPut(): void
     {
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap();
         $previousValue = $associativeArrayMapObject->put('foo', 123);
 
@@ -115,7 +108,6 @@ public function testPut(): void
 
     public function testPutIfAbsent(): void
     {
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap();
         $currentValue = $associativeArrayMapObject->putIfAbsent('foo', 123);
 
@@ -134,12 +126,12 @@ public function testRemove(): void
     {
         $data = ['foo' => 123];
 
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap($data);
         $previousValue = $associativeArrayMapObject->remove('foo');
 
         $this->assertSame($data['foo'], $previousValue);
 
+        /** @var mixed $previousValue */
         $previousValue = $associativeArrayMapObject->remove('foo');
 
         $this->assertNull($previousValue);
@@ -150,7 +142,6 @@ public function testRemoveIf(): void
     {
         $data = ['foo' => 123];
 
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap($data);
 
         $this->assertFalse($associativeArrayMapObject->removeIf('foo', 456));
@@ -163,15 +154,16 @@ public function testReplace(): void
     {
         $data = ['foo' => 123];
 
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap($data);
 
         $previousValue = $associativeArrayMapObject->replace('foo', 456);
 
         $this->assertSame($data['foo'], $previousValue);
         $this->assertSame(456, $associativeArrayMapObject->get('foo'));
 
+        /** @var mixed $previousValue */
         $previousValue = $associativeArrayMapObject->replace('bar', 789);
+
         $this->assertNull($previousValue);
         $this->assertFalse($associativeArrayMapObject->containsKey('bar'));
     }
@@ -180,7 +172,6 @@ public function testReplaceIf(): void
     {
         $data = ['foo' => 123];
 
-        /** @var AssociativeArrayMap<int> $associativeArrayMapObject */
         $associativeArrayMapObject = new AssociativeArrayMap($data);
 
         $this->assertFalse($associativeArrayMapObject->replaceIf('foo', 456, 789));

diff --git a/tests/types/maps.php b/tests/types/maps.php
@@ -13,36 +13,36 @@
 use Ramsey\Collection\Test\Mock\Person;
 use function PHPStan\Testing\assertType;
 
-/** @var AssociativeArrayMap<scalar> $associativeArray */
 $associativeArray = new AssociativeArrayMap([
     'foo' => 1,
     'bar' => 'something',
     'baz' => false,
     'qux' => 23.3,
 ]);
 
-assertType('Ramsey\Collection\Map\AssociativeArrayMap<bool|float|int|string>', $associativeArray);
+assertType('Ramsey\Collection\Map\AssociativeArrayMap', $associativeArray);
 
-assertType('bool|float|int|string', $associativeArray['foo']);
-assertType('bool|float|int|string', $associativeArray['bar']);
-assertType('bool|float|int|string', $associativeArray['baz']);
-assertType('bool|float|int|string', $associativeArray['qux']);
-assertType('bool|float|int|string', $associativeArray->offsetGet('foo'));
-assertType('array<string, bool|float|int|string>', $associativeArray->toArray());
-assertType('array<string, bool|float|int|string>', $associativeArray->__serialize());
-assertType('Traversable<string, bool|float|int|string>', $associativeArray->getIterator());
+assertType('mixed', $associativeArray['foo']);
+assertType('mixed', $associativeArray['bar']);
+assertType('mixed', $associativeArray['baz']);
+assertType('mixed', $associativeArray['qux']);
+assertType('mixed', $associativeArray->offsetGet('foo'));
+assertType('array<string, mixed>', $associativeArray->toArray());
+assertType('array<string, mixed>', $associativeArray->__serialize());
+assertType('Traversable<string, mixed>', $associativeArray->getIterator());
 
+/** @psalm-suppress MixedAssignment */
 foreach ($associativeArray as $key => $value) {
     assertType('string', $key);
-    assertType('bool|float|int|string', $value);
+    assertType('mixed', $value);
 }
 
 assertType('array<int, string>', $associativeArray->keys());
-assertType('bool|float|int|string|null', $associativeArray->get('foo'));
-assertType('bool|float|int|string|null', $associativeArray->put('foo', 'hello'));
-assertType('bool|float|int|string|null', $associativeArray->putIfAbsent('foo', 'hello'));
-assertType('bool|float|int|string|null', $associativeArray->remove('foo'));
-assertType('bool|float|int|string|null', $associativeArray->replace('foo', 'hello'));
+assertType('mixed', $associativeArray->get('foo'));
+assertType('mixed', $associativeArray->put('foo', 'hello'));
+assertType('mixed', $associativeArray->putIfAbsent('foo', 'hello'));
+assertType('mixed', $associativeArray->remove('foo'));
+assertType('mixed', $associativeArray->replace('foo', 'hello'));
 
 $namedParameterMap = new NamedParameterMap(
     [