✨ Add Zero.Companion.orThrow(Float) method (#719)

kotools · Jan 9, 2025 · 2c5dc6b · 2c5dc6b
1 parent d9fd679
commit 2c5dc6b
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 0 deletions.
diff --git a/subprojects/library/src/api/types.api b/subprojects/library/src/api/types.api
@@ -440,6 +440,7 @@ public final class org/kotools/types/Zero {
 	public final fun equals (Ljava/lang/Object;)Z
 	public final fun hashCode ()I
 	public static final fun orThrow (B)Lorg/kotools/types/Zero;
+	public static final fun orThrow (F)Lorg/kotools/types/Zero;
 	public static final fun orThrow (I)Lorg/kotools/types/Zero;
 	public static final fun orThrow (J)Lorg/kotools/types/Zero;
 	public static final fun orThrow (S)Lorg/kotools/types/Zero;
@@ -459,6 +460,7 @@ public final class org/kotools/types/Zero$Companion {
 	public final synthetic fun orNull (J)Lorg/kotools/types/Zero;
 	public final synthetic fun orNull (S)Lorg/kotools/types/Zero;
 	public final fun orThrow (B)Lorg/kotools/types/Zero;
+	public final fun orThrow (F)Lorg/kotools/types/Zero;
 	public final fun orThrow (I)Lorg/kotools/types/Zero;
 	public final fun orThrow (J)Lorg/kotools/types/Zero;
 	public final fun orThrow (S)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
@@ -794,5 +794,42 @@ public class Zero {
             require(number == 0L) { InvalidZero(number) }
             return Zero()
         }
+
+        /**
+         * Creates an instance of [Zero] from the specified [number], or throws
+         * an [IllegalArgumentException] if the [number] is other than zero.
+         *
+         * <br>
+         * <details>
+         * <summary>
+         *     <b>Calling from Kotlin</b>
+         * </summary>
+         *
+         * Here's an example of calling this method from Kotlin code:
+         *
+         * SAMPLE: [org.kotools.types.ZeroCompanionCommonSample.orThrowWithFloat]
+         * </details>
+         *
+         * <br>
+         * <details>
+         * <summary>
+         *     <b>Calling from Java</b>
+         * </summary>
+         *
+         * Here's an example of calling this method from Java code:
+         *
+         * SAMPLE: [org.kotools.types.ZeroCompanionJavaSample.orThrowWithFloat]
+         * </details>
+         * <br>
+         *
+         * See the [orNull] method for returning `null` instead of throwing an
+         * exception in case of invalid [number].
+         */
+        @ExperimentalSince(KotoolsTypesVersion.V5_0_0)
+        @JvmStatic
+        public fun orThrow(number: Float): Zero {
+            require(number == 0f) { InvalidZero(number) }
+            return Zero()
+        }
     }
 }
diff --git a/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionCommonSample.kt b/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionCommonSample.kt
@@ -77,4 +77,15 @@ class ZeroCompanionCommonSample {
         }
         assertTrue(isSuccess)
     }
+
+    @Test
+    fun orThrowWithFloat() {
+        val isSuccess: Boolean = try {
+            Zero.orThrow(0f)
+            true
+        } catch (exception: IllegalArgumentException) {
+            false
+        }
+        assertTrue(isSuccess)
+    }
 }
diff --git a/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionTest.kt b/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionTest.kt
@@ -1,6 +1,7 @@
 package org.kotools.types
 
 import org.kotools.types.internal.InvalidZero
+import kotlin.random.Random
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
@@ -83,8 +84,28 @@ class ZeroCompanionTest {
         assertFailsWith<IllegalArgumentException> { Zero.orThrow(number) }
             .assertIsInvalidZero(number)
     }
+
+    @Test
+    fun orThrowShouldFailWithFloatOtherThanZero() {
+        val number: Float = Float.randomNonZero()
+        assertFailsWith<IllegalArgumentException> { Zero.orThrow(number) }
+            .assertIsInvalidZero(number)
+    }
 }
 
+// ----------------------------- Number extensions -----------------------------
+
+private fun Float.Companion.randomNonZero(): Float {
+    val negativeRange: IntRange = Byte.MIN_VALUE..-1
+    val positiveRange: IntRange = 1..Byte.MAX_VALUE
+    val integer: Int = negativeRange.plus(positiveRange)
+        .random()
+    val decimal: Float = Random.nextFloat()
+    return integer + decimal
+}
+
+// -------------------------------- Assertions ---------------------------------
+
 private fun IllegalArgumentException.assertIsInvalidZero(number: Number) {
     val actual: String? = this.message
     val expected: String = InvalidZero(number)

diff --git a/subprojects/library/src/jvmTest/java/org/kotools/types/ZeroCompanionJavaSample.java b/subprojects/library/src/jvmTest/java/org/kotools/types/ZeroCompanionJavaSample.java
@@ -56,4 +56,17 @@ void orThrowWithLong() {
         }
         Assertions.assertTrue(isSuccess);
     }
+
+    @Test
+    void orThrowWithFloat() {
+        final float number = 0;
+        boolean isSuccess;
+        try {
+            Zero.orThrow(number);
+            isSuccess = true;
+        } catch (final IllegalArgumentException exception) {
+            isSuccess = false;
+        }
+        Assertions.assertTrue(isSuccess);
+    }
 }