From d3807d88ecf40b2c37ed31d823af038a091ffca0 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sat, 20 Aug 2022 12:53:22 -0400 Subject: [PATCH] ArrayBufferUtil (#2215) * Rename StringUtil to ArrayBufferUtil * Update docs * Rename file string-util.js to array-buffer-util.js --- .eslintrc.json | 2 +- ext/background.html | 2 +- ext/info.html | 2 +- ext/js/background/backend.js | 4 ++-- ext/js/data/sandbox/{string-util.js => array-buffer-util.js} | 4 ++-- ext/js/display/display-content-manager.js | 4 ++-- ext/js/media/audio-downloader.js | 4 ++-- ext/js/pages/settings/backup-controller.js | 4 ++-- ext/popup.html | 2 +- ext/search.html | 2 +- ext/settings.html | 2 +- ext/sw.js | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) rename ext/js/data/sandbox/{string-util.js => array-buffer-util.js} (96%) diff --git a/.eslintrc.json b/.eslintrc.json index dad145be..ec1e0375 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -232,7 +232,7 @@ "ext/js/data/json-schema.js", "ext/js/data/options-util.js", "ext/js/data/permissions-util.js", - "ext/js/data/sandbox/string-util.js", + "ext/js/data/sandbox/array-buffer-util.js", "ext/js/dom/simple-dom-parser.js", "ext/js/extension/environment.js", "ext/js/general/cache-map.js", diff --git a/ext/background.html b/ext/background.html index deef5214..b3f85240 100644 --- a/ext/background.html +++ b/ext/background.html @@ -37,7 +37,7 @@ - + diff --git a/ext/info.html b/ext/info.html index d3da035f..a40895a8 100644 --- a/ext/info.html +++ b/ext/info.html @@ -68,7 +68,7 @@ - + diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js index f3c76311..a3694dd3 100644 --- a/ext/js/background/backend.js +++ b/ext/js/background/backend.js @@ -19,6 +19,7 @@ * AccessibilityController * AnkiConnect * AnkiUtil + * ArrayBufferUtil * AudioDownloader * ClipboardMonitor * ClipboardReader @@ -33,7 +34,6 @@ * ProfileConditionsUtil * RequestBuilder * ScriptManager - * StringUtil * Translator * wanakana */ @@ -2223,7 +2223,7 @@ class Backend { for (const item of results) { const {content} = item; if (content instanceof ArrayBuffer) { - item.content = StringUtil.arrayBufferToBase64(content); + item.content = ArrayBufferUtil.arrayBufferToBase64(content); } } return results; diff --git a/ext/js/data/sandbox/string-util.js b/ext/js/data/sandbox/array-buffer-util.js similarity index 96% rename from ext/js/data/sandbox/string-util.js rename to ext/js/data/sandbox/array-buffer-util.js index de6933cd..13988e76 100644 --- a/ext/js/data/sandbox/string-util.js +++ b/ext/js/data/sandbox/array-buffer-util.js @@ -16,9 +16,9 @@ */ /** - * Class containing generic string utility functions. + * Class containing generic ArrayBuffer utility functions. */ -class StringUtil { +class ArrayBufferUtil { /** * Decodes the contents of an ArrayBuffer using UTF8. * @param {ArrayBuffer} arrayBuffer The input ArrayBuffer. diff --git a/ext/js/display/display-content-manager.js b/ext/js/display/display-content-manager.js index 0b91b40c..bfba5fb8 100644 --- a/ext/js/display/display-content-manager.js +++ b/ext/js/display/display-content-manager.js @@ -16,7 +16,7 @@ */ /* global - * StringUtil + * ArrayBufferUtil */ /** @@ -139,7 +139,7 @@ class DisplayContentManager { const token = this._token; const data = (await yomichan.api.getMedia([{path, dictionary}]))[0]; if (token === this._token && data !== null) { - const buffer = StringUtil.base64ToArrayBuffer(data.content); + const buffer = ArrayBufferUtil.base64ToArrayBuffer(data.content); const blob = new Blob([buffer], {type: data.mediaType}); const url = URL.createObjectURL(blob); cachedData.data = data; diff --git a/ext/js/media/audio-downloader.js b/ext/js/media/audio-downloader.js index 4142e3f4..77e9afd2 100644 --- a/ext/js/media/audio-downloader.js +++ b/ext/js/media/audio-downloader.js @@ -16,11 +16,11 @@ */ /* global + * ArrayBufferUtil * JsonSchema * NativeSimpleDOMParser * RequestBuilder * SimpleDOMParser - * StringUtil */ class AudioDownloader { @@ -283,7 +283,7 @@ class AudioDownloader { throw new Error('Could not retrieve audio'); } - const data = StringUtil.arrayBufferToBase64(arrayBuffer); + const data = ArrayBufferUtil.arrayBufferToBase64(arrayBuffer); const contentType = response.headers.get('Content-Type'); return {data, contentType}; } diff --git a/ext/js/pages/settings/backup-controller.js b/ext/js/pages/settings/backup-controller.js index ba36a828..a232ce34 100644 --- a/ext/js/pages/settings/backup-controller.js +++ b/ext/js/pages/settings/backup-controller.js @@ -16,9 +16,9 @@ */ /* global + * ArrayBufferUtil * DictionaryController * OptionsUtil - * StringUtil */ class BackupController { @@ -319,7 +319,7 @@ class BackupController { } async _importSettingsFile(file) { - const dataString = StringUtil.arrayBufferUtf8Decode(await this._readFileArrayBuffer(file)); + const dataString = ArrayBufferUtil.arrayBufferUtf8Decode(await this._readFileArrayBuffer(file)); const data = JSON.parse(dataString); // Type check diff --git a/ext/popup.html b/ext/popup.html index cb6ca7da..58090a9e 100644 --- a/ext/popup.html +++ b/ext/popup.html @@ -103,7 +103,7 @@ - + diff --git a/ext/search.html b/ext/search.html index e9f624b3..0143f7f1 100644 --- a/ext/search.html +++ b/ext/search.html @@ -90,7 +90,7 @@ - + diff --git a/ext/settings.html b/ext/settings.html index 4dfa3100..1a50a4b4 100644 --- a/ext/settings.html +++ b/ext/settings.html @@ -3788,7 +3788,7 @@ - + diff --git a/ext/sw.js b/ext/sw.js index 253058c9..4030dd8a 100644 --- a/ext/sw.js +++ b/ext/sw.js @@ -34,7 +34,7 @@ self.importScripts( '/js/data/json-schema.js', '/js/data/options-util.js', '/js/data/permissions-util.js', - '/js/data/sandbox/string-util.js', + '/js/data/sandbox/array-buffer-util.js', '/js/dom/simple-dom-parser.js', '/js/extension/environment.js', '/js/general/cache-map.js',