add String.replaceOrFail

Author: RBusarow

modulecheck-internal-testing/src/main/kotlin/modulecheck/testing/FancyShould.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2021-2022 Rick Busarow
+ * Copyright (C) 2021-2023 Rick Busarow
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -49,10 +49,15 @@ fun <T, U : T> T.trimmedShouldBe(expected: U?, vararg excludeFromStack: KClass<*
   }
 }
 
-fun <T> T.trimmedAssert(
+fun <R> trimmedAssert(
   vararg excludeFromStack: KClass<*>,
-  assertion: suspend T.() -> Unit
-) {
+  assertion: suspend () -> R
+): R = Unit.trimmedAssert(*excludeFromStack) { assertion() }
+
+fun <T, R> T.trimmedAssert(
+  vararg excludeFromStack: KClass<*>,
+  assertion: suspend T.() -> R
+): R {
 
   /*
   Any AssertionError generated by this function will have this function at the top of its stacktrace.
@@ -61,7 +66,7 @@ fun <T> T.trimmedAssert(
 
   So, we can catch the assertion error, remove this function from the stacktrace, and rethrow.
    */
-  try {
+  return try {
     runBlocking { assertion() }
   } catch (assertionError: AssertionError) {
 

modulecheck-internal-testing/src/main/kotlin/modulecheck/testing/asserts.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2021-2022 Rick Busarow
+ * Copyright (C) 2021-2023 Rick Busarow
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -15,13 +15,66 @@
 
 package modulecheck.testing
 
+import io.kotest.assertions.asClue
+import io.kotest.matchers.shouldNotBe
 import org.junit.jupiter.api.fail
 
 fun <T : Any> T?.requireNotNullOrFail(
   lazyMessage: () -> String = { "The receiver cannot be null, but it was. ¯\\_(ツ)_/¯" }
 ): T {
-
   if (this != null) return this
 
   fail(lazyMessage)
 }
+
+/**
+ * Asserts that the receiver string is changed after calling [String.replace]
+ *
+ * @since 0.12.4
+ */
+fun String.replaceOrFail(oldValue: String, replacement: String): String {
+  return assertChanged(
+    oldString = this@replaceOrFail,
+    newString = replace(oldValue, replacement),
+    token = oldValue,
+    replacement = replacement
+  )
+}
+
+/**
+ * Asserts that the receiver string is changed after calling [String.replace]
+ *
+ * @since 0.12.4
+ */
+fun String.replaceOrFail(regex: Regex, replacement: String): String {
+  return assertChanged(
+    oldString = this@replaceOrFail,
+    newString = replace(regex, replacement),
+    token = regex,
+    replacement = replacement
+  )
+}
+
+private fun assertChanged(
+  oldString: String,
+  newString: String,
+  token: Any,
+  replacement: String
+) = newString.also { new ->
+  trimmedAssert {
+
+    val tokenName = (if (token is Regex) "regex" else "oldValue").padStart(9)
+
+    """
+      |String replacement did not change the original string.
+      |
+      |     $tokenName: $token
+      |    replacement: $replacement
+      |
+      |original string (starting on the new line):
+      |$oldString
+      |____________________________________________________
+      |""".replaceIndentByMargin()
+      .asClue { new shouldNotBe oldString }
+  }
+}