Merge pull request #1022 from strongloop/feature/add_globalization

Support for globalization

Author: Amir-61

.gitignore

@@ -12,3 +12,6 @@ docs/man
 npm-debug.log
 .project
 test/memory.json
+intl/*
+!intl/en/
+

index.js

@@ -3,6 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+var SG = require('strong-globalize');
+SG.SetRootDir(__dirname);
+
 exports.ModelBuilder = exports.LDL = require('./lib/model-builder.js').ModelBuilder;
 exports.DataSource = exports.Schema = require('./lib/datasource.js').DataSource;
 exports.ModelBaseClass = require('./lib/model.js');

intl/en/messages.json

@@ -0,0 +1,62 @@
+{
+  "4c78325cedbb826db3a05bf5df0e8546": "You must provide an {{id}} when replacing!",
+  "a0cf0e09c26df14283223e84e6a10f00": "Could not update attributes. {{Object}} with {{id}} {0} does not exist!",
+  "e54d944c2a2c85a23caa86027ae307cf": "Cannot migrate models not attached to this datasource: {0}",
+  "e6161ae8459c79d810e2aa9d21282a39": "You must provide an {{id}} when updating attributes!",
+  "fca4d12faff1035d9d0438d73432571b": "Duplicate entry for {0}.{1}",
+  "09483e03b91c8bd58732a74b3ef1ec13": "Invalid date: {0}",
+  "0e88a84c6bc2638fbcc5d3ea95181f99": "Unknown property: {0}",
+  "416dfbb7b823f51c9f3800be81060b41": "No instance with {{id}} {0} found for {1}",
+  "5ec8efeb715a2c34b440f2d76e2cf87d": "  {0}",
+  "6c3234937d69763fc7f6bcafccc59bbc": "{{Model::deleteById}} requires the {{id}} argument",
+  "6eb6fd4fbd73394000bc25f5776fd20c": "{{Model::exists}} requires the {{id}} argument",
+  "7bbbdece4eea90e42aa5c0bce295e503": "{{Model::findById}} requires the {{id}} argument",
+  "a829dee089c912e68c18920ba015400c": "WARNING: {{id}} property cannot be changed from {0} to {1} for model:{2} in {{'loaded'}} operation hook",
+  "a984a076c59e451948b2bcf7a393d860": "WARNING: {{id}} property cannot be changed from {0} to {1} for model:{2} in {{'before save'}} operation hook",
+  "db03083e9a768388fdbee865249ac67a": "Ignoring validation errors in {{updateOrCreate()}}:",
+  "e4434de4bb8f5a3cd1d416e4d80d7e0b": "Unknown \"{0}\" {{id}} \"{1}\".",
+  "f6e8c96c93b9c7687d6c172b3695e898": "{{id}} property ({0}) cannot be updated from {1} to {2}",
+  "0be2d39d225b1d8b2a0f92ad5c65c9ac": "No model specified for {{polymorphic}} {0}: {1}",
+  "0c4eb8b6c2ff6e51d7e195eee346ced9": "Table '{0}' does not exist.",
+  "2f4af31c144bbfab1bbf479866acd820": "\nWARNING: {{LoopBack}} connector \"{0}\" is not installed as any of the following modules:\n\n {1}\n\nTo fix, run:\n\n    {{npm install {2} --save}}\n",
+  "6111399276924ffa3bc9a410cdfcb2e5": "No {{id}} name {0}",
+  "791ab3031a73ede03f7d6299a85e8289": "Timeout in connecting after {0} ms",
+  "7b277018e43d41bc445731092b91547d": "Not connected",
+  "a2487abefef4259c2131d96cdb8543b1": "Connection fails: {0}\nIt will be retried for the next request.",
+  "b15b20280211ad258d92947f05b6e4a5": "The connector has not been initialized.",
+  "ddf0aa14803f1c84f4a97f3803f7471c": "Class name required",
+  "e0e9504e137a3c3339144b51ed76fef2": "Connector is not defined correctly: it should create `{{connector}}` member of dataSource",
+  "ec42dca074f1818c447f7ad16e2d01af": "{0} is not provided by the attached connector",
+  "ba0fd8106eb54de4d003a844206431fd": "Model hook \"{0}\" is deprecated, use Operation hooks instead. {{http://docs.strongloop.com/display/LB/Operation+hooks}}",
+  "280f4550f90e133118955ec6f6f72830": "Discriminator type {0} specified but no model exists with such name",
+  "83abbb3ad105947dccbb21b4cf41e98f": "{{Relation.modelTo}} is not defined for relation {0} and is no polymorphic",
+  "eb56c2b0c30cf006e2df00a549ec9c2c": "Relation \"{0}\" is not defined for {1} model",
+  "514985b2327f061ffb1c932f6b909979": "Model {0} is not defined.",
+  "8091838319a5cc7d6a34af2f2a616ce9": "Property name should not be \"{{constructor}}\" in Model: {0}",
+  "da02dd6c53d4148320eeb31718a7aebe": "Invalid type for property {0}",
+  "da751a8a748adbde5b55fa83b707b4e2": "Property names containing dot(s) are not supported. Model: {0}, property: {1}",
+  "881e4b0cb86ed59549248ee540a9fd10": "Property name \"{{constructor}}\" is not allowed in {0} data",
+  "bdb11cc1c780c9ccac33c316cfdc9d82": "Type not defined for property {0}.{1}",
+  "cd930369e86cdd222f7bd117c6f9fa94": "Unknown default value provider {0}",
+  "cfee4d8149316d9a647c0885cf3cafaf": "Property names containing dot(s) are not supported. Model: {0}, dynamic property: {1}",
+  "0c0b867aca0973ba26e887d3337cc4ec": "{{Polymorphic}} model not found: `{0}` not set",
+  "2f062cbecdf24245731bddc77714c814": "Could not find \"{0}\" relation for {1}",
+  "3cde8cc9bca22c67278b202ab0720106": "No instance with id {0} found for {1}",
+  "6502a117987610380b9068ef98b1b0ee": "No record found in {0} for ({1}.{2} ,{3}.{4})",
+  "6fcc2ff0db7a4f490f5e0ce9e24691f3": "{{HasOne}} relation cannot create more than one instance of {0}",
+  "7e9530c0399289be0ee601a604be71ff": "{{BelongsTo}} relation {0} is empty",
+  "7faa840eb6ce11250a141deb42a6c489": "Unknown relation {{scope}}: {0}",
+  "89afd3a9249f5a8d3edda07d84ca049d": "{{Polymorphic}} model not found: `{0}`",
+  "a004f310d315e592843776fab964eaeb": "{{Polymorphic}} relations need a through model",
+  "a25e41a39c60c4702e55d0c3936576a1": "Key mismatch: {0}.{1}: {2}, {3}.{4}: {5}",
+  "a327355560d495454fba2c1aad6bdf09": "Unknown scope method: {0}",
+  "e08ab0e1ab55f26c357061447b635905": "No relation found in {0} for ({1}.{2},{3}.{4})",
+  "e55937649d8d7a11706b8cec22d02eae": "{{HasOne}} relation {0} is empty",
+  "2c4904377a87fdab502118719cc0d266": "{{Transaction}} is not supported",
+  "ecb7aa804bf54c682999d20d6436104c": "The {{transaction}} is not active: {0}",
+  "89bf6d92731fe7bd2146ce8d0bec205c": "Invalid argument, must be a string, {{regex}} literal, or {{RegExp}} object",
+  "8c5ab01638c1ac1d58168c6346a8481a": "Invalid {{regex}} flags: {0}",
+  "a6c18a7f4390cd3d59a2a7a047ae2aab": "Run \"{{npm install loopback-datasource-juggler}} {0}\" command ",
+  "b138294f132edfe1eb2a8211150c7238": "Unexpected `undefined` in query",
+  "8a39126103a157f501affa070367a1b0": "The {0} instance is not valid. Details: {1}."
+}

lib/connectors/memory.js

@@ -3,6 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+var g = require('strong-globalize')();
 var util = require('util');
 var Connector = require('loopback-connector').Connector;
 var geo = require('../geo');
@@ -217,7 +218,7 @@ Memory.prototype._createSync = function(model, data, fn) {
   }
 
   if (this.collection(model)[id])
-    return fn(new Error('Duplicate entry for ' + model + '.' + idName));
+    return fn(new Error(g.f('Duplicate entry for %s.%s', model, idName)));
 
   this.collection(model)[id] = serialize(data);
   fn(null, id);
@@ -711,7 +712,7 @@ Memory.prototype.update =
 
 Memory.prototype.updateAttributes = function updateAttributes(model, id, data, options, cb) {
   if (!id) {
-    var err = new Error('You must provide an id when updating attributes!');
+    var err = new Error(g.f('You must provide an {{id}} when updating attributes!'));
     if (cb) {
       return cb(err);
     } else {
@@ -730,14 +731,14 @@ Memory.prototype.updateAttributes = function updateAttributes(model, id, data, o
   if (modelData) {
     this.save(model, data, options, cb);
   } else {
-    cb(new Error('Could not update attributes. Object with id ' + id + ' does not exist!'));
+    cb(new Error(g.f('Could not update attributes. {{Object}} with {{id}} %s does not exist!', id)));
   }
 };
 
 Memory.prototype.replaceById = function(model, id, data, options, cb) {
   var self = this;
   if (!id) {
-    var err = new Error('You must provide an id when replacing!');
+    var err = new Error(g.f('You must provide an {{id}} when replacing!'));
     return process.nextTick(function() { cb(err); });
   }
   // Do not modify the data object passed in arguments
@@ -828,8 +829,8 @@ Memory.prototype.automigrate = function(models, cb) {
 
   if (invalidModels.length) {
     return process.nextTick(function() {
-      cb(new Error('Cannot migrate models not attached to this datasource: ' +
-        invalidModels.join(' ')));
+      cb(new Error(g.f('Cannot migrate models not attached to this datasource: %s',
+        invalidModels.join(' '))));
     });
   }
 

lib/connectors/transient.js

@@ -3,6 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+var g = require('strong-globalize')();
 var util = require('util');
 var Connector = require('loopback-connector').Connector;
 var utils = require('../utils');
@@ -108,7 +109,7 @@ Transient.prototype.update =
 
 Transient.prototype.updateAttributes = function updateAttributes(model, id, data, cb) {
   if (!id) {
-    var err = new Error('You must provide an id when updating attributes!');
+    var err = new Error(g.f('You must provide an {{id}} when updating attributes!'));
     if (cb) {
       return cb(err);
     } else {

lib/dao.js

@@ -11,6 +11,7 @@ module.exports = DataAccessObject;
 /*!
  * Module dependencies
  */
