Create test framework for Euler problems

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+
+end_of_line = lf
+insert_final_newline = true
+
+indent_style = space
+indent_size = 4

.gitignore

@@ -1,6 +1,6 @@
 ## Custom
-**/main/resources/*/Day*.txt
-!**/main/resources/*/DayX.txt
+**/main/resources/aoc/*/Day*.txt
+!**/main/resources/aoc/*/DayX.txt
 src/main/kotlin/com/fwdekker/euler
 
 

src/main/kotlin/com/fwdekker/aoc/Day.kt

@@ -29,10 +29,13 @@ abstract class Day(val resource: String) {
      */
     companion object {
         /**
-         * Shorthand for returning the standard resource for the given [year] and [day].
+         * Shorthand for returning the resource for the given [year] and [day].
+         *
+         * Setting [sample] to `0` returns the final difficult input, whereas all other values return easier sample
+         * inputs.
          */
         fun resource(year: Int, day: Int, sample: Int = 0) =
-            if (sample == 0) "/y$year/Day$day.txt"
-            else "/y${year}/Day${day}Sample${sample}.txt"
+            if (sample == 0) "/aoc/y$year/Day$day.txt"
+            else "/aoc/y${year}/Day${day}Sample${sample}.txt"
     }
 }

src/main/kotlin/com/fwdekker/std/grid.kt

@@ -37,6 +37,11 @@ val <T> Grid<T>.lastRowIndex: Int get() = lastIndex
  */
 val <T> Grid<T>.lastColIndex: Int get() = this[0].lastIndex
 
+/**
+ * All pairs of coordinates in the grid.
+ */
+val <T> Grid<T>.allCoords: List<Coords> get() = rows.map { row -> cols.map { col -> Coords(col, row) } }.flatten()
+
 
 /**
  * Returns the first row.

src/main/kotlin/com/fwdekker/std/maths.kt

@@ -346,6 +346,20 @@ fun IntRange.shift(by: Int): IntRange = this.first + by..this.last + by
 fun LongRange.shift(by: Long): LongRange = this.first + by..this.last + by
 
 
+/**
+ * Returns an infinite sequence of Fibonacci numbers, starting with 1, 1, 2.
+ */
+fun fibonacci(): Sequence<Long> =
+    sequence {
+        var a = 1L
+        var b = 1L
+
+        while (true) {
+            yield(a)
+            a = b.also { b += a }
+        }
+    }
+
 /**
  * Returns an infinite sequence of all natural numbers, starting at 0.
  */

src/main/resources/aoc/y2023/DayX.txt

@@ -0,0 +1,3 @@
+Put your input files in this directory with names 'Day1.txt' etc.
+
+These files are ignored in the `.gitignore` because everyone will have different inputs.

src/main/resources/euler/Problem1.txt

@@ -0,0 +1 @@
+1000

src/main/resources/euler/Problem2.txt

@@ -0,0 +1 @@
+4000000

src/main/resources/euler/ProblemX.txt

@@ -0,0 +1,3 @@
+Put your input files in this directory with names 'Problem1.txt' etc.
+
+These files are not ignored in the `.gitignore` because everyone has the same inputs anyway.

src/test/kotlin/com/fwdekker/aoc/DayTest.kt

@@ -8,7 +8,7 @@ import io.kotest.matchers.shouldBe
 /**
  * Tests that a given [Day] has the expected outputs for given file inputs.
  *
- * @param day creates a new [Day] from a path to a file
+ * @param day the constructor of the [Day] to test
  * @param tests tests to run, expressed as an input file, a reference to the part to run, and the expected output
  * @constructor
  */

src/test/kotlin/com/fwdekker/euler/Problem1Test.kt

@@ -0,0 +1,13 @@
+package com.fwdekker.euler
+
+
+/**
+ * Tests for [Problem1].
+ */
+class Problem1Test : ProblemTest<Int>(
+    ::Problem1,
+    listOf(
+        Pair(Problem.resource(1, sample = 1), 0),
+        Pair(Problem.resource(1), 0),
+    )
+)

src/test/kotlin/com/fwdekker/euler/Problem2Test.kt

@@ -0,0 +1,10 @@
+package com.fwdekker.euler
+
+
+/**
+ * Tests for [Problem2].
+ */
+class Problem2Test : ProblemTest<Long>(
+    ::Problem2,
+    listOf(Pair(Problem.resource(2), 0L))
+)

src/test/kotlin/com/fwdekker/euler/ProblemTest.kt

@@ -0,0 +1,20 @@
+package com.fwdekker.euler
+
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.datatest.withData
+import io.kotest.matchers.shouldBe
+
+
+/**
+ * Tests that a given [Problem] has the expected outputs for given file inputs.
+ *
+ * @param problem the constructor of the [Problem] to test
+ * @param tests tests to run, expressed as an input file and the expected output
+ * @constructor
+ */
+abstract class ProblemTest<S>(problem: (String) -> Problem<S>, tests: Collection<Pair<String, S>>) : FunSpec({
+    withData(
+        nameFn = { (file, expected) -> "($file) = $expected" },
+        tests
+    ) { (resource, expected) -> problem(resource).solve() shouldBe expected }
+})

src/test/resources/euler/Problem1Sample1.txt

@@ -0,0 +1 @@
+10