Merge pull request #54 from ingenerator/1.x-bug-unique-map-null

Fix ability to store & retrieve null values in UniqueMap

Author: acoulton

CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Unreleased
 
+### v1.19.1 (2023-03-22)
+
+* Fix a bug in UniqueMap where it throws on attempt to access an offset with a null value
+
 * Fix the docblock typehint for InitialisableSingletonTrait so that ::instance() to @return static
 
 ### v1.19.0 (2023-03-17)

src/ArrayHelpers/UniqueMap.php

@@ -37,7 +37,7 @@ public function offsetExists(mixed $offset): bool
 
     public function offsetGet(mixed $offset): mixed
     {
-        if ( ! isset($this->items[$offset])) {
+        if ( ! array_key_exists($offset, $this->items)) {
             throw new \OutOfBoundsException('No item with key '.$offset);
         }
 

test/unit/ArrayHelpers/UniqueMapTest.php

@@ -20,10 +20,12 @@ public function test_it_returns_entries_by_key()
             [
                 'foo' => 'some-foo',
                 'bar' => $bar,
+                'nully' => null,
             ]
         );
         $this->assertSame($bar, $subject['bar']);
         $this->assertSame('some-foo', $subject['foo']);
+        $this->assertSame(null, $subject['nully']);
     }
 
     public function test_it_throws_on_access_to_undefined_key()
@@ -39,9 +41,11 @@ public function test_it_accepts_new_items()
         $subject = new UniqueMap(['any' => 'item']);
         $subject['new1'] = $new1;
         $subject['new2'] = 'some-string';
+        $subject['new3'] = null;
 
         $this->assertSame($new1, $subject['new1']);
         $this->assertSame('some-string', $subject['new2']);
+        $this->assertSame(null, $subject['new3']);
     }
 
     public function test_it_throws_on_attempt_to_overwrite_key()
@@ -95,9 +99,10 @@ public function test_it_is_iterable()
         $subject = new UniqueMap(['any' => 'item']);
         $subject['new'] = 'new1';
         $subject['other'] = 'new2';
+        $subject['nully'] = null;
 
         $this->assertSame(
-            ['any' => 'item', 'new' => 'new1', 'other' => 'new2'],
+            ['any' => 'item', 'new' => 'new1', 'other' => 'new2', 'nully' => null],
             iterator_to_array($subject)
         );
     }