Added if null variants

sksamuel · Dec 30, 2023 · 7207484 · 7207484
1 parent 179a31d
commit 7207484
Show file tree

Hide file tree

Showing 13 changed files with 99 additions and 8 deletions.
diff --git a/changelog.md b/changelog.md
@@ -1,6 +1,14 @@
 Changelog
 =========================
 
+
+### 2.0.0
+
+* Updated to Arrow 1.2.x - Note: Arrow has deprecated `Validated`. In this release, `Parser` has been updated to use `EitherNel`.
+* Moved some parsers to new packages.
+* Removed all previously deprecated functions.
+* Added variants of string parsers to work on nullable strings.
+
 ### 1.3.0
 
 * Released support (and min version) for Kotlin 1.8.x

diff --git a/...lin/com/sksamuel/tribune/core/booleans.kt → ...ksamuel/tribune/core/booleans/booleans.kt b/...lin/com/sksamuel/tribune/core/booleans.kt → ...ksamuel/tribune/core/booleans/booleans.kt
@@ -1,7 +1,9 @@
-package com.sksamuel.tribune.core
+package com.sksamuel.tribune.core.booleans
 
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.Parser
+import com.sksamuel.tribune.core.flatMap
 
 fun <I, E> Parser<I, String, E>.boolean(ifError: (String) -> E): Parser<I, Boolean, E> =
    flatMap {

diff --git a/...tlin/com/sksamuel/tribune/core/doubles.kt → .../sksamuel/tribune/core/doubles/doubles.kt b/...tlin/com/sksamuel/tribune/core/doubles.kt → .../sksamuel/tribune/core/doubles/doubles.kt
@@ -1,7 +1,11 @@
-package com.sksamuel.tribune.core
+package com.sksamuel.tribune.core.doubles
 
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.Parser
+import com.sksamuel.tribune.core.filter
+import com.sksamuel.tribune.core.flatMap
+import com.sksamuel.tribune.core.map
 
 /**
  * Extends a [Parser] of output type string to parse that string into a double.
@@ -40,3 +44,6 @@ fun <I, E> Parser<I, Double, E>.inrange(
    flatMap {
       if (it in range) it.right() else ifError(it).leftNel()
    }
+
+fun <I, E> Parser<I, Double, E>.nullIf(fn: (Double) -> Boolean): Parser<I, Double?, E> =
+   this.map { if (fn(it)) null else it }
diff --git a/...kotlin/com/sksamuel/tribune/core/enums.kt → .../com/sksamuel/tribune/core/enums/enums.kt b/...kotlin/com/sksamuel/tribune/core/enums.kt → .../com/sksamuel/tribune/core/enums/enums.kt
@@ -1,7 +1,9 @@
-package com.sksamuel.tribune.core
+package com.sksamuel.tribune.core.enums
 
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.Parser
+import com.sksamuel.tribune.core.flatMap
 
 inline fun <I, E, reified ENUM : Enum<ENUM>> Parser<I, String, E>.enum(crossinline ifError: (String) -> E): Parser<I, ENUM, E> {
    return flatMap { symbol ->

diff --git a/...otlin/com/sksamuel/tribune/core/floats.kt → ...om/sksamuel/tribune/core/floats/floats.kt b/...otlin/com/sksamuel/tribune/core/floats.kt → ...om/sksamuel/tribune/core/floats/floats.kt
@@ -1,7 +1,10 @@
-package com.sksamuel.tribune.core
+package com.sksamuel.tribune.core.floats
 
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.Parser
+import com.sksamuel.tribune.core.flatMap
+import com.sksamuel.tribune.core.map
 
 /**
  * Extends a [Parser] of output type string to parse that string into a double.
@@ -16,3 +19,10 @@ fun <I, E> Parser<I, String, E>.float(ifError: (String) -> E): Parser<I, Float,
       val f = it.toFloatOrNull()
       f?.right() ?: ifError(it).leftNel()
    }
+
+fun <I, E> Parser<I, Float, E>.nullIf(fn: (Float) -> Boolean): Parser<I, Float?, E> =
+   this.map { if (fn(it)) null else it }
+
+@JvmName("nullIfNullable")
+fun <I, E> Parser<I, Float?, E>.nullIf(fn: (Float) -> Boolean): Parser<I, Float?, E> =
+   this.map { if (it == null || fn(it)) null else it }
diff --git a/.../kotlin/com/sksamuel/tribune/core/ints.kt → ...in/com/sksamuel/tribune/core/ints/ints.kt b/.../kotlin/com/sksamuel/tribune/core/ints.kt → ...in/com/sksamuel/tribune/core/ints/ints.kt
@@ -1,9 +1,12 @@
-package com.sksamuel.tribune.core
+package com.sksamuel.tribune.core.ints
 
-import arrow.core.invalidNel
+import arrow.core.Either
 import arrow.core.leftNel
 import arrow.core.right
-import arrow.core.validNel
+import com.sksamuel.tribune.core.Parser
+import com.sksamuel.tribune.core.filter
+import com.sksamuel.tribune.core.flatMap
+import com.sksamuel.tribune.core.map
 
 /**
  * Chains a [Parser] to convert String -> Int.
@@ -42,10 +45,24 @@ fun <I, E> Parser<I, Int, E>.min(min: Int, ifError: (Int) -> E): Parser<I, Int,
       if (it >= min) it.right() else ifError(it).leftNel()
    }
 
+fun <I, E> Parser<I, Int?, E>.min(min: Int, ifError: (Int) -> E): Parser<I, Int?, E> =
+   flatMap {
+      if (it == null) Either.Right(null) else if (it >= min) it.right() else ifError(it).leftNel()
+   }
+
 fun <I, E> Parser<I, Int, E>.max(min: Int, ifError: (Int) -> E): Parser<I, Int, E> =
    flatMap {
       if (it >= min) it.right() else ifError(it).leftNel()
    }
 
+fun <I, E> Parser<I, Int?, E>.max(min: Int, ifError: (Int) -> E): Parser<I, Int?, E> =
+   flatMap {
+      if (it == null) Either.Right(null) else if (it >= min) it.right() else ifError(it).leftNel()
+   }
 
+fun <I, E> Parser<I, Int, E>.nullIf(fn: (Int) -> Boolean): Parser<I, Int?, E> =
+   this.map { if (fn(it)) null else it }
 
+@JvmName("nullIfNullable")
+fun <I, E> Parser<I, Long?, E>.nullIf(fn: (Long) -> Boolean): Parser<I, Long?, E> =
+   this.map { if (it == null || fn(it)) null else it }
diff --git a/...kotlin/com/sksamuel/tribune/core/longs.kt → .../com/sksamuel/tribune/core/longs/longs.kt b/...kotlin/com/sksamuel/tribune/core/longs.kt → .../com/sksamuel/tribune/core/longs/longs.kt
@@ -1,7 +1,11 @@
-package com.sksamuel.tribune.core
+package com.sksamuel.tribune.core.longs
 
+import arrow.core.Either
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.Parser
+import com.sksamuel.tribune.core.flatMap
+import com.sksamuel.tribune.core.map
 
 /**
  * Extends a [Parser] of output type string to parse that string into a long.
@@ -32,3 +36,21 @@ fun <I, E> Parser<I, Long, E>.max(min: Long, ifError: (Long) -> E): Parser<I, Lo
       if (it >= min) it.right() else ifError(it).leftNel()
    }
 
+@JvmName("minOrNull")
+fun <I, E> Parser<I, Long?, E>.min(min: Long, ifError: (Long) -> E): Parser<I, Long?, E> =
+   flatMap {
+      if (it == null) Either.Right(null) else if (it >= min) it.right() else ifError(it).leftNel()
+   }
+
+@JvmName("maxOrNull")
+fun <I, E> Parser<I, Long?, E>.max(min: Long, ifError: (Long) -> E): Parser<I, Long?, E> =
+   flatMap {
+      if (it == null) Either.Right(null) else if (it >= min) it.right() else ifError(it).leftNel()
+   }
+
+fun <I, E> Parser<I, Long, E>.nullIf(fn: (Long) -> Boolean): Parser<I, Long?, E> =
+   this.map { if (fn(it)) null else it }
+
+@JvmName("nullIfNullable")
+fun <I, E> Parser<I, Long?, E>.nullIf(fn: (Long) -> Boolean): Parser<I, Long?, E> =
+   this.map { if (it == null || fn(it)) null else it }
diff --git a/.../kotlin/com/sksamuel/tribune/core/fmap.kt → ...n/kotlin/com/sksamuel/tribune/core/map.kt b/.../kotlin/com/sksamuel/tribune/core/fmap.kt → ...n/kotlin/com/sksamuel/tribune/core/map.kt
diff --git a/tribune-core/src/main/kotlin/com/sksamuel/tribune/core/strings/strings.kt b/tribune-core/src/main/kotlin/com/sksamuel/tribune/core/strings/strings.kt
@@ -77,3 +77,10 @@ fun <I, E> Parser<I, String?, E>.nullOrNotBlank(ifBlank: () -> E): Parser<I, Str
       if (it == null) null.right() else if (it.isBlank()) ifBlank().leftNel() else it.right()
    }
 }
+
+fun <I, E> Parser<I, String, E>.nullIf(fn: (String) -> Boolean): Parser<I, String?, E> =
+   this.map { if (fn(it)) null else it }
+
+@JvmName("nullIfNullable")
+fun <I, E> Parser<I, String?, E>.nullIf(fn: (String) -> Boolean): Parser<I, String?, E> =
+   this.map { if (it == null || fn(it)) null else it }
diff --git a/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/DoubleTest.kt b/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/DoubleTest.kt
@@ -2,6 +2,11 @@ package com.sksamuel.tribune.core
 
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.doubles.double
+import com.sksamuel.tribune.core.doubles.inrange
+import com.sksamuel.tribune.core.doubles.negative
+import com.sksamuel.tribune.core.doubles.nonNegative
+import com.sksamuel.tribune.core.doubles.positive
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 

diff --git a/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/ParserTest.kt b/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/ParserTest.kt
@@ -3,6 +3,10 @@ package com.sksamuel.tribune.core
 import arrow.core.EitherNel
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.booleans.boolean
+import com.sksamuel.tribune.core.floats.float
+import com.sksamuel.tribune.core.ints.int
+import com.sksamuel.tribune.core.longs.long
 import com.sksamuel.tribune.core.strings.minlen
 import com.sksamuel.tribune.core.strings.notBlank
 import com.sksamuel.tribune.core.strings.notNullOrBlank

diff --git a/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/enums.kt b/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/enums.kt
@@ -2,6 +2,7 @@ package com.sksamuel.tribune.core
 
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.enums.enum
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 

diff --git a/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/ints.kt b/tribune-core/src/test/kotlin/com/sksamuel/tribune/core/ints.kt
@@ -2,6 +2,12 @@ package com.sksamuel.tribune.core
 
 import arrow.core.leftNel
 import arrow.core.right
+import com.sksamuel.tribune.core.ints.inrange
+import com.sksamuel.tribune.core.ints.int
+import com.sksamuel.tribune.core.ints.negative
+import com.sksamuel.tribune.core.ints.nonNegative
+import com.sksamuel.tribune.core.ints.positive
+import com.sksamuel.tribune.core.longs.long
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe