fix frames types transitions

Innmind · Dec 3, 2023 · 11b9d58 · 11b9d58
1 parent b1a20b5
commit 11b9d58
Show file tree

Hide file tree

Showing 9 changed files with 129 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Fixed
 
 - `Innmind\IO\Readable\Frame\NoOp` constructor type
+- Frames types transitions via `::filter()`, `::map()` and `::flatMap()`
 
 ## 2.4.0 - 2023-12-03
 

diff --git a/src/Readable/Frame/Chunk.php b/src/Readable/Frame/Chunk.php
@@ -48,6 +48,10 @@ public static function of(int $size): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(Str): bool $predicate
+     *
+     * @return Frame<Str>
      */
     public function filter(callable $predicate): Frame
     {
@@ -56,6 +60,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Str): U $map
+     *
+     * @return Frame<U>
      */
     public function map(callable $map): Frame
     {
@@ -64,6 +74,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Str): Frame<U> $map
+     *
+     * @return Frame<U>
      */
     public function flatMap(callable $map): Frame
     {

diff --git a/src/Readable/Frame/Chunks.php b/src/Readable/Frame/Chunks.php
@@ -100,6 +100,10 @@ public function until(int $size, callable $predicate): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(Seq<Str>): bool $predicate
+     *
+     * @return Frame<Seq<Str>>
      */
     public function filter(callable $predicate): Frame
     {
@@ -108,6 +112,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Seq<Str>): U $map
+     *
+     * @return Frame<U>
      */
     public function map(callable $map): Frame
     {
@@ -116,6 +126,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Seq<Str>): Frame<U> $map
+     *
+     * @return Frame<U>
      */
     public function flatMap(callable $map): Frame
     {

diff --git a/src/Readable/Frame/Filter.php b/src/Readable/Frame/Filter.php
@@ -54,6 +54,10 @@ public static function of(Frame $frame, callable $predicate): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(T): bool $predicate
+     *
+     * @return Frame<T>
      */
     public function filter(callable $predicate): Frame
     {
@@ -62,6 +66,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(T): U $map
+     *
+     * @return Frame<U>
      */
     public function map(callable $map): Frame
     {
@@ -70,6 +80,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(T): Frame<U> $map
+     *
+     * @return Frame<U>
      */
     public function flatMap(callable $map): Frame
     {

diff --git a/src/Readable/Frame/FlatMap.php b/src/Readable/Frame/FlatMap.php
@@ -57,6 +57,10 @@ public static function of(Frame $frame, callable $map): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(U): bool $predicate
+     *
+     * @return Frame<U>
      */
     public function filter(callable $predicate): Frame
     {
@@ -65,6 +69,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template V
+     *
+     * @param callable(U): V $map
+     *
+     * @return Frame<V>
      */
     public function map(callable $map): Frame
     {
@@ -73,6 +83,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template V
+     *
+     * @param callable(U): Frame<V> $map
+     *
+     * @return Frame<V>
      */
     public function flatMap(callable $map): Frame
     {

diff --git a/src/Readable/Frame/Line.php b/src/Readable/Frame/Line.php
@@ -38,6 +38,10 @@ public static function new(): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(Str): bool $predicate
+     *
+     * @return Frame<Str>
      */
     public function filter(callable $predicate): Frame
     {
@@ -46,6 +50,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Str): U $map
+     *
+     * @return Frame<U>
      */
     public function map(callable $map): Frame
     {
@@ -54,6 +64,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Str): Frame<U> $map
+     *
+     * @return Frame<U>
      */
     public function flatMap(callable $map): Frame
     {

diff --git a/src/Readable/Frame/Map.php b/src/Readable/Frame/Map.php
@@ -56,6 +56,10 @@ public static function of(Frame $frame, callable $map): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(U): bool $predicate
+     *
+     * @return Frame<U>
      */
     public function filter(callable $predicate): Frame
     {
@@ -64,6 +68,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template V
+     *
+     * @param callable(U): V $map
+     *
+     * @return Frame<V>
      */
     public function map(callable $map): Frame
     {
@@ -72,6 +82,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template V
+     *
+     * @param callable(U): Frame<V> $map
+     *
+     * @return Frame<V>
      */
     public function flatMap(callable $map): Frame
     {

diff --git a/src/Readable/Frame/NoOp.php b/src/Readable/Frame/NoOp.php
@@ -52,6 +52,10 @@ public static function of(mixed $value): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(T): bool $predicate
+     *
+     * @return Frame<T>
      */
     public function filter(callable $predicate): Frame
     {
@@ -60,6 +64,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(T): U $map
+     *
+     * @return Frame<U>
      */
     public function map(callable $map): Frame
     {
@@ -68,6 +78,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(T): Frame<U> $map
+     *
+     * @return Frame<U>
      */
     public function flatMap(callable $map): Frame
     {

diff --git a/src/Readable/Frame/Sequence.php b/src/Readable/Frame/Sequence.php
@@ -82,6 +82,10 @@ public function until(callable $predicate): self
 
     /**
      * @psalm-mutation-free
+     *
+     * @param callable(Seq<T>): bool $predicate
+     *
+     * @return Frame<Seq<T>>
      */
     public function filter(callable $predicate): Frame
     {
@@ -90,6 +94,12 @@ public function filter(callable $predicate): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Seq<T>): U $map
+     *
+     * @return Frame<U>
      */
     public function map(callable $map): Frame
     {
@@ -98,6 +108,12 @@ public function map(callable $map): Frame
 
     /**
      * @psalm-mutation-free
+     *
+     * @template U
+     *
+     * @param callable(Seq<T>): Frame<U> $map
+     *
+     * @return Frame<U>
      */
     public function flatMap(callable $map): Frame
     {