Create basic data model.

* Can add and remove words and tags on words.

* Sorts the words by length and alphabetically.

* Capitalizes all words in the database.

Author: JTimothyKing

src/WordStore.js

@@ -0,0 +1,95 @@
+/**
+ * The data model for the Word Cookies Worksheet.
+ */
+class WordStore {
+    #wordsData = [];
+
+    _findWord(word) {
+        return this.#wordsData.find((W) => (W.word === word));
+    }
+
+    /**
+     * @typedef {Object} WordData a structure containing all the information about a word
+     * @property {string} word
+     * @property {string|number} [tag]
+     */
+
+    /**
+     * Gets the compiled list of word data.
+     *
+     * The words are sorted first by length and then alphabetically.
+     *
+     * @returns {WordData[]} sorted list of word structures
+     */
+    get words() {
+        return this.#wordsData.sort(
+            (a, b) =>
+                (a.word.length - b.word.length)
+                || (a.word.localeCompare(b.word))
+        );
+    }
+
+    /**
+     * Adds words to the list.
+     * @param {string} words
+     */
+    addWords(...words) {
+        for (let word of words) {
+            word = word.toLocaleUpperCase();
+            let data = this._findWord(word);
+            if (data === undefined) {
+                this.#wordsData.push({word});
+            }
+        }
+    }
+
+    /**
+     * Removes words from the list.
+     * @param {string} words
+     */
+    removeWords(...words) {
+        for (let word of words) {
+            word = word.toLocaleUpperCase();
+            this.#wordsData = this.#wordsData.filter((W) => (W.word !== word));
+        }
+    }
+
+    /**
+     * Tags a word.
+     *
+     * If the word does not yet exist in the database,
+     * it is added with the given tag attached.
+     *
+     * @param {string} word
+     * @param {string|number} tag
+     */
+    tagWord(word, tag) {
+        word = word.toLocaleUpperCase();
+        let data = this._findWord(word);
+        if (data === undefined) {
+            this.#wordsData.push({word, tag});
+        } else {
+            data.tag = tag;
+        }
+    }
+
+    /**
+     * Removes any tags from the given word.
+     *
+     * If the word does not yet exist in the database,
+     * it is added with no tag attached.
+     *
+     * @param {string} word
+     */
+    untagWord(word) {
+        word = word.toLocaleUpperCase();
+        let data = this._findWord(word);
+        if (data === undefined) {
+            this.addWords(word);
+        } else {
+            delete data.tag;
+        }
+    }
+}
+
+export default WordStore;

src/WordStore.test.js

@@ -0,0 +1,91 @@
+import WordStore from "./WordStore";
+
+
+function expectedWords(...wordList) {
+    return wordList
+        .map(word => ( (typeof word === 'object') ? word : {word} ));
+}
+
+
+test('new data model has no words', () => {
+    let wd = new WordStore();
+    expect(wd.words).toEqual([]);
+});
+
+test('add a word', () => {
+    let wd = new WordStore();
+    wd.addWords('ABC');
+    expect(wd.words).toEqual(expectedWords('ABC'));
+});
+
+test('add multiple words', () => {
+    let wd = new WordStore();
+    wd.addWords('ABC', 'DEF');
+    expect(wd.words).toEqual(expectedWords('ABC', 'DEF'));
+})
+
+test('add a duplicate word', () => {
+    let wd = new WordStore();
+    wd.addWords('ABC');
+    wd.addWords('ABC');
+    expect(wd.words).toEqual(expectedWords('ABC'));
+});
+
+test('words are sorted', () => {
+    let wd = new WordStore();
+    wd.addWords('QWERTY', 'ABC', 'UIOP', 'XYZ', 'DEF', 'FURBY');
+    expect(wd.words).toEqual(expectedWords('ABC', 'DEF', 'XYZ', 'UIOP', 'FURBY', 'QWERTY'));
+});
+
+test('remove a word', () => {
+    let wd = new WordStore();
+    wd.addWords('ABC', 'DEF');
+    wd.removeWords('ABC');
+    expect(wd.words).toEqual(expectedWords('DEF'));
+});
+
+test('remove multiple words', () => {
+    let wd = new WordStore();
+    wd.addWords('ABC', 'DEF', 'XYZ');
+    wd.removeWords('ABC', 'XYZ');
+    expect(wd.words).toEqual(expectedWords('DEF'));
+});
+
+test('tag a word', () => {
+    let wd = new WordStore();
+    wd.addWords('ABC');
+    wd.tagWord('ABC', 1);
+    expect(wd.words).toEqual(expectedWords({word: 'ABC', tag: 1}));
+});
+
+test('tag a new word', () => {
+    let wd = new WordStore();
+    wd.tagWord('ABC', 1);
+    expect(wd.words).toEqual(expectedWords({word: 'ABC', tag: 1}));
+});
+
+test('untag a word', () => {
+    let wd = new WordStore();
+    wd.tagWord('ABC', 1);
+    wd.untagWord('ABC');
+    expect(wd.words).toEqual(expectedWords('ABC'));
+});
+
+test('untag a new word', () => {
+    let wd = new WordStore();
+    wd.untagWord('ABC');
+    expect(wd.words).toEqual(expectedWords('ABC'));
+});
+
+test('words are capitalized in all operations', () => {
+    let wd = new WordStore();
+    wd.addWords('abc', 'def');
+    expect(wd.words).toEqual(expectedWords('ABC', 'DEF'));
+    wd.removeWords('def');
+    expect(wd.words).toEqual(expectedWords('ABC'));
+    wd.tagWord('abc', 1);
+    expect(wd.words).toEqual(expectedWords({word: 'ABC', tag: 1}));
+    wd.untagWord('abc');
+    expect(wd.words).toEqual(expectedWords('ABC'));
+});
+