.

Author: ChristianOellers

tests/term-text-search.js

@@ -0,0 +1,8 @@
+class TermTextSearch {
+  constructor() {
+  }
+}
+
+
+module.exports = TermTextSearch;
+

tests/term-text-search.test.js

@@ -0,0 +1,73 @@
+/**
+ * 0. Definitions
+ *
+ * - Caret : Cursor position in text (numeric)
+ * - Term  : User input, any string value, can be empty
+ * - Token : Matched part of term (part left, part right)
+ * - Word  : Result (combined tokens, if any)
+ *
+ * ###
+ *
+ * 1. Decide tiny aspects and limitations: Business and data requirements,
+ * responsibilities and scope, domain specific feature needs.
+ *
+ * Required
+ * - Input data expectations + assumptions:
+ *   - All values are strings
+ *   - Term can be empty
+ *   - Multi-byte support (= No RegEx for a-z possible)
+ *   - Arrow symbol constant value = '->'
+ * - Term = Standalone part of full text
+ *   - Boundary by whitespace before and/or after
+ *   - No whitespace boundary if first + only part in full text
+ * - Minimum term length to find = 1
+ * - Get term if caret is ...
+ *   - In the middle of a term (any position within)
+ *   - At the end / after a term (last character)
+ *
+ * Optional
+ * - Get term if caret is at term start / before term
+ *
+ * Excluded / Boundaries
+ * - No other data types except strings supported
+ * - Case does not matter (no need to check here)
+ *
+ * ###
+ *
+ * 2. Define input/output of aspects (data types, structures, results)
+ * 3. Define function signatures (parameters, variants)
+ *
+ * Pseudo-type annotations similar to TypeScript/Flow:
+ * - constructor()
+ * - getWordAtCaretPosition(string text, uint caretPosition): string
+ *
+ * ###
+ *
+ * 4. Define edge test cases for tiny aspects (including misuse and expected fails).
+ * For sake of simplicity, no other data types have been considered here.
+ *
+ * - --------- : ----- : ------------------------------------
+ * - Expect    : Text  : Caret position | Reason
+ * - --------- : ----- : ------------------------------------
+ * - No result : ''    : *              | Empty
+ * - No result : ' '   : *              | Whitespace
+ * - No result : ' A ' : Before         | Whitespace
+ * - No result : ' A ' : After          | Whitespace
+ * - Result    : 'A'   : Before         | Match (right)
+ * - Result    : 'A'   : After          | Match (left)
+ * - Result    : 'AA'  : Inner          | Match (left + right)
+ * - ---------- : ---- : --------------------------------------
+ */
+const TermTextSearch = require('./term-text-search');
+
+const instance = new TermTextSearch();
+
+describe('xxx', () => {
+
+  test('', () => {
+    //const result = instance.search('');
+    //expect(result).toStrictEqual([]);
+  });
+
+});
+