Improve filtering index for Ordered Map objects

Author: nyamsprod

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All Notable changes to `bakame/http-strucured-fields` will be documented in this file
 
-## [Next] - TBD
+## [0.4.0] - 2022-03-27
 
 ### Added
 
@@ -91,7 +91,8 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 
 **Initial release!**
 
-[Next]: https://github.com/bakame-php/http-structured-fields/compare/0.3.0...master
+[Next]: https://github.com/bakame-php/http-structured-fields/compare/0.4.0...master
+[0.4.0]: https://github.com/bakame-php/http-structured-fields/compare/0.3.0...0.4.0
 [0.3.0]: https://github.com/bakame-php/http-structured-fields/compare/0.2.0...0.3.0
 [0.2.0]: https://github.com/bakame-php/http-structured-fields/compare/0.1.0...0.2.0
 [0.1.0]: https://github.com/bakame-php/http-structured-fields/releases/tag/0.1.0

README.md

@@ -188,7 +188,8 @@ key to its members as such they expose the following methods:
 - `prepend` always add an element at the beginning of the container, if already present the previous value is removed;
 - `delete` to remove elements based on their associated keys;
 - `keys` to list all existing keys for the ordered maps as an array list;
-- `merge` merge multiple instances of iterable structure as associative constructs;
+- `mergeAssociative` merge multiple instances of iterable structure as associative constructs;
+- `mergePairs` merge multiple instances of iterable structure as pairs constructs;
 
 ```php
 use Bakame\Http\StructuredFields\Dictionary;

src/Dictionary.php

@@ -174,18 +174,24 @@ public function get(string $key): Item|InnerList
      */
     public function hasPair(int $index): bool
     {
-        return null !== $this->filterIndex($index);
+        try {
+            $this->filterIndex($index);
+
+            return true;
+        } catch (InvalidOffset) {
+            return false;
+        }
     }
 
     /**
      * Validate and Format the submitted index position.
      */
-    private function filterIndex(int $index): int|null
+    private function filterIndex(int $index): int
     {
         $max = count($this->members);
 
         return match (true) {
-            [] === $this->members, 0 > $max + $index, 0 > $max - $index - 1 => null,
+            [] === $this->members, 0 > $max + $index, 0 > $max - $index - 1 => throw InvalidOffset::dueToIndexNotFound($index),
             0 > $index => $max + $index,
             default => $index,
         };
@@ -202,9 +208,6 @@ private function filterIndex(int $index): int|null
     public function pair(int $index): array
     {
         $offset = $this->filterIndex($index);
-        if (null === $offset) {
-            throw InvalidOffset::dueToIndexNotFound($index);
-        }
 
         foreach ($this->toPairs() as $k => $pair) {
             if ($k === $offset) {

src/DictionaryTest.php

@@ -75,6 +75,8 @@ public function it_can_add_or_remove_members(): void
         self::assertFalse($instance->hasPair(1));
 
         $instance->append('foobar', Item::from('BarBaz'));
+        self::assertTrue($instance->hasPair(1));
+
         /** @var array{0:string, 1:Item} $foundItem */
         $foundItem = $instance->pair(1);
 

src/Parameters.php

@@ -267,18 +267,24 @@ public function value(string $key): Token|ByteSequence|float|int|bool|string|nul
      */
     public function hasPair(int $index): bool
     {
-        return null !== $this->formatIndex($index);
+        try {
+            $this->filterIndex($index);
+
+            return true;
+        } catch (InvalidOffset) {
+            return false;
+        }
     }
 
     /**
      * Filter and format instance index.
      */
-    private function formatIndex(int $index): int|null
+    private function filterIndex(int $index): int
     {
         $max = count($this->members);
 
         return match (true) {
-            [] === $this->members, 0 > $max + $index, 0 > $max - $index - 1 => null,
+            [] === $this->members, 0 > $max + $index, 0 > $max - $index - 1 => throw InvalidOffset::dueToIndexNotFound($index),
             0 > $index => $max + $index,
             default => $index,
         };
@@ -294,10 +300,7 @@ private function formatIndex(int $index): int|null
      */
     public function pair(int $index): array
     {
-        $offset = $this->formatIndex($index);
-        if (null === $offset) {
-            throw InvalidOffset::dueToIndexNotFound($index);
-        }
+        $offset = $this->filterIndex($index);
 
         $i = 0;
         foreach ($this->members as $key => $member) {

src/ParametersTest.php

@@ -96,6 +96,7 @@ public function it_can_add_or_remove_members(): void
         self::assertFalse($instance->hasPair(1));
 
         $instance->append('foobar', Item::from('BarBaz'));
+        self::assertTrue($instance->hasPair(1));
         $foundItem = $instance->pair(1);
 
         self::assertCount(2, $instance);