Change profile.js into a class (#566)

* Update how settings profile is stored and accessed

* Convert profiles.js into a class

* Rename members of ProfileController
This commit is contained in:
toasted-nutbread 2020-05-29 19:47:18 -04:00 committed by GitHub
parent 8537c8f386
commit fde0072118
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 277 additions and 253 deletions

View File

@ -16,6 +16,7 @@
*/ */
/* global /* global
* ProfileController
* SettingsBackup * SettingsBackup
* SettingsController * SettingsController
* ankiInitialize * ankiInitialize
@ -25,15 +26,28 @@
* appearanceInitialize * appearanceInitialize
* audioSettingsInitialize * audioSettingsInitialize
* dictSettingsInitialize * dictSettingsInitialize
* getOptionsContext
* onAnkiOptionsChanged * onAnkiOptionsChanged
* onDictionaryOptionsChanged * onDictionaryOptionsChanged
* profileOptionsSetup
* storageInfoInitialize * storageInfoInitialize
* utilBackend * utilBackend
* utilBackgroundIsolate * utilBackgroundIsolate
*/ */
let profileIndex = 0;
function getOptionsContext() {
return {index: getProfileIndex()};
}
function getProfileIndex() {
return profileIndex;
}
function setProfileIndex(value) {
profileIndex = value;
}
function getOptionsMutable(optionsContext) { function getOptionsMutable(optionsContext) {
return utilBackend().getOptions( return utilBackend().getOptions(
utilBackgroundIsolate(optionsContext) utilBackgroundIsolate(optionsContext)
@ -302,7 +316,7 @@ async function onReady() {
formSetupEventListeners(); formSetupEventListeners();
appearanceInitialize(); appearanceInitialize();
await audioSettingsInitialize(); await audioSettingsInitialize();
await profileOptionsSetup(); await (new ProfileController()).prepare();
await dictSettingsInitialize(); await dictSettingsInitialize();
ankiInitialize(); ankiInitialize();
ankiTemplatesInitialize(); ankiTemplatesInitialize();

View File

@ -20,45 +20,44 @@
* api * api
* conditionsClearCaches * conditionsClearCaches
* getOptionsFullMutable * getOptionsFullMutable
* getProfileIndex
* onOptionsUpdated * onOptionsUpdated
* profileConditionsDescriptor * profileConditionsDescriptor
* profileConditionsDescriptorPromise * profileConditionsDescriptorPromise
* setProfileIndex
* settingsSaveOptions * settingsSaveOptions
* utilBackgroundIsolate * utilBackgroundIsolate
*/ */
let currentProfileIndex = 0; class ProfileController {
let profileConditionsContainer = null; constructor() {
this._conditionsContainer = null;
function getOptionsContext() {
return {
index: currentProfileIndex
};
} }
async prepare() {
async function profileOptionsSetup() {
const optionsFull = await getOptionsFullMutable(); const optionsFull = await getOptionsFullMutable();
currentProfileIndex = optionsFull.profileCurrent; setProfileIndex(optionsFull.profileCurrent);
profileOptionsSetupEventListeners(); this._setupEventListeners();
await profileOptionsUpdateTarget(optionsFull); await this._updateTarget(optionsFull);
} }
function profileOptionsSetupEventListeners() { // Private
$('#profile-target').change(onTargetProfileChanged);
$('#profile-name').change(onProfileNameChanged); _setupEventListeners() {
$('#profile-add').click(onProfileAdd); $('#profile-target').change(this._onTargetProfileChanged.bind(this));
$('#profile-remove').click(onProfileRemove); $('#profile-name').change(this._onNameChanged.bind(this));
$('#profile-remove-confirm').click(onProfileRemoveConfirm); $('#profile-add').click(this._onAdd.bind(this));
$('#profile-copy').click(onProfileCopy); $('#profile-remove').click(this._onRemove.bind(this));
$('#profile-copy-confirm').click(onProfileCopyConfirm); $('#profile-remove-confirm').click(this._onRemoveConfirm.bind(this));
$('#profile-move-up').click(() => onProfileMove(-1)); $('#profile-copy').click(this._onCopy.bind(this));
$('#profile-move-down').click(() => onProfileMove(1)); $('#profile-copy-confirm').click(this._onCopyConfirm.bind(this));
$('.profile-form').find('input, select, textarea').not('.profile-form-manual').change(onProfileOptionsChanged); $('#profile-move-up').click(() => this._onMove(-1));
$('#profile-move-down').click(() => this._onMove(1));
$('.profile-form').find('input, select, textarea').not('.profile-form-manual').change(this._onInputChanged.bind(this));
} }
function tryGetIntegerValue(selector, min, max) { _tryGetIntegerValue(selector, min, max) {
const value = parseInt($(selector).val(), 10); const value = parseInt($(selector).val(), 10);
return ( return (
typeof value === 'number' && typeof value === 'number' &&
@ -69,11 +68,12 @@ function tryGetIntegerValue(selector, min, max) {
) ? value : null; ) ? value : null;
} }
async function profileFormRead(optionsFull) { async _formRead(optionsFull) {
const currentProfileIndex = getProfileIndex();
const profile = optionsFull.profiles[currentProfileIndex]; const profile = optionsFull.profiles[currentProfileIndex];
// Current profile // Current profile
const index = tryGetIntegerValue('#profile-active', 0, optionsFull.profiles.length); const index = this._tryGetIntegerValue('#profile-active', 0, optionsFull.profiles.length);
if (index !== null) { if (index !== null) {
optionsFull.profileCurrent = index; optionsFull.profileCurrent = index;
} }
@ -82,11 +82,12 @@ async function profileFormRead(optionsFull) {
profile.name = $('#profile-name').val(); profile.name = $('#profile-name').val();
} }
async function profileFormWrite(optionsFull) { async _formWrite(optionsFull) {
const currentProfileIndex = getProfileIndex();
const profile = optionsFull.profiles[currentProfileIndex]; const profile = optionsFull.profiles[currentProfileIndex];
profileOptionsPopulateSelect($('#profile-active'), optionsFull.profiles, optionsFull.profileCurrent, null); this._populateSelect($('#profile-active'), optionsFull.profiles, optionsFull.profileCurrent, null);
profileOptionsPopulateSelect($('#profile-target'), optionsFull.profiles, currentProfileIndex, null); this._populateSelect($('#profile-target'), optionsFull.profiles, currentProfileIndex, null);
$('#profile-remove').prop('disabled', optionsFull.profiles.length <= 1); $('#profile-remove').prop('disabled', optionsFull.profiles.length <= 1);
$('#profile-copy').prop('disabled', optionsFull.profiles.length <= 1); $('#profile-copy').prop('disabled', optionsFull.profiles.length <= 1);
$('#profile-move-up').prop('disabled', currentProfileIndex <= 0); $('#profile-move-up').prop('disabled', currentProfileIndex <= 0);
@ -94,26 +95,26 @@ async function profileFormWrite(optionsFull) {
$('#profile-name').val(profile.name); $('#profile-name').val(profile.name);
if (profileConditionsContainer !== null) { if (this._conditionsContainer !== null) {
profileConditionsContainer.cleanup(); this._conditionsContainer.cleanup();
} }
await profileConditionsDescriptorPromise; await profileConditionsDescriptorPromise;
profileConditionsContainer = new ConditionsUI.Container( this._conditionsContainer = new ConditionsUI.Container(
profileConditionsDescriptor, profileConditionsDescriptor,
'popupLevel', 'popupLevel',
profile.conditionGroups, profile.conditionGroups,
$('#profile-condition-groups'), $('#profile-condition-groups'),
$('#profile-add-condition-group') $('#profile-add-condition-group')
); );
profileConditionsContainer.save = () => { this._conditionsContainer.save = () => {
settingsSaveOptions(); settingsSaveOptions();
conditionsClearCaches(profileConditionsDescriptor); conditionsClearCaches(profileConditionsDescriptor);
}; };
profileConditionsContainer.isolate = utilBackgroundIsolate; this._conditionsContainer.isolate = utilBackgroundIsolate;
} }
function profileOptionsPopulateSelect(select, profiles, currentValue, ignoreIndices) { _populateSelect(select, profiles, currentValue, ignoreIndices) {
select.empty(); select.empty();
@ -128,12 +129,12 @@ function profileOptionsPopulateSelect(select, profiles, currentValue, ignoreIndi
select.val(`${currentValue}`); select.val(`${currentValue}`);
} }
async function profileOptionsUpdateTarget(optionsFull) { async _updateTarget(optionsFull) {
await profileFormWrite(optionsFull); await this._formWrite(optionsFull);
await onOptionsUpdated({source: null}); await onOptionsUpdated({source: null});
} }
function profileOptionsCreateCopyName(name, profiles, maxUniqueAttempts) { _createCopyName(name, profiles, maxUniqueAttempts) {
let space, index, prefix, suffix; let space, index, prefix, suffix;
const match = /^([\w\W]*\(Copy)((\s+)(\d+))?(\)\s*)$/.exec(name); const match = /^([\w\W]*\(Copy)((\s+)(\d+))?(\)\s*)$/.exec(name);
if (match === null) { if (match === null) {
@ -168,47 +169,49 @@ function profileOptionsCreateCopyName(name, profiles, maxUniqueAttempts) {
} }
} }
async function onProfileOptionsChanged(e) { async _onInputChanged(e) {
if (!e.originalEvent && !e.isTrigger) { if (!e.originalEvent && !e.isTrigger) {
return; return;
} }
const optionsFull = await getOptionsFullMutable(); const optionsFull = await getOptionsFullMutable();
await profileFormRead(optionsFull); await this._formRead(optionsFull);
await settingsSaveOptions(); await settingsSaveOptions();
} }
async function onTargetProfileChanged() { async _onTargetProfileChanged() {
const optionsFull = await getOptionsFullMutable(); const optionsFull = await getOptionsFullMutable();
const index = tryGetIntegerValue('#profile-target', 0, optionsFull.profiles.length); const currentProfileIndex = getProfileIndex();
const index = this._tryGetIntegerValue('#profile-target', 0, optionsFull.profiles.length);
if (index === null || currentProfileIndex === index) { if (index === null || currentProfileIndex === index) {
return; return;
} }
currentProfileIndex = index; setProfileIndex(index);
await profileOptionsUpdateTarget(optionsFull); await this._updateTarget(optionsFull);
yomichan.trigger('modifyingProfileChange'); yomichan.trigger('modifyingProfileChange');
} }
async function onProfileAdd() { async _onAdd() {
const optionsFull = await getOptionsFullMutable(); const optionsFull = await getOptionsFullMutable();
const currentProfileIndex = getProfileIndex();
const profile = utilBackgroundIsolate(optionsFull.profiles[currentProfileIndex]); const profile = utilBackgroundIsolate(optionsFull.profiles[currentProfileIndex]);
profile.name = profileOptionsCreateCopyName(profile.name, optionsFull.profiles, 100); profile.name = this._createCopyName(profile.name, optionsFull.profiles, 100);
optionsFull.profiles.push(profile); optionsFull.profiles.push(profile);
currentProfileIndex = optionsFull.profiles.length - 1; setProfileIndex(optionsFull.profiles.length - 1);
await profileOptionsUpdateTarget(optionsFull); await this._updateTarget(optionsFull);
await settingsSaveOptions(); await settingsSaveOptions();
yomichan.trigger('modifyingProfileChange'); yomichan.trigger('modifyingProfileChange');
} }
async function onProfileRemove(e) { async _onRemove(e) {
if (e.shiftKey) { if (e.shiftKey) {
return await onProfileRemoveConfirm(); return await this._onRemoveConfirm();
} }
const optionsFull = await api.optionsGetFull(); const optionsFull = await api.optionsGetFull();
@ -216,13 +219,14 @@ async function onProfileRemove(e) {
return; return;
} }
const currentProfileIndex = getProfileIndex();
const profile = optionsFull.profiles[currentProfileIndex]; const profile = optionsFull.profiles[currentProfileIndex];
$('#profile-remove-modal-profile-name').text(profile.name); $('#profile-remove-modal-profile-name').text(profile.name);
$('#profile-remove-modal').modal('show'); $('#profile-remove-modal').modal('show');
} }
async function onProfileRemoveConfirm() { async _onRemoveConfirm() {
$('#profile-remove-modal').modal('hide'); $('#profile-remove-modal').modal('hide');
const optionsFull = await getOptionsFullMutable(); const optionsFull = await getOptionsFullMutable();
@ -230,28 +234,31 @@ async function onProfileRemoveConfirm() {
return; return;
} }
const currentProfileIndex = getProfileIndex();
optionsFull.profiles.splice(currentProfileIndex, 1); optionsFull.profiles.splice(currentProfileIndex, 1);
if (currentProfileIndex >= optionsFull.profiles.length) { if (currentProfileIndex >= optionsFull.profiles.length) {
--currentProfileIndex; setProfileIndex(optionsFull.profiles.length - 1);
} }
if (optionsFull.profileCurrent >= optionsFull.profiles.length) { if (optionsFull.profileCurrent >= optionsFull.profiles.length) {
optionsFull.profileCurrent = optionsFull.profiles.length - 1; optionsFull.profileCurrent = optionsFull.profiles.length - 1;
} }
await profileOptionsUpdateTarget(optionsFull); await this._updateTarget(optionsFull);
await settingsSaveOptions(); await settingsSaveOptions();
yomichan.trigger('modifyingProfileChange'); yomichan.trigger('modifyingProfileChange');
} }
function onProfileNameChanged() { _onNameChanged() {
const currentProfileIndex = getProfileIndex();
$('#profile-active, #profile-target').find(`[value="${currentProfileIndex}"]`).text(this.value); $('#profile-active, #profile-target').find(`[value="${currentProfileIndex}"]`).text(this.value);
} }
async function onProfileMove(offset) { async _onMove(offset) {
const optionsFull = await getOptionsFullMutable(); const optionsFull = await getOptionsFullMutable();
const currentProfileIndex = getProfileIndex();
const index = currentProfileIndex + offset; const index = currentProfileIndex + offset;
if (index < 0 || index >= optionsFull.profiles.length) { if (index < 0 || index >= optionsFull.profiles.length) {
return; return;
@ -265,29 +272,31 @@ async function onProfileMove(offset) {
optionsFull.profileCurrent = index; optionsFull.profileCurrent = index;
} }
currentProfileIndex = index; setProfileIndex(index);
await profileOptionsUpdateTarget(optionsFull); await this._updateTarget(optionsFull);
await settingsSaveOptions(); await settingsSaveOptions();
yomichan.trigger('modifyingProfileChange'); yomichan.trigger('modifyingProfileChange');
} }
async function onProfileCopy() { async _onCopy() {
const optionsFull = await api.optionsGetFull(); const optionsFull = await api.optionsGetFull();
if (optionsFull.profiles.length <= 1) { if (optionsFull.profiles.length <= 1) {
return; return;
} }
profileOptionsPopulateSelect($('#profile-copy-source'), optionsFull.profiles, currentProfileIndex === 0 ? 1 : 0, [currentProfileIndex]); const currentProfileIndex = getProfileIndex();
this._populateSelect($('#profile-copy-source'), optionsFull.profiles, currentProfileIndex === 0 ? 1 : 0, [currentProfileIndex]);
$('#profile-copy-modal').modal('show'); $('#profile-copy-modal').modal('show');
} }
async function onProfileCopyConfirm() { async _onCopyConfirm() {
$('#profile-copy-modal').modal('hide'); $('#profile-copy-modal').modal('hide');
const optionsFull = await getOptionsFullMutable(); const optionsFull = await getOptionsFullMutable();
const index = tryGetIntegerValue('#profile-copy-source', 0, optionsFull.profiles.length); const index = this._tryGetIntegerValue('#profile-copy-source', 0, optionsFull.profiles.length);
const currentProfileIndex = getProfileIndex();
if (index === null || index === currentProfileIndex) { if (index === null || index === currentProfileIndex) {
return; return;
} }
@ -295,6 +304,7 @@ async function onProfileCopyConfirm() {
const profileOptions = utilBackgroundIsolate(optionsFull.profiles[index].options); const profileOptions = utilBackgroundIsolate(optionsFull.profiles[index].options);
optionsFull.profiles[currentProfileIndex].options = profileOptions; optionsFull.profiles[currentProfileIndex].options = profileOptions;
await profileOptionsUpdateTarget(optionsFull); await this._updateTarget(optionsFull);
await settingsSaveOptions(); await settingsSaveOptions();
} }
}