Add Java Pair goody

Hypothetically we could use [`javafx.util.Pair`](https://docs.oracle.com/javase/8/javafx/api/javafx/util/Pair.html) but I don't love that the fields are named key and value. So let's reinvent the wheel!

Author: miorel

tools/adventure-pack/goodies/java/src/pair/Pair.java

@@ -0,0 +1,3 @@
+package pair;
+
+public record Pair<TFirst, TSecond>(TFirst first, TSecond second) {}

tools/adventure-pack/goodies/java/src/pair/goody.json

@@ -0,0 +1,3 @@
+{
+  "name": "Pair"
+}

tools/adventure-pack/src/app/__tests__/__snapshots__/equip-test.ts.snap

@@ -1,5 +1,17 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`App can equip single goody: Java Pair 1`] = `
+"////////////////////////// BEGIN ADVENTURE PACK CODE ///////////////////////////
+// Adventure Pack commit fake-commit-hash
+// Running at: https://example.com/
+
+record Pair<TFirst, TSecond>(TFirst first, TSecond second) {
+
+}
+
+/////////////////////////// END ADVENTURE PACK CODE ////////////////////////////"
+`;
+
 exports[`App can equip single goody: Java UnionFind 1`] = `
 "////////////////////////// BEGIN ADVENTURE PACK CODE ///////////////////////////
 // Adventure Pack commit fake-commit-hash

tools/adventure-pack/src/app/__tests__/__snapshots__/render-test.ts.snap

@@ -1,5 +1,13 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`App can render goody: Java Pair 1`] = `
+"package pair;
+
+record Pair<TFirst, TSecond>(TFirst first, TSecond second) {
+
+}"
+`;
+
 exports[`App can render goody: Java UnionFind 1`] = `
 "package union_find;
 

tools/adventure-pack/src/app/mergeJavaCode.ts

@@ -6,19 +6,18 @@ import type { JavaGoody } from "./parsers/javaGoodyParser";
 const ADVENTURE_PACK_CLASS_NAME = "AP";
 
 export function mergeJavaCode(goodies: Iterable<ReadonlyDeep<JavaGoody>>) {
-  const classes: Record<string, { code: string[]; modifiers: Set<string> }> =
-    {};
+  const classes: Record<string, { code: string[]; declaration: string }> = {};
   for (const goody of goodies) {
     for (const className of Object.keys(goody.codeByClass)) {
       invariant(
         classes[className] == null || className === ADVENTURE_PACK_CLASS_NAME,
         `Only the ${ADVENTURE_PACK_CLASS_NAME} class can exist in multiple goodies!`,
       );
 
-      classes[className] ??= { code: [], modifiers: new Set() };
-      for (const modifier of goody.codeByClass[className].modifiers) {
-        classes[className].modifiers.add(modifier);
-      }
+      classes[className] ??= {
+        code: [],
+        declaration: goody.codeByClass[className].declaration,
+      };
       classes[className].code.push(goody.codeByClass[className].code);
     }
   }
@@ -33,7 +32,7 @@ export function mergeJavaCode(goodies: Iterable<ReadonlyDeep<JavaGoody>>) {
   const res: string[] = [];
   for (const className of Object.keys(classes)) {
     res.push(
-      `${[...classes[className].modifiers, "class", className].join(" ")} {\n${classes[className].code.map((section) => section + "\n").join("\n")}}`,
+      `${classes[className].declaration}\n${classes[className].code.map((section) => section + "\n").join("\n")}}`,
     );
   }
 

tools/adventure-pack/src/app/parsers/javaGoodyParser.ts

@@ -11,7 +11,7 @@ export const javaGoodyParser = goodyBaseParser
       z
         .object({
           code: z.string(),
-          modifiers: z.array(nonBlankStringParser),
+          declaration: nonBlankStringParser,
         })
         .strict(),
     ),

tools/adventure-pack/src/scripts/package-goodies/java/splitCodeIntoClasses.ts

@@ -8,23 +8,35 @@ import {
 
 export function splitCodeIntoClasses(
   code: string,
-): Record<string, { code: string; modifiers: string[] }> {
-  const classes: Record<string, { code: string[]; modifiers: Set<string> }> =
-    {};
+): Record<string, { code: string; declaration: string }> {
+  const classes: Record<string, { code: string[]; declaration: string }> = {};
 
   let currentClassName: string | null = null;
   for (const line of getLines(code)) {
     const classMatch = line.match(
-      /^((?:(?:abstract|final|public)\s+)*)class\s+(\S+)\s*{/,
+      /^((?:(?:abstract|final|public)\s+)*)((?:class|record)\s+(\S+)\s*[{<].*)$/s,
     );
     if (classMatch != null) {
       invariant(currentClassName == null, "Top-level class nesting?");
 
       const modifiers = new Set(classMatch[1].trim().split(/\s+/));
       modifiers.delete("public");
 
-      currentClassName = classMatch[2];
-      classes[currentClassName] = { code: [], modifiers };
+      currentClassName = classMatch[3];
+      classes[currentClassName] = {
+        code: [],
+        declaration: [
+          ...Array.from(modifiers).sort(),
+          classMatch[2].replace(/}?\n*$/, ""),
+        ]
+          .filter(Boolean)
+          .join(" "),
+      };
+
+      if (/}\n*$/.test(line)) {
+        currentClassName = null;
+      }
+
       continue;
     }
 
@@ -44,8 +56,8 @@ export function splitCodeIntoClasses(
 
   invariant(currentClassName == null, "Unfinished class?");
 
-  return mapObjectValues(classes, ({ code, modifiers }) => ({
+  return mapObjectValues(classes, ({ code, declaration }) => ({
     code: code.join("").replace(/^\n+/, "").replace(/\n+$/, ""),
-    modifiers: Array.from(modifiers),
+    declaration,
   }));
 }

tools/adventure-pack/src/scripts/package-goodies/main.ts

@@ -10,7 +10,7 @@ async function main(): Promise<void> {
   await fsPromises.writeFile(
     path.join("dist", "goodies.json"),
     // TODO: pretty print if NODE_ENV is "development"
-    JSON.stringify(goodies) + "\n",
+    JSON.stringify(goodies, null, 2) + "\n",
   );
 }