Adding new methods to OrderedMap

Author: nyamsprod

CHANGELOG.md

@@ -10,6 +10,8 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - `OrederedMap::unshift`
 - `OrederedMap::insert`
 - `OrederedMap::replace`
+- `OrederedMap::removeByIndices`
+- `OrederedMap::removeByKeys`
 - `ParameterAccess::pushParanmeters`
 - `ParameterAccess::unshiftParamaters`
 - `ParameterAccess::insertParamaters`

README.md

@@ -448,6 +448,8 @@ $map->unshift(array ...$pairs): static;
 $map->push(array ...$pairs): static;
 $map->insert(int $key, array ...$pairs): static;
 $map->replace(int $key, array $pair): static;
+$map->removeByKeys(string ...$keys): static;
+$map->removeByIndices(int ...$indices): static;
 ```
 
 We can rewrite the previous example
@@ -477,8 +479,8 @@ echo $value;                //b=?0, a=(bar "42" 42 42.0), c=@1671800423
 
 **⚠️WARNING: on duplicate `keys` pair values are merged as per RFC logic.**
 
-The `remove` always accepted string or integer as input. Since version `1.1` it will also remove
-the corresponding pair if its index is given to the method.
+The `remove` always accepted string or integer as input. Since version `1.1` the method is fixed to
+remove the corresponding pair if its index is given to the method.
 
 ```diff
 <?php
@@ -490,6 +492,16 @@ $field = Dictionary::fromHttpValue('b=?0, a=(bar "42" 42 42.0), c=@1671800423');
 + echo $field->remove('b', 2)->toHttpValue(); // returns a=(bar "42" 42 42.0)
 ```
 
+If a stricter approach is needed, use the following new methods `removeByIndices` and/or `removeByKeys`:
+
+```php
+use Bakame\Http\StructuredFields\Parameters;
+
+$field = Parameters::fromHttpValue(';expire=@1681504328;path="/";max-age=2500;secure;httponly=?0;samesite=lax');
+echo $field->removeByIndices(4, 2, 0)->toHttpValue();                      // returns ;path="/";secure;samesite=lax
+echo $field->removeByKeys('expire', 'httponly', 'max-age')->toHttpValue(); // returns ;path="/";secure;samesite=lax
+```
+
 #### Automatic conversion
 
 For all containers, to ease instantiation the following automatic conversion are applied on

src/Dictionary.php

@@ -290,6 +290,16 @@ public function remove(string|int ...$keys): static
         };
     }
 
+    public function removeByIndices(int ...$indices): static
+    {
+        return $this->remove(...$indices);
+    }
+
+    public function removeByKeys(string ...$keys): static
+    {
+        return $this->remove(...$keys);
+    }
+
     /**
      * @param SfMember|SfMemberInput $member
      */

src/DictionaryTest.php

@@ -256,6 +256,8 @@ public function it_can_delete_a_member_via_remove_method(): void
 
         self::assertFalse($newInstance->remove('foo')->hasMembers());
         self::assertSame($newInstance, $newInstance->remove('baz', 'bar', 'yolo-not-there', 325));
+        self::assertSame($newInstance, $newInstance->removeByKeys('baz', 'bar', 'yolo-not-there'));
+        self::assertSame($newInstance, $newInstance->removeByIndices(325));
 
         $instanceWithoutMember = Dictionary::new();
         self::assertSame($instanceWithoutMember->remove(), $instanceWithoutMember);

src/InnerList.php

@@ -386,12 +386,12 @@ public function withoutParameter(string ...$keys): static
 
     public function withoutParameterByKeys(string ...$keys): static
     {
-        return $this->withParameters($this->parameters()->remove(...$keys));
+        return $this->withParameters($this->parameters()->removeByKeys(...$keys));
     }
 
     public function withoutParameterByIndices(int ...$indices): static
     {
-        return $this->withParameters($this->parameters()->remove(...$indices));
+        return $this->withParameters($this->parameters()->removeByIndices(...$indices));
     }
 
     public function withoutAnyParameter(): static

src/Item.php

@@ -339,12 +339,12 @@ public function withoutParameter(string ...$keys): static
 
     public function withoutParameterByKeys(string ...$keys): static
     {
-        return $this->withParameters($this->parameters()->remove(...$keys));
+        return $this->withParameters($this->parameters()->removeByKeys(...$keys));
     }
 
     public function withoutParameterByIndices(int ...$indices): static
     {
-        return $this->withParameters($this->parameters()->remove(...$indices));
+        return $this->withParameters($this->parameters()->removeByIndices(...$indices));
     }
 
     public function withoutAnyParameter(): static

src/MemberOrderedMap.php

@@ -15,6 +15,8 @@
  * @method static unshift(array ...$pairs) Inserts pair at the start of the member list
  * @method static insert(int $index, array ...$pairs) Inserts pairs at the index
  * @method static replace(int $index, array $pair) Replaces the pair at the given index
+ * @method static removeByIndices(int ... $indices) Remove members by index
+ * @method static removeByKeys(string ...$keys) Remove members by keys
  */
 interface MemberOrderedMap extends MemberContainer
 {

src/Parameters.php

@@ -272,6 +272,16 @@ public function remove(string|int ...$keys): static
         };
     }
 
+    public function removeByIndices(int ...$indices): static
+    {
+        return $this->remove(...$indices);
+    }
+
+    public function removeByKeys(string ...$keys): static
+    {
+        return $this->remove(...$keys);
+    }
+
     public function append(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|string|int|float|bool $member): static
     {
         $members = $this->members;