Move Utils to package 'extensions', add tests for it

rhaendel · rhaendel · commit 4adee7ef2b47 · 2025-06-08T14:49:29.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 .idea
 .kotlin/
 build
-src/**/*.txt
+src/input/**/*.txt
+!src/input/2024/ForTests.txt
 local.properties
 /.kotlintest/
diff --git a/src/input/2024/ForTests.txt b/src/input/2024/ForTests.txt
@@ -0,0 +1,5 @@
+line one
+line two
+line three
+
+line five
diff --git a/src/main/kotlin/de/ronny_h/aoc/extensions/Utils.kt b/src/main/kotlin/de/ronny_h/aoc/extensions/Utils.kt
@@ -1,3 +1,5 @@
+package de.ronny_h.aoc.extensions
+
 import java.math.BigInteger
 import java.security.MessageDigest
 import kotlin.io.path.Path
@@ -9,7 +11,7 @@ import kotlin.time.measureTimedValue
 /**
  * Reads lines from the given input txt file.
  */
-fun readInput(name: String) = Path("src/main/kotlin/$name.txt").readText().trim().lines()
+fun readInput(name: String) = Path("src/input/2024/$name.txt").readText().trim().lines()
 
 /**
  * Converts string to md5 hash.
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day01/HistorianHysteria.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day01/HistorianHysteria.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day01
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.math.abs
 
 fun main() {
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day02/RedNosedReports.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day02/RedNosedReports.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day02
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.math.abs
 
 fun main() {
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day03/MullItOver.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day03/MullItOver.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day03
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.text.get
 
 fun main() {
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day04/CeresSearch.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day04/CeresSearch.kt
@@ -1,8 +1,8 @@
 package de.ronny_h.aoc.year24.day04
 
 import de.ronny_h.aoc.extensions.Grid
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day04"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day05/PrintQueue.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day05/PrintQueue.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day05
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.collections.get
 
 fun main() {
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day06/GuardGallivant.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day06/GuardGallivant.kt
@@ -6,8 +6,8 @@ import de.ronny_h.aoc.extensions.Direction.NORTH
 import de.ronny_h.aoc.extensions.Grid
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.produce
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import java.lang.Runtime.getRuntime
 import java.util.concurrent.atomic.AtomicInteger
 
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day07/BridgeRepair.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day07/BridgeRepair.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day07
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.math.pow
 
 fun main() {
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day08/ResonantCollinearity.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day08/ResonantCollinearity.kt
@@ -3,8 +3,8 @@ package de.ronny_h.aoc.year24.day08
 import de.ronny_h.aoc.extensions.Coordinates
 import de.ronny_h.aoc.extensions.Grid
 import de.ronny_h.aoc.extensions.combinations
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day08"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day09/DiskFragmenter.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day09/DiskFragmenter.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day09
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day09"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day10/HoofIt.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day10/HoofIt.kt
@@ -3,8 +3,8 @@ package de.ronny_h.aoc.year24.day10
 import de.ronny_h.aoc.extensions.Coordinates
 import de.ronny_h.aoc.extensions.Direction
 import de.ronny_h.aoc.extensions.Grid
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day10"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day11/PlutonianPebbles.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day11/PlutonianPebbles.kt
@@ -1,8 +1,8 @@
 package de.ronny_h.aoc.year24.day11
 
 import de.ronny_h.aoc.extensions.memoize
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.text.toLong
 
 fun main() {
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day12/GardenGroups.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day12/GardenGroups.kt
@@ -4,8 +4,8 @@ import de.ronny_h.aoc.extensions.Coordinates
 import de.ronny_h.aoc.extensions.Direction
 import de.ronny_h.aoc.extensions.Direction.*
 import de.ronny_h.aoc.extensions.Grid
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 const val verbose = false
 
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day13/ClawContraption.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day13/ClawContraption.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day13
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.math.floor
 
 fun main() {
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day14/RestroomRedoubt.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day14/RestroomRedoubt.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day14
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day14"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day15/WarehouseWoes.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day15/WarehouseWoes.kt
@@ -3,8 +3,8 @@ package de.ronny_h.aoc.year24.day15
 import de.ronny_h.aoc.extensions.Coordinates
 import de.ronny_h.aoc.extensions.Direction
 import de.ronny_h.aoc.extensions.Grid
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day15"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day16/ReindeerMaze.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day16/ReindeerMaze.kt
@@ -5,8 +5,8 @@ import de.ronny_h.aoc.extensions.Direction
 import de.ronny_h.aoc.extensions.Grid
 import de.ronny_h.aoc.extensions.ShortestPath
 import de.ronny_h.aoc.extensions.aStarAllPaths
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day16"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day17/ChronospatialComputer.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day17/ChronospatialComputer.kt
@@ -1,7 +1,7 @@
 package de.ronny_h.aoc.year24.day17
 
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 import kotlin.math.pow
 import kotlin.properties.Delegates
 
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day18/RAMRun.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day18/RAMRun.kt
@@ -5,8 +5,8 @@ import de.ronny_h.aoc.extensions.Direction
 import de.ronny_h.aoc.extensions.Grid
 import de.ronny_h.aoc.extensions.ShortestPath
 import de.ronny_h.aoc.extensions.aStar
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day18"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day19/LinenLayout.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day19/LinenLayout.kt
@@ -1,8 +1,8 @@
 package de.ronny_h.aoc.year24.day19
 
 import de.ronny_h.aoc.extensions.PrefixTree
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day19"
diff --git a/src/main/kotlin/de/ronny_h/aoc/year24/day20/RaceCondition.kt b/src/main/kotlin/de/ronny_h/aoc/year24/day20/RaceCondition.kt
@@ -5,8 +5,8 @@ import de.ronny_h.aoc.extensions.Direction
 import de.ronny_h.aoc.extensions.Grid
 import de.ronny_h.aoc.extensions.ShortestPath
 import de.ronny_h.aoc.extensions.aStar
-import printAndCheck
-import readInput
+import de.ronny_h.aoc.extensions.printAndCheck
+import de.ronny_h.aoc.extensions.readInput
 
 fun main() {
     val day = "Day20"
diff --git a/src/test/kotlin/de/ronny_h/aoc/extensions/UtilsTest.kt b/src/test/kotlin/de/ronny_h/aoc/extensions/UtilsTest.kt
@@ -0,0 +1,39 @@
+package de.ronny_h.aoc.extensions
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.shouldBe
+
+class UtilsTest : StringSpec({
+
+    "readInput() reads a file into a list of String - one line each" {
+        val input = readInput("ForTests")
+        input[0] shouldBe "line one"
+        input[1] shouldBe "line two"
+        input[2] shouldBe "line three"
+        input[3] shouldBe ""
+        input[4] shouldBe "line five"
+    }
+
+    "md5() converts a String to an MD5 hash" {
+        "This is just a test".md5() shouldBe "df0a9498a65ca6e20dc58022267f339a"
+    }
+
+    "printAndCheck calls the block with the input list as parameter and succeeds on String expectation met" {
+        val input = listOf("input")
+        var parameter: List<String> = emptyList()
+        printAndCheck(input, { it: List<String> -> parameter = it; "output" }, "output")
+        parameter shouldBe input
+    }
+    "printAndCheck calls the block with the input list as parameter and succeeds on Int expectation met" {
+        val input = listOf("input")
+        var parameter: List<String> = emptyList()
+        printAndCheck(input, { it: List<String> -> parameter = it; 7 } as (List<String>) -> Int, 7)
+        parameter shouldBe input
+    }
+    "printAndCheck calls the block with the input list as parameter and succeeds on Long expectation met" {
+        val input = listOf("input")
+        var parameter: List<String> = emptyList()
+        printAndCheck(input, { it: List<String> -> parameter = it; 7L } as (List<String>) -> Long, 7L)
+        parameter shouldBe input
+    }
+})
