Merge branch 'develop'

* develop:
  CS
  add Sequence::lazyStartingWith() named constructor

Author: Baptouuuu

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 4.7.0 - 2022-11-26
+
+## Added
+
+- `Innmind\Immutable\Sequence::lazyStartingWith()`
+
 ## 4.6.0 - 2022-10-08
 
 ## Added

docs/SEQUENCE.md

@@ -41,6 +41,16 @@ $sequence = Sequence::lazy(function() {
 
 **Important**: since the elements are reloaded each time the immutability responsability is up to you because the source may change or if you generate objects it will generate new objects each time (so if you make strict comparison it will fail).
 
+## `::lazyStartingWith()`
+
+Same as `::lazy()` except you don't need to manually build the generator.
+
+```php
+$sequence = Sequence::lazyStartingWith(1, 2, 3);
+```
+
+**Note**: this is useful when you know the first items of the sequence and you'll `append` another lazy sequence at the end.
+
 ## `::mixed()`
 
 This is a shortcut for `::of(mixed ...$mixed)`.

src/Sequence.php

@@ -90,6 +90,24 @@ public static function lazy(callable $generator): self
         return new self(new Sequence\Lazy($generator));
     }
 
+    /**
+     * Same as self::lazy() except you don't have to create the generator manually
+     *
+     * @template V
+     * @no-named-arguments
+     * @psalm-pure
+     *
+     * @param V $values
+     */
+    public static function lazyStartingWith(...$values): self
+    {
+        return self::lazy(static function() use ($values) {
+            foreach ($values as $value) {
+                yield $value;
+            }
+        });
+    }
+
     /**
      * @no-named-arguments
      * @psalm-pure

tests/SequenceTest.php

@@ -67,6 +67,22 @@ public function testLazy()
         $this->assertTrue($loaded);
     }
 
+    public function testLazyStartingWith()
+    {
+        $loaded = false;
+        $sequence = Sequence::lazyStartingWith(1, 2, 3)->append(
+            Sequence::lazy(static function() use (&$loaded) {
+                yield 4;
+                $loaded = true;
+            }),
+        );
+
+        $this->assertInstanceOf(Sequence::class, $sequence);
+        $this->assertFalse($loaded);
+        $this->assertSame([1, 2, 3, 4], $sequence->toList());
+        $this->assertTrue($loaded);
+    }
+
     public function testMixed()
     {
         $sequence = Sequence::mixed(1, '2', 3);