From d594d49ea81e1b546b6e39b7f85f098d9dc6fc48 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Mon, 18 Dec 2023 04:53:48 -0500 Subject: Mock updates (#370) * Move DictionaryImporterMediaLoader mock * Move TemplateRendererProxy mock * Simplify mock * Remove ignore rule because it seems unused --- .gitignore | 1 - dev/translator-vm.js | 2 +- .../__mocks__/dictionary-importer-media-loader.js | 25 --------- .../templates/__mocks__/template-renderer-proxy.js | 63 ---------------------- test/anki-note-builder.test.js | 2 +- test/database.test.js | 4 +- test/mocks/dictionary-importer-media-loader.js | 25 +++++++++ test/mocks/template-renderer-proxy.js | 63 ++++++++++++++++++++++ 8 files changed, 91 insertions(+), 94 deletions(-) delete mode 100644 ext/js/language/__mocks__/dictionary-importer-media-loader.js delete mode 100644 ext/js/templates/__mocks__/template-renderer-proxy.js create mode 100644 test/mocks/dictionary-importer-media-loader.js create mode 100644 test/mocks/template-renderer-proxy.js diff --git a/.gitignore b/.gitignore index 3941db60..459af2b7 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,5 @@ dictionaries/ ext/manifest.json ext/lib/* -!ext/lib/__mocks__/ ext/legal-npm.html diff --git a/dev/translator-vm.js b/dev/translator-vm.js index 7fdda879..60777da0 100644 --- a/dev/translator-vm.js +++ b/dev/translator-vm.js @@ -28,7 +28,7 @@ import {JapaneseUtil} from '../ext/js/language/sandbox/japanese-util.js'; import {Translator} from '../ext/js/language/translator.js'; import {createDictionaryArchive} from './util.js'; -vi.mock('../ext/js/language/dictionary-importer-media-loader.js'); +vi.mock('../ext/js/language/dictionary-importer-media-loader.js', async () => await import('../test/mocks/dictionary-importer-media-loader.js')); const dirname = path.dirname(fileURLToPath(import.meta.url)); diff --git a/ext/js/language/__mocks__/dictionary-importer-media-loader.js b/ext/js/language/__mocks__/dictionary-importer-media-loader.js deleted file mode 100644 index ffda29b3..00000000 --- a/ext/js/language/__mocks__/dictionary-importer-media-loader.js +++ /dev/null @@ -1,25 +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 . - */ - -export class DictionaryImporterMediaLoader { - /** @type {import('dictionary-importer-media-loader').GetImageDetailsFunction} */ - async getImageDetails(content) { - // Placeholder values - return {content, width: 100, height: 100}; - } -} diff --git a/ext/js/templates/__mocks__/template-renderer-proxy.js b/ext/js/templates/__mocks__/template-renderer-proxy.js deleted file mode 100644 index 8823e8f3..00000000 --- a/ext/js/templates/__mocks__/template-renderer-proxy.js +++ /dev/null @@ -1,63 +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 . - */ - -import {AnkiTemplateRenderer} from '../sandbox/anki-template-renderer.js'; - -export class TemplateRendererProxy { - constructor() { - /** @type {?Promise} */ - this._preparePromise = null; - /** @type {AnkiTemplateRenderer} */ - this._ankiTemplateRenderer = new AnkiTemplateRenderer(); - } - - /** - * @param {string} template - * @param {import('template-renderer').PartialOrCompositeRenderData} data - * @param {import('anki-templates').RenderMode} type - * @returns {Promise} - */ - async render(template, data, type) { - await this._prepare(); - return this._ankiTemplateRenderer.templateRenderer.render(template, data, type); - } - - /** - * @param {import('template-renderer').RenderMultiItem[]} items - * @returns {Promise[]>} - */ - async renderMulti(items) { - await this._prepare(); - return this._ankiTemplateRenderer.templateRenderer.renderMulti(items); - } - - /** - * @returns {Promise} - */ - _prepare() { - if (this._preparePromise === null) { - this._preparePromise = this._prepareInternal(); - } - return this._preparePromise; - } - - /** */ - async _prepareInternal() { - await this._ankiTemplateRenderer.prepare(); - } -} diff --git a/test/anki-note-builder.test.js b/test/anki-note-builder.test.js index 6901dde9..42ee2290 100644 --- a/test/anki-note-builder.test.js +++ b/test/anki-note-builder.test.js @@ -53,7 +53,7 @@ async function fetch(url2) { }; } vi.stubGlobal('fetch', fetch); -vi.mock('../ext/js/templates/template-renderer-proxy.js'); +vi.mock('../ext/js/templates/template-renderer-proxy.js', async () => await import('../test/mocks/template-renderer-proxy.js')); /** * @returns {Promise} diff --git a/test/database.test.js b/test/database.test.js index e7774d95..2fdea99c 100644 --- a/test/database.test.js +++ b/test/database.test.js @@ -22,15 +22,13 @@ import path from 'path'; import {beforeEach, describe, expect, test, vi} from 'vitest'; import {createDictionaryArchive} from '../dev/util.js'; import {DictionaryDatabase} from '../ext/js/language/dictionary-database.js'; -import {DictionaryImporterMediaLoader} from '../ext/js/language/dictionary-importer-media-loader.js'; import {DictionaryImporter} from '../ext/js/language/dictionary-importer.js'; +import {DictionaryImporterMediaLoader} from './mocks/dictionary-importer-media-loader.js'; const dirname = path.dirname(fileURLToPath(import.meta.url)); vi.stubGlobal('IDBKeyRange', IDBKeyRange); -vi.mock('../ext/js/language/dictionary-importer-media-loader.js'); - /** * @param {string} dictionary * @param {string} [dictionaryName] diff --git a/test/mocks/dictionary-importer-media-loader.js b/test/mocks/dictionary-importer-media-loader.js new file mode 100644 index 00000000..ffda29b3 --- /dev/null +++ b/test/mocks/dictionary-importer-media-loader.js @@ -0,0 +1,25 @@ +/* + * 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 . + */ + +export class DictionaryImporterMediaLoader { + /** @type {import('dictionary-importer-media-loader').GetImageDetailsFunction} */ + async getImageDetails(content) { + // Placeholder values + return {content, width: 100, height: 100}; + } +} diff --git a/test/mocks/template-renderer-proxy.js b/test/mocks/template-renderer-proxy.js new file mode 100644 index 00000000..106cdb35 --- /dev/null +++ b/test/mocks/template-renderer-proxy.js @@ -0,0 +1,63 @@ +/* + * 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 . + */ + +import {AnkiTemplateRenderer} from '../../ext/js/templates/sandbox/anki-template-renderer.js'; + +export class TemplateRendererProxy { + constructor() { + /** @type {?Promise} */ + this._preparePromise = null; + /** @type {AnkiTemplateRenderer} */ + this._ankiTemplateRenderer = new AnkiTemplateRenderer(); + } + + /** + * @param {string} template + * @param {import('template-renderer').PartialOrCompositeRenderData} data + * @param {import('anki-templates').RenderMode} type + * @returns {Promise} + */ + async render(template, data, type) { + await this._prepare(); + return this._ankiTemplateRenderer.templateRenderer.render(template, data, type); + } + + /** + * @param {import('template-renderer').RenderMultiItem[]} items + * @returns {Promise[]>} + */ + async renderMulti(items) { + await this._prepare(); + return this._ankiTemplateRenderer.templateRenderer.renderMulti(items); + } + + /** + * @returns {Promise} + */ + _prepare() { + if (this._preparePromise === null) { + this._preparePromise = this._prepareInternal(); + } + return this._preparePromise; + } + + /** */ + async _prepareInternal() { + await this._ankiTemplateRenderer.prepare(); + } +} -- cgit v1.2.3