not-locale 0.0.19 → 0.0.20

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "not-locale",
-	"version": "0.0.19",
+	"version": "0.0.20",
 	"description": "not-* family module for localization in not- environment",
 	"main": "index.js",
 	"scripts": {
@@ -24,13 +24,13 @@
 	},
 	"homepage": "https://github.com/interrupter/not-locale#readme",
 	"dependencies": {
-		"not-log": "^0.0.18",
+		"not-log": "^0.0.20",
 		"not-path": "^1.0.1"
 	},
 	"devDependencies": {
 		"chai": "*",
 		"chai-as-promised": "*",
-		"eslint": "^8.0.1",
+		"eslint": "^8.3.0",
 		"ink-docstrap": "^1.3.2",
 		"jsdoc": "^3.6.7",
 		"mocha": "*",

package/src/common/lib.js

@@ -15,37 +15,37 @@ var store = {},
 		getter: null
 	};
 
-	/**
-	* Express middleware, to determine in which locale should we process response
-	*/
-
-	function detect( req, res, next ){
-		let reqLang;
-		if (OPTS.getter){
-			reqLang = OPTS.getter(req);
-		}else{
-			reqLang = req.get('Accept-Language');
-		}
-		if (Object.prototype.hasOwnProperty.call(store, reqLang)){
-			res.locals.locale = reqLang;
-		}else{
-			res.locals.locale = OPTS.default;
-		}
-		next();
+/**
+ * Express middleware, to determine in which locale should we process response
+ */
+
+function detect(req, res, next) {
+	let reqLang;
+	if (OPTS.getter) {
+		reqLang = OPTS.getter(req);
+	} else {
+		reqLang = req.get('Accept-Language');
+	}
+	if (Object.prototype.hasOwnProperty.call(store, reqLang)) {
+		res.locals.locale = reqLang;
+	} else {
+		res.locals.locale = OPTS.default;
 	}
+	next();
+}
 
-	/**
-	* Express middleware initializer, to determine in which locale should we process response
-	* @param {object} options - object with `deafult` {string}, `getter` {function} redefined
-	* @return {function} function wich will accept three params (req, res, next) and run as express middleware
-	*/
+/**
+ * Express middleware initializer, to determine in which locale should we process response
+ * @param {object} options - object with `deafult` {string}, `getter` {function} redefined
+ * @return {function} function wich will accept three params (req, res, next) and run as express middleware
+ */
 
-exports.getMiddleware = (options)=>{
-	if (options){
-		if (options.default && options.default.length > 1){
+exports.getMiddleware = (options) => {
+	if (options) {
+		if (options.default && options.default.length > 1) {
 			OPTS.default = options.default;
 		}
-		if (options.getter && typeof options.getter === 'function'){
+		if (options.getter && typeof options.getter === 'function') {
 			OPTS.getter = options.getter;
 		}
 	}
@@ -54,12 +54,12 @@ exports.getMiddleware = (options)=>{
 
 
 /**
-  * Add locale by json object
-  * @param {string} locale - name of locale
-  * @param {json} json - json object
-  */
-exports.fromJSON = (locale, json, prefix = '')=>{
-	if(prefix){
+ * Add locale by json object
+ * @param {string} locale - name of locale
+ * @param {json} json - json object
+ */
+exports.fromJSON = (locale, json, prefix = '') => {
+	if (prefix) {
 		let tmp = {};
 		const keys = Object.keys(json);
 		keys.forEach((key) => {
@@ -67,36 +67,36 @@ exports.fromJSON = (locale, json, prefix = '')=>{
 		});
 		json = tmp;
 	}
-	if (typeof store[locale] !== 'undefined'){
+	if (typeof store[locale] !== 'undefined') {
 		store[locale] = Object.assign(store[locale], json);
-	}else{
+	} else {
 		store[locale] = Object.assign({}, json);
 	}
 };
 
 /**
-  * Load locales from directory, with json files, names as [locale_name].json
-  * @param {number} pathToLocales - absolute path to directory
-  * @return {Promise}
-  */
-exports.fromDir = (pathToLocales, prefix = '')=>{
-	return new Promise((resolve, reject)=>{
+ * Load locales from directory, with json files, names as [locale_name].json
+ * @param {number} pathToLocales - absolute path to directory
+ * @return {Promise}
+ */
+exports.fromDir = (pathToLocales, prefix = '') => {
+	return new Promise((resolve, reject) => {
 		fs.readdir(pathToLocales, (err, items) => {
-			if (err){
+			if (err) {
 				reject(err);
-			}else{
-				for(let i = 0; i < items.length; i++) {
+			} else {
+				for (let i = 0; i < items.length; i++) {
 					let filename = path.join(pathToLocales, items[i]),
 						stats = fs.lstatSync(filename);
-					if (stats.isFile()){
-						try{
+					if (stats.isFile()) {
+						try {
 							let file = require(filename),
 								[localeName] = items[i].split('.');
 							exports.fromJSON(localeName, file, prefix);
-						}catch(e){
+						} catch (e) {
 							Log.error(e);
 						}
-					}else{
+					} else {
 						continue;
 					}
 				}
@@ -107,56 +107,63 @@ exports.fromDir = (pathToLocales, prefix = '')=>{
 };
 
 /**
-  * Returns localized variant of code phrase
-  * @param {string} phrase - code phrase
-  * @param {array|object} params - array or hash with params for template parser
-  * @return {string} localized variant
-  */
-function say(phrase, params = {}, locale = OPTS.default){
-	try{
+ * Returns localized variant of code phrase
+ * @param {string} phrase - code phrase
+ * @param {array|object} params - array or hash with params for template parser
+ * @return {string} localized variant
+ */
+function say(phrase, params = {}, locale = OPTS.default) {
+	try {
 		let tmpl = store[locale][phrase],
 			result = '';
-		if (params){
+		if (typeof tmpl === 'undefined') {
+			return phrase;
+		}
+		if (params) {
 			return notPath.parseSubs(tmpl, params, {});
-		}else{
+		} else {
 			result = tmpl;
 		}
 		return result;
-	}catch(e){
+	} catch (e) {
 		Log.error(e);
 	}
-};
+}
 
-exports.say = say
+exports.say = say;
 
 /**
-  * Getter for stores of all locales
-  * @return {objects} all locales
-  */
-exports.vocabulary = () => {return store;};
+ * Getter for stores of all locales
+ * @return {objects} all locales
+ */
+exports.vocabulary = () => {
+	return store;
+};
 
 /**
-  * Getter for OPTS variable
-  * @return {object} copy of OPTS object
-  */
-exports.OPTS = () => { return Object.assign({}, OPTS);};
+ * Getter for OPTS variable
+ * @return {object} copy of OPTS object
+ */
+exports.OPTS = () => {
+	return Object.assign({}, OPTS);
+};
 
 
-exports.get = (locale)=>{
-	if(Object.prototype.hasOwnProperty.call(store, locale)){
+exports.get = (locale) => {
+	if (Object.prototype.hasOwnProperty.call(store, locale)) {
 		return store[locale];
-	}else{
+	} else {
 		return {};
 	}
 };
 
 
-exports.available = ()=>{
+exports.available = () => {
 	return Object.keys(store);
 };
 
 
-function modulePhrase(moduleName = ''){
+function modulePhrase(moduleName = '') {
 	return (phrase) => [moduleName, phrase].join(':');
 }
 
@@ -169,5 +176,5 @@ exports.sayForModule = (moduleName = '') => {
 			params,
 			locale
 		);
-	}
+	};
 };

package/src/controllers/common/nsLocale.js

@@ -1,75 +1,81 @@
 /**
-* detects current locale, loads dictionary from server
-*
-**/
+ * detects current locale, loads dictionary from server
+ *
+ **/
 
 const SECTION_ID = 'locale';
 
-import {notCommon, notLocale, TopMenu} from 'not-bulma';
+import {
+  notCommon,
+  notLocale,
+  TopMenu
+} from 'not-bulma';
 
-class nsLocale{
-  constructor(app){
+class nsLocale {
+  constructor(app) {
     this.app = app;
     this.locales = [];
     this.failures = 0;
     this.app.on('wsClient:main:connected', this.update.bind(this));
-    notLocale.on('change', ()=>{
+    notLocale.on('change', () => {
       this.app.emit('locale');
     });
   }
 
   /**
-  * Creates network interface for this service
-  */
-  interface(data){
+   * Creates network interface for this service
+   */
+  interface(data) {
     return this.app.getInterface('locale')(data);
   }
 
   /**
-  * Retrieves dictionary for current locale
-  * sets dictionary in notLocale object
-  */
-  async update(){
-    try{
+   * Retrieves dictionary for current locale
+   * sets dictionary in notLocale object
+   */
+  async update() {
+    try {
       await this.updateAvailable();
-      let res = await this.interface({locale: this.getCurrentLocale()}).$get({});
-      if(res.status === 'ok' && res.result){
+      let res = await this.interface({
+        locale: this.getCurrentLocale()
+      }).$get({});
+      if (res.status === 'ok' && res.result) {
         notLocale.set(res.result);
-      }else{
+      } else {
         this.scheduleUpdate();
       }
-    }catch(e){
+    } catch (e) {
       notCommon.error(e);
       this.scheduleUpdate();
     }
   }
 
-  scheduleUpdate(){
+  scheduleUpdate() {
     this.failures++;
-    if(this.failures < 100){
+    if (this.failures < 100) {
       setTimeout(this.update.bind(this), 1000 * this.failures);
-    }else{
+    } else {
       notCommon.error('Too many failures of locale loading');
     }
   }
 
-  async updateAvailable(){
-    try{
+  async updateAvailable() {
+    try {
       let res = await this.interface({}).$available({});
-      if(res.status === 'ok' && res.result){
+      if (res.status === 'ok' && res.result) {
         this.setAvailable(res.result);
       }
-    }catch(e){
+    } catch (e) {
       notCommon.error(e);
     }
   }
 
-  updateUI(list){
+  updateUI(list) {
     let menuItems = this.createMenuItems(list);
     TopMenu.updateSectionItems(SECTION_ID, () => {
       return menuItems;
     });
-    setTimeout(()=>{
+    setTimeout(() => {
       this.app.emit(`tag-${SECTION_ID}:update`, {
         title: this.getCurrentLocale()
       });
@@ -91,18 +97,18 @@ class nsLocale{
     };
   }
 
-  changeLocale(locale){
+  changeLocale(locale) {
     this.saveLocaleToStore(locale);
     this.update();
   }
 
   /**
-  * @returns {string}   code of current locale
-  **/
-  getCurrentLocale(){
+   * @returns {string}   code of current locale
+   **/
+  getCurrentLocale() {
     let stored = this.restoreLocaleFromStore();
-    if (stored){
-      if(this.locales.includes(stored)){
+    if (stored) {
+      if (this.locales.includes(stored)) {
         return stored;
       }
     }
@@ -110,22 +116,22 @@ class nsLocale{
   }
 
   /**
-  * @returns {Promise<Array>}   of locales objects {code, title}
-  **/
-  getAvailable(){
+   * @returns {Promise<Array>}   of locales objects {code, title}
+   **/
+  getAvailable() {
     return this.interface().$available({});
   }
 
 
-  setAvailable(list){
+  setAvailable(list) {
     this.locales = list;
     this.updateUI(list);
   }
 
-  restoreLocaleFromStore(){
+  restoreLocaleFromStore() {
     if (window.localStorage) {
-    	try {
-    	  return window.localStorage.getItem('locale');
+      try {
+        return window.localStorage.getItem('locale');
       } catch (e) {
         this.app.error(e);
         return false;
@@ -134,10 +140,10 @@ class nsLocale{
     return false;
   }
 
-  saveLocaleToStore(locale){
+  saveLocaleToStore(locale) {
     if (window.localStorage) {
-    	try {
-    	  return window.localStorage.setItem('locale', locale);
+      try {
+        return window.localStorage.setItem('locale', locale);
       } catch (e) {
         this.app.error(e);
         return false;
@@ -146,12 +152,12 @@ class nsLocale{
     return false;
   }
 
-  selectBest(){
-    if(navigator.languages){
+  selectBest() {
+    if (navigator.languages) {
       let locale = navigator.languages.find((itm) => {
         return this.locales.includes(itm);
       });
-      if(locale){
+      if (locale) {
         return locale;
       }
     }

package/src/routes/locale.manifest.js

@@ -1,4 +1,4 @@
-const Log = require('not-log')(module, 'locale:route');
+const {error} = require('not-log')(module, 'locale:route');
 
 try {
 	module.exports = {
@@ -33,5 +33,5 @@ try {
 		}
 	};
 } catch (e) {
-	Log.error(e);
+	error(e);
 }

package/src/routes/locale.ws.js

@@ -11,10 +11,10 @@ async function available(){
 }
 
 module.exports = {
-	servers:{
-		main:{
-			request: {
-				get,
+	servers:{					//collection type
+		main:{					//collection name
+			request: { 		//routes(end-points) type
+				get,				//end-points
 				available
 			}
 		}

package/test/index.js

@@ -71,7 +71,7 @@ describe("say", function() {
 	});
 
 	it("phrase not exists `like`", function() {
-		expect(locale.say('like')).to.be.undefined;
+		expect(locale.say('like_me')).to.be.equal('like_me');
 	});
 
 	it("locale not exists, should throw", function() {