🔥 Remove Zero.Companion.orNull(Any) function (#676)

kotools · Jul 15, 2024 · 01fab1f · 01fab1f
1 parent 0878450
commit 01fab1f
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 86 deletions.
diff --git a/...ommonMain/kotlin/org/kotools/types/kotlinx/serialization/internal/ZeroAsByteSerializer.kt b/...ommonMain/kotlin/org/kotools/types/kotlinx/serialization/internal/ZeroAsByteSerializer.kt
@@ -26,9 +26,11 @@ internal object ZeroAsByteSerializer : KSerializer<Zero> {
 
     override fun deserialize(decoder: Decoder): Zero {
         val decodedValue: Byte = decoder.decodeByte()
-        val zero: Zero? = Zero.orNull(decodedValue)
-        if (zero != null) return zero
-        val error = InvalidZero(decodedValue)
-        throw SerializationException("$error")
+        return try {
+            Zero(decodedValue)
+        } catch (exception: IllegalArgumentException) {
+            val error = InvalidZero(decodedValue)
+            throw SerializationException("$error")
+        }
     }
 }
diff --git a/subprojects/library/src/api/types.api b/subprojects/library/src/api/types.api
@@ -466,7 +466,6 @@ public final class org/kotools/types/Zero {
 	public final fun compareTo (S)I
 	public final fun equals (Ljava/lang/Object;)Z
 	public final fun hashCode ()I
-	public static final fun orNull (Ljava/lang/Object;)Lorg/kotools/types/Zero;
 	public final fun toByte ()B
 	public final fun toChar ()C
 	public final fun toDouble ()D
@@ -478,6 +477,5 @@ public final class org/kotools/types/Zero {
 }
 
 public final class org/kotools/types/Zero$Companion {
-	public final fun orNull (Ljava/lang/Object;)Lorg/kotools/types/Zero;
 }
 
diff --git a/subprojects/library/src/commonMain/kotlin/org/kotools/types/Zero.kt b/subprojects/library/src/commonMain/kotlin/org/kotools/types/Zero.kt
@@ -5,7 +5,6 @@ import kotools.types.internal.hashCodeOf
 import org.kotools.types.internal.ExperimentalSince
 import org.kotools.types.internal.KotoolsTypesVersion
 import org.kotools.types.internal.Warning
-import kotlin.jvm.JvmStatic
 
 /** Represents the [zero](https://en.wikipedia.org/wiki/0) number. */
 @ExperimentalKotoolsTypesApi
@@ -603,39 +602,5 @@ public class Zero {
          */
         @ExperimentalSince(KotoolsTypesVersion.Unreleased)
         public const val PATTERN: String = "^[+-]?0+(?:\\.0+)?\$"
-
-        /**
-         * Creates an instance of [Zero] from the string representation of the
-         * specified [number], or returns `null` if the string representation of
-         * [number] doesn't match the [corresponding pattern][Zero.PATTERN].
-         *
-         * <br>
-         * <details open>
-         * <summary>
-         *     <b>Calling from Kotlin</b>
-         * </summary>
-         *
-         * Here's an example of calling this function from Kotlin code:
-         *
-         * SAMPLE: [org.kotools.types.ZeroCompanionCommonSample.orNull]
-         * </details>
-         *
-         * <br>
-         * <details>
-         * <summary>
-         *     <b>Calling from Java</b>
-         * </summary>
-         *
-         * Here's an example of calling this function from Java code:
-         *
-         * SAMPLE: [org.kotools.types.ZeroCompanionJavaSample.orNull]
-         * </details>
-         */
-        @ExperimentalSince(KotoolsTypesVersion.Unreleased)
-        @JvmStatic
-        public fun orNull(number: Any): Zero? {
-            val regex = Regex(this.PATTERN)
-            return if ("$number" matches regex) Zero() else null
-        }
     }
 }
diff --git a/subprojects/library/src/commonSample/kotlin/org/kotools/types/ZeroCompanionCommonSample.kt b/subprojects/library/src/commonSample/kotlin/org/kotools/types/ZeroCompanionCommonSample.kt
@@ -2,7 +2,6 @@ package org.kotools.types
 
 import kotools.types.experimental.ExperimentalKotoolsTypesApi
 import kotlin.test.Test
-import kotlin.test.assertNotNull
 import kotlin.test.assertTrue
 
 @OptIn(ExperimentalKotoolsTypesApi::class)
@@ -18,11 +17,4 @@ class ZeroCompanionCommonSample {
         val numbersAreValid: Boolean = numbers.all { "$it" matches regex }
         assertTrue(numbersAreValid)
     }
-
-    @Test
-    fun orNull() {
-        val number: Any = "-000.000"
-        val actual: Zero? = Zero.orNull(number)
-        assertNotNull(actual)
-    }
 }
diff --git a/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroTest.kt b/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroTest.kt
@@ -6,8 +6,6 @@ import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertFalse
-import kotlin.test.assertNotNull
-import kotlin.test.assertNull
 import kotlin.test.assertTrue
 
 @OptIn(ExperimentalKotoolsTypesApi::class)
@@ -303,38 +301,10 @@ class ZeroTest {
 
 @OptIn(ExperimentalKotoolsTypesApi::class)
 class ZeroCompanionTest {
-    private val validNumbers: List<Any>
-        get() = listOf(
-            0, 0.0,
-            "+0", "+000", "+0.000", "+000.000", // with unary plus
-            "-0", "-000", "-0.000", "-000.000" // with unary minus
-        )
-
-    private val invalidNumbers: List<Any>
-        get() = listOf<Any>(
-            ".0", "+.0", "-.0", // integer part missing
-            "0,0", "+0,0", "-0,0", // comma as decimal point
-            "0.", "+0.", "-0.", // decimal part missing
-            "hello world", "123456789" // not zero number
-        )
-
     @Test
     fun patternShouldPass() {
         val actual: String = Zero.PATTERN
         val expected = """^[+-]?0+(?:\.0+)?$"""
         assertEquals(expected, actual)
     }
-
-    @Test
-    fun orNullShouldPassWithValidNumber(): Unit = this.validNumbers.forEach {
-        val actual: Zero? = Zero.orNull(it)
-        assertNotNull(actual)
-    }
-
-    @Test
-    fun orNullShouldFailWithInvalidNumber(): Unit =
-        this.invalidNumbers.forEach {
-            val actual: Zero? = Zero.orNull(it)
-            assertNull(actual)
-        }
 }
diff --git a/subprojects/library/src/jvmSample/java/org/kotools/types/ZeroCompanionJavaSample.java b/subprojects/library/src/jvmSample/java/org/kotools/types/ZeroCompanionJavaSample.java
@@ -19,11 +19,4 @@ void pattern() {
                 .allMatch(number -> number.toString().matches(regex));
         Assertions.assertTrue(numbersAreValid);
     }
-
-    @Test
-    void orNull() {
-        final Object number = "-000.000";
-        final Zero actual = Zero.orNull(number);
-        Assertions.assertNotNull(actual);
-    }
 }