Skip to content

Commit 68cf88f

Browse files
klimickklimick
committed
Add sequenceEitherMerged
1 parent 448e3a9 commit 68cf88f

4 files changed

Lines changed: 136 additions & 2 deletions

File tree

‎src/Fp/Functions/Collection/Sequence.php‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use Fp\Functional\Either\Either;
99
use Fp\Functional\Option\Option;
1010
use Fp\Operations\TraverseEitherAccOperation;
11+
use Fp\Operations\TraverseEitherMergedOperation;
1112
use Fp\Operations\TraverseEitherOperation;
1213
use Fp\Operations\TraverseOptionOperation;
1314

@@ -70,6 +71,42 @@ function sequenceEither(iterable $collection): Either
7071
return TraverseEitherOperation::id($collection)->map(asArray(...));
7172
}
7273

74+
/**
75+
* Same as {@see traverseEither()} but merge all left errors into non-empty-list.
76+
*
77+
* @template E
78+
* @template TK of array-key
79+
* @template TVI
80+
*
81+
* @param iterable<TK, Either<non-empty-list<E>, TVI> | Closure(): Either<non-empty-list<E>, TVI>> $collection
82+
* @return Either<non-empty-list<E>, array<TK, TVI>>
83+
* @psalm-return (
84+
* $collection is non-empty-list ? Either<non-empty-list<E>, non-empty-list<TVI>> :
85+
* $collection is list ? Either<non-empty-list<E>, list<TVI>> :
86+
* $collection is non-empty-array ? Either<non-empty-list<E>, non-empty-array<TK, TVI>> :
87+
* Either<non-empty-list<E>, array<TK, TVI>>
88+
* )
89+
*/
90+
function sequenceEitherMerged(iterable $collection): Either
91+
{
92+
return TraverseEitherMergedOperation::id($collection)->map(asArray(...));
93+
}
94+
95+
/**
96+
* Varargs version of {@see sequenceEitherMerged()}.
97+
*
98+
* @template E
99+
* @template TK of array-key
100+
* @template TVI
101+
*
102+
* @param Either<non-empty-list<E>, TVI> | Closure(): Either<non-empty-list<E>, TVI> ...$items
103+
* @return Either<non-empty-list<E>, list<TVI>>
104+
*/
105+
function sequenceEitherMergedT(Either|Closure ...$items): Either
106+
{
107+
return TraverseEitherMergedOperation::id($items)->map(asList(...));
108+
}
109+
73110
/**
74111
* Varargs version of {@see sequenceEither()}.
75112
*

‎src/Fp/Psalm/Hook/FunctionReturnTypeProvider/SequenceEitherFunctionReturnTypeProvider.php‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
use Psalm\Type\Union;
2121

2222
use function Fp\Callable\ctor;
23+
use function Fp\Collection\contains;
2324
use function Fp\Collection\sequenceOptionT;
2425
use function Fp\Evidence\of;
2526
use function Fp\Evidence\proveTrue;
@@ -31,6 +32,8 @@ public static function getFunctionIds(): array
3132
return [
3233
strtolower('Fp\Collection\sequenceEither'),
3334
strtolower('Fp\Collection\sequenceEitherT'),
35+
strtolower('Fp\Collection\sequenceEitherMerged'),
36+
strtolower('Fp\Collection\sequenceEitherMergedT'),
3437
];
3538
}
3639

@@ -67,7 +70,12 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
6770
*/
6871
private static function getInputTypeFromSequenceEither(FunctionReturnTypeProviderEvent $event): Option
6972
{
70-
return proveTrue(strtolower('Fp\Collection\sequenceEither') === $event->getFunctionId())
73+
$isSequenceEither = contains($event->getFunctionId(), [
74+
strtolower('Fp\Collection\sequenceEither'),
75+
strtolower('Fp\Collection\sequenceEitherMerged'),
76+
]);
77+
78+
return proveTrue($isSequenceEither)
7179
->flatMap(fn() => PsalmApi::$args->getCallArgs($event))
7280
->flatMap(fn($args) => $args->head())
7381
->flatMap(fn(CallArg $arg) => PsalmApi::$types->asSingleAtomic($arg->type))
@@ -79,7 +87,12 @@ private static function getInputTypeFromSequenceEither(FunctionReturnTypeProvide
7987
*/
8088
private static function getInputTypeFromSequenceEitherT(FunctionReturnTypeProviderEvent $event): Option
8189
{
82-
return proveTrue(strtolower('Fp\Collection\sequenceEitherT') === $event->getFunctionId())
90+
$isSequenceEitherT = contains($event->getFunctionId(), [
91+
strtolower('Fp\Collection\sequenceEitherT'),
92+
strtolower('Fp\Collection\sequenceEitherMergedT'),
93+
]);
94+
95+
return proveTrue($isSequenceEitherT)
8396
->flatMap(fn() => PsalmApi::$args->getCallArgs($event))
8497
->flatMap(fn(ArrayList $args) => $args->toNonEmptyArrayList())
8598
->map(fn(NonEmptyArrayList $args) => new TKeyedArray(

‎tests/Runtime/Functions/Collection/EitherTraverseTest.php‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
use function Fp\Collection\sequenceEither;
1111
use function Fp\Collection\sequenceEitherAcc;
12+
use function Fp\Collection\sequenceEitherMerged;
13+
use function Fp\Collection\sequenceEitherMergedT;
1214
use function Fp\Collection\sequenceEitherT;
1315
use function Fp\Collection\traverseEither;
1416
use function Fp\Collection\traverseEitherAcc;
@@ -140,6 +142,59 @@ public function testSequence(): void
140142
);
141143
}
142144

145+
public function testSequenceMerged(): void
146+
{
147+
$this->assertEquals(
148+
Either::right([]),
149+
sequenceEitherMerged([]),
150+
);
151+
152+
$this->assertEquals(
153+
Either::right([1, 2]),
154+
sequenceEitherMerged([
155+
Either::right(1),
156+
Either::right(2),
157+
])
158+
);
159+
160+
$this->assertEquals(
161+
Either::left(['error1']),
162+
sequenceEitherMerged([
163+
Either::right(1),
164+
Either::left(['error1']),
165+
])
166+
);
167+
168+
$this->assertEquals(
169+
Either::left(['error1', 'error2']),
170+
sequenceEitherMerged([
171+
Either::right(1),
172+
Either::left(['error1']),
173+
Either::left(['error2']),
174+
])
175+
);
176+
177+
$this->assertEquals(
178+
Either::right([]),
179+
sequenceEitherMergedT(),
180+
);
181+
182+
$this->assertEquals(
183+
Either::right([1, 2]),
184+
sequenceEitherMergedT(Either::right(1), Either::right(2)),
185+
);
186+
187+
$this->assertEquals(
188+
Either::left(['error1']),
189+
sequenceEitherMergedT(Either::right(1), Either::left(['error1']))
190+
);
191+
192+
$this->assertEquals(
193+
Either::left(['error1', 'error2']),
194+
sequenceEitherMergedT(Either::right(1), Either::left(['error1']), Either::left(['error2']))
195+
);
196+
}
197+
143198
public function testLazySequence(): void
144199
{
145200
$this->assertEquals(

‎tests/Static/Plugin/SequenceEitherPluginStaticTest.php‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
use function Fp\Collection\at;
1212
use function Fp\Collection\sequenceEither;
1313
use function Fp\Collection\sequenceEitherAcc;
14+
use function Fp\Collection\sequenceEitherMerged;
15+
use function Fp\Collection\sequenceEitherMergedT;
1416
use function Fp\Collection\sequenceEitherT;
1517
use function Fp\Evidence\proveInt;
1618
use function Fp\Evidence\proveNonEmptyString;
@@ -150,6 +152,33 @@ public function sequenceEitherT(array $data): Either
150152
);
151153
}
152154

155+
/**
156+
* @param array<string, mixed> $data
157+
* @return Either<non-empty-list<-1|-2>, array{non-empty-string, int}>
158+
*/
159+
public function sequenceEitherMergedT(array $data): Either
160+
{
161+
return sequenceEitherMergedT(
162+
at($data, 'name')->flatMap(proveNonEmptyString(...))->toRight(fn() => [-1]),
163+
at($data, 'age')->flatMap(proveInt(...))->toRight(fn() => [-2]),
164+
);
165+
}
166+
167+
/**
168+
* @param array<string, mixed> $data
169+
* @return Either<non-empty-list<-1|-2>, array{
170+
* n: non-empty-string,
171+
* a: int,
172+
* }>
173+
*/
174+
public function sequenceEitherMerged(array $data): Either
175+
{
176+
return sequenceEitherMerged([
177+
'n' => at($data, 'name')->flatMap(proveNonEmptyString(...))->toRight(fn() => [-1]),
178+
'a' => at($data, 'age')->flatMap(proveInt(...))->toRight(fn() => [-2]),
179+
]);
180+
}
181+
153182
/**
154183
* @return Either<
155184
* array{

0 commit comments

Comments
 (0)