Util rename (#1389)

* Rename MediaUtility to MediaUtil for consistency

* Update variable names

* Rename media-utility.js to media-util.js

* Rename ProfileConditions to ProfileConditionsUtil

* Rename variables

* Move profile-conditions.js to profile-conditions-util.js

* Rename test-profile-conditions.js to test-profile-conditions-util.js
This commit is contained in:
toasted-nutbread 2021-02-14 11:32:30 -05:00 committed by GitHub
parent 0117df6bd8
commit 5268c5d1bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 36 additions and 36 deletions

View File

@ -173,10 +173,10 @@
"ext/js/language/dictionary-database.js", "ext/js/language/dictionary-database.js",
"ext/js/data/json-schema.js", "ext/js/data/json-schema.js",
"ext/js/comm/mecab.js", "ext/js/comm/mecab.js",
"ext/js/media/media-utility.js", "ext/js/media/media-util.js",
"ext/js/data/options-util.js", "ext/js/data/options-util.js",
"ext/js/data/permissions-util.js", "ext/js/data/permissions-util.js",
"ext/js/background/profile-conditions.js", "ext/js/background/profile-conditions-util.js",
"ext/js/background/request-builder.js", "ext/js/background/request-builder.js",
"ext/js/dom/simple-dom-parser.js", "ext/js/dom/simple-dom-parser.js",
"ext/js/templates/template-patcher.js", "ext/js/templates/template-patcher.js",

View File

@ -35,10 +35,10 @@
<script src="/js/language/dictionary-database.js"></script> <script src="/js/language/dictionary-database.js"></script>
<script src="/js/data/json-schema.js"></script> <script src="/js/data/json-schema.js"></script>
<script src="/js/comm/mecab.js"></script> <script src="/js/comm/mecab.js"></script>
<script src="/js/media/media-utility.js"></script> <script src="/js/media/media-util.js"></script>
<script src="/js/data/options-util.js"></script> <script src="/js/data/options-util.js"></script>
<script src="/js/data/permissions-util.js"></script> <script src="/js/data/permissions-util.js"></script>
<script src="/js/background/profile-conditions.js"></script> <script src="/js/background/profile-conditions-util.js"></script>
<script src="/js/background/request-builder.js"></script> <script src="/js/background/request-builder.js"></script>
<script src="/js/dom/native-simple-dom-parser.js"></script> <script src="/js/dom/native-simple-dom-parser.js"></script>
<script src="/js/templates/template-patcher.js"></script> <script src="/js/templates/template-patcher.js"></script>

View File

@ -25,11 +25,11 @@
* JapaneseUtil * JapaneseUtil
* JsonSchemaValidator * JsonSchemaValidator
* Mecab * Mecab
* MediaUtility * MediaUtil
* ObjectPropertyAccessor * ObjectPropertyAccessor
* OptionsUtil * OptionsUtil
* PermissionsUtil * PermissionsUtil
* ProfileConditions * ProfileConditionsUtil
* RequestBuilder * RequestBuilder
* Translator * Translator
* wanakana * wanakana
@ -46,13 +46,13 @@ class Backend {
}); });
this._anki = new AnkiConnect(); this._anki = new AnkiConnect();
this._mecab = new Mecab(); this._mecab = new Mecab();
this._mediaUtility = new MediaUtility(); this._mediaUtil = new MediaUtil();
this._clipboardReader = new ClipboardReader({ this._clipboardReader = new ClipboardReader({
// eslint-disable-next-line no-undef // eslint-disable-next-line no-undef
document: (typeof document === 'object' && document !== null ? document : null), document: (typeof document === 'object' && document !== null ? document : null),
pasteTargetSelector: '#clipboard-paste-target', pasteTargetSelector: '#clipboard-paste-target',
imagePasteTargetSelector: '#clipboard-image-paste-target', imagePasteTargetSelector: '#clipboard-image-paste-target',
mediaUtility: this._mediaUtility mediaUtil: this._mediaUtil
}); });
this._clipboardMonitor = new ClipboardMonitor({ this._clipboardMonitor = new ClipboardMonitor({
japaneseUtil: this._japaneseUtil, japaneseUtil: this._japaneseUtil,
@ -61,7 +61,7 @@ class Backend {
this._options = null; this._options = null;
this._profileConditionsSchemaValidator = new JsonSchemaValidator(); this._profileConditionsSchemaValidator = new JsonSchemaValidator();
this._profileConditionsSchemaCache = []; this._profileConditionsSchemaCache = [];
this._profileConditionsUtil = new ProfileConditions(); this._profileConditionsUtil = new ProfileConditionsUtil();
this._defaultAnkiFieldTemplates = null; this._defaultAnkiFieldTemplates = null;
this._requestBuilder = new RequestBuilder(); this._requestBuilder = new RequestBuilder();
this._audioDownloader = new AudioDownloader({ this._audioDownloader = new AudioDownloader({
@ -1707,7 +1707,7 @@ class Backend {
return null; return null;
} }
let extension = this._mediaUtility.getFileExtensionFromAudioMediaType(contentType); let extension = this._mediaUtil.getFileExtensionFromAudioMediaType(contentType);
if (extension === null) { extension = '.mp3'; } if (extension === null) { extension = '.mp3'; }
let fileName = this._generateAnkiNoteMediaFileName('yomichan_audio', extension, timestamp, definitionDetails); let fileName = this._generateAnkiNoteMediaFileName('yomichan_audio', extension, timestamp, definitionDetails);
fileName = fileName.replace(/\]/g, ''); fileName = fileName.replace(/\]/g, '');
@ -1721,7 +1721,7 @@ class Backend {
const dataUrl = await this._getScreenshot(tabId, frameId, format, quality); const dataUrl = await this._getScreenshot(tabId, frameId, format, quality);
const {mediaType, data} = this._getDataUrlInfo(dataUrl); const {mediaType, data} = this._getDataUrlInfo(dataUrl);
const extension = this._mediaUtility.getFileExtensionFromImageMediaType(mediaType); const extension = this._mediaUtil.getFileExtensionFromImageMediaType(mediaType);
if (extension === null) { if (extension === null) {
throw new Error('Unknown media type for screenshot image'); throw new Error('Unknown media type for screenshot image');
} }
@ -1739,7 +1739,7 @@ class Backend {
} }
const {mediaType, data} = this._getDataUrlInfo(dataUrl); const {mediaType, data} = this._getDataUrlInfo(dataUrl);
const extension = this._mediaUtility.getFileExtensionFromImageMediaType(mediaType); const extension = this._mediaUtil.getFileExtensionFromImageMediaType(mediaType);
if (extension === null) { if (extension === null) {
throw new Error('Unknown media type for clipboard image'); throw new Error('Unknown media type for clipboard image');
} }

View File

@ -18,7 +18,7 @@
/** /**
* Utility class to help processing profile conditions. * Utility class to help processing profile conditions.
*/ */
class ProfileConditions { class ProfileConditionsUtil {
/** /**
* Creates a new instance. * Creates a new instance.
*/ */

View File

@ -25,14 +25,14 @@ class ClipboardReader {
* @param pasteTargetSelector The selector for the paste target element. * @param pasteTargetSelector The selector for the paste target element.
* @param imagePasteTargetSelector The selector for the image paste target element. * @param imagePasteTargetSelector The selector for the image paste target element.
*/ */
constructor({document=null, pasteTargetSelector=null, imagePasteTargetSelector=null, mediaUtility=null}) { constructor({document=null, pasteTargetSelector=null, imagePasteTargetSelector=null, mediaUtil=null}) {
this._document = document; this._document = document;
this._browser = null; this._browser = null;
this._pasteTarget = null; this._pasteTarget = null;
this._pasteTargetSelector = pasteTargetSelector; this._pasteTargetSelector = pasteTargetSelector;
this._imagePasteTarget = null; this._imagePasteTarget = null;
this._imagePasteTargetSelector = imagePasteTargetSelector; this._imagePasteTargetSelector = imagePasteTargetSelector;
this._mediaUtility = mediaUtility; this._mediaUtil = mediaUtil;
} }
/** /**
@ -107,7 +107,7 @@ class ClipboardReader {
// See browser-specific notes in getText // See browser-specific notes in getText
if ( if (
this._isFirefox() && this._isFirefox() &&
this._mediaUtility !== null && this._mediaUtil !== null &&
typeof navigator.clipboard !== 'undefined' && typeof navigator.clipboard !== 'undefined' &&
typeof navigator.clipboard.read === 'function' typeof navigator.clipboard.read === 'function'
) { ) {
@ -120,7 +120,7 @@ class ClipboardReader {
} }
for (const file of files) { for (const file of files) {
if (this._mediaUtility.getFileExtensionFromImageMediaType(file.type) !== null) { if (this._mediaUtil.getFileExtensionFromImageMediaType(file.type) !== null) {
return await this._readFileAsDataURL(file); return await this._readFileAsDataURL(file);
} }
} }

View File

@ -18,14 +18,14 @@
/* global /* global
* JSZip * JSZip
* JsonSchemaValidator * JsonSchemaValidator
* MediaUtility * MediaUtil
*/ */
class DictionaryImporter { class DictionaryImporter {
constructor() { constructor() {
this._schemas = new Map(); this._schemas = new Map();
this._jsonSchemaValidator = new JsonSchemaValidator(); this._jsonSchemaValidator = new JsonSchemaValidator();
this._mediaUtility = new MediaUtility(); this._mediaUtil = new MediaUtil();
} }
async importDictionary(dictionaryDatabase, archiveSource, details, onProgress) { async importDictionary(dictionaryDatabase, archiveSource, details, onProgress) {
@ -325,7 +325,7 @@ class DictionaryImporter {
} }
const content = await file.async('base64'); const content = await file.async('base64');
const mediaType = this._mediaUtility.getImageMediaTypeFromFileName(path); const mediaType = this._mediaUtil.getImageMediaTypeFromFileName(path);
if (mediaType === null) { if (mediaType === null) {
throw new Error(`Could not determine media type for image at path ${JSON.stringify(path)} for ${errorSource}`); throw new Error(`Could not determine media type for image at path ${JSON.stringify(path)} for ${errorSource}`);
} }

View File

@ -16,9 +16,9 @@
*/ */
/** /**
* MediaUtility is a class containing helper methods related to media processing. * MediaUtil is a class containing helper methods related to media processing.
*/ */
class MediaUtility { class MediaUtil {
/** /**
* Gets the file extension of a file path. URL search queries and hash * Gets the file extension of a file path. URL search queries and hash
* fragments are not handled. * fragments are not handled.

View File

@ -1304,7 +1304,7 @@
<script src="/js/language/dictionary-database.js"></script> <script src="/js/language/dictionary-database.js"></script>
<script src="/js/language/dictionary-importer.js"></script> <script src="/js/language/dictionary-importer.js"></script>
<script src="/js/data/json-schema.js"></script> <script src="/js/data/json-schema.js"></script>
<script src="/js/media/media-utility.js"></script> <script src="/js/media/media-util.js"></script>
<script src="/js/data/permissions-util.js"></script> <script src="/js/data/permissions-util.js"></script>
<script src="/js/templates/template-patcher.js"></script> <script src="/js/templates/template-patcher.js"></script>
<script src="/js/templates/template-renderer-proxy.js"></script> <script src="/js/templates/template-renderer-proxy.js"></script>

View File

@ -3218,7 +3218,7 @@
<script src="/js/language/dictionary-database.js"></script> <script src="/js/language/dictionary-database.js"></script>
<script src="/js/language/dictionary-importer.js"></script> <script src="/js/language/dictionary-importer.js"></script>
<script src="/js/data/json-schema.js"></script> <script src="/js/data/json-schema.js"></script>
<script src="/js/media/media-utility.js"></script> <script src="/js/media/media-util.js"></script>
<script src="/js/data/permissions-util.js"></script> <script src="/js/data/permissions-util.js"></script>
<script src="/js/templates/template-patcher.js"></script> <script src="/js/templates/template-patcher.js"></script>
<script src="/js/templates/template-renderer-proxy.js"></script> <script src="/js/templates/template-renderer-proxy.js"></script>

View File

@ -34,10 +34,10 @@ self.importScripts(
'/js/language/dictionary-database.js', '/js/language/dictionary-database.js',
'/js/data/json-schema.js', '/js/data/json-schema.js',
'/js/comm/mecab.js', '/js/comm/mecab.js',
'/js/media/media-utility.js', '/js/media/media-util.js',
'/js/data/options-util.js', '/js/data/options-util.js',
'/js/data/permissions-util.js', '/js/data/permissions-util.js',
'/js/background/profile-conditions.js', '/js/background/profile-conditions-util.js',
'/js/background/request-builder.js', '/js/background/request-builder.js',
'/js/dom/simple-dom-parser.js', '/js/dom/simple-dom-parser.js',
'/js/templates/template-patcher.js', '/js/templates/template-patcher.js',

View File

@ -335,7 +335,7 @@
<script src="/js/language/dictionary-database.js"></script> <script src="/js/language/dictionary-database.js"></script>
<script src="/js/language/dictionary-importer.js"></script> <script src="/js/language/dictionary-importer.js"></script>
<script src="/js/data/json-schema.js"></script> <script src="/js/data/json-schema.js"></script>
<script src="/js/media/media-utility.js"></script> <script src="/js/media/media-util.js"></script>
<script src="/js/data/permissions-util.js"></script> <script src="/js/data/permissions-util.js"></script>
<script src="/js/settings/dictionary-controller.js"></script> <script src="/js/settings/dictionary-controller.js"></script>

View File

@ -26,7 +26,7 @@ vm.execute([
'js/core.js', 'js/core.js',
'js/general/cache-map.js', 'js/general/cache-map.js',
'js/data/json-schema.js', 'js/data/json-schema.js',
'js/media/media-utility.js', 'js/media/media-util.js',
'js/language/dictionary-importer.js', 'js/language/dictionary-importer.js',
'js/data/database.js', 'js/data/database.js',
'js/language/dictionary-database.js' 'js/language/dictionary-database.js'

View File

@ -25,9 +25,9 @@ vm.execute([
'js/core.js', 'js/core.js',
'js/general/cache-map.js', 'js/general/cache-map.js',
'js/data/json-schema.js', 'js/data/json-schema.js',
'js/background/profile-conditions.js' 'js/background/profile-conditions-util.js'
]); ]);
const [JsonSchemaValidator, ProfileConditions] = vm.get(['JsonSchemaValidator', 'ProfileConditions']); const [JsonSchemaValidator, ProfileConditionsUtil] = vm.get(['JsonSchemaValidator', 'ProfileConditionsUtil']);
function schemaValidate(value, schema) { function schemaValidate(value, schema) {
@ -63,8 +63,8 @@ function testNormalizeContext() {
]; ];
for (const {context, expected} of data) { for (const {context, expected} of data) {
const profileConditions = new ProfileConditions(); const profileConditionsUtil = new ProfileConditionsUtil();
const actual = profileConditions.normalizeContext(context); const actual = profileConditionsUtil.normalizeContext(context);
vm.assert.deepStrictEqual(actual, expected); vm.assert.deepStrictEqual(actual, expected);
} }
} }
@ -818,14 +818,14 @@ function testSchemas() {
]; ];
for (const {conditionGroups, expectedSchema, inputs} of data) { for (const {conditionGroups, expectedSchema, inputs} of data) {
const profileConditions = new ProfileConditions(); const profileConditionsUtil = new ProfileConditionsUtil();
const schema = profileConditions.createSchema(conditionGroups); const schema = profileConditionsUtil.createSchema(conditionGroups);
if (typeof expectedSchema !== 'undefined') { if (typeof expectedSchema !== 'undefined') {
vm.assert.deepStrictEqual(schema, expectedSchema); vm.assert.deepStrictEqual(schema, expectedSchema);
} }
if (Array.isArray(inputs)) { if (Array.isArray(inputs)) {
for (const {expected, context} of inputs) { for (const {expected, context} of inputs) {
const normalizedContext = profileConditions.normalizeContext(context); const normalizedContext = profileConditionsUtil.normalizeContext(context);
const actual = schemaValidate(normalizedContext, schema); const actual = schemaValidate(normalizedContext, schema);
assert.strictEqual(actual, expected); assert.strictEqual(actual, expected);
} }

View File

@ -40,7 +40,7 @@ async function createVM() {
'js/general/cache-map.js', 'js/general/cache-map.js',
'js/language/japanese-util.js', 'js/language/japanese-util.js',
'js/data/json-schema.js', 'js/data/json-schema.js',
'js/media/media-utility.js', 'js/media/media-util.js',
'js/language/dictionary-importer.js', 'js/language/dictionary-importer.js',
'js/data/database.js', 'js/data/database.js',
'js/language/dictionary-database.js', 'js/language/dictionary-database.js',