From 5e83330ba04971f46f8d2f7a8e3ad78d43b9faec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Djobbo=20Ma=C3=AFga?= <hi@djobbo.com>
Date: Wed, 10 Apr 2024 17:07:27 +0200
Subject: [PATCH] rename checkKeyword to checkProunounciation

---
 components/Steps/KeywordChallenge.tsx |  4 +-
 util/checkKeyword.test.ts             | 54 -------------------------
 util/checkKeyword.ts                  | 19 ---------
 util/checkPronounciation.test.ts      | 58 +++++++++++++++++++++++++++
 util/checkPronounciation.ts           | 25 ++++++++++++
 5 files changed, 85 insertions(+), 75 deletions(-)
 delete mode 100644 util/checkKeyword.test.ts
 delete mode 100644 util/checkKeyword.ts
 create mode 100644 util/checkPronounciation.test.ts
 create mode 100644 util/checkPronounciation.ts

diff --git a/components/Steps/KeywordChallenge.tsx b/components/Steps/KeywordChallenge.tsx
index 1e2f754..96e2b68 100644
--- a/components/Steps/KeywordChallenge.tsx
+++ b/components/Steps/KeywordChallenge.tsx
@@ -1,7 +1,7 @@
 import { type KeywordChallengeStep } from "@/data/levels"
 import { useMemo, useState } from "react"
 import { Button } from "@/components/Button"
