Code cleanup

lib/translator/filter.js

@@ -4,34 +4,73 @@
  * @module paper/lib/translator/filter
  */
 
+/*
+* Internal method to filter an object containing string keys using the given keyPrefix
+*
+* @private
+* @param {Object.<string, string>} obj
+* @param {string} keyPrefix
+* @returns {Object.<string, string>}
+*/
+function filterByKeyPrefix(obj, keyPrefix) {
+    const result = {};
+    for (const key in obj) {
+        if (typeof key === 'string' && key.startsWith(keyPrefix)) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+}
+
+
 /**
- * Filter translation and locales by translation key
+ * Filter translation and locales of the given language object by translation key prefix.
+ * This is used by the `langJson` helper. This method expects an object in the format
+ * returned by `translator/transformer.js:transform()`.
+ *
+ * The incoming language object looks like this:
+ * {
+ *   locale: 'en',
+ *   locales: {
+ *     'salutations.welcome': 'en',
+ *     'salutations.hello': 'en',
+ *     'salutations.bye': 'en',
+ *     items: 'en',
+ *   },
+ *   translations: {
+ *     'salutations.welcome': 'Welcome',
+ *     'salutations.hello': 'Hello {name}',
+ *     'salutations.bye': 'Bye bye',
+ *     items: '{count, plural, one{1 Item} other{# Items}}',
+ *   }
+ * }
+ *
+ * The return value, assuming `keyFilter` of `salutations`, would look like this:
+ * {
+ *   locale: 'en',
+ *   locales: {
+ *     'salutations.welcome': 'en',
+ *     'salutations.hello': 'en',
+ *     'salutations.bye': 'en',
+ *   },
+ *   translations: {
+ *     'salutations.welcome': 'Welcome',
+ *     'salutations.hello': 'Hello {name}',
+ *     'salutations.bye': 'Bye bye',
+ *   }
+ * }
  * @param {Object.<string, string|Object>} language
  * @param {string} keyFilter
  * @returns {Object.<string, string|Object>}
  */
-function filterByKey(language, keyFilter) {
-    const result = {};
-    const languageKeys = Object.keys(language);
-    for (let i = 0; i < languageKeys.length; i++) {
-        const key = languageKeys[i];
-        if (key === 'translations' || key === 'locales') {
-            const languageSubKeys = Object.keys(language[key]);
-            result[key] = {};
-            for (let k = 0; k < languageSubKeys.length; k++) {
-                const subKey = languageSubKeys[k];
-                if (subKey.startsWith(keyFilter)) {
-                    result[key][subKey] = language[key][subKey];
-                }
-            }
-        } else if (key !== 'compiledTranslations') {
-            result[key] = language[key];
-        }
-    }
-
-    return result;
+function filterLanguageObject(language, keyFilter) {
+    return {
+        locale: language.locale,
+        locales: filterByKeyPrefix(language.locales, keyFilter),
+        translations: filterByKeyPrefix(language.translations, keyFilter),
+    };
 }
 
 module.exports = {
-    filterByKey: filterByKey,
+    filterByKey: filterLanguageObject,
 };

lib/translator/index.js

@@ -22,7 +22,6 @@ const DEFAULT_LOCALE = 'en';
  * @param {string} acceptLanguage
  * @param {Object} allTranslations
  * @param {Object} logger
- * @param {Boolean} omitTransforming
  */
 function Translator(acceptLanguage, allTranslations, logger = console) {
     this.logger = logger;
@@ -145,6 +144,7 @@ Translator.prototype._compileTemplate = function (key) {
 
             return () => '';
         }
+
         throw err;
     }
 };

spec/lib/translator.js

@@ -304,7 +304,6 @@ describe('Translator', () => {
                     search: 'German translation',
                 },
             };
-            console.log('before');
             const translator = Translator.create('es-mx,es,de,en', translations);
             expect(translator.translate('search')).to.equal(translations.de.search);
             done();