Something went wrong. Try again.
Pop-up dictionary browser extension for language learning. Successor to Yomichan. (PERSONAL FORK)
Something went wrong. Try again.
JavaScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292/* * Copyright (C) 2023-2025 Yomitan Authors * Copyright (C) 2020-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/>. */
import {fileURLToPath} from 'node:url';import path from 'path';import {afterAll, describe, expect, test} from 'vitest';import {parseJson} from '../dev/json.js';import {DOMTextScanner} from '../ext/js/dom/dom-text-scanner.js';import {TextSourceElement} from '../ext/js/dom/text-source-element.js';import {TextSourceGenerator} from '../ext/js/dom/text-source-generator.js';import {TextSourceRange} from '../ext/js/dom/text-source-range.js';import {setupDomTest} from './fixtures/dom-test.js';
const dirname = path.dirname(fileURLToPath(import.meta.url));
// DOMRect class definitionclass DOMRect { /** * @param {number} x * @param {number} y * @param {number} width * @param {number} height */ constructor(x, y, width, height) { /** @type {number} */ this._x = x; /** @type {number} */ this._y = y; /** @type {number} */ this._width = width; /** @type {number} */ this._height = height; }
/** @type {number} */ get x() { return this._x; } /** @type {number} */ get y() { return this._y; } /** @type {number} */ get width() { return this._width; } /** @type {number} */ get height() { return this._height; } /** @type {number} */ get left() { return this._x + Math.min(0, this._width); } /** @type {number} */ get right() { return this._x + Math.max(0, this._width); } /** @type {number} */ get top() { return this._y + Math.min(0, this._height); } /** @type {number} */ get bottom() { return this._y + Math.max(0, this._height); } /** @returns {string} */ toJSON() { return '<not implemented>'; }}
/** * @param {Element} element * @param {string|undefined} selector * @returns {?Element} */function querySelectorChildOrSelf(element, selector) { return selector ? element.querySelector(selector) : element;}
/** * @param {import('jsdom').DOMWindow} window * @param {?Node} node * @returns {?Text|Node} */function getChildTextNodeOrSelf(window, node) { if (node === null) { return null; } const Node = window.Node; const childNode = node.firstChild; return (childNode !== null && childNode.nodeType === Node.TEXT_NODE ? childNode : node);}
/** * @param {unknown} value * @returns {unknown} */function getPrototypeOfOrNull(value) { try { return Object.getPrototypeOf(value); } catch (e) { return null; }}
/** * @param {Document} document * @returns {?Element} */function findImposterElement(document) { // Finds the imposter element based on it's z-index style return document.querySelector('div[style*="2147483646"]>*');}
const documentUtilTestEnv = await setupDomTest(path.join(dirname, 'data/html/document-util.html'));
describe('Document utility tests', () => { const {window, teardown} = documentUtilTestEnv; afterAll(() => teardown(global));
describe('DocumentUtil', () => { describe('Text scanning functions', () => { let testIndex = 0; const {document} = window; for (const testElement of /** @type {NodeListOf<HTMLElement>} */ (document.querySelectorAll('test-case[data-test-type=scan]'))) { test(`test-case-${testIndex++}`, () => { // Get test parameters /** @type {import('test/document-util').DocumentUtilTestData} */ const { elementFromPointSelector, caretRangeFromPointSelector, startNodeSelector, startOffset, endNodeSelector, endOffset, resultType, sentenceScanExtent, sentence, hasImposter, terminateAtNewlines, } = parseJson(/** @type {string} */ (testElement.dataset.testData));
const elementFromPointValue = querySelectorChildOrSelf(testElement, elementFromPointSelector); const caretRangeFromPointValue = querySelectorChildOrSelf(testElement, caretRangeFromPointSelector); const startNode = getChildTextNodeOrSelf(window, querySelectorChildOrSelf(testElement, startNodeSelector)); const endNode = getChildTextNodeOrSelf(window, querySelectorChildOrSelf(testElement, endNodeSelector));
// Defaults to true const terminateAtNewlines2 = typeof terminateAtNewlines === 'boolean' ? terminateAtNewlines : true;
expect(elementFromPointValue).not.toStrictEqual(null); expect(caretRangeFromPointValue).not.toStrictEqual(null); expect(startNode).not.toStrictEqual(null); expect(endNode).not.toStrictEqual(null);
// Setup functions document.elementFromPoint = () => elementFromPointValue;
document.caretRangeFromPoint = (x, y) => { const imposter = getChildTextNodeOrSelf(window, findImposterElement(document)); expect(!!imposter).toStrictEqual(!!hasImposter);
const range = document.createRange(); range.setStart(/** @type {Node} */ (imposter ?? startNode), startOffset); range.setEnd(/** @type {Node} */ (imposter ?? startNode), endOffset);
// Override getClientRects to return a rect guaranteed to contain (x, y) range.getClientRects = () => { /** @type {import('test/document-types').PseudoDOMRectList} */ // eslint-disable-next-line sonarjs/prefer-immediate-return const domRectList = Object.assign( [new DOMRect(x - 1, y - 1, 2, 2)], { /** * @this {DOMRect[]} * @param {number} index * @returns {DOMRect} */ item: function item(index) { return this[index]; }, }, ); return domRectList; }; return range; };
// Test docRangeFromPoint const textSourceGenerator = new TextSourceGenerator(); const source = textSourceGenerator.getRangeFromPoint(0, 0, { deepContentScan: false, normalizeCssZoom: true, language: null, }); switch (resultType) { case 'TextSourceRange': expect(getPrototypeOfOrNull(source)).toStrictEqual(TextSourceRange.prototype); break; case 'TextSourceElement': expect(getPrototypeOfOrNull(source)).toStrictEqual(TextSourceElement.prototype); break; case 'null': expect(source).toStrictEqual(null); break; default: expect.unreachable(); break; } if (source === null) { return; }
// Sentence info const terminatorString = '…。．.？?！!'; /** @type {import('text-scanner').SentenceTerminatorMap} */ const terminatorMap = new Map(); for (const char of terminatorString) { terminatorMap.set(char, [false, true]); } const quoteArray = [['「', '」'], ['『', '』'], ['\'', '\''], ['"', '"']]; /** @type {import('text-scanner').SentenceForwardQuoteMap} */ const forwardQuoteMap = new Map(); /** @type {import('text-scanner').SentenceBackwardQuoteMap} */ const backwardQuoteMap = new Map(); for (const [char1, char2] of quoteArray) { forwardQuoteMap.set(char1, [char2, false]); backwardQuoteMap.set(char2, [char1, false]); }
// Test docSentenceExtract const sentenceActual = textSourceGenerator.extractSentence( source, false, sentenceScanExtent, terminateAtNewlines2, terminatorMap, forwardQuoteMap, backwardQuoteMap, ).text; expect(sentenceActual).toStrictEqual(sentence);
// Clean source.cleanup(); }); } }); });
describe('DOMTextScanner', () => { describe('Seek functions', () => { let testIndex = 0; const {document} = window; for (const testElement of /** @type {NodeListOf<HTMLElement>} */ (document.querySelectorAll('test-case[data-test-type=text-source-range-seek]'))) { test(`test-case-${testIndex++}`, () => { // Get test parameters /** @type {import('test/document-util').DOMTextScannerTestData} */ const { seekNodeSelector, seekNodeIsText, seekOffset, seekLength, seekDirection, expectedResultNodeSelector, expectedResultNodeIsText, expectedResultOffset, expectedResultContent, } = parseJson(/** @type {string} */ (testElement.dataset.testData));
/** @type {?Node} */ let seekNode = testElement.querySelector(/** @type {string} */ (seekNodeSelector)); if (seekNodeIsText && seekNode !== null) { seekNode = seekNode.firstChild; }
const expectedResultContent2 = expectedResultContent.join('\n');
/** @type {?Node} */ let expectedResultNode = testElement.querySelector(/** @type {string} */ (expectedResultNodeSelector)); if (expectedResultNodeIsText && expectedResultNode !== null) { expectedResultNode = expectedResultNode.firstChild; }
const {node, offset, content} = ( seekDirection === 'forward' ? new DOMTextScanner(/** @type {Node} */ (seekNode), seekOffset, true, false).seek(seekLength) : new DOMTextScanner(/** @type {Node} */ (seekNode), seekOffset, true, false).seek(-seekLength) );
expect(node).toStrictEqual(expectedResultNode); expect(offset).toStrictEqual(expectedResultOffset); expect(content).toStrictEqual(expectedResultContent2); }); } }); });});