From 166b2fdb979f5de1e8e99c978f94ae62735efa7a Mon Sep 17 00:00:00 2001
From: Olaoluwa Osuntokun <laolu32@gmail.com>
Date: Sat, 24 Feb 2024 16:39:56 -0800
Subject: [PATCH] fn: add UnwrapOrErr and UnwrapOrFail to Option

In this commit, we add two new methods that simplify usage of an
handling a value wrapped in an Option. Thes methods allow a caller to
force the nil/None check up front, and either obtain the value, or fail
the current execution or test.

This should replace most usages of `UnsafeFromSome` where ever used
today.
---
 fn/option.go | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/fn/option.go b/fn/option.go
index 59012effb..d500359be 100644
--- a/fn/option.go
+++ b/fn/option.go
@@ -1,5 +1,7 @@
 package fn
 
+import "testing"
+
 // Option[A] represents a value which may or may not be there. This is very
 // often preferable to nil-able pointers.
 type Option[A any] struct {
@@ -54,6 +56,32 @@ func (o Option[A]) UnwrapOrFunc(f func() A) A {
 	return ElimOption(o, f, func(a A) A { return a })
 }
 
+// UnwrapOrFail is used to extract a value from an option within a test
+// context. If the option is None, then the test fails.
+func (o Option[A]) UnwrapOrFail(t *testing.T) A {
+	t.Helper()
+
+	if o.isSome {
+		return o.some
+	}
+
+	t.Fatalf("Option[%T] was None()", o.some)
+
+	var zero A
+	return zero
+}
+
+// UnwrapOrErr is used to extract a value from an option, if the option is
+// empty, then the specified error is returned directly.
+func (o Option[A]) UnwrapOrErr(err error) (A, error) {
+	if !o.isSome {
+		var zero A
+		return zero, err
+	}
+
+	return o.some, nil
+}
+
 // UnwrapOrFuncErr is used to extract a value from an option, and we supply a
 // thunk to be evaluated in the case when the Option is empty.
 func (o Option[A]) UnwrapOrFuncErr(f func() (A, error)) (A, error) {