aboutsummaryrefslogtreecommitdiff
path: root/test/anki-note-builder.test.js
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2023-12-22 07:52:33 -0500
committerGitHub <noreply@github.com>2023-12-22 12:52:33 +0000
commit11d2b933be3f775fe1723a4a60452635b0aa6cfd (patch)
tree031d891983271e16ee3d662e02a27cb0f9e1cef4 /test/anki-note-builder.test.js
parentab847b124d418b13037b59f446b288ff435e66a4 (diff)
Dictionary data tests + write mode (#415)
* Rename test * Refactor * Create new dictionary-data.test.js * Move utility functions * Remove old tests * Slight refactor * Add command to rebuild test data * Clarify name * Don't expect in write mode * Ignore config file
Diffstat (limited to 'test/anki-note-builder.test.js')
-rw-r--r--test/anki-note-builder.test.js215
1 files changed, 0 insertions, 215 deletions
diff --git a/test/anki-note-builder.test.js b/test/anki-note-builder.test.js
deleted file mode 100644
index 35db5107..00000000
--- a/test/anki-note-builder.test.js
+++ /dev/null
@@ -1,215 +0,0 @@
-/*
- * Copyright (C) 2023 Yomitan Authors
- * Copyright (C) 2021-2022 Yomichan Authors
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-
-// @vitest-environment jsdom
-
-import {readFileSync} from 'fs';
-import {fileURLToPath} from 'node:url';
-import path from 'path';
-import {describe} from 'vitest';
-import {parseJson} from '../dev/json.js';
-import {AnkiNoteBuilder} from '../ext/js/data/anki-note-builder.js';
-import {JapaneseUtil} from '../ext/js/language/sandbox/japanese-util.js';
-import {AnkiTemplateRenderer} from '../ext/js/templates/sandbox/anki-template-renderer.js';
-import {createTranslatorTest} from './fixtures/translator-test.js';
-import {createFindOptions} from './utilities/translator.js';
-
-const dirname = path.dirname(fileURLToPath(import.meta.url));
-
-/**
- * @param {'terms'|'kanji'} type
- * @returns {string[]}
- */
-function getFieldMarkers(type) {
- switch (type) {
- case 'terms':
- return [
- 'audio',
- 'clipboard-image',
- 'clipboard-text',
- 'cloze-body',
- 'cloze-prefix',
- 'cloze-suffix',
- 'conjugation',
- 'dictionary',
- 'document-title',
- 'expression',
- 'frequencies',
- 'furigana',
- 'furigana-plain',
- 'glossary',
- 'glossary-brief',
- 'glossary-no-dictionary',
- 'part-of-speech',
- 'pitch-accents',
- 'pitch-accent-graphs',
- 'pitch-accent-positions',
- 'reading',
- 'screenshot',
- 'search-query',
- 'selection-text',
- 'sentence',
- 'sentence-furigana',
- 'tags',
- 'url'
- ];
- case 'kanji':
- return [
- 'character',
- 'clipboard-image',
- 'clipboard-text',
- 'cloze-body',
- 'cloze-prefix',
- 'cloze-suffix',
- 'dictionary',
- 'document-title',
- 'glossary',
- 'kunyomi',
- 'onyomi',
- 'screenshot',
- 'search-query',
- 'selection-text',
- 'sentence',
- 'sentence-furigana',
- 'stroke-count',
- 'tags',
- 'url'
- ];
- default:
- return [];
- }
-}
-
-/**
- * @param {import('dictionary').DictionaryEntry[]} dictionaryEntries
- * @param {'terms'|'kanji'} type
- * @param {import('settings').ResultOutputMode} mode
- * @param {string} template
- * @param {import('vitest').ExpectStatic} expect
- * @returns {Promise<import('anki').NoteFields[]>}
- */
-async function getRenderResults(dictionaryEntries, type, mode, template, expect) {
- const markers = getFieldMarkers(type);
- /** @type {import('anki-note-builder').Field[]} */
- const fields = [];
- for (const marker of markers) {
- fields.push([marker, `{${marker}}`]);
- }
-
- const ankiTemplateRenderer = new AnkiTemplateRenderer();
- await ankiTemplateRenderer.prepare();
- const japaneseUtil = new JapaneseUtil(null);
- const clozePrefix = 'cloze-prefix';
- const clozeSuffix = 'cloze-suffix';
- const results = [];
- for (const dictionaryEntry of dictionaryEntries) {
- let source = '';
- switch (dictionaryEntry.type) {
- case 'kanji':
- source = dictionaryEntry.character;
- break;
- case 'term':
- if (dictionaryEntry.headwords.length > 0 && dictionaryEntry.headwords[0].sources.length > 0) {
- source = dictionaryEntry.headwords[0].sources[0].originalText;
- }
- break;
- }
- const ankiNoteBuilder = new AnkiNoteBuilder(japaneseUtil, ankiTemplateRenderer.templateRenderer);
- const context = {
- url: 'url:',
- sentence: {
- text: `${clozePrefix}${source}${clozeSuffix}`,
- offset: clozePrefix.length
- },
- documentTitle: 'title',
- query: 'query',
- fullQuery: 'fullQuery'
- };
- /** @type {import('anki-note-builder').CreateNoteDetails} */
- const details = {
- dictionaryEntry,
- mode: 'test',
- context,
- template,
- deckName: 'deckName',
- modelName: 'modelName',
- fields,
- tags: ['yomitan'],
- checkForDuplicates: true,
- duplicateScope: 'collection',
- duplicateScopeCheckAllModels: false,
- resultOutputMode: mode,
- glossaryLayoutMode: 'default',
- compactTags: false,
- requirements: [],
- mediaOptions: null
- };
- const {note: {fields: noteFields}, errors} = await ankiNoteBuilder.createNote(details);
- for (const error of errors) {
- console.error(error);
- }
- expect(errors.length).toStrictEqual(0);
- results.push(noteFields);
- }
-
- return results;
-}
-
-
-const testInputsFilePath = path.join(dirname, 'data/translator-test-inputs.json');
-/** @type {import('test/translator').TranslatorTestInputs} */
-const {optionsPresets, tests} = parseJson(readFileSync(testInputsFilePath, {encoding: 'utf8'}));
-
-const testResults1FilePath = path.join(dirname, 'data/anki-note-builder-test-results.json');
-/** @type {import('test/translator').AnkiNoteBuilderTestResults} */
-const expectedResults1 = parseJson(readFileSync(testResults1FilePath, {encoding: 'utf8'}));
-
-const template = readFileSync(path.join(dirname, '../ext/data/templates/default-anki-field-templates.handlebars'), {encoding: 'utf8'});
-
-const dictionaryName = 'Test Dictionary 2';
-const test = await createTranslatorTest(void 0, path.join(dirname, 'data/dictionaries/valid-dictionary1'), dictionaryName);
-
-describe('AnkiNoteBuilder', () => {
- const testData = tests.map((data, i) => ({data, expected1: expectedResults1[i]}));
- describe.each(testData)('Test %#: $data.name', ({data, expected1}) => {
- test('Test', async ({expect, translator}) => {
- switch (data.func) {
- case 'findTerms':
- {
- const {mode, text} = data;
- /** @type {import('translation').FindTermsOptions} */
- const options = createFindOptions(dictionaryName, optionsPresets, data.options);
- const {dictionaryEntries} = await translator.findTerms(mode, text, options);
- const results = mode !== 'simple' ? await getRenderResults(dictionaryEntries, 'terms', mode, template, expect) : null;
- expect(results).toStrictEqual(expected1.results);
- }
- break;
- case 'findKanji':
- {
- const {text} = data;
- /** @type {import('translation').FindKanjiOptions} */
- const options = createFindOptions(dictionaryName, optionsPresets, data.options);
- const dictionaryEntries = await translator.findKanji(text, options);
- const results = await getRenderResults(dictionaryEntries, 'kanji', 'split', template, expect);
- expect(results).toStrictEqual(expected1.results);
- }
- break;
- }
- });
- });
-});