Add String.Blank & fix removeDuplicateEmptyLines()/endWithNewLine()

JavierSegoviaCordoba · JavierSegoviaCordoba · commit 621f0ad69ee2 · 2025-01-10T13:06:42.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,12 +4,17 @@
 
 ### Added
 
+- `String.Blank`
+
 ### Changed
 
 ### Deprecated
 
 ### Fixed
 
+- `removeDuplicateEmptyLines` move back to use `String`
+- `endWithNewLine` move back to use `String`
+
 ### Removed
 
 ### Updated
diff --git a/kotlin-stdlib/api/android/kotlin-stdlib.api b/kotlin-stdlib/api/android/kotlin-stdlib.api
@@ -144,13 +144,11 @@ public final class com/javiersc/kotlin/stdlib/BooleanKt {
 }
 
 public final class com/javiersc/kotlin/stdlib/CharSequenceKt {
-	public static final fun endWithNewLine (Ljava/lang/CharSequence;)Ljava/lang/CharSequence;
 	public static final fun isNotNullNorBlank (Ljava/lang/CharSequence;)Z
 	public static final fun isNotNullNorEmpty (Ljava/lang/CharSequence;)Z
 	public static final fun notContain (Ljava/lang/CharSequence;Ljava/lang/CharSequence;Z)Z
 	public static final fun notContain (Ljava/lang/CharSequence;Lkotlin/text/Regex;)Z
 	public static synthetic fun notContain$default (Ljava/lang/CharSequence;Ljava/lang/CharSequence;ZILjava/lang/Object;)Z
-	public static final fun removeDuplicateEmptyLines (Ljava/lang/CharSequence;)Ljava/lang/CharSequence;
 }
 
 public abstract class com/javiersc/kotlin/stdlib/Either {
@@ -249,11 +247,14 @@ public final class com/javiersc/kotlin/stdlib/ListKt {
 public final class com/javiersc/kotlin/stdlib/StringsKt {
 	public static final fun capitalize (Ljava/lang/String;)Ljava/lang/String;
 	public static final fun decapitalize (Ljava/lang/String;)Ljava/lang/String;
+	public static final fun endWithNewLine (Ljava/lang/String;)Ljava/lang/String;
+	public static final fun getBlank (Lkotlin/jvm/internal/StringCompanionObject;)Ljava/lang/String;
 	public static final fun getEmpty (Lkotlin/jvm/internal/StringCompanionObject;)Ljava/lang/String;
 	public static final fun remove (Ljava/lang/String;Ljava/lang/String;Z)Ljava/lang/String;
 	public static final fun remove (Ljava/lang/String;[Ljava/lang/String;Z)Ljava/lang/String;
 	public static synthetic fun remove$default (Ljava/lang/String;Ljava/lang/String;ZILjava/lang/Object;)Ljava/lang/String;
 	public static synthetic fun remove$default (Ljava/lang/String;[Ljava/lang/String;ZILjava/lang/Object;)Ljava/lang/String;
+	public static final fun removeDuplicateEmptyLines (Ljava/lang/String;)Ljava/lang/String;
 	public static final fun removeIf (Ljava/lang/String;Ljava/lang/String;ZLkotlin/jvm/functions/Function1;)Ljava/lang/String;
 	public static synthetic fun removeIf$default (Ljava/lang/String;Ljava/lang/String;ZLkotlin/jvm/functions/Function1;ILjava/lang/Object;)Ljava/lang/String;
 	public static final fun replace (Ljava/lang/String;[Lkotlin/Pair;)Ljava/lang/String;
diff --git a/kotlin-stdlib/api/jvm/kotlin-stdlib.api b/kotlin-stdlib/api/jvm/kotlin-stdlib.api
@@ -144,13 +144,11 @@ public final class com/javiersc/kotlin/stdlib/BooleanKt {
 }
 
 public final class com/javiersc/kotlin/stdlib/CharSequenceKt {
-	public static final fun endWithNewLine (Ljava/lang/CharSequence;)Ljava/lang/CharSequence;
 	public static final fun isNotNullNorBlank (Ljava/lang/CharSequence;)Z
 	public static final fun isNotNullNorEmpty (Ljava/lang/CharSequence;)Z
 	public static final fun notContain (Ljava/lang/CharSequence;Ljava/lang/CharSequence;Z)Z
 	public static final fun notContain (Ljava/lang/CharSequence;Lkotlin/text/Regex;)Z
 	public static synthetic fun notContain$default (Ljava/lang/CharSequence;Ljava/lang/CharSequence;ZILjava/lang/Object;)Z
-	public static final fun removeDuplicateEmptyLines (Ljava/lang/CharSequence;)Ljava/lang/CharSequence;
 }
 
 public class com/javiersc/kotlin/stdlib/DirScope : com/javiersc/kotlin/stdlib/FileScope {
@@ -272,11 +270,14 @@ public final class com/javiersc/kotlin/stdlib/ListKt {
 public final class com/javiersc/kotlin/stdlib/StringsKt {
 	public static final fun capitalize (Ljava/lang/String;)Ljava/lang/String;
 	public static final fun decapitalize (Ljava/lang/String;)Ljava/lang/String;
+	public static final fun endWithNewLine (Ljava/lang/String;)Ljava/lang/String;
+	public static final fun getBlank (Lkotlin/jvm/internal/StringCompanionObject;)Ljava/lang/String;
 	public static final fun getEmpty (Lkotlin/jvm/internal/StringCompanionObject;)Ljava/lang/String;
 	public static final fun remove (Ljava/lang/String;Ljava/lang/String;Z)Ljava/lang/String;
 	public static final fun remove (Ljava/lang/String;[Ljava/lang/String;Z)Ljava/lang/String;
 	public static synthetic fun remove$default (Ljava/lang/String;Ljava/lang/String;ZILjava/lang/Object;)Ljava/lang/String;
 	public static synthetic fun remove$default (Ljava/lang/String;[Ljava/lang/String;ZILjava/lang/Object;)Ljava/lang/String;
+	public static final fun removeDuplicateEmptyLines (Ljava/lang/String;)Ljava/lang/String;
 	public static final fun removeIf (Ljava/lang/String;Ljava/lang/String;ZLkotlin/jvm/functions/Function1;)Ljava/lang/String;
 	public static synthetic fun removeIf$default (Ljava/lang/String;Ljava/lang/String;ZLkotlin/jvm/functions/Function1;ILjava/lang/Object;)Ljava/lang/String;
 	public static final fun replace (Ljava/lang/String;[Lkotlin/Pair;)Ljava/lang/String;
diff --git a/kotlin-stdlib/common/main/kotlin/com/javiersc/kotlin/stdlib/CharSequence.kt b/kotlin-stdlib/common/main/kotlin/com/javiersc/kotlin/stdlib/CharSequence.kt
@@ -20,11 +20,3 @@ public inline fun CharSequence.notContain(
 ): Boolean = !contains(other, ignoreCase)
 
 public inline fun CharSequence.notContain(regex: Regex): Boolean = !contains(regex)
-
-/** Remove all consecutive line breaks in a `CharSequence` */
-public fun CharSequence.removeDuplicateEmptyLines(): CharSequence =
-    lines().removeDuplicateEmptyLines()
-
-/** Add an empty line as last item if it is not empty */
-public fun CharSequence.endWithNewLine(): CharSequence =
-    if (lines().lastOrNull().isNullOrBlank()) this else "$this\n"
diff --git a/kotlin-stdlib/common/main/kotlin/com/javiersc/kotlin/stdlib/Strings.kt b/kotlin-stdlib/common/main/kotlin/com/javiersc/kotlin/stdlib/Strings.kt
@@ -33,6 +33,9 @@ public fun String.removeIf(
 public inline val String.Companion.Empty: String
     get() = ""
 
+public inline val String.Companion.Blank: String
+    get() = "   "
+
 /**
  * Returns a copy of this string having its first letter title-cased using the rules of the default
  * locale, or the original string if it's empty or already starts with a title case letter.
@@ -50,3 +53,10 @@ public inline fun String.capitalize(): String = replaceFirstChar {
  * locale, or the original string if it's empty or already starts with a lower case letter.
  */
 public inline fun String.decapitalize(): String = replaceFirstChar { it.lowercase() }
+
+/** Remove all consecutive line breaks in a `CharSequence` */
+public fun String.removeDuplicateEmptyLines(): String = lines().removeDuplicateEmptyLines()
+
+/** Add an empty line as last item if it is not empty */
+public fun String.endWithNewLine(): String =
+    if (lines().lastOrNull().isNullOrBlank()) this else "$this\n"
diff --git a/kotlin-stdlib/common/test/kotlin/com/javiersc/kotlin/stdlib/CharSequenceTest.kt b/kotlin-stdlib/common/test/kotlin/com/javiersc/kotlin/stdlib/CharSequenceTest.kt
@@ -69,30 +69,4 @@ internal class CharSequenceTest {
         assertFalse { "Hello World 1".notContain(regex) }
         assertTrue { "Hello World".notContain(regex) }
     }
-
-    @Test
-    fun string_remove_duplicate_empty_lines() {
-        assertTrue { "a\nb\n\n\nc\n".removeDuplicateEmptyLines() == "a\nb\n\nc\n" }
-        assertTrue { "a\n\nb\n\n\nc\n".removeDuplicateEmptyLines() == "a\n\nb\n\nc\n" }
-        assertTrue { "a\n\nb\n\n\nc\n\n".removeDuplicateEmptyLines() == "a\n\nb\n\nc\n" }
-        assertTrue { "a\n\n\n\n\nb\n\n".removeDuplicateEmptyLines() == "a\n\nb\n" }
-    }
-
-    @Test
-    fun string_end_with_new_line() {
-        assertTrue { "a".endWithNewLine() == "a\n" }
-        assertTrue { "a\n".endWithNewLine() == "a\n" }
-        assertTrue { "".endWithNewLine() == "" }
-        assertTrue { "a\nb".endWithNewLine() == "a\nb\n" }
-        assertTrue { "".endWithNewLine() == "" }
-        assertTrue { "\n".endWithNewLine() == "\n" }
-
-        val helloWorld =
-            """
-                |Hello World
-                |
-            """
-
-        assertTrue { helloWorld.trimMargin().endWithNewLine() == helloWorld.trimMargin() }
-    }
 }
diff --git a/kotlin-stdlib/common/test/kotlin/com/javiersc/kotlin/stdlib/StringsTest.kt b/kotlin-stdlib/common/test/kotlin/com/javiersc/kotlin/stdlib/StringsTest.kt
@@ -42,6 +42,38 @@ internal class StringsTest {
 
     @Test
     fun empty_string() {
-        assertTrue { String.Empty == "" }
+        assertTrue { String.Empty.isEmpty() }
+    }
+
+    @Test
+    fun blank_string() {
+        assertTrue { String.Empty.isBlank() }
+        assertTrue { String.Blank.isBlank() && !String.Blank.isEmpty() }
+    }
+
+    @Test
+    fun string_remove_duplicate_empty_lines() {
+        assertTrue { "a\nb\n\n\nc\n".removeDuplicateEmptyLines() == "a\nb\n\nc\n" }
+        assertTrue { "a\n\nb\n\n\nc\n".removeDuplicateEmptyLines() == "a\n\nb\n\nc\n" }
+        assertTrue { "a\n\nb\n\n\nc\n\n".removeDuplicateEmptyLines() == "a\n\nb\n\nc\n" }
+        assertTrue { "a\n\n\n\n\nb\n\n".removeDuplicateEmptyLines() == "a\n\nb\n" }
+    }
+
+    @Test
+    fun string_end_with_new_line() {
+        assertTrue { "a".endWithNewLine() == "a\n" }
+        assertTrue { "a\n".endWithNewLine() == "a\n" }
+        assertTrue { "".endWithNewLine() == "" }
+        assertTrue { "a\nb".endWithNewLine() == "a\nb\n" }
+        assertTrue { "".endWithNewLine() == "" }
+        assertTrue { "\n".endWithNewLine() == "\n" }
+
+        val helloWorld =
+            """
+                |Hello World
+                |
+            """
+
+        assertTrue { helloWorld.trimMargin().endWithNewLine() == helloWorld.trimMargin() }
     }
 }
