Merge pull request #165 from boesing/feature/orderedlist-removeat

feature: add `OrderedListInterface#removeAt`

Author: boesing

phpcs.xml.dist

@@ -27,6 +27,7 @@
         <exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix"/>
         <exclude name="Generic.NamingConventions.ConstructorName.OldStyle"/>
         <exclude name="Generic.CodeAnalysis.UselessOverridingMethod.Found"/>
+        <exclude name="Squiz.NamingConventions.ValidVariableName.NotCamelCaps"/>
         <exclude name="Generic.Files.LineLength.TooLong"/>
         <!-- Can be removed with dropping support for PHP 7.3 -->
         <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint"/>

src/OrderedList.php

@@ -417,4 +417,9 @@ public function prepend($value): OrderedListInterface
 
         return $instance;
     }
+
+    public function removeAt(int $index): OrderedListInterface
+    {
+        return $this->filter(static fn ($_, int $i) => $i !== $index);
+    }
 }

src/OrderedListInterface.php

@@ -256,4 +256,12 @@ public function findFirstMatchingIndex(callable $filter): ?int;
      * @return OrderedListInterface<TValue>
      */
     public function prepend($value): self;
+
+    /**
+     * Removes an element at the given index.
+     *
+     * @param 0|positive-int $index
+     * @return OrderedListInterface<TValue>
+     */
+    public function removeAt(int $index): self;
 }

tests/GenericOrderedListTest.php

@@ -1478,4 +1478,16 @@ public function testReduceWillReturnInitialValueOnEmptyList(): void
         $list = new GenericOrderedList([]);
         self::assertSame(PHP_INT_MAX, $list->reduce(static fn () => 1, PHP_INT_MAX));
     }
+
+    public function testWillRemoveItemAtSpecificPosition(): void
+    {
+        $list = new GenericOrderedList([
+            1,
+            2,
+            3,
+        ]);
+
+        $list = $list->removeAt(1);
+        self::assertSame([1, 3], $list->toNativeArray());
+    }
 }