refactor(data): Refactor wordSearch and other methods for clarity and maintainability

extension/test/data_test.ts

@@ -1,6 +1,7 @@
 import { Config } from '../configuration';
-import { RcxDict } from '../data';
+import { DictEntryData, RcxDict } from '../data';
 import { expect, use } from '@esm-bundle/chai';
+import Sinon from 'sinon';
 import chaiLike from 'chai-like';
 import chaiThings from 'chai-things';
 import sinonChrome from 'sinon-chrome';
@@ -63,4 +64,145 @@ describe('data.ts', function () {
       ).to.not.include.something.like({ entry: /^凡打 .*/ });
     });
   });
+  describe('kanjiSearch', function () {
+    it('should return null for kanji with char code < 0x3000', function () {
+      const result = rcxDict.kanjiSearch('A');
+      expect(result).to.be.null;
+    });
+
+    it('should return null if kanjiData entry is not properly formatted', function () {
+      const result = rcxDict.kanjiSearch('子9');
+      expect(result).to.be.null;
+    });
+
+    it('should return a DictEntryData object for valid kanji', function () {
+      const result: DictEntryData | null = rcxDict.kanjiSearch('日');
+      expect(result).to.deep.include({
+        kanji: '日',
+        eigo: 'day, sun, Japan, counter for days',
+      });
+    });
+
+    it('should set kanji property of DictEntryData object', function () {
+      const result = rcxDict.kanjiSearch('日');
+      expect(result?.kanji).to.equal('日');
+    });
+
+    it('should set misc property of DictEntryData object', function () {
+      const result = rcxDict.kanjiSearch('日');
+      expect(result?.misc).to.deep.include({
+        U: '65E5',
+        B: '72',
+        G: '1',
+        S: '4',
+        F: '1',
+        N: '2097',
+        V: '2410',
+        H: '3027',
+        DK: '1915',
+        L: '12 day',
+        DN: '12 day',
+        E: '62',
+        IN: '5',
+        P: '3-3-1',
+        I: '4c0.1',
+        Y: 'ri4',
+      });
+    });
+
+    it('should set onkun property of DictEntryData object', function () {
+      const result = rcxDict.kanjiSearch('日');
+      expect(result?.onkun).to.contain('ニチ、 ジツ、 ひ、 -び、 -か');
+    });
+
+    it('should set nanori property of DictEntryData object', function () {
+      const result = rcxDict.kanjiSearch('日');
+      expect(result?.nanori).to.contain(
+        'あ、 あき、 いる、 く、 くさ、 こう、 す、 たち、 に、 にっ、 につ、 へ'
+      );
+    });
+
+    it('should set bushumei property of DictEntryData object to empty string if null', function () {
+      const result = rcxDict.kanjiSearch('日');
+      expect(result?.bushumei).to.equal('');
+    });
+
+    it('should set eigo property of DictEntryData object', function () {
+      const result = rcxDict.kanjiSearch('日');
+      expect(result?.eigo).to.contain('day, sun, Japan');
+    });
+  });
+  describe('(fileRead)', function () {
+    it('should take a valid file url and return a response', function () {
+      const url = 'data/dict.dat';
+      const result = rcxDict.fileRead(url);
+      expect(result).to.be.a('string');
+    });
+  });
+  describe('(fileReadArray)', function () {
+    it('should call fileRead and return an array of data', function () {
+      const fileName = 'data/dict.dat';
+      const result = rcxDict.fileReadArray(fileName);
+      expect(result).to.be.an('array');
+      expect(result).to.have.lengthOf.at.least(1);
+    });
+    it('should remove any whitespace or newlines from end of array', function () {
+      const stub = Sinon.stub(rcxDict, 'fileReadArray').returns([
+        'testing',
+        'is',
+        'fun  \n',
+      ]);
+      const results: string[] = rcxDict.fileReadArray('someFile/here');
+      expect(results).to.be.an('array');
+      expect(results[results.length - 1].endsWith(' ')).to.be.false;
+      Sinon.assert.calledOnce(stub);
+    });
+  });
+  describe('(loadNames)', function () {
+    it('should load name dictionary information if not loaded already', function () {
+      // set nameDict to true or initiate and confirm that rcxDict.nameDict/Index is set.
+      rcxDict.nameDict = '';
+      rcxDict.nameIndex = '';
+      expect(rcxDict.nameDict).to.equal('');
+      expect(rcxDict.nameIndex).to.equal('');
+      rcxDict.loadNames();
+      expect(rcxDict.nameDict).to.exist;
+      expect(rcxDict.nameIndex).to.exist;
+    });
+  });
+  describe('isKana', function () {
+    it('should return true if charCode is a kana character', function () {
+      const kanaCode = 'て'.charCodeAt(0);
+      console.log(kanaCode);
+      expect(rcxDict.isKana(kanaCode)).to.be.true;
+    });
+    it('should return false if non kana character is searched', function () {
+      const nonKanaCode = 'Test'.charCodeAt(0);
+      expect(rcxDict.isKana(nonKanaCode)).to.be.false;
+    });
+  });
+  describe('convertToHiragana', function () {
+    it('should return hiragana character when passed half-width katakana', function () {
+      const kanaCode = 'ﾃｽﾄ'.charCodeAt(0);
+      console.log(kanaCode);
+      expect(rcxDict.isKana(kanaCode)).to.be.true;
+    });
+    it('should return hiragana character when passed full-width katakana', function () {
+      const nonKanaCode = 'Test'.charCodeAt(0);
+      expect(rcxDict.isKana(nonKanaCode)).to.be.false;
+    });
+    it('should do correct hiragana lookup when parsing voiced and semi-voiced half-width katakana', function () {
+      // const expected = 'ﾃﾞｯｽｸﾄｯﾌﾟ'
+      const expected = 'ﾎﾟｼﾞﾃｨﾌﾞ';
+      expect(rcxDict.convertToHiragana(expected)).to.equal('ぽじてぃぶ');
+    });
+  });
+
+  // describe('(makeHtmlForRuby)', function () {
+  //   it('should take a valid file url and return a response', function () {});
+  // });
+  // describe('(makeText)', function () {
+  //   it('should return a string of data when given a valid kanji entry', function () {});
+  //   it('should return and empty string when entry is null', function () {});
+  // });
 });