Skip to content

Sligtly improve failure API #60

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
May 10, 2022
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
6 changes: 3 additions & 3 deletions core/src/commonMain/kotlin/CommonJsonLogicEngine.kt
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ internal class CommonJsonLogicEngine(private val evaluator: LogicEvaluator) : Js
it.isNotEmpty()
}?.let {
safeEvaluate(expression, data)
} ?: JsonLogicResult.EmptyExpressionFailure
} ?: JsonLogicResult.Failure.EmptyExpression

private fun safeEvaluate(expression: Map<String, Any?>, data: Any?) = runCatching {
evaluator.evaluateLogic(expression, data)
}.fold(
onSuccess = ::toJsonLogicResult,
onFailure = { JsonLogicResult.MissingOperationFailure }
onFailure = { JsonLogicResult.Failure.MissingOperation }
)

private fun toJsonLogicResult(evaluatedValue: Any?) = evaluatedValue?.let { notNullResult ->
JsonLogicResult.Success(notNullResult)
} ?: JsonLogicResult.NullResultFailure
} ?: JsonLogicResult.Failure.NullResult
}
10 changes: 7 additions & 3 deletions core/src/commonMain/kotlin/JsonLogicResult.kt
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
sealed class JsonLogicResult {
data class Success(val value: Any) : JsonLogicResult()
object NullResultFailure : JsonLogicResult()
object EmptyExpressionFailure : JsonLogicResult()
object MissingOperationFailure : JsonLogicResult()

sealed class Failure : JsonLogicResult() {
object NullResult : Failure()
object EmptyExpression : Failure()
object MissingOperation : Failure()
}

}
6 changes: 3 additions & 3 deletions core/src/commonTest/kotlin/CommonJsonLogicEngineTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class CommonJsonLogicEngineTest : BehaviorSpec({
val result = logicEngine.evaluate(logicExpression, null)

then("returns missing operation failure result") {
result shouldBe JsonLogicResult.MissingOperationFailure
result shouldBe JsonLogicResult.Failure.MissingOperation
}
}
}
Expand All @@ -24,7 +24,7 @@ class CommonJsonLogicEngineTest : BehaviorSpec({
val result = logicEngine.evaluate(logicExpression, null)

then("returns empty expression failure result") {
result shouldBe JsonLogicResult.EmptyExpressionFailure
result shouldBe JsonLogicResult.Failure.EmptyExpression
}
}
}
Expand All @@ -36,7 +36,7 @@ class CommonJsonLogicEngineTest : BehaviorSpec({
val result = logicEngine.evaluate(logicExpression, null)

then("returns null failure result") {
result shouldBe JsonLogicResult.NullResultFailure
result shouldBe JsonLogicResult.Failure.NullResult
}
}
}
Expand Down
16 changes: 8 additions & 8 deletions core/src/commonTest/kotlin/operations/array/ReduceTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class ReduceTest : FunSpec({
9
)
),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf(
Expand All @@ -32,14 +32,14 @@ class ReduceTest : FunSpec({
)
),
data = mapOf("b" to "banana"),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf(
"reduce" to listOf(mapOf("var" to "integers"))
),
data = mapOf("integers" to listOf(1, 2, 3, 4)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf(
Expand All @@ -48,25 +48,25 @@ class ReduceTest : FunSpec({
0
)
),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("reduce" to listOf(0)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("reduce" to emptyList<Any>()),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("reduce" to null),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf(
"reduce" to listOf(listOf(1, 2), null, 4)
),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("reduce" to listOf(mapOf("var" to "integers"), 0)),
Expand Down
22 changes: 11 additions & 11 deletions core/src/commonTest/kotlin/operations/data/VarTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -16,45 +16,45 @@ class VarTest : FunSpec({
TestInput(
expression = mapOf("var" to "b"),
data = mapOf("a" to 1),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("var" to "a"), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("var" to "a"), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("var" to listOf(listOf(""))),
data = listOf(1, 2, 3, 4),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("var" to listOf(listOf(null))),
data = listOf(1, 2, 3, 4),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("var" to listOf("b")),
data = mapOf("a" to 1),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("var" to listOf("b")), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("var" to listOf("b")), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("var" to listOf(emptyList<Any>())),
data = listOf(1, 2, 3, 4),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("var" to "a.b.c"), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("var" to "a.b.c"), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("var" to "a.b.c"),
data = mapOf("a" to null),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("var" to "a.q"),
data = mapOf("a" to mapOf("b" to "c")),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("var" to "a.b.c"),
data = mapOf("a" to mapOf("b" to null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf(
Expand Down
8 changes: 4 additions & 4 deletions core/src/commonTest/kotlin/operations/logic/IfTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -210,16 +210,16 @@ class IfTest : FunSpec({
),
TestInput(
expression = mapOf("if" to listOf(false, "apple")),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("if" to listOf<Any>()), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("if" to listOf<Any>()), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("if" to listOf(false, "apple", false, "banana")),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("if" to listOf(false, "apple", false, "banana", false, "carrot")),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
)
)
// given
Expand Down
38 changes: 19 additions & 19 deletions core/src/commonTest/kotlin/operations/numeric/AdditionTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -83,55 +83,55 @@ class AdditionTest : FunSpec({
),
TestInput(
expression = mapOf("+" to listOf(2, 2, null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("+" to listOf("1", 1.5, "banana")),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("+" to listOf("1", 1, listOf("banana"))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("+" to listOf("a", 2)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf("a", 2)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("+" to listOf(listOf("a", 2), 2)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("+" to listOf(listOf(2, "a"), listOf("a", 2))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("+" to listOf(null, 5)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf(5, null)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf(null, 5)), result = JsonLogicResult.Failure.NullResult),
TestInput(expression = mapOf("+" to listOf(5, null)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("+" to listOf(null, null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("+" to listOf(null)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf(null)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("+" to listOf(true, false)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("+" to listOf(true)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf(false)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf(true)), result = JsonLogicResult.Failure.NullResult),
TestInput(expression = mapOf("+" to listOf(false)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("+" to listOf(true, null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("+" to listOf(false, null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("+" to listOf(false, true)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("+" to listOf(0, true)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf(1, true)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("+" to listOf(0, true)), result = JsonLogicResult.Failure.NullResult),
TestInput(expression = mapOf("+" to listOf(1, true)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("+" to listOf(emptyList<String>(), 2)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
)
// given
Expand Down
38 changes: 19 additions & 19 deletions core/src/commonTest/kotlin/operations/numeric/DivisionTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -77,57 +77,57 @@ class DivisionTest : FunSpec({
expression = mapOf("/" to listOf(emptyList<String>(), 2)),
result = JsonLogicResult.Success(0)
),
TestInput(expression = mapOf("/" to listOf("1", "0")), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf("1", 0)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf("1", "0")), result = JsonLogicResult.Failure.NullResult),
TestInput(expression = mapOf("/" to listOf("1", 0)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("/" to listOf("2.5", listOf("2", "3", 5))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("/" to listOf(2, null)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf(2, null)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("/" to listOf(null, null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("/" to listOf(null)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf("banana")), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf(null)), result = JsonLogicResult.Failure.NullResult),
TestInput(expression = mapOf("/" to listOf("banana")), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("/" to listOf(true, false)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("/" to listOf(true)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf(false)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf(true)), result = JsonLogicResult.Failure.NullResult),
TestInput(expression = mapOf("/" to listOf(false)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("/" to listOf(true, null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("/" to listOf(false, null)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(expression = mapOf("/" to listOf("a", 2)), result = JsonLogicResult.NullResultFailure),
TestInput(expression = mapOf("/" to listOf("a", 2)), result = JsonLogicResult.Failure.NullResult),
TestInput(
expression = mapOf("/" to listOf(listOf(2, "a"), 2)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("/" to listOf(listOf("a", 2), 2)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("/" to listOf(listOf(2, 2), 2)),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("/" to listOf(listOf(2, "a"), listOf("a", 2))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("/" to listOf(listOf("5", listOf("5")), listOf("5"), listOf("5"))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("/" to listOf(listOf(listOf("5"), listOf(6)))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
)
// given
Expand Down
4 changes: 2 additions & 2 deletions core/src/commonTest/kotlin/operations/numeric/MaxTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ class MaxTest : FunSpec({
),
TestInput(
expression = mapOf("max" to listOf(1, "banana")),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("max" to listOf(1, "banana", listOf(1, 2))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("max" to listOf(1, "2")),
Expand Down
4 changes: 2 additions & 2 deletions core/src/commonTest/kotlin/operations/numeric/MinTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ class MinTest : FunSpec({
),
TestInput(
expression = mapOf("min" to listOf(1, "banana")),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
TestInput(
expression = mapOf("min" to listOf(1, "banana", listOf(1, 2))),
result = JsonLogicResult.NullResultFailure
result = JsonLogicResult.Failure.NullResult
),
)
// given
Expand Down
Loading