Skip to content

Add Opt.when method #560

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.

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

Merged
merged 1 commit into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 17 additions & 2 deletions core/src/main/scala/com/avsystem/commons/misc/Opt.scala
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ object Opt {
def foreach[U](f: A => U): Unit = self filter p foreach f
def withFilter(q: A => Boolean): WithFilter[A] = new WithFilter[A](self, x => p(x) && q(x))
}

final class LazyOptOps[A](private val opt: () => Opt[A]) extends AnyVal {
/** When a given condition is true, evaluates the `opt` argument and returns it.
* When the condition is false, `opt` is not evaluated and `Opt.Empty` is
* returned.
*/
def when(cond: Boolean): Opt[A] = if (cond) opt() else Opt.Empty
/** Unless a given condition is true, this will evaluate the `opt` argument and
* return it. Otherwise, `opt` is not evaluated and `Opt.Empty` is returned.
*/
@inline def unless(cond: Boolean): Opt[A] = when(!cond)
}

implicit def lazyOptOps[A](opt: => Opt[A]): LazyOptOps[A] = new LazyOptOps(() => opt)
}

/**
Expand All @@ -41,7 +55,8 @@ object Opt {
* Please be aware of that tradeoff.
*/
final class Opt[+A] private(private val rawValue: Any) extends AnyVal with OptBase[A] with Serializable {
import Opt._

import Opt.*

private def value: A = rawValue.asInstanceOf[A]

Expand Down Expand Up @@ -140,7 +155,7 @@ final class Opt[+A] private(private val rawValue: Any) extends AnyVal with OptBa
if (isEmpty) Iterator.empty else Iterator.single(value)

@inline def toList: List[A] =
if (isEmpty) List() else new ::(value, Nil)
if (isEmpty) List() else value :: Nil

@inline def toRight[X](left: => X): Either[X, A] =
if (isEmpty) Left(left) else Right(value)
Expand Down
12 changes: 12 additions & 0 deletions core/src/test/scala/com/avsystem/commons/misc/OptTest.scala
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,16 @@ class OptTest extends AnyFunSuite {
val seq: Seq[Int] = Opt(5).mapOr(Nil, i => 0 until i)
assert(seq == (0 until 5))
}

test("Opt.{when, unless}") {
val opt = Opt(42)

assert(opt.when(true) == opt)
assert(opt.when(false) == Opt.Empty)
assert(Opt(fail("Parameter should not be evaluated")).when(false) == Opt.Empty)

assert(opt.unless(false) == opt)
assert(opt.unless(true) == Opt.Empty)
assert(Opt(fail("Parameter should not be evaluated")).unless(true) == Opt.Empty)
}
}