feature: introduce OrderedListInterface#combine

Signed-off-by: Maximilian Bösing <[email protected]>
boesing · Aug 22, 2024 · a359f2c · a359f2c
1 parent d36e7b6
commit a359f2c
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 0 deletions.
diff --git a/src/OrderedList.php b/src/OrderedList.php
@@ -491,4 +491,14 @@ public function shuffle(): OrderedListInterface
 
         return $instance;
     }
+
+    public function combine(OrderedListInterface $other, OrderedListInterface ...$others): OrderedListInterface
+    {
+        $instance = clone $this;
+        foreach ([$other, ...$others] as $other) {
+            $instance->data = [...$instance->data, ...$other->toNativeArray()];
+        }
+
+        return $instance;
+    }
 }
diff --git a/src/OrderedListInterface.php b/src/OrderedListInterface.php
@@ -271,4 +271,14 @@ public function removeAt(int $index): self;
      * @return OrderedListInterface<TValue>
      */
     public function shuffle(): self;
+
+    /**
+     * Combines multiple lists into one.
+     *
+     * @template TValueFromOther of TValue
+     * @param OrderedListInterface<TValueFromOther> $other
+     * @param OrderedListInterface<TValueFromOther> ...$others
+     * @return OrderedListInterface<TValue|TValueFromOther>
+     */
+    public function combine(OrderedListInterface $other, OrderedListInterface ...$others): self;
 }
diff --git a/tests/GenericOrderedListTest.php b/tests/GenericOrderedListTest.php
@@ -1487,4 +1487,49 @@ public function testWillShuffleValuesInList(): void
         self::assertNotSame($list, $list2);
         self::assertNotSame([1, 2, 3], $list2->toNativeArray());
     }
+
+    public function testWillCombineWithAnohterList(): void
+    {
+        /**
+         * @var OrderedListInterface<non-empty-string> $list
+         */
+        $list = new GenericOrderedList([
+            'foo',
+            'bar',
+            'baz',
+        ]);
+
+        $list2 = new GenericOrderedList([
+            'qoo',
+            'ooq',
+        ]);
+
+        $list3 = $list->combine($list2);
+
+        self::assertNotSame($list, $list3);
+        self::assertSame(['foo', 'bar', 'baz', 'qoo', 'ooq'], $list3->toNativeArray());
+    }
+
+    public function testWillCombineWithMultipleLists(): void
+    {
+        /**
+         * @var OrderedListInterface<non-empty-string> $list
+         */
+        $list = new GenericOrderedList(['foo']);
+
+        $list2 = new GenericOrderedList(['bar']);
+
+        $list3 = new GenericOrderedList([
+            'baz',
+            'qoo',
+            'ooq',
+        ]);
+
+        $list4 = $list->combine($list2, $list3);
+
+        self::assertNotSame($list, $list2);
+        self::assertNotSame($list, $list3);
+        self::assertNotSame($list, $list4);
+        self::assertSame(['foo', 'bar', 'baz', 'qoo', 'ooq'], $list4->toNativeArray());
+    }
 }