Merge pull request #4 from connorwyatt/result

Add Result type

result/build.gradle.kts

@@ -0,0 +1,6 @@
+dependencies {
+    testImplementation(testingLibraries.jUnit.jupiter)
+    testImplementation(testingLibraries.strikt.core)
+
+    testRuntimeOnly(testingLibraries.jUnit.jupiter.engine)
+}

result/src/main/kotlin/io/connorwyatt/common/result/Result.kt

@@ -0,0 +1,13 @@
+package io.connorwyatt.common.result
+
+sealed interface Result<out TSuccess, out TFailure> {
+    fun getOrThrow(): TSuccess =
+        when (this) {
+            is Success -> value
+            is Failure -> throw Exception("Result was a failure: $error")
+        }
+
+    data class Success<TSuccess>(val value: TSuccess) : Result<TSuccess, Nothing>
+
+    data class Failure<TFailure>(val error: TFailure) : Result<Nothing, TFailure>
+}

result/src/test/kotlin/io/connorwyatt/common/result/ResultTests.kt

@@ -0,0 +1,26 @@
+package io.connorwyatt.common.result
+
+import org.junit.jupiter.api.Test
+import strikt.api.expectThat
+import strikt.api.expectThrows
+import strikt.assertions.isEqualTo
+
+class ResultTests {
+    @Test
+    fun `getOrThrow returns the value when Result is a success`() {
+        val value = "value"
+
+        val result = Result.Success(value)
+
+        expectThat(result.getOrThrow()).isEqualTo(value)
+    }
+
+    @Test
+    fun `getOrThrow throws when Result is a failure`() {
+        val value = "value"
+
+        val result = Result.Failure(value)
+
+        expectThrows<Exception> { result.getOrThrow() }
+    }
+}

settings.gradle.kts

@@ -8,6 +8,7 @@ include(":http")
 include(":mongodb")
 include(":optional")
 include(":rabbitmq")
+include(":result")
 include(":server")
 include(":time")