+var g = require('strong-globalize')();
 var async = require('async');
 var jutil = require('./jutil');
 var ValidationError = require('./validations').ValidationError;
@@ -89,7 +90,7 @@ function applyStrictCheck(model, strict, data, inst, cb) {
     if (props[key]) {
       result[key] = data[key];
     } else if (strict === 'throw') {
-      cb(new Error('Unknown property: ' + key));
+      cb(new Error(g.f('Unknown property: %s', key)));
       return;
     } else if (strict === 'validate') {
       inst.__unknownProperties.push(key);
@@ -533,8 +534,8 @@ DataAccessObject.upsert = function(data, options, cb) {
                 return cb(new ValidationError(inst), inst);
               } else {
                 // TODO(bajtos) Remove validateUpsert:undefined in v3.0
-                console.warn('Ignoring validation errors in updateOrCreate():');
-                console.warn('  %s', new ValidationError(inst).message);
+                g.warn('Ignoring validation errors in {{updateOrCreate()}}:');
+                g.warn('  %s', new ValidationError(inst).message);
                 // continue with updateOrCreate
               }
             }
@@ -1049,7 +1050,7 @@ DataAccessObject.exists = function exists(id, options, cb) {
     });
   } else {
     process.nextTick(function() {
-      cb(new Error('Model::exists requires the id argument'));
+      cb(new Error(g.f('{{Model::exists}} requires the {{id}} argument')));
     });
   }
   return cb.promise;
