Optimize random display (#3)

* Optimize random display

CHANGELOG.md

@@ -6,10 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.26.1] - 2020-03-14
+### Changed
+- Optimize random display
+
 ## [0.26.0] - 2020-03-14
 ### Changed
 - Random character includes styles
 - Random character select the first color automatically
 
 [Unreleased]: https://github.com/mugen-launcher/quick-versus/compare/0.26.0...HEAD
+[0.26.1]: https://github.com/mugen-launcher/quick-versus/compare/0.26.0...0.26.1
 [0.26.0]: https://github.com/mugen-launcher/quick-versus/compare/0.25.3...0.26.0

package.json

@@ -2,7 +2,7 @@
     "name": "mugen-quick-versus-launcher",
     "author": "neolao",
     "license": "MIT",
-    "version": "0.26.0",
+    "version": "0.26.1",
     "description": "Mugen launcher for Quick Versus",
     "keywords": [
         "mugen",

src/character/__tests__/useCharacterDefinition.hook.test.js

@@ -5,6 +5,10 @@ import useEnvironment from "../../configuration/useEnvironment.hook";
 jest.mock("../../configuration/useEnvironment.hook");
 
 describe("useCharacterDefinition()", () => {
+  useEnvironment.mockReturnValue({
+    currentDirectory: ""
+  });
+
   it("should return null if the provided character is null", () => {
     expect(useCharacterDefinition(null)).toBeNull();
   });
@@ -22,9 +26,6 @@ describe("useCharacterDefinition()", () => {
   });
 
   it("should return null if the definition file does not exists", () => {
-    useEnvironment.mockReturnValue({
-      currentDirectory: ""
-    });
     remote.require.mockReturnValue({
       resolve: jest.fn(),
       existsSync: jest.fn().mockReturnValue(false)
@@ -37,9 +38,6 @@ describe("useCharacterDefinition()", () => {
   });
 
   it("should return the definition", () => {
-    useEnvironment.mockReturnValue({
-      currentDirectory: ""
-    });
     remote.require.mockReturnValue({
       resolve: jest.fn(),
       existsSync: jest.fn().mockReturnValue(true),

src/character/useCharacterDefinition.hook.js

@@ -1,36 +1,7 @@
-import ini from "ini";
-import { remote } from "electron";
 import useEnvironment from "../configuration/useEnvironment.hook";
-
-const cache = new WeakMap();
+import getCharacterDefinition from "./util/getCharacterDefinition";
 
 export default function useCharacterDefinition(character) {
-  const fs = remote.require("fs");
-  const path = remote.require("path");
   const environment = useEnvironment();
-
-  if (cache.has(character)) {
-    return cache.get(character);
-  }
-
-  if (!character) {
-    return null;
-  }
-
-  if (character.random) {
-    return null;
-  }
-
-  if (!character.definition) {
-    return null;
-  }
-
-  const definitionPath = path.resolve(environment.currentDirectory, "chars", character.definition);
-  if (!fs.existsSync(definitionPath)) {
-    return null;
-  }
-
-  const definition = ini.parse(fs.readFileSync(definitionPath, "utf-8"));
-  cache.set(character, definition);
-  return definition;
+  return getCharacterDefinition(character, environment.currentDirectory);
 }

src/character/useCharacterName.hook.js

@@ -1,38 +1,7 @@
-import ini from "ini";
-import useCharacterDefinition from "./useCharacterDefinition.hook";
-import getObjectPropertyValueCaseInsensitive from "./util/getObjectPropertyValueCaseInsensitive";
-
-const infoKeys = ["Info", "info"];
-const nameKeys = ["displayname", "Displayname", "DisplayName", "name", "Name"];
+import useEnvironment from "../configuration/useEnvironment.hook";
+import getCharacterName from "./util/getCharacterName";
 
 export default function useCharacterName(character) {
-  const definition = useCharacterDefinition(character);
-
-  if (!character) {
-    return "Unknown";
-  }
-
-  if (character.random) {
-    return "Random";
-  }
-
-  if (!definition) {
-    return "Unknown";
-  }
-
-  const info = getObjectPropertyValueCaseInsensitive(definition, "info");
-  if (!info) {
-    return "Unknown";
-  }
-
-  const displayName = getObjectPropertyValueCaseInsensitive(info, "displayname");
-  if (displayName) {
-    return ini.unsafe(displayName);
-  }
-  const name = getObjectPropertyValueCaseInsensitive(info, "name");
-  if (name) {
-    return ini.unsafe(name);
-  }
-
-  return "Unknown";
+  const environment = useEnvironment();
+  return getCharacterName(character, environment.currentDirectory);
 }

src/character/useSelectableCharacterNames.hook.js

@@ -0,0 +1,18 @@
+import getSelectableCharactersFromCategories from "./util/getSelectableCharactersFromCategories";
+import useCategories from "../configuration/useCategories.hook";
+import getCharacterName from "./util/getCharacterName";
+import useEnvironment from "../configuration/useEnvironment.hook";
+
+export default function useSelectableCharacterNames() {
+  const environment = useEnvironment();
+  const categories = useCategories();
+
+  const names = [];
+  const selectableCharacters = getSelectableCharactersFromCategories(categories);
+  for (const character of selectableCharacters) {
+    const name = getCharacterName(character, environment.currentDirectory);
+    names.push(name);
+  }
+
+  return names;
+}

src/character/useSelectableCharacterNamesFromCategory.hook.js

@@ -0,0 +1,23 @@
+import getSelectableCharactersFromCategory from "./util/getSelectableCharactersFromCategory";
+import getCharacterName from "./util/getCharacterName";
+import useEnvironment from "../configuration/useEnvironment.hook";
+
+const cache = new WeakMap();
+
+export default function useSelectableCharacterNamesFromCategory(category) {
+  const environment = useEnvironment();
+
+  if (cache.has(category)) {
+    return cache.get(category);
+  }
+
+  const names = [];
+  const selectableCharacters = getSelectableCharactersFromCategory(category);
+  for (const character of selectableCharacters) {
+    const name = getCharacterName(character, environment.currentDirectory);
+    names.push(name);
+  }
+
+  cache.set(category, names);
+  return names;
+}

src/character/util/__tests__/getSelectableCharactersFromCategory.test.js

@@ -0,0 +1,28 @@
+import getSelectableCharactersFromCategory from "../getSelectableCharactersFromCategory";
+
+describe("getSelectableCharactersFromCategory()", () => {
+  const characterA = { definition: "A" };
+  const characterB = { definition: "B" };
+  const characterC = { definition: "C" };
+  const characterD = { definition: "D" };
+  const characterE = {
+    definition: "E",
+    styles: [characterD]
+  };
+
+  it("should return all characters", () => {
+    const category = {
+      characters: [characterA, characterB, characterC]
+    };
+    const characters = getSelectableCharactersFromCategory(category);
+    expect(characters).toEqual([characterA, characterB, characterC]);
+  });
+
+  it("should return all characters including sub characters", () => {
+    const category = {
+      characters: [characterA, characterB, characterE]
+    };
+    const characters = getSelectableCharactersFromCategory(category);
+    expect(characters).toEqual([characterA, characterB, characterE, characterD]);
+  });
+});

src/character/util/getCharacterDefinition.js

@@ -0,0 +1,34 @@
+import ini from "ini";
+import { remote } from "electron";
+
+const cache = new WeakMap();
+
+export default function useCharacterDefinition(character, currentDirectory) {
+  const fs = remote.require("fs");
+  const path = remote.require("path");
+
+  if (cache.has(character)) {
+    return cache.get(character);
+  }
+
+  if (!character) {
+    return null;
+  }
+
+  if (character.random) {
+    return null;
+  }
+
+  if (!character.definition) {
+    return null;
+  }
+
+  const definitionPath = path.resolve(currentDirectory, "chars", character.definition);
+  if (!fs.existsSync(definitionPath)) {
+    return null;
+  }
+
+  const definition = ini.parse(fs.readFileSync(definitionPath, "utf-8"));
+  cache.set(character, definition);
+  return definition;
+}

src/character/util/getCharacterName.js

@@ -0,0 +1,34 @@
+import ini from "ini";
+import getCharacterDefinition from "./getCharacterDefinition";
+import getObjectPropertyValueCaseInsensitive from "./getObjectPropertyValueCaseInsensitive";
+
+export default function getCharacterName(character, currentDirectory) {
+  if (!character) {
+    return "Unknown";
+  }
+
+  if (character.random) {
+    return "Random";
+  }
+
+  const definition = getCharacterDefinition(character, currentDirectory);
+  if (!definition) {
+    return "Unknown";
+  }
+
+  const info = getObjectPropertyValueCaseInsensitive(definition, "info");
+  if (!info) {
+    return "Unknown";
+  }
+
+  const displayName = getObjectPropertyValueCaseInsensitive(info, "displayname");
+  if (displayName) {
+    return ini.unsafe(displayName);
+  }
+  const name = getObjectPropertyValueCaseInsensitive(info, "name");
+  if (name) {
+    return ini.unsafe(name);
+  }
+
+  return "Unknown";
+}