-import { checkKeyword } from "@/util/checkKeyword"
+import { checkPronounciation } from "@/util/checkPronounciation"
 
 type KeywordChallengeStepContentProps = {
     step: KeywordChallengeStep
@@ -60,7 +60,7 @@ export const KeywordChallenge = ({
                 <button
                     type="button"
                     onClick={() => {
-                        const errorIndex = checkKeyword(
+                        const errorIndex = checkPronounciation(
                             inputValue.toLowerCase(),
                             step.pronounciation,
                         )
diff --git a/util/checkKeyword.test.ts b/util/checkKeyword.test.ts
deleted file mode 100644
index 8b60dda..0000000
--- a/util/checkKeyword.test.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-import { checkKeyword } from "./checkKeyword"
-
-describe("Check Keyword", () => {
-    describe("Should return -1 if the keyword is right", () => {
-        test("single solution", () => {
-            expect(checkKeyword("ai", [["a"], ["i"]])).toBe(-1)
-        })
-
-        test("multiple solutions", () => {
-            expect(checkKeyword("ichi", [["i"], ["chi", "ti"]])).toBe(-1)
-            expect(checkKeyword("iti", [["i"], ["chi", "ti"]])).toBe(-1)
-
-            expect(checkKeyword("jaa", [["ja", "zya"], ["a"]])).toBe(-1)
-            expect(checkKeyword("zyaa", [["ja", "zya"], ["a"]])).toBe(-1)
-        })
-    })
-
-    describe("should return the index of the error if the keyword is wrong", () => {
-        test("wrong character", () => {
-            expect(checkKeyword("ai", [["i"], ["a"]])).toBe(0)
-            expect(checkKeyword("ai", [["i"], ["i"]])).toBe(0)
-            expect(checkKeyword("ia", [["i"], ["i"]])).toBe(1)
-
-            expect(checkKeyword("aoi", [["a"], ["o"], ["i"]])).toBe(-1)
-            expect(checkKeyword("eoi", [["a"], ["o"], ["i"]])).toBe(0)
-            expect(checkKeyword("aei", [["a"], ["o"], ["i"]])).toBe(1)
-            expect(checkKeyword("aee", [["a"], ["o"], ["i"]])).toBe(1)
-            expect(checkKeyword("aoe", [["a"], ["o"], ["i"]])).toBe(2)
-        })
-
-        test("wrong character (multiple solutions)", () => {
-            expect(checkKeyword("iti", [["i"], ["chi", "ti"]])).toBe(-1)
-            expect(checkKeyword("ici", [["i"], ["chi", "ti"]])).toBe(1)
-            expect(checkKeyword("tci", [["i"], ["chi", "ti"]])).toBe(0)
-        })
-
-        test("missing character", () => {
-            expect(checkKeyword("ai", [["a"], ["i"], ["i"]])).toBe(2)
-            expect(checkKeyword("ai", [["a"], ["i"], ["a"]])).toBe(2)
-            expect(checkKeyword("ai", [["a"], ["i"], ["o"]])).toBe(2)
-        })
-
-        test("missing character (multiple solutions)", () => {
-            expect(checkKeyword("iti", [["i"], ["chi", "ti"], ["i"]])).toBe(3)
-            expect(checkKeyword("ichi", [["i"], ["chi", "ti"], ["i"]])).toBe(4)
-        })
-
-        test("extra character", () => {
-            expect(checkKeyword("aii", [["a"], ["i"]])).toBe(2)
-            expect(checkKeyword("aiii", [["a"], ["i"]])).toBe(2)
-            expect(checkKeyword("aiii", [["a"], ["i"], ["i"]])).toBe(3)
-        })
-    })
-})
diff --git a/util/checkKeyword.ts b/util/checkKeyword.ts
deleted file mode 100644
index 155eeaf..0000000
--- a/util/checkKeyword.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-export const checkKeyword = (
-    inputValue: string,
-    pronounciation: string[][],
-): number => {
-    let checkIndex = 0
-    let ok = pronounciation.every((p) => {
-        const rest = inputValue.slice(checkIndex)
-        const found = p.find((p) => rest.startsWith(p))
-
-        if (!found) {
-            return false
-        }
-
-        checkIndex += found.length
-        return true
-    })
-
-    return ok && checkIndex === inputValue.length ? -1 : checkIndex
-}
diff --git a/util/checkPronounciation.test.ts b/util/checkPronounciation.test.ts
new file mode 100644
index 0000000..06e3955
--- /dev/null
+++ b/util/checkPronounciation.test.ts
@@ -0,0 +1,58 @@
+import { checkPronounciation } from "./checkPronounciation"
+
+describe("Check Pronounciation", () => {
+    describe("Should return -1 if the pronounciation is right", () => {
+        test("single solution", () => {
+            expect(checkPronounciation("ai", [["a"], ["i"]])).toBe(-1)
+        })
+
+        test("multiple solutions", () => {
+            expect(checkPronounciation("ichi", [["i"], ["chi", "ti"]])).toBe(-1)
+            expect(checkPronounciation("iti", [["i"], ["chi", "ti"]])).toBe(-1)
+
+            expect(checkPronounciation("jaa", [["ja", "zya"], ["a"]])).toBe(-1)
+            expect(checkPronounciation("zyaa", [["ja", "zya"], ["a"]])).toBe(-1)
+        })
+    })
+
+    describe("should return the index of the error if the pronounciation is wrong", () => {
+        test("wrong character", () => {
+            expect(checkPronounciation("ai", [["i"], ["a"]])).toBe(0)
+            expect(checkPronounciation("ai", [["i"], ["i"]])).toBe(0)
+            expect(checkPronounciation("ia", [["i"], ["i"]])).toBe(1)
+
+            expect(checkPronounciation("aoi", [["a"], ["o"], ["i"]])).toBe(-1)
+            expect(checkPronounciation("eoi", [["a"], ["o"], ["i"]])).toBe(0)
+            expect(checkPronounciation("aei", [["a"], ["o"], ["i"]])).toBe(1)
+            expect(checkPronounciation("aee", [["a"], ["o"], ["i"]])).toBe(1)
+            expect(checkPronounciation("aoe", [["a"], ["o"], ["i"]])).toBe(2)
+        })
+
+        test("wrong character (multiple solutions)", () => {
+            expect(checkPronounciation("iti", [["i"], ["chi", "ti"]])).toBe(-1)
+            expect(checkPronounciation("ici", [["i"], ["chi", "ti"]])).toBe(1)
+            expect(checkPronounciation("tci", [["i"], ["chi", "ti"]])).toBe(0)
+        })
+
+        test("missing character", () => {
+            expect(checkPronounciation("ai", [["a"], ["i"], ["i"]])).toBe(2)
+            expect(checkPronounciation("ai", [["a"], ["i"], ["a"]])).toBe(2)
+            expect(checkPronounciation("ai", [["a"], ["i"], ["o"]])).toBe(2)
+        })
+
+        test("missing character (multiple solutions)", () => {
+            expect(
+                checkPronounciation("iti", [["i"], ["chi", "ti"], ["i"]]),
+            ).toBe(3)
+            expect(
+                checkPronounciation("ichi", [["i"], ["chi", "ti"], ["i"]]),
+            ).toBe(4)
+        })
+
+        test("extra character", () => {
+            expect(checkPronounciation("aii", [["a"], ["i"]])).toBe(2)
+            expect(checkPronounciation("aiii", [["a"], ["i"]])).toBe(2)
+            expect(checkPronounciation("aiii", [["a"], ["i"], ["i"]])).toBe(3)
+        })
+    })
+})
diff --git a/util/checkPronounciation.ts b/util/checkPronounciation.ts
new file mode 100644
index 0000000..26be068
--- /dev/null
+++ b/util/checkPronounciation.ts
@@ -0,0 +1,25 @@
+/**
+ * Check if the input value is a is a valid pronounciation of the keyword
+ * @param inputValue - The input value to check
+ * @param pronounciation - The pronounciation of the keyword
+ * @returns -1 if the keyword is right, otherwise the index of the error
+ */
+export const checkPronounciation = (
+    inputValue: string,
+    pronounciation: string[][],
+): number => {
+    let checkIndex = 0
+    let ok = pronounciation.every((p) => {
+        const rest = inputValue.slice(checkIndex)
+        const found = p.find((p) => rest.startsWith(p))
+
+        if (!found) return false
+
+        checkIndex += found.length
+        return true
+    })
+
+    if (ok && checkIndex === inputValue.length) return -1
+
+    return checkIndex
+}