@@ -1111,7 +1112,7 @@ DataAccessObject.findById = function findById(id, filter, options, cb) {
     return cb.promise;
   } else if (id == null || id === '') {
     process.nextTick(function() {
-      cb(new Error('Model::findById requires the id argument'));
+      cb(new Error(g.f('{{Model::findById}} requires the {{id}} argument')));
     });
   } else {
     var query = byIdQuery(this, id);
@@ -1184,7 +1185,7 @@ function convertNullToNotFoundError(ctx, cb) {
 
   var modelName = ctx.method.sharedClass.name;
   var id = ctx.getArgByName('id');
-  var msg = 'Unknown "' + modelName + '" id "' + id + '".';
+  var msg = g.f('Unknown "%s" {{id}} "%s".', modelName, id);
   var error = new Error(msg);
   error.statusCode = error.status = 404;
   cb(error);
@@ -1242,22 +1243,22 @@ DataAccessObject._normalize = function(filter) {
   }
   var err = null;
   if ((typeof filter !== 'object') || Array.isArray(filter)) {
-    err = new Error(util.format('The query filter %j is not an object', filter));
+    err = new Error(g.f(util.format('The query filter %j is not an {{object}}', filter)));
     err.statusCode = 400;
     throw err;
   }
   if (filter.limit || filter.skip || filter.offset) {
     var limit = Number(filter.limit || 100);
     var offset = Number(filter.skip || filter.offset || 0);
     if (isNaN(limit) || limit <= 0 || Math.ceil(limit) !== limit) {
-      err = new Error(util.format('The limit parameter %j is not valid',
-        filter.limit));
+      err = new Error(g.f(util.format('The {{limit}} parameter %j is not valid',
+        filter.limit)));
       err.statusCode = 400;
       throw err;
     }
     if (isNaN(offset) || offset < 0 || Math.ceil(offset) !== offset) {
-      err = new Error(util.format('The offset/skip parameter %j is not valid',
-          filter.skip || filter.offset));
+      err = new Error(g.f(util.format('The {{offset/skip}} parameter %j is not valid',
+          filter.skip || filter.offset)));
       err.statusCode = 400;
       throw err;
     }
@@ -1288,7 +1289,7 @@ DataAccessObject._normalize = function(filter) {
             if (dir === 'ASC' || dir === 'DESC') {
               token = parts[0] + ' ' + dir;
             } else {
-              err = new Error(util.format('The order %j has invalid direction', token));
+              err = new Error(g.f(util.format('The {{order}} %j has invalid direction', token)));
               err.statusCode = 400;
               throw err;
             }
@@ -1324,7 +1325,7 @@ DataAccessObject._normalize = function(filter) {
 function DateType(arg) {
   var d = new Date(arg);
   if (isNaN(d.getTime())) {
-    throw new Error('Invalid date: ' + arg);
+    throw new Error(g.f('Invalid date: %s', arg));
   }
   return d;
 }
@@ -1365,7 +1366,7 @@ DataAccessObject._coerce = function(where) {
 
   var err;
   if (typeof where !== 'object' || Array.isArray(where)) {
-    err = new Error(util.format('The where clause %j is not an object', where));
+    err = new Error(g.f(util.format('The where clause %j is not an {{object}}', where)));
     err.statusCode = 400;
     throw err;
   }
@@ -1380,7 +1381,7 @@ DataAccessObject._coerce = function(where) {
           self._coerce(clauses[k]);
         }
       } else {
-        err = new Error(util.format('The %s operator has invalid clauses %j', p, clauses));
+        err = new Error(g.f(util.format('The %s operator has invalid clauses %j', p, clauses)));
         err.statusCode = 400;
         throw err;
       }
@@ -1439,22 +1440,22 @@ DataAccessObject._coerce = function(where) {
             case 'inq':
             case 'nin':
               if (!Array.isArray(val)) {
-                err = new Error(util.format('The %s property has invalid clause %j', p, where[p]));
+                err = new Error(g.f(util.format('The %s property has invalid clause %j', p, where[p])));
                 err.statusCode = 400;
                 throw err;
               }
               break;
             case 'between':
               if (!Array.isArray(val) || val.length !== 2) {
-                err = new Error(util.format('The %s property has invalid clause %j', p, where[p]));
+                err = new Error(g.f(util.format('The %s property has invalid clause %j', p, where[p])));
                 err.statusCode = 400;
                 throw err;
               }
               break;
             case 'like':
             case 'nlike':
               if (!(typeof val === 'string' || val instanceof RegExp)) {
-                err = new Error(util.format('The %s property has invalid clause %j', p, where[p]));
+                err = new Error(g.f(util.format('The %s property has invalid clause %j', p, where[p])));
                 err.statusCode = 400;
                 throw err;
               }
@@ -2011,7 +2012,7 @@ DataAccessObject.deleteById = function deleteById(id, options, cb) {
     return cb.promise;
   } else if (id == null || id === '') {
     process.nextTick(function() {
-      cb(new Error('Model::deleteById requires the id argument'));
+      cb(new Error(g.f('{{Model::deleteById}} requires the {{id}} argument')));
     });
     return cb.promise;
   }
@@ -2022,7 +2023,7 @@ DataAccessObject.deleteById = function deleteById(id, options, cb) {
     if (err) return cb(err);
     var deleted = info && info.count > 0;
     if (Model.settings.strictDelete && !deleted) {
-      err = new Error('No instance with id ' + id + ' found for ' + Model.modelName);
+      err = new Error(g.f('No instance with {{id}} %s found for %s', id, Model.modelName));
       err.code = 'NOT_FOUND';
       err.statusCode = 404;
       return cb(err);
@@ -2485,7 +2486,7 @@ DataAccessObject.prototype.remove =
             if (err) return cb(err, false);
             var deleted = info && info.count > 0;
             if (Model.settings.strictDelete && !deleted) {
-              err = new Error('No instance with id ' + id + ' found for ' + Model.modelName);
+              err = new Error(g.f('No instance with {{id}} %s found for %s', id, Model.modelName));
               err.code = 'NOT_FOUND';
               err.statusCode = 404;
               return cb(err, false);
@@ -2509,7 +2510,7 @@ DataAccessObject.prototype.remove =
             if (err) return cb(err);
             var deleted = info && info.count > 0;
             if (Model.settings.strictDelete && !deleted) {
-              err = new Error('No instance with id ' + id + ' found for ' + Model.modelName);
+              err = new Error(g.f('No instance with {{id}} %s found for %s', id, Model.modelName));
               err.code = 'NOT_FOUND';
               err.statusCode = 404;
               return cb(err);
@@ -2654,8 +2655,8 @@ DataAccessObject.replaceById = function(id, data, options, cb) {
   var hookState = {};
 
   if (id !== data[pkName]) {
-    var err = new Error('id property (' + pkName + ') ' +
-            'cannot be updated from ' + id + ' to ' + data[pkName]);
+    var err = new Error(g.f('{{id}} property (%s) ' +
+            'cannot be updated from %s to %s', pkName, id, data[pkName]));
     err.statusCode = 400;
     process.nextTick(function() { cb(err); });
     return cb.promise;
@@ -2674,9 +2675,8 @@ DataAccessObject.replaceById = function(id, data, options, cb) {
 
     if (ctx.instance[pkName] !== id && !Model._warned.cannotOverwritePKInBeforeSaveHook) {
       Model._warned.cannotOverwritePKInBeforeSaveHook = true;
-      console.warn('WARNING: id property cannot be changed from ' +
-        id + ' to ' + inst[pkName] + ' for model:' + Model.modelName +
-        ' in \'before save\' operation hook');
+      g.warn('WARNING: {{id}} property cannot be changed from %s to %s for model:%s ' +
+        'in {{\'before save\'}} operation hook', id, inst[pkName], Model.modelName);
     }
 
     data = inst.toObject(false);
@@ -2732,9 +2732,9 @@ DataAccessObject.replaceById = function(id, data, options, cb) {
 
             if (ctx.data[pkName] !== id && !Model._warned.cannotOverwritePKInLoadedHook) {
               Model._warned.cannotOverwritePKInLoadedHook = true;
-              console.warn('WARNING: id property cannot be changed from ' +
-                id + ' to ' + ctx.data[pkName] + ' for model:' + Model.modelName +
-                ' in \'loaded\' operation hook');
+              g.warn('WARNING: {{id}} property cannot be changed from %s to %s for model:%s in ' +
+                '{{\'loaded\'}} operation hook',
+                id, ctx.data[pkName], Model.modelName);
             }
 
             inst.__persisted = true;
@@ -2841,8 +2841,8 @@ function(data, options, cb) {
   for (var i = 0, n = idNames.length; i < n; i++) {
     var idName = idNames[i];
     if (data[idName] !== undefined && !idEquals(data[idName], inst[idName])) {
-      var err = new Error('id property (' + idName + ') ' +
-        'cannot be updated from ' + inst[idName] + ' to ' + data[idName]);
+      var err = new Error(g.f('{{id}} property (%s) ' +
+        'cannot be updated from %s to %s'), idName, inst[idName], data[idName]);
       err.statusCode = 400;
       process.nextTick(function() {
         cb(err);