allow free exam labels

nknapp · Aug 17, 2024 · 3d46080 · 3d46080
1 parent 3f57a2a
commit 3d46080
Show file tree

Hide file tree

Showing 25 changed files with 232 additions and 45 deletions.
diff --git a/scripts/merge-youtube-data.mjs b/scripts/merge-youtube-data.mjs
@@ -10,7 +10,7 @@ for (const exam of Object.values(tables.exams)) {
       metadata.youtube = findVideo(technique);
     }
   }
-  result[exam.labelKey] = exam;
+  result[exam.id] = exam;
 }
 
 console.log(JSON.stringify(result, 0, 2));

diff --git a/src/components/solid/organisms/TechniqueChooser/TechniqueChooser.test.tsx b/src/components/solid/organisms/TechniqueChooser/TechniqueChooser.test.tsx
@@ -15,9 +15,24 @@ describe("Chooser.test.tsx", async () => {
     const dojo = createResolvedDojo({
       details: createDojoDetails({
         exams: [
-          createExam({ labelKey: "chooser.button.kyu5" }),
-          createExam({ labelKey: "chooser.button.kyu4" }),
-          createExam({ labelKey: "chooser.button.kyu3" }),
+          createExam({
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
+          }),
+          createExam({
+            label: {
+              type: "wellknown",
+              key: "kyu4",
+            },
+          }),
+          createExam({
+            label: {
+              type: "wellknown",
+              key: "kyu3",
+            },
+          }),
         ],
       }),
     });
@@ -30,7 +45,14 @@ describe("Chooser.test.tsx", async () => {
   it("clicking an exam selects it", async () => {
     const dojo = createResolvedDojo({
       details: createDojoDetails({
-        exams: [createExam({ labelKey: "chooser.button.kyu5" })],
+        exams: [
+          createExam({
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
+          }),
+        ],
       }),
     });
     render(() => <TechniqueChooser dojo={dojo} />);
@@ -44,7 +66,14 @@ describe("Chooser.test.tsx", async () => {
   it("clicking an selected exam deselects it", async () => {
     const dojo = createResolvedDojo({
       details: createDojoDetails({
-        exams: [createExam({ labelKey: "chooser.button.kyu5" })],
+        exams: [
+          createExam({
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
+          }),
+        ],
       }),
     });
     render(() => <TechniqueChooser dojo={dojo} />);
@@ -60,7 +89,10 @@ describe("Chooser.test.tsx", async () => {
       details: createDojoDetails({
         exams: [
           createExam({
-            labelKey: "chooser.button.kyu5",
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
             techniques: {
               "suwari waza": {
                 "ai hanmi katate dori": {
@@ -86,7 +118,10 @@ describe("Chooser.test.tsx", async () => {
       details: createDojoDetails({
         exams: [
           createExam({
-            labelKey: "chooser.button.kyu5",
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
             techniques: {
               "suwari waza": {
                 "ai hanmi katate dori": {
@@ -108,7 +143,10 @@ describe("Chooser.test.tsx", async () => {
       details: createDojoDetails({
         exams: [
           createExam({
-            labelKey: "chooser.button.kyu5",
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
             techniques: {
               "hanmi handachi waza": {
                 "ai hanmi katate dori": {
@@ -138,7 +176,10 @@ describe("Chooser.test.tsx", async () => {
       details: createDojoDetails({
         exams: [
           createExam({
-            labelKey: "chooser.button.kyu5",
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
             techniques: {
               "hanmi handachi waza": {
                 "ai hanmi katate dori": {
@@ -163,8 +204,20 @@ describe("Chooser.test.tsx", async () => {
     const dojo = createResolvedDojo({
       details: createDojoDetails({
         exams: [
-          createExam({ id: "kyu5", labelKey: "chooser.button.kyu5" }),
-          createExam({ id: "kyu4", labelKey: "chooser.button.kyu4" }),
+          createExam({
+            id: "kyu5",
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
+          }),
+          createExam({
+            id: "kyu4",
+            label: {
+              type: "wellknown",
+              key: "kyu4",
+            },
+          }),
         ],
       }),
     });
@@ -186,8 +239,20 @@ describe("Chooser.test.tsx", async () => {
         info: createDojoInfo({ id }),
         details: createDojoDetails({
           exams: [
-            createExam({ id: "kyu5", labelKey: "chooser.button.kyu5" }),
-            createExam({ id: "kyu4", labelKey: "chooser.button.kyu4" }),
+            createExam({
+              id: "kyu5",
+              label: {
+                type: "wellknown",
+                key: "kyu5",
+              },
+            }),
+            createExam({
+              id: "kyu4",
+              label: {
+                type: "wellknown",
+                key: "kyu4",
+              },
+            }),
           ],
         }),
       });
@@ -211,7 +276,15 @@ describe("Chooser.test.tsx", async () => {
   it("renders filters", () => {
     const dojo = createResolvedDojo({
       details: createDojoDetails({
-        exams: [createExam({ id: "kyu5", labelKey: "chooser.button.kyu5" })],
+        exams: [
+          createExam({
+            id: "kyu5",
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
+          }),
+        ],
       }),
     });
     renderSolid(() => <TechniqueChooser dojo={dojo} />);
@@ -225,7 +298,10 @@ describe("Chooser.test.tsx", async () => {
         exams: [
           createExam({
             id: "kyu5",
-            labelKey: "chooser.button.kyu5",
+            label: {
+              type: "wellknown",
+              key: "kyu5",
+            },
             techniques: {
               "suwari waza": { "ai hanmi katate dori": { ikkyo: { omote: {} } } },
               "hanmi handachi waza": { "ai hanmi katate dori": { ikkyo: { omote: {} } } },

diff --git a/src/components/solid/organisms/TechniqueChooser/TechniqueChooser.tsx b/src/components/solid/organisms/TechniqueChooser/TechniqueChooser.tsx
@@ -1,13 +1,13 @@
 import { type Component, createDeferred, createSignal } from "solid-js";
 import type { ResolvedDojo } from "$core/model/Dojo.ts";
-import { t } from "@/i18n";
+import { t, tx } from "@/i18n";
 import { l } from "astro-i18n";
 import { ExamSheet } from "@/components/solid/organisms/TechniqueChooser/ExamSheet.tsx";
 import {
   ChooserControlButtons,
   type Option,
 } from "@/components/solid/organisms/TechniqueChooser/ChooserControlButtons.tsx";
-import type { Exam } from "$core/model";
+import type { Exam, ExamLabel, WellKnownExam } from "$core/model";
 import { syncToStorage } from "@/components/solid/hooks/syncToStorage.ts";
 import { isServer } from "solid-js/web";
 import { ChooserControlContainer } from "@/components/solid/organisms/TechniqueChooser/ChooserControlContainer.tsx";
@@ -21,6 +21,7 @@ import { SimpleButton } from "@/components/solid/atoms/SimpleButton.tsx";
 import { IconPrint, IconSpeak } from "@/icons";
 import { createTechniqueStore } from "$core/store";
 import { LinkButton } from "@/components/solid/atoms/LinkButton.tsx";
+import type { TranslationSchema } from "@/i18n/TranslationSchema.ts";
 
 export const TechniqueChooser: Component<{ dojo: ResolvedDojo }> = (props) => {
   const [examSelection, setExamSelection] = syncToStorage(createSignal(new Set<string>()), {
@@ -115,5 +116,26 @@ export const TechniqueChooser: Component<{ dojo: ResolvedDojo }> = (props) => {
 };
 
 function examsToOptions(exams: Exam[]): Option[] {
-  return exams.map((exam) => ({ id: exam.id, label: t(exam.labelKey) }));
+  return exams.map((exam) => ({ id: exam.id, label: resoveExamLabel(exam.label) }));
+}
+
+const wellknownLabels: Record<WellKnownExam, keyof TranslationSchema> = {
+  kyu5: "chooser.button.kyu5",
+  kyu4: "chooser.button.kyu4",
+  kyu3: "chooser.button.kyu3",
+  kyu2: "chooser.button.kyu2",
+  kyu1: "chooser.button.kyu1",
+  dan1: "chooser.button.dan1",
+  dan2: "chooser.button.dan2",
+  dan3: "chooser.button.dan3",
+  dan4: "chooser.button.dan4",
+};
+
+function resoveExamLabel(label: ExamLabel): string {
+  switch (label.type) {
+    case "wellknown":
+      return t(wellknownLabels[label.key]);
+    case "free":
+      return tx(label.text);
+  }
 }
diff --git a/src/core/model/Dojo.test-helper.ts b/src/core/model/Dojo.test-helper.ts
@@ -12,9 +12,24 @@ export function createDojoInfo(partialInfo: Partial<DojoInfo> = {}): DojoInfo {
 
 export function createExams() {
   return [
-    createExam({ labelKey: "chooser.button.kyu5" }),
-    createExam({ labelKey: "chooser.button.kyu4" }),
-    createExam({ labelKey: "chooser.button.kyu3" }),
+    createExam({
+      label: {
+        type: "wellknown",
+        key: "kyu5",
+      },
+    }),
+    createExam({
+      label: {
+        type: "wellknown",
+        key: "kyu4",
+      },
+    }),
+    createExam({
+      label: {
+        type: "wellknown",
+        key: "kyu3",
+      },
+    }),
   ];
 }
 

diff --git a/src/core/model/Exam.test-helper.ts b/src/core/model/Exam.test-helper.ts
@@ -4,7 +4,10 @@ import { nanoid } from "nanoid";
 export function createExam(exam: Partial<Exam>): Exam {
   return {
     id: nanoid(),
-    labelKey: "chooser.button.kyu5",
+    label: {
+      type: "wellknown",
+      key: "kyu5",
+    },
     techniques: {},
     ...exam,
   };

diff --git a/src/core/model/Exam.ts b/src/core/model/Exam.ts
@@ -3,15 +3,25 @@ import type { TechniqueMetadata } from "./TechniqueMetadata";
 import type { Defence } from "./Defence";
 import type { Attack } from "./Attack";
 import type { Execution } from "./Execution";
-import type { TranslationSchema } from "./TranslationSchema";
+import type { TranslatedText } from "$core/model/Dojo.ts";
 
 export type Directions = Partial<Record<Direction, TechniqueMetadata>>;
 export type Defences = Partial<Record<Defence, Directions>>;
 export type Attacks = Partial<Record<Attack, Defences>>;
 export type Table = Partial<Record<Execution, Attacks>>;
+export type WellKnownExam = "kyu5" | "kyu4" | "kyu3" | "kyu2" | "kyu1" | "dan1" | "dan2" | "dan3" | "dan4";
+export type ExamLabel =
+  | {
+      type: "wellknown";
+      key: WellKnownExam;
+    }
+  | {
+      type: "free";
+      text: TranslatedText;
+    };
 
 export interface Exam {
   id: string;
-  labelKey: keyof TranslationSchema;
+  label: ExamLabel;
   techniques: Table;
 }
diff --git a/src/core/resolveExamTables/resolveExamTables.test.ts b/src/core/resolveExamTables/resolveExamTables.test.ts
@@ -6,7 +6,10 @@ describe("resolve-exam-tables", () => {
     const actual = resolveExamTables([
       {
         id: "dan2",
-        labelKey: "chooser.button.dan2",
+        label: {
+          type: "wellknown",
+          key: "dan2",
+        },
         techniques: {
           "suwari waza": {
             "ryote dori": {
@@ -23,7 +26,10 @@ describe("resolve-exam-tables", () => {
       },
       {
         id: "dan3",
-        labelKey: "chooser.button.dan3",
+        label: {
+          type: "wellknown",
+          key: "dan3",
+        },
         techniques: {
           "tachi waza": {
             "ai hanmi katate dori": {

diff --git a/src/data/dojos/aikido-dojo-darmstadt/exams/additional.ts b/src/data/dojos/aikido-dojo-darmstadt/exams/additional.ts
@@ -2,7 +2,12 @@ import type { Exam } from "$core/model";
 
 export const additional: Exam = {
   id: "additional",
-  labelKey: "chooser.button.additional",
+  label: {
+    type: "free",
+    text: {
+      en: "+X",
+    },
+  },
   techniques: {
     "tachi waza": {
       "chudan tsuki": {

diff --git a/src/data/dojos/aikido-dojo-darmstadt/exams/dan1.ts b/src/data/dojos/aikido-dojo-darmstadt/exams/dan1.ts
@@ -2,7 +2,10 @@ import type { Exam } from "$core/model";
 
 export const dan1: Exam = {
   id: "dan1",
-  labelKey: "chooser.button.dan1",
+  label: {
+    type: "wellknown",
+    key: "dan1",
+  },
   techniques: {
     "hanmi handachi waza": {
       "gyuako hanmi katate dori": {

diff --git a/src/data/dojos/aikido-dojo-darmstadt/exams/kyu1.ts b/src/data/dojos/aikido-dojo-darmstadt/exams/kyu1.ts
@@ -2,7 +2,10 @@ import type { Exam } from "$core/model";
 
 export const kyu1: Exam = {
   id: "kyu1",
-  labelKey: "chooser.button.kyu1",
+  label: {
+    type: "wellknown",
+    key: "kyu1",
+  },
   techniques: {
     "suwari waza": {
       "yokomen uchi": {

diff --git a/src/data/dojos/aikido-dojo-darmstadt/exams/kyu2.ts b/src/data/dojos/aikido-dojo-darmstadt/exams/kyu2.ts
@@ -2,7 +2,10 @@ import type { Exam } from "$core/model/Exam";
 
 export const kyu2: Exam = {
   id: "kyu2",
-  labelKey: "chooser.button.kyu2",
+  label: {
+    type: "wellknown",
+    key: "kyu2",
+  },
   techniques: {
     "suwari waza": {
       "yokomen uchi": {

diff --git a/src/data/dojos/aikido-dojo-darmstadt/exams/kyu3.ts b/src/data/dojos/aikido-dojo-darmstadt/exams/kyu3.ts
@@ -2,7 +2,10 @@ import type { Exam } from "$core/model/Exam";
 
 export const kyu3: Exam = {
   id: "kyu3",
-  labelKey: "chooser.button.kyu3",
+  label: {
+    type: "wellknown",
+    key: "kyu3",
+  },
   techniques: {
     "suwari waza": {
       "gyuako hanmi katate dori": {