Refactor anki field templates (#1323)
* Update glossary and glossary-single * Define patch * Create TemplatePatcher * Add test
This commit is contained in:
parent
ed0c0c20c0
commit
e610a62ceb
@ -179,6 +179,7 @@
|
|||||||
"ext/bg/js/profile-conditions.js",
|
"ext/bg/js/profile-conditions.js",
|
||||||
"ext/bg/js/request-builder.js",
|
"ext/bg/js/request-builder.js",
|
||||||
"ext/bg/js/simple-dom-parser.js",
|
"ext/bg/js/simple-dom-parser.js",
|
||||||
|
"ext/bg/js/template-patcher.js",
|
||||||
"ext/bg/js/text-source-map.js",
|
"ext/bg/js/text-source-map.js",
|
||||||
"ext/bg/js/translator.js",
|
"ext/bg/js/translator.js",
|
||||||
"ext/bg/js/backend.js",
|
"ext/bg/js/backend.js",
|
||||||
|
@ -40,6 +40,7 @@
|
|||||||
<script src="/bg/js/profile-conditions.js"></script>
|
<script src="/bg/js/profile-conditions.js"></script>
|
||||||
<script src="/bg/js/request-builder.js"></script>
|
<script src="/bg/js/request-builder.js"></script>
|
||||||
<script src="/bg/js/native-simple-dom-parser.js"></script>
|
<script src="/bg/js/native-simple-dom-parser.js"></script>
|
||||||
|
<script src="/bg/js/template-patcher.js"></script>
|
||||||
<script src="/bg/js/text-source-map.js"></script>
|
<script src="/bg/js/text-source-map.js"></script>
|
||||||
<script src="/bg/js/translator.js"></script>
|
<script src="/bg/js/translator.js"></script>
|
||||||
|
|
||||||
|
@ -12,3 +12,108 @@
|
|||||||
{{~/if~}}
|
{{~/if~}}
|
||||||
{{~/scope~}}
|
{{~/scope~}}
|
||||||
{{/inline}}
|
{{/inline}}
|
||||||
|
|
||||||
|
{{<<<<<<<}}
|
||||||
|
{{#*inline "glossary-single"}}
|
||||||
|
{{~#unless brief~}}
|
||||||
|
{{~#scope~}}
|
||||||
|
{{~#set "any" false}}{{/set~}}
|
||||||
|
{{~#if definitionTags~}}{{#each definitionTags~}}
|
||||||
|
{{~#if (op "||" (op "!" ../data.compactTags) (op "!" redundant))~}}
|
||||||
|
{{~#if (get "any")}}, {{else}}<i>({{/if~}}
|
||||||
|
{{name}}
|
||||||
|
{{~#set "any" true}}{{/set~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/each~}}
|
||||||
|
{{~#if (get "any")}})</i> {{/if~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/scope~}}
|
||||||
|
{{~#if only~}}({{#each only}}{{{.}}}{{#unless @last}}, {{/unless}}{{/each}} only) {{/if~}}
|
||||||
|
{{~/unless~}}
|
||||||
|
{{~#if glossary.[1]~}}
|
||||||
|
{{~#if compactGlossaries~}}
|
||||||
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{#unless @last}} | {{/unless}}{{/each}}
|
||||||
|
{{~else~}}
|
||||||
|
<ul>{{#each glossary}}<li>{{#multiLine}}{{.}}{{/multiLine}}</li>{{/each}}</ul>
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else~}}
|
||||||
|
{{~#multiLine}}{{glossary.[0]}}{{/multiLine~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{/inline}}
|
||||||
|
{{=======}}
|
||||||
|
{{#*inline "glossary-single"}}
|
||||||
|
{{~#unless brief~}}
|
||||||
|
{{~#scope~}}
|
||||||
|
{{~#set "any" false}}{{/set~}}
|
||||||
|
{{~#each definitionTags~}}
|
||||||
|
{{~#if (op "||" (op "!" @root.compactTags) (op "!" redundant))~}}
|
||||||
|
{{~#if (get "any")}}, {{else}}<i>({{/if~}}
|
||||||
|
{{name}}
|
||||||
|
{{~#set "any" true}}{{/set~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/each~}}
|
||||||
|
{{~#if (get "any")}})</i> {{/if~}}
|
||||||
|
{{~/scope~}}
|
||||||
|
{{~#if only~}}({{#each only}}{{.}}{{#unless @last}}, {{/unless}}{{/each}} only) {{/if~}}
|
||||||
|
{{~/unless~}}
|
||||||
|
{{~#if (op "<=" glossary.length 1)~}}
|
||||||
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{/each}}
|
||||||
|
{{~else if @root.compactGlossaries~}}
|
||||||
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{#unless @last}} | {{/unless}}{{/each}}
|
||||||
|
{{~else~}}
|
||||||
|
<ul>{{#each glossary}}<li>{{#multiLine}}{{.}}{{/multiLine}}</li>{{/each}}</ul>
|
||||||
|
{{~/if~}}
|
||||||
|
{{/inline}}
|
||||||
|
{{>>>>>>>}}
|
||||||
|
|
||||||
|
{{<<<<<<<}}
|
||||||
|
{{#*inline "glossary"}}
|
||||||
|
<div style="text-align: left;">
|
||||||
|
{{~#if modeKanji~}}
|
||||||
|
{{~#if definition.glossary.[1]~}}
|
||||||
|
<ol>{{#each definition.glossary}}<li>{{.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{definition.glossary.[0]}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else~}}
|
||||||
|
{{~#if group~}}
|
||||||
|
{{~#if definition.definitions.[1]~}}
|
||||||
|
<ol>{{#each definition.definitions}}<li>{{> glossary-single brief=../brief compactGlossaries=../compactGlossaries data=../.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~> glossary-single definition.definitions.[0] brief=brief compactGlossaries=compactGlossaries data=.~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else if merge~}}
|
||||||
|
{{~#if definition.definitions.[1]~}}
|
||||||
|
<ol>{{#each definition.definitions}}<li>{{> glossary-single brief=../brief compactGlossaries=../compactGlossaries data=../.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~> glossary-single definition.definitions.[0] brief=brief compactGlossaries=compactGlossaries data=.~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else~}}
|
||||||
|
{{~> glossary-single definition brief=brief compactGlossaries=compactGlossaries data=.~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/if~}}
|
||||||
|
</div>
|
||||||
|
{{/inline}}
|
||||||
|
{{=======}}
|
||||||
|
{{~#*inline "glossary"~}}
|
||||||
|
<div style="text-align: left;">
|
||||||
|
{{~#scope~}}
|
||||||
|
{{~#if (op "===" definition.type "term")~}}
|
||||||
|
{{~> glossary-single definition brief=brief ~}}
|
||||||
|
{{~else if (op "||" (op "===" definition.type "termGrouped") (op "===" definition.type "termMerged"))~}}
|
||||||
|
{{~#if (op ">" definition.definitions.length 1)~}}
|
||||||
|
<ol>{{~#each definition.definitions~}}<li>{{~> glossary-single . brief=../brief ~}}</li>{{~/each~}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~#each definition.definitions~}}{{~> glossary-single . brief=../brief ~}}{{~/each~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else if (op "===" definition.type "kanji")~}}
|
||||||
|
{{~#if (op ">" definition.glossary.length 1)~}}
|
||||||
|
<ol>{{#each definition.glossary}}<li>{{.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~#each definition.glossary~}}{{.}}{{~/each~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/scope~}}
|
||||||
|
</div>
|
||||||
|
{{~/inline~}}
|
||||||
|
{{>>>>>>>}}
|
||||||
|
@ -2,26 +2,23 @@
|
|||||||
{{~#unless brief~}}
|
{{~#unless brief~}}
|
||||||
{{~#scope~}}
|
{{~#scope~}}
|
||||||
{{~#set "any" false}}{{/set~}}
|
{{~#set "any" false}}{{/set~}}
|
||||||
{{~#if definitionTags~}}{{#each definitionTags~}}
|
{{~#each definitionTags~}}
|
||||||
{{~#if (op "||" (op "!" ../data.compactTags) (op "!" redundant))~}}
|
{{~#if (op "||" (op "!" @root.compactTags) (op "!" redundant))~}}
|
||||||
{{~#if (get "any")}}, {{else}}<i>({{/if~}}
|
{{~#if (get "any")}}, {{else}}<i>({{/if~}}
|
||||||
{{name}}
|
{{name}}
|
||||||
{{~#set "any" true}}{{/set~}}
|
{{~#set "any" true}}{{/set~}}
|
||||||
{{~/if~}}
|
{{~/if~}}
|
||||||
{{~/each~}}
|
{{~/each~}}
|
||||||
{{~#if (get "any")}})</i> {{/if~}}
|
{{~#if (get "any")}})</i> {{/if~}}
|
||||||
{{~/if~}}
|
|
||||||
{{~/scope~}}
|
{{~/scope~}}
|
||||||
{{~#if only~}}({{#each only}}{{{.}}}{{#unless @last}}, {{/unless}}{{/each}} only) {{/if~}}
|
{{~#if only~}}({{#each only}}{{.}}{{#unless @last}}, {{/unless}}{{/each}} only) {{/if~}}
|
||||||
{{~/unless~}}
|
{{~/unless~}}
|
||||||
{{~#if glossary.[1]~}}
|
{{~#if (op "<=" glossary.length 1)~}}
|
||||||
{{~#if compactGlossaries~}}
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{/each}}
|
||||||
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{#unless @last}} | {{/unless}}{{/each}}
|
{{~else if @root.compactGlossaries~}}
|
||||||
{{~else~}}
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{#unless @last}} | {{/unless}}{{/each}}
|
||||||
<ul>{{#each glossary}}<li>{{#multiLine}}{{.}}{{/multiLine}}</li>{{/each}}</ul>
|
|
||||||
{{~/if~}}
|
|
||||||
{{~else~}}
|
{{~else~}}
|
||||||
{{~#multiLine}}{{glossary.[0]}}{{/multiLine~}}
|
<ul>{{#each glossary}}<li>{{#multiLine}}{{.}}{{/multiLine}}</li>{{/each}}</ul>
|
||||||
{{~/if~}}
|
{{~/if~}}
|
||||||
{{/inline}}
|
{{/inline}}
|
||||||
|
|
||||||
@ -92,33 +89,27 @@
|
|||||||
{{~/if~}}
|
{{~/if~}}
|
||||||
{{/inline}}
|
{{/inline}}
|
||||||
|
|
||||||
{{#*inline "glossary"}}
|
{{~#*inline "glossary"~}}
|
||||||
<div style="text-align: left;">
|
<div style="text-align: left;">
|
||||||
{{~#if modeKanji~}}
|
{{~#scope~}}
|
||||||
{{~#if definition.glossary.[1]~}}
|
{{~#if (op "===" definition.type "term")~}}
|
||||||
<ol>{{#each definition.glossary}}<li>{{.}}</li>{{/each}}</ol>
|
{{~> glossary-single definition brief=brief ~}}
|
||||||
{{~else~}}
|
{{~else if (op "||" (op "===" definition.type "termGrouped") (op "===" definition.type "termMerged"))~}}
|
||||||
{{definition.glossary.[0]}}
|
{{~#if (op ">" definition.definitions.length 1)~}}
|
||||||
{{~/if~}}
|
<ol>{{~#each definition.definitions~}}<li>{{~> glossary-single . brief=../brief ~}}</li>{{~/each~}}</ol>
|
||||||
{{~else~}}
|
|
||||||
{{~#if group~}}
|
|
||||||
{{~#if definition.definitions.[1]~}}
|
|
||||||
<ol>{{#each definition.definitions}}<li>{{> glossary-single brief=../brief compactGlossaries=../compactGlossaries data=../.}}</li>{{/each}}</ol>
|
|
||||||
{{~else~}}
|
{{~else~}}
|
||||||
{{~> glossary-single definition.definitions.[0] brief=brief compactGlossaries=compactGlossaries data=.~}}
|
{{~#each definition.definitions~}}{{~> glossary-single . brief=../brief ~}}{{~/each~}}
|
||||||
{{~/if~}}
|
{{~/if~}}
|
||||||
{{~else if merge~}}
|
{{~else if (op "===" definition.type "kanji")~}}
|
||||||
{{~#if definition.definitions.[1]~}}
|
{{~#if (op ">" definition.glossary.length 1)~}}
|
||||||
<ol>{{#each definition.definitions}}<li>{{> glossary-single brief=../brief compactGlossaries=../compactGlossaries data=../.}}</li>{{/each}}</ol>
|
<ol>{{#each definition.glossary}}<li>{{.}}</li>{{/each}}</ol>
|
||||||
{{~else~}}
|
{{~else~}}
|
||||||
{{~> glossary-single definition.definitions.[0] brief=brief compactGlossaries=compactGlossaries data=.~}}
|
{{~#each definition.glossary~}}{{.}}{{~/each~}}
|
||||||
{{~/if~}}
|
{{~/if~}}
|
||||||
{{~else~}}
|
|
||||||
{{~> glossary-single definition brief=brief compactGlossaries=compactGlossaries data=.~}}
|
|
||||||
{{~/if~}}
|
{{~/if~}}
|
||||||
{{~/if~}}
|
{{~/scope~}}
|
||||||
</div>
|
</div>
|
||||||
{{/inline}}
|
{{~/inline~}}
|
||||||
|
|
||||||
{{#*inline "glossary-brief"}}
|
{{#*inline "glossary-brief"}}
|
||||||
{{~> glossary brief=true ~}}
|
{{~> glossary brief=true ~}}
|
||||||
|
@ -17,11 +17,13 @@
|
|||||||
|
|
||||||
/* global
|
/* global
|
||||||
* JsonSchemaValidator
|
* JsonSchemaValidator
|
||||||
|
* TemplatePatcher
|
||||||
*/
|
*/
|
||||||
|
|
||||||
class OptionsUtil {
|
class OptionsUtil {
|
||||||
constructor() {
|
constructor() {
|
||||||
this._schemaValidator = new JsonSchemaValidator();
|
this._schemaValidator = new JsonSchemaValidator();
|
||||||
|
this._templatePatcher = null;
|
||||||
this._optionsSchema = null;
|
this._optionsSchema = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -381,32 +383,22 @@ class OptionsUtil {
|
|||||||
|
|
||||||
// Private
|
// Private
|
||||||
|
|
||||||
async _addFieldTemplatesToOptions(options, additionSourceUrl) {
|
async _applyAnkiFieldTemplatesPatch(options, modificationsUrl) {
|
||||||
let addition = null;
|
let patch = null;
|
||||||
for (const {options: profileOptions} of options.profiles) {
|
for (const {options: profileOptions} of options.profiles) {
|
||||||
const fieldTemplates = profileOptions.anki.fieldTemplates;
|
const fieldTemplates = profileOptions.anki.fieldTemplates;
|
||||||
if (fieldTemplates !== null) {
|
if (fieldTemplates === null) { continue; }
|
||||||
if (addition === null) {
|
|
||||||
addition = await this._fetchAsset(additionSourceUrl);
|
|
||||||
}
|
|
||||||
profileOptions.anki.fieldTemplates = this._addFieldTemplatesBeforeEnd(fieldTemplates, addition);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
_addFieldTemplatesBeforeEnd(fieldTemplates, addition) {
|
if (patch === null) {
|
||||||
const pattern = /[ \t]*\{\{~?>\s*\(\s*lookup\s*\.\s*"marker"\s*\)\s*~?\}\}/g;
|
const content = await this._fetchAsset(modificationsUrl);
|
||||||
const newline = '\n';
|
if (this._templatePatcher === null) {
|
||||||
let replaced = false;
|
this._templatePatcher = new TemplatePatcher();
|
||||||
fieldTemplates = fieldTemplates.replace(pattern, (g0) => {
|
}
|
||||||
replaced = true;
|
patch = this._templatePatcher.parsePatch(content);
|
||||||
return `${addition}${newline}${g0}`;
|
}
|
||||||
});
|
|
||||||
if (!replaced) {
|
profileOptions.anki.fieldTemplates = this._templatePatcher.applyPatch(fieldTemplates, patch);
|
||||||
fieldTemplates += newline;
|
|
||||||
fieldTemplates += addition;
|
|
||||||
}
|
}
|
||||||
return fieldTemplates;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async _fetchAsset(url, json=false) {
|
async _fetchAsset(url, json=false) {
|
||||||
@ -495,7 +487,7 @@ class OptionsUtil {
|
|||||||
async _updateVersion3(options) {
|
async _updateVersion3(options) {
|
||||||
// Version 3 changes:
|
// Version 3 changes:
|
||||||
// Pitch accent Anki field templates added.
|
// Pitch accent Anki field templates added.
|
||||||
await this._addFieldTemplatesToOptions(options, '/bg/data/anki-field-templates-upgrade-v2.handlebars');
|
await this._applyAnkiFieldTemplatesPatch(options, '/bg/data/anki-field-templates-upgrade-v2.handlebars');
|
||||||
return options;
|
return options;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -580,7 +572,7 @@ class OptionsUtil {
|
|||||||
});
|
});
|
||||||
profileOptions.scanning.inputs = scanningInputs;
|
profileOptions.scanning.inputs = scanningInputs;
|
||||||
}
|
}
|
||||||
await this._addFieldTemplatesToOptions(options, '/bg/data/anki-field-templates-upgrade-v4.handlebars');
|
await this._applyAnkiFieldTemplatesPatch(options, '/bg/data/anki-field-templates-upgrade-v4.handlebars');
|
||||||
return options;
|
return options;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -600,7 +592,7 @@ class OptionsUtil {
|
|||||||
// Added global option useSettingsV2.
|
// Added global option useSettingsV2.
|
||||||
// Added anki.checkForDuplicates.
|
// Added anki.checkForDuplicates.
|
||||||
// Added general.glossaryLayoutMode; removed general.compactGlossaries.
|
// Added general.glossaryLayoutMode; removed general.compactGlossaries.
|
||||||
await this._addFieldTemplatesToOptions(options, '/bg/data/anki-field-templates-upgrade-v6.handlebars');
|
await this._applyAnkiFieldTemplatesPatch(options, '/bg/data/anki-field-templates-upgrade-v6.handlebars');
|
||||||
options.global.showPopupPreview = false;
|
options.global.showPopupPreview = false;
|
||||||
options.global.useSettingsV2 = false;
|
options.global.useSettingsV2 = false;
|
||||||
for (const profile of options.profiles) {
|
for (const profile of options.profiles) {
|
||||||
@ -673,7 +665,7 @@ class OptionsUtil {
|
|||||||
// Moved general.enableClipboardMonitor => clipboard.enableSearchPageMonitor. Forced value to false due to a bug which caused its value to not be read.
|
// Moved general.enableClipboardMonitor => clipboard.enableSearchPageMonitor. Forced value to false due to a bug which caused its value to not be read.
|
||||||
// Moved general.maximumClipboardSearchLength => clipboard.maximumSearchLength.
|
// Moved general.maximumClipboardSearchLength => clipboard.maximumSearchLength.
|
||||||
// Added clipboard.autoSearchContent.
|
// Added clipboard.autoSearchContent.
|
||||||
await this._addFieldTemplatesToOptions(options, '/bg/data/anki-field-templates-upgrade-v8.handlebars');
|
await this._applyAnkiFieldTemplatesPatch(options, '/bg/data/anki-field-templates-upgrade-v8.handlebars');
|
||||||
options.global.useSettingsV2 = true;
|
options.global.useSettingsV2 = true;
|
||||||
for (const profile of options.profiles) {
|
for (const profile of options.profiles) {
|
||||||
profile.options.translation.textReplacements = {
|
profile.options.translation.textReplacements = {
|
||||||
|
92
ext/bg/js/template-patcher.js
Normal file
92
ext/bg/js/template-patcher.js
Normal file
@ -0,0 +1,92 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2021 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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
class TemplatePatcher {
|
||||||
|
constructor() {
|
||||||
|
this._diffPattern1 = /\n?\{\{<<<<<<<\}\}\n/g;
|
||||||
|
this._diffPattern2 = /\n\{\{=======\}\}\n/g;
|
||||||
|
this._diffPattern3 = /\n\{\{>>>>>>>\}\}\n*/g;
|
||||||
|
this._lookupMarkerPattern = /[ \t]*\{\{~?>\s*\(\s*lookup\s*\.\s*"marker"\s*\)\s*~?\}\}/g;
|
||||||
|
}
|
||||||
|
|
||||||
|
parsePatch(content) {
|
||||||
|
const diffPattern1 = this._diffPattern1;
|
||||||
|
const diffPattern2 = this._diffPattern2;
|
||||||
|
const diffPattern3 = this._diffPattern3;
|
||||||
|
const modifications = [];
|
||||||
|
let index = 0;
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
// Find modification boundaries
|
||||||
|
diffPattern1.lastIndex = index;
|
||||||
|
const m1 = diffPattern1.exec(content);
|
||||||
|
if (m1 === null) { break; }
|
||||||
|
|
||||||
|
diffPattern2.lastIndex = m1.index + m1[0].length;
|
||||||
|
const m2 = diffPattern2.exec(content);
|
||||||
|
if (m2 === null) { break; }
|
||||||
|
|
||||||
|
diffPattern3.lastIndex = m2.index + m2[0].length;
|
||||||
|
const m3 = diffPattern3.exec(content);
|
||||||
|
if (m3 === null) { break; }
|
||||||
|
|
||||||
|
// Construct
|
||||||
|
const current = content.substring(m1.index + m1[0].length, m2.index);
|
||||||
|
const replacement = content.substring(m2.index + m2[0].length, m3.index);
|
||||||
|
|
||||||
|
if (current.length > 0) {
|
||||||
|
modifications.push({current, replacement});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update
|
||||||
|
content = content.substring(0, m1.index) + content.substring(m3.index + m3[0].length);
|
||||||
|
index = m1.index;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {addition: content, modifications};
|
||||||
|
}
|
||||||
|
|
||||||
|
applyPatch(template, patch) {
|
||||||
|
for (const {current, replacement} of patch.modifications) {
|
||||||
|
let fromIndex = 0;
|
||||||
|
while (true) {
|
||||||
|
const index = template.indexOf(current, fromIndex);
|
||||||
|
if (index < 0) { break; }
|
||||||
|
template = template.substring(0, index) + replacement + template.substring(index + current.length);
|
||||||
|
fromIndex = index + replacement.length;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
template = this._addFieldTemplatesBeforeEnd(template, patch.addition);
|
||||||
|
return template;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Private
|
||||||
|
|
||||||
|
_addFieldTemplatesBeforeEnd(template, addition) {
|
||||||
|
const newline = '\n';
|
||||||
|
let replaced = false;
|
||||||
|
template = template.replace(this._lookupMarkerPattern, (g0) => {
|
||||||
|
replaced = true;
|
||||||
|
return `${addition}${newline}${g0}`;
|
||||||
|
});
|
||||||
|
if (!replaced) {
|
||||||
|
template += newline;
|
||||||
|
template += addition;
|
||||||
|
}
|
||||||
|
return template;
|
||||||
|
}
|
||||||
|
}
|
@ -1305,6 +1305,7 @@
|
|||||||
<script src="/bg/js/dictionary-importer.js"></script>
|
<script src="/bg/js/dictionary-importer.js"></script>
|
||||||
<script src="/bg/js/json-schema.js"></script>
|
<script src="/bg/js/json-schema.js"></script>
|
||||||
<script src="/bg/js/media-utility.js"></script>
|
<script src="/bg/js/media-utility.js"></script>
|
||||||
|
<script src="/bg/js/template-patcher.js"></script>
|
||||||
<script src="/bg/js/template-renderer-proxy.js"></script>
|
<script src="/bg/js/template-renderer-proxy.js"></script>
|
||||||
|
|
||||||
<script src="/bg/js/settings/keyboard-mouse-input-field.js"></script>
|
<script src="/bg/js/settings/keyboard-mouse-input-field.js"></script>
|
||||||
|
@ -3208,6 +3208,7 @@
|
|||||||
<script src="/bg/js/dictionary-importer.js"></script>
|
<script src="/bg/js/dictionary-importer.js"></script>
|
||||||
<script src="/bg/js/json-schema.js"></script>
|
<script src="/bg/js/json-schema.js"></script>
|
||||||
<script src="/bg/js/media-utility.js"></script>
|
<script src="/bg/js/media-utility.js"></script>
|
||||||
|
<script src="/bg/js/template-patcher.js"></script>
|
||||||
<script src="/bg/js/template-renderer-proxy.js"></script>
|
<script src="/bg/js/template-renderer-proxy.js"></script>
|
||||||
|
|
||||||
<script src="/bg/js/settings/keyboard-mouse-input-field.js"></script>
|
<script src="/bg/js/settings/keyboard-mouse-input-field.js"></script>
|
||||||
|
@ -39,6 +39,7 @@ self.importScripts(
|
|||||||
'/bg/js/profile-conditions.js',
|
'/bg/js/profile-conditions.js',
|
||||||
'/bg/js/request-builder.js',
|
'/bg/js/request-builder.js',
|
||||||
'/bg/js/simple-dom-parser.js',
|
'/bg/js/simple-dom-parser.js',
|
||||||
|
'/bg/js/template-patcher.js',
|
||||||
'/bg/js/text-source-map.js',
|
'/bg/js/text-source-map.js',
|
||||||
'/bg/js/translator.js',
|
'/bg/js/translator.js',
|
||||||
'/bg/js/backend.js',
|
'/bg/js/backend.js',
|
||||||
|
@ -50,6 +50,7 @@ function createVM(extDir) {
|
|||||||
'mixed/js/core.js',
|
'mixed/js/core.js',
|
||||||
'mixed/js/cache-map.js',
|
'mixed/js/cache-map.js',
|
||||||
'bg/js/json-schema.js',
|
'bg/js/json-schema.js',
|
||||||
|
'bg/js/template-patcher.js',
|
||||||
'bg/js/options.js'
|
'bg/js/options.js'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
@ -610,11 +611,15 @@ async function testDefault(extDir) {
|
|||||||
|
|
||||||
async function testFieldTemplatesUpdate(extDir) {
|
async function testFieldTemplatesUpdate(extDir) {
|
||||||
const vm = createVM(extDir);
|
const vm = createVM(extDir);
|
||||||
const [OptionsUtil] = vm.get(['OptionsUtil']);
|
const [OptionsUtil, TemplatePatcher] = vm.get(['OptionsUtil', 'TemplatePatcher']);
|
||||||
const optionsUtil = new OptionsUtil();
|
const optionsUtil = new OptionsUtil();
|
||||||
await optionsUtil.prepare();
|
await optionsUtil.prepare();
|
||||||
|
|
||||||
const loadDataFile = (fileName) => fs.readFileSync(path.join(extDir, fileName), {encoding: 'utf8'});
|
const templatePatcher = new TemplatePatcher();
|
||||||
|
const loadDataFile = (fileName) => {
|
||||||
|
const content = fs.readFileSync(path.join(extDir, fileName), {encoding: 'utf8'});
|
||||||
|
return templatePatcher.parsePatch(content).addition;
|
||||||
|
};
|
||||||
const update2 = loadDataFile('bg/data/anki-field-templates-upgrade-v2.handlebars');
|
const update2 = loadDataFile('bg/data/anki-field-templates-upgrade-v2.handlebars');
|
||||||
const update4 = loadDataFile('bg/data/anki-field-templates-upgrade-v4.handlebars');
|
const update4 = loadDataFile('bg/data/anki-field-templates-upgrade-v4.handlebars');
|
||||||
const update6 = loadDataFile('bg/data/anki-field-templates-upgrade-v6.handlebars');
|
const update6 = loadDataFile('bg/data/anki-field-templates-upgrade-v6.handlebars');
|
||||||
@ -746,12 +751,143 @@ ${update6}
|
|||||||
${update8}
|
${update8}
|
||||||
{{~> (lookup . "marker") ~}}
|
{{~> (lookup . "marker") ~}}
|
||||||
`.trimStart()
|
`.trimStart()
|
||||||
|
},
|
||||||
|
// glossary and glossary-brief update
|
||||||
|
{
|
||||||
|
oldVersion: 7,
|
||||||
|
old: `
|
||||||
|
{{#*inline "glossary-single"}}
|
||||||
|
{{~#unless brief~}}
|
||||||
|
{{~#scope~}}
|
||||||
|
{{~#set "any" false}}{{/set~}}
|
||||||
|
{{~#if definitionTags~}}{{#each definitionTags~}}
|
||||||
|
{{~#if (op "||" (op "!" ../data.compactTags) (op "!" redundant))~}}
|
||||||
|
{{~#if (get "any")}}, {{else}}<i>({{/if~}}
|
||||||
|
{{name}}
|
||||||
|
{{~#set "any" true}}{{/set~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/each~}}
|
||||||
|
{{~#if (get "any")}})</i> {{/if~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/scope~}}
|
||||||
|
{{~#if only~}}({{#each only}}{{{.}}}{{#unless @last}}, {{/unless}}{{/each}} only) {{/if~}}
|
||||||
|
{{~/unless~}}
|
||||||
|
{{~#if glossary.[1]~}}
|
||||||
|
{{~#if compactGlossaries~}}
|
||||||
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{#unless @last}} | {{/unless}}{{/each}}
|
||||||
|
{{~else~}}
|
||||||
|
<ul>{{#each glossary}}<li>{{#multiLine}}{{.}}{{/multiLine}}</li>{{/each}}</ul>
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else~}}
|
||||||
|
{{~#multiLine}}{{glossary.[0]}}{{/multiLine~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{/inline}}
|
||||||
|
|
||||||
|
{{#*inline "character"}}
|
||||||
|
{{~definition.character~}}
|
||||||
|
{{/inline}}
|
||||||
|
|
||||||
|
{{#*inline "glossary"}}
|
||||||
|
<div style="text-align: left;">
|
||||||
|
{{~#if modeKanji~}}
|
||||||
|
{{~#if definition.glossary.[1]~}}
|
||||||
|
<ol>{{#each definition.glossary}}<li>{{.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{definition.glossary.[0]}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else~}}
|
||||||
|
{{~#if group~}}
|
||||||
|
{{~#if definition.definitions.[1]~}}
|
||||||
|
<ol>{{#each definition.definitions}}<li>{{> glossary-single brief=../brief compactGlossaries=../compactGlossaries data=../.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~> glossary-single definition.definitions.[0] brief=brief compactGlossaries=compactGlossaries data=.~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else if merge~}}
|
||||||
|
{{~#if definition.definitions.[1]~}}
|
||||||
|
<ol>{{#each definition.definitions}}<li>{{> glossary-single brief=../brief compactGlossaries=../compactGlossaries data=../.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~> glossary-single definition.definitions.[0] brief=brief compactGlossaries=compactGlossaries data=.~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else~}}
|
||||||
|
{{~> glossary-single definition brief=brief compactGlossaries=compactGlossaries data=.~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/if~}}
|
||||||
|
</div>
|
||||||
|
{{/inline}}
|
||||||
|
|
||||||
|
{{#*inline "glossary-brief"}}
|
||||||
|
{{~> glossary brief=true ~}}
|
||||||
|
{{/inline}}
|
||||||
|
|
||||||
|
{{~> (lookup . "marker") ~}}`.trimStart(),
|
||||||
|
|
||||||
|
expected: `
|
||||||
|
{{#*inline "glossary-single"}}
|
||||||
|
{{~#unless brief~}}
|
||||||
|
{{~#scope~}}
|
||||||
|
{{~#set "any" false}}{{/set~}}
|
||||||
|
{{~#each definitionTags~}}
|
||||||
|
{{~#if (op "||" (op "!" @root.compactTags) (op "!" redundant))~}}
|
||||||
|
{{~#if (get "any")}}, {{else}}<i>({{/if~}}
|
||||||
|
{{name}}
|
||||||
|
{{~#set "any" true}}{{/set~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/each~}}
|
||||||
|
{{~#if (get "any")}})</i> {{/if~}}
|
||||||
|
{{~/scope~}}
|
||||||
|
{{~#if only~}}({{#each only}}{{.}}{{#unless @last}}, {{/unless}}{{/each}} only) {{/if~}}
|
||||||
|
{{~/unless~}}
|
||||||
|
{{~#if (op "<=" glossary.length 1)~}}
|
||||||
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{/each}}
|
||||||
|
{{~else if @root.compactGlossaries~}}
|
||||||
|
{{#each glossary}}{{#multiLine}}{{.}}{{/multiLine}}{{#unless @last}} | {{/unless}}{{/each}}
|
||||||
|
{{~else~}}
|
||||||
|
<ul>{{#each glossary}}<li>{{#multiLine}}{{.}}{{/multiLine}}</li>{{/each}}</ul>
|
||||||
|
{{~/if~}}
|
||||||
|
{{/inline}}
|
||||||
|
|
||||||
|
{{#*inline "character"}}
|
||||||
|
{{~definition.character~}}
|
||||||
|
{{/inline}}
|
||||||
|
|
||||||
|
{{~#*inline "glossary"~}}
|
||||||
|
<div style="text-align: left;">
|
||||||
|
{{~#scope~}}
|
||||||
|
{{~#if (op "===" definition.type "term")~}}
|
||||||
|
{{~> glossary-single definition brief=brief ~}}
|
||||||
|
{{~else if (op "||" (op "===" definition.type "termGrouped") (op "===" definition.type "termMerged"))~}}
|
||||||
|
{{~#if (op ">" definition.definitions.length 1)~}}
|
||||||
|
<ol>{{~#each definition.definitions~}}<li>{{~> glossary-single . brief=../brief ~}}</li>{{~/each~}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~#each definition.definitions~}}{{~> glossary-single . brief=../brief ~}}{{~/each~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~else if (op "===" definition.type "kanji")~}}
|
||||||
|
{{~#if (op ">" definition.glossary.length 1)~}}
|
||||||
|
<ol>{{#each definition.glossary}}<li>{{.}}</li>{{/each}}</ol>
|
||||||
|
{{~else~}}
|
||||||
|
{{~#each definition.glossary~}}{{.}}{{~/each~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/if~}}
|
||||||
|
{{~/scope~}}
|
||||||
|
</div>
|
||||||
|
{{~/inline~}}
|
||||||
|
|
||||||
|
{{#*inline "glossary-brief"}}
|
||||||
|
{{~> glossary brief=true ~}}
|
||||||
|
{{/inline}}
|
||||||
|
|
||||||
|
${update8}
|
||||||
|
{{~> (lookup . "marker") ~}}`.trimStart()
|
||||||
}
|
}
|
||||||
];
|
];
|
||||||
|
|
||||||
for (const {old, expected} of data) {
|
for (const {old, expected, oldVersion} of data) {
|
||||||
const options = createOptionsTestData1();
|
const options = createOptionsTestData1();
|
||||||
options.profiles[0].options.anki.fieldTemplates = old;
|
options.profiles[0].options.anki.fieldTemplates = old;
|
||||||
|
if (typeof oldVersion === 'number') {
|
||||||
|
options.version = oldVersion;
|
||||||
|
}
|
||||||
|
|
||||||
const optionsUpdated = clone(await optionsUtil.update(options));
|
const optionsUpdated = clone(await optionsUtil.update(options));
|
||||||
const fieldTemplatesActual = optionsUpdated.profiles[0].options.anki.fieldTemplates;
|
const fieldTemplatesActual = optionsUpdated.profiles[0].options.anki.fieldTemplates;
|
||||||
assert.deepStrictEqual(fieldTemplatesActual, expected);
|
assert.deepStrictEqual(fieldTemplatesActual, expected);
|
||||||
|
Loading…
Reference in New Issue
Block a user