Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NonEmptyList: Add bindAll and more unit tests #2995

Merged
merged 6 commits into from
Mar 27, 2023
Merged

NonEmptyList: Add bindAll and more unit tests #2995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a7a0ad4
Add bindAll function for NonEmptyList
franciscodr Mar 24, 2023
e993d3e
Add unit tests for NonEmptyList
franciscodr Mar 24, 2023
caaf309
Merge branch 'main' into fd-nel-additional-changes
franciscodr Mar 24, 2023
38bccaf
Update API files
franciscodr Mar 24, 2023
75564ed
Trigger build
franciscodr Mar 24, 2023
dd8feec
Fix compilation error
franciscodr Mar 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions arrow-libs/core/arrow-core/api/arrow-core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3250,6 +3250,7 @@ public final class arrow/core/raise/DefaultRaise : arrow/core/raise/Raise {
public fun bind (Larrow/core/continuations/Effect;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bindAll (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public fun bindAll (Ljava/lang/Iterable;)Ljava/util/List;
public fun bindAll (Ljava/util/Map;)Ljava/util/Map;
public fun catch (Larrow/core/continuations/Effect;Lkotlin/jvm/functions/Function3;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand All @@ -3274,8 +3275,10 @@ public final class arrow/core/raise/IorRaise : arrow/core/raise/Raise {
public fun bind (Larrow/core/continuations/Effect;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bindAll (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public fun bindAll (Ljava/lang/Iterable;)Ljava/util/List;
public fun bindAll (Ljava/util/Map;)Ljava/util/Map;
public final fun bindAllIor (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public final fun bindAllIor (Ljava/lang/Iterable;)Ljava/util/List;
public final fun bindAllIor (Ljava/util/Map;)Ljava/util/Map;
public fun catch (Larrow/core/continuations/Effect;Lkotlin/jvm/functions/Function3;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand All @@ -3296,6 +3299,7 @@ public final class arrow/core/raise/NullableRaise : arrow/core/raise/Raise {
public final fun bind (Ljava/lang/Object;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bindAll (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public fun bindAll (Ljava/lang/Iterable;)Ljava/util/List;
public fun bindAll (Ljava/util/Map;)Ljava/util/Map;
public final fun bindAllNullable (Ljava/lang/Iterable;)Ljava/util/List;
Expand All @@ -3321,8 +3325,10 @@ public final class arrow/core/raise/OptionRaise : arrow/core/raise/Raise {
public fun bind (Larrow/core/continuations/Effect;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bindAll (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public fun bindAll (Ljava/lang/Iterable;)Ljava/util/List;
public fun bindAll (Ljava/util/Map;)Ljava/util/Map;
public final fun bindAllOption (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public final fun bindAllOption (Ljava/lang/Iterable;)Ljava/util/List;
public final fun bindAllOption (Ljava/util/Map;)Ljava/util/Map;
public fun catch (Larrow/core/continuations/Effect;Lkotlin/jvm/functions/Function3;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand All @@ -3344,6 +3350,7 @@ public abstract interface class arrow/core/raise/Raise {
public abstract fun bind (Larrow/core/continuations/Effect;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun bind (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public abstract fun bind (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun bindAll (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public abstract fun bindAll (Ljava/lang/Iterable;)Ljava/util/List;
public abstract fun bindAll (Ljava/util/Map;)Ljava/util/Map;
public abstract fun catch (Larrow/core/continuations/Effect;Lkotlin/jvm/functions/Function3;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand All @@ -3361,6 +3368,7 @@ public final class arrow/core/raise/Raise$DefaultImpls {
public static fun bind (Larrow/core/raise/Raise;Larrow/core/continuations/Effect;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static fun bind (Larrow/core/raise/Raise;Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public static fun bind (Larrow/core/raise/Raise;Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static fun bindAll (Larrow/core/raise/Raise;Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public static fun bindAll (Larrow/core/raise/Raise;Ljava/lang/Iterable;)Ljava/util/List;
public static fun bindAll (Larrow/core/raise/Raise;Ljava/util/Map;)Ljava/util/Map;
public static fun catch (Larrow/core/raise/Raise;Larrow/core/continuations/Effect;Lkotlin/jvm/functions/Function3;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand All @@ -3378,6 +3386,7 @@ public class arrow/core/raise/RaiseAccumulate : arrow/core/raise/Raise {
public fun bind (Larrow/core/continuations/Effect;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bindAll (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public fun bindAll (Ljava/lang/Iterable;)Ljava/util/List;
public fun bindAll (Ljava/util/Map;)Ljava/util/Map;
public final fun bindNel (Larrow/core/Either;)Ljava/lang/Object;
Expand Down Expand Up @@ -3473,8 +3482,10 @@ public final class arrow/core/raise/ResultRaise : arrow/core/raise/Raise {
public final fun bind (Ljava/lang/Object;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
public fun bind (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun bindAll (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public fun bindAll (Ljava/lang/Iterable;)Ljava/util/List;
public fun bindAll (Ljava/util/Map;)Ljava/util/Map;
public final fun bindAllResult (Larrow/core/NonEmptyList;)Larrow/core/NonEmptyList;
public final fun bindAllResult (Ljava/lang/Iterable;)Ljava/util/List;
public final fun bindAllResult (Ljava/util/Map;)Ljava/util/Map;
public fun catch (Larrow/core/continuations/Effect;Lkotlin/jvm/functions/Function3;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand Down
16 changes: 16 additions & 0 deletions arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Builders.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import arrow.atomic.Atomic
import arrow.atomic.updateAndGet
import arrow.core.Either
import arrow.core.Ior
import arrow.core.NonEmptyList
import arrow.core.None
import arrow.core.Option
import arrow.core.Some
Expand Down Expand Up @@ -84,6 +85,11 @@ public class ResultRaise(private val raise: Raise<Throwable>) : Raise<Throwable>
@JvmName("bindAllResult")
public fun <A> Iterable<Result<A>>.bindAll(): List<A> =
map { it.bind() }

@RaiseDSL
@JvmName("bindAllResult")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may have a problem with this name clashing in the Arrow 2.0 branch, where NonEmptyList is defined as a value class.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how it would differ when it being a value class 🤔 From Kotlin AST point-of-view it's a different type, and from JVM binary it has a different name.

public fun <A> NonEmptyList<Result<A>>.bindAll(): NonEmptyList<A> =
map { it.bind() }
}

public class OptionRaise(private val raise: Raise<None>) : Raise<None> by raise {
Expand All @@ -99,6 +105,11 @@ public class OptionRaise(private val raise: Raise<None>) : Raise<None> by raise
public fun <A> Iterable<Option<A>>.bindAll(): List<A> =
map { it.bind() }

@RaiseDSL
@JvmName("bindAllOption")
public fun <A> NonEmptyList<Option<A>>.bindAll(): NonEmptyList<A> =
map { it.bind() }

@RaiseDSL
public fun ensure(value: Boolean): Unit = ensure(value) { None }

Expand All @@ -123,6 +134,11 @@ public class IorRaise<Error> @PublishedApi internal constructor(
public fun <A> Iterable<Ior<Error, A>>.bindAll(): List<A> =
map { it.bind() }

@RaiseDSL
@JvmName("bindAllIor")
public fun <A> NonEmptyList<Ior<Error, A>>.bindAll(): NonEmptyList<A> =
map { it.bind() }

@RaiseDSL
public fun <A> Ior<Error, A>.bind(): A =
when (this) {
Expand Down
5 changes: 5 additions & 0 deletions arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Raise.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package arrow.core.raise

import arrow.core.Either
import arrow.core.NonEmptyList
import arrow.core.Validated
import arrow.core.ValidatedDeprMsg
import arrow.core.continuations.EffectScope
Expand Down Expand Up @@ -249,6 +250,10 @@ public interface Raise<in Error> {
@RaiseDSL
public fun <A> Iterable<Either<Error, A>>.bindAll(): List<A> =
map { it.bind() }

@RaiseDSL
public fun <A> NonEmptyList<Either<Error, A>>.bindAll(): NonEmptyList<A> =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we are including NonEmptyList, should we also include Set and other types of collections?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I thought about adding NonEmptySet too today

map { it.bind() }
}

/**
Expand Down
3 changes: 3 additions & 0 deletions arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/RaiseAccumulate.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,9 @@ public open class RaiseAccumulate<Error>(
override fun <A> Iterable<Either<Error, A>>.bindAll(): List<A> =
mapOrAccumulate { it.bind() }

override fun <A> NonEmptyList<Either<Error, A>>.bindAll(): NonEmptyList<A> =
requireNotNull(mapOrAccumulate { it.bind() }.toNonEmptyListOrNull())
nomisRev marked this conversation as resolved.
Show resolved Hide resolved

@RaiseDSL
public fun <A> EitherNel<Error, A>.bindNel(): A = when (this) {
is Either.Left -> raise.raise(value)
Expand Down
166 changes: 141 additions & 25 deletions arrow-libs/core/arrow-core/src/commonTest/kotlin/arrow/core/NonEmptyListTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,21 @@ package arrow.core

import arrow.core.test.laws.SemigroupLaws
import arrow.core.test.nonEmptyList
import arrow.core.test.stackSafeIteration
import arrow.core.test.testLaws
import arrow.typeclasses.Semigroup
import io.kotest.assertions.withClue
import io.kotest.core.spec.style.StringSpec
import io.kotest.inspectors.shouldForAll
import io.kotest.matchers.booleans.shouldBeTrue
import io.kotest.matchers.nulls.shouldNotBeNull
import io.kotest.property.Arb
import io.kotest.matchers.shouldBe
import io.kotest.property.arbitrary.boolean
import io.kotest.property.arbitrary.int
import io.kotest.property.arbitrary.negativeInt
import io.kotest.property.arbitrary.pair
import io.kotest.property.arbitrary.string
import io.kotest.property.checkAll
import kotlin.math.max
import kotlin.math.min
Expand All @@ -32,15 +37,21 @@ class NonEmptyListTest : StringSpec({
}
}

"flatten" {
checkAll(Arb.nonEmptyList(Arb.int())) { nel ->
nonEmptyListOf(nel).flatten() shouldBe nel
}
}

"traverse for Either stack-safe" {
// also verifies result order and execution order (l to r)
val acc = mutableListOf<Int>()
val res = (0..20_000).toNonEmptyListOrNull()?.traverse { a ->
val res = (0..stackSafeIteration()).toNonEmptyListOrNull()?.traverse { a ->
acc.add(a)
Either.Right(a)
}
res shouldBe Either.Right(acc.toNonEmptyListOrNull())
res shouldBe Either.Right((0..20_000).toNonEmptyListOrNull())
res shouldBe Either.Right((0..stackSafeIteration()).toNonEmptyListOrNull())
}

"traverse for Either short-circuit" {
Expand All @@ -62,29 +73,31 @@ class NonEmptyListTest : StringSpec({

"sequence for Either should be consistent with traverseEither" {
checkAll(Arb.nonEmptyList(Arb.int())) { ints ->
ints.map { if (it % 2 == 0) Either.Right(it) else Either.Left(it) }.sequence() shouldBe
ints.traverse { if (it % 2 == 0) Either.Right(it) else Either.Left(it) }
fun onlyEven(i: Int) = if (i % 2 == 0) Either.Right(i) else Either.Left(i)
ints.map { onlyEven(it) }.sequence() shouldBe ints.traverse { onlyEven(it) }
}
}

"traverse for Option is stack-safe" {
// also verifies result order and execution order (l to r)
val acc = mutableListOf<Int>()
val res = (0..20_000).toNonEmptyListOrNull()?.traverse { a ->
val res = (0..stackSafeIteration()).toNonEmptyListOrNull()?.traverse { a ->
acc.add(a)
Some(a)
}
res shouldBe Some(acc.toNonEmptyListOrNull())
res shouldBe Some((0..20_000).toNonEmptyListOrNull())
res shouldBe Some((0..stackSafeIteration()).toNonEmptyListOrNull())
}

"traverse for Option short-circuits" {
checkAll(Arb.nonEmptyList(Arb.int())) { ints ->
val acc = mutableListOf<Int>()
val evens = ints.traverse {
(it % 2 == 0).maybe {
acc.add(it)
it
val evens = ints.traverse { a ->
if ((a % 2 == 0)) {
acc.add(a)
Some(a)
} else {
None
}
}
acc shouldBe ints.takeWhile { it % 2 == 0 }
Expand All @@ -94,32 +107,49 @@ class NonEmptyListTest : StringSpec({

"sequence for Option yields some when all entries in the list are some" {
checkAll(Arb.nonEmptyList(Arb.int())) { ints ->
val evens = ints.map { (it % 2 == 0).maybe { it } }.sequence()
val evens = ints.map { a ->
if ((a % 2 == 0)) {
Some(a)
} else {
None
}
}.sequence()
evens.fold({ Unit }) { it shouldBe ints }
}
}

"sequence for Option should be consistent with traverseOption" {
checkAll(Arb.nonEmptyList(Arb.int())) { ints ->
ints.map { (it % 2 == 0).maybe { it } }.sequence() shouldBe
ints.traverse { (it % 2 == 0).maybe { it } }
ints.map { a->
if ((a % 2 == 0)) {
Some(a)
} else {
None
}
}.sequence() shouldBe
ints.traverse { a->
if ((a % 2 == 0)) {
Some(a)
} else {
None
}
}
}
}

"traverse for Validated stack-safe" {
"traverse for Validated is stack-safe" {
// also verifies result order and execution order (l to r)
val acc = mutableListOf<Int>()
val res = (0..20_000)
.toNonEmptyListOrNull()!!
.traverse(Semigroup.string()) {
val res = (0..stackSafeIteration())
.toNonEmptyListOrNull()?.traverse(Semigroup.string()) {
acc.add(it)
Validated.Valid(it)
}
Validated.Valid(it)
}
res shouldBe Validated.Valid(acc)
res shouldBe Validated.Valid((0..20_000).toList())
res shouldBe Validated.Valid((0..stackSafeIteration()).toList())
}

"traverse for Validated acummulates" {
"traverse for Validated accumulates" {
checkAll(Arb.nonEmptyList(Arb.int())) { ints ->
val res: ValidatedNel<Int, NonEmptyList<Int>> =
ints.traverse(Semigroup.nonEmptyList()) { i: Int -> if (i % 2 == 0) i.validNel() else i.invalidNel() }
Expand All @@ -133,13 +163,99 @@ class NonEmptyListTest : StringSpec({

"can align lists with different lengths" {
checkAll(Arb.nonEmptyList(Arb.boolean()), Arb.nonEmptyList(Arb.boolean())) { a, b ->
a.align(b).size shouldBe max(a.size, b.size)
val result = a.align(b)

result.size shouldBe max(a.size, b.size)
result.take(min(a.size, b.size)).shouldForAll {
it.isBoth() shouldBe true
}
result.drop(min(a.size, b.size)).shouldForAll {
if (a.size < b.size) {
it.isRight() shouldBe true
} else {
it.isLeft() shouldBe true
}
}
}
}

checkAll(Arb.nonEmptyList(Arb.boolean()), Arb.nonEmptyList(Arb.boolean())) { a, b ->
a.align(b).all.take(min(a.size, b.size)).forEach {
it.isBoth shouldBe true
"mapOrAccumulate is stack-safe, and runs in original order" {
val acc = mutableListOf<Int>()
val res = (0..stackSafeIteration())
.toNonEmptyListOrNull()!!
.mapOrAccumulate(String::plus) {
acc.add(it)
it
}
res shouldBe Either.Right(acc)
res shouldBe Either.Right((0..stackSafeIteration()).toList())
}

"mapOrAccumulate accumulates errors" {
checkAll(Arb.nonEmptyList(Arb.int())) { nel ->
val res = nel.mapOrAccumulate { i ->
if (i % 2 == 0) i else raise(i)
}

val expected = nel.filterNot { it % 2 == 0 }
.toNonEmptyListOrNull()?.left() ?: nel.filter { it % 2 == 0 }.right()

res shouldBe expected
}
}

"mapOrAccumulate accumulates errors with combine function" {
checkAll(Arb.nonEmptyList(Arb.negativeInt())) { nel ->
val res = nel.mapOrAccumulate(String::plus) { i ->
if (i > 0) i else raise("Negative")
}

res shouldBe nel.map { "Negative" }.joinToString("").left()
}
}

"padZip" {
checkAll(Arb.nonEmptyList(Arb.int()), Arb.nonEmptyList(Arb.int())) { a, b ->
val result = a.padZip(b)
val left = a + List(max(0, b.size - a.size)) { null }
val right = b + List(max(0, a.size - b.size)) { null }

result shouldBe left.zip(right)
}
}

"padZip with transformation" {
checkAll(Arb.nonEmptyList(Arb.int()), Arb.nonEmptyList(Arb.int())) { a, b ->
val result = a.padZip(b, { it * 2 }, { it * 3 }, { x, y -> x + y })

val minSize = min(a.size, b.size)
result.size shouldBe max(a.size, b.size)
result.take(minSize) shouldBe a.take(minSize).zip(b.take(minSize)) { x, y -> x + y }

if (a.size > b.size)
result.drop(minSize) shouldBe a.drop(minSize).map { it * 2 }
else
result.drop(minSize) shouldBe b.drop(minSize).map { it * 3 }
}
}

"unzip is the inverse of zip" {
checkAll(Arb.nonEmptyList(Arb.int())) { nel ->
val zipped = nel.zip(nel)
val left = zipped.map { it.first }
val right = zipped.map { it.second }

left shouldBe nel
right shouldBe nel
}
}

"unzip with split function" {
checkAll(Arb.nonEmptyList(Arb.pair(Arb.int(), Arb.string()))) { nel ->
val unzipped = nel.unzip(::identity)

unzipped.first shouldBe nel.map { it.first }
unzipped.second shouldBe nel.map { it.second }
}
}

Expand Down
Loading