ui.8; sort objects by key when saving mfAll.js (closes #195)

Author: gadicc

README.md

@@ -18,7 +18,7 @@ the stable release):
 ```
 meteor add msgfmt:[email protected]         # 2016-01-11
 meteor add msgfmt:[email protected]
-meteor add msgfmt:[email protected].7            # 2016-01-11
+meteor add msgfmt:[email protected].8            # 2016-01-27
 ```
 
 If you don't want the UI translator on production (i.e. no crowd translation),

msgfmt:ui-dev-only/.versions

@@ -41,8 +41,8 @@ [email protected]
 [email protected]
 [email protected]
 msgfmt:[email protected]
-msgfmt:[email protected].7
-msgfmt:[email protected].0
+msgfmt:[email protected].8
+msgfmt:[email protected].1
 nicolaslopezj:[email protected]
 [email protected]_1
 [email protected]

msgfmt:ui-dev-only/package.js

@@ -1,12 +1,12 @@
 Package.describe({
   name:      "msgfmt:ui-dev-only",
-  version:   "2.0.0",
+  version:   "2.0.1",
   summary:   "msgfmt-ui that is never deployed",
   git:       "https://github.com/gadicc/meteor-messageformat.git",
   debugOnly: true
 });
 
 Package.onUse(function (api) {
-  api.use('msgfmt:[email protected].7');
+  api.use('msgfmt:[email protected].8');
   api.imply('msgfmt:ui');
 });

msgfmt:ui/.versions

@@ -31,7 +31,7 @@ jag:[email protected]
 [email protected]
 [email protected]
 [email protected]
-local-test:msgfmt:[email protected].7
+local-test:msgfmt:[email protected].8
 [email protected]
 [email protected]
 [email protected]
@@ -42,7 +42,7 @@ [email protected]
 [email protected]
 [email protected]
 msgfmt:[email protected]
-msgfmt:[email protected].7
+msgfmt:[email protected].8
 nicolaslopezj:[email protected]
 [email protected]_1
 [email protected]

msgfmt:ui/History.md

@@ -1,5 +1,11 @@
 ## vNEXT
 
+## 2.0.0-preview.8
+
+* Feature: sort objects by key when saving mfAll.js (#195)
+  Instead of natural order.  This helps keeping commits of
+  mfAll.js small, and gives better overview of changes.
+
 ## 2.0.0-preview.7
 
 * Feature: show/hide and sort by `key` (thanks @tomitrescak, #133,

msgfmt:ui/lib/server.js

@@ -78,14 +78,28 @@ Meteor.publish('mfStats', function() {
 });
 
 WebApp.connectHandlers.use('/translate/mfAll.js', function(req, res, next) {
-  var out, meta = { exportedAt: new Date().getTime(), updatedAt: 0 };
+  var lang, out, meta = { exportedAt: new Date().getTime(), updatedAt: 0 };
+
   for (lang in mfPkg.strings)
       for (key in mfPkg.strings[lang])
           if (mfPkg.strings[lang][key].mtime > meta.updatedAt)
               meta.updatedAt = mfPkg.strings[lang][key].mtime;
 
+  /*
+   * sort objects by key when saving mfAll.js (#195)
+   *   this helps keeping commits of mfAll.js small,
+   *   and gives better overview of changes.
+   */
+  var sortedStrings = {};
+  _.each(Object.keys(mfPkg.strings).sort(), function(lang) {
+    sortedStrings[lang] = {};
+    _.each(Object.keys(mfPkg.strings[lang]).sort(), function(key) {
+      sortedStrings[lang][key] = mfPkg.strings[lang][key];
+    });
+  });
+
   out = 'mfPkg.syncAll('
-      + JSON.stringify(mfPkg.strings, null, 2)
+      + JSON.stringify(sortedStrings, null, 2)
       + ', ' + JSON.stringify(meta, null, 2) + ');';
   //res.writeHead(200, {'Content-Type': 'application/javascript'});
   res.writeHead(200, {'Content-Disposition': 'attachment; filename=mfAll.js'});

msgfmt:ui/package.js

@@ -1,6 +1,6 @@
 Package.describe({
   name:    "msgfmt:ui",
-  version: "2.0.0-preview.7",
+  version: "2.0.0-preview.8",
   summary: "messageformat: translation UI",
   git:      "https://github.com/gadicc/meteor-messageformat.git",
 });
@@ -30,8 +30,8 @@ Package.onUse(function (api) {
 });
 
 Package.onTest(function(api) {
-  api.use('tinytest');
-  api.use('msgfmt:ui');
+  api.use(['tinytest', 'http', 'ejson', 'underscore']);
+  api.use(['msgfmt:core', 'msgfmt:ui']);
 
   api.addFiles('tests/tests-client.js', 'client');
   api.addFiles('tests/tests-server.js', 'server');

msgfmt:ui/tests/tests-client.js

@@ -1,3 +1,3 @@
-Tinytest.add('messageformat-ui', function(test) {
+Tinytest.add('msgfmt:ui', function(test) {
   test.ok(true);
 });

msgfmt:ui/tests/tests-server.js

@@ -1,3 +1,40 @@
-Tinytest.add('messageformat-ui', function(test) {
-  test.ok(true);
-});
+var vm = Npm.require('vm');
+
+function getMfAll() {
+  var res = HTTP.get(Meteor.absoluteUrl('/translate/mfAll.js'));
+  //var json = res.content.match(/^mfPkg.syncAll\(([\s\S]*)\);/)[1];
+  var sandbox = {
+    out: {},
+    mfPkg: {
+      syncAll: function(strings, meta) {
+        sandbox.out.strings = strings;
+        sandbox.out.meta = meta;
+      }
+    }
+  };
+
+  vm.runInNewContext(res.content, sandbox);
+  return sandbox.out;
+}
+
+Tinytest.add('msgfmt:ui - mfAll.js - sorted by key', function(test) {
+  // Add some out of order stuff to whatever's already in db
+  msgfmt.langUpdate('en', {
+    keyOrderC: { key: 'keyOrderC', lang: 'en', text: 'keyOrderC', ctime: 1453884079148, mtime: 1453884079148, revisionId: 'c8eDxMdMJJKDfpEME', file: 'msgfmt:ui-tests', line: 0, func: 'function()' },
+    keyOrderA: { key: 'keyOrderA', lang: 'en', text: 'keyOrderA', ctime: 1453884079148, mtime: 1453884079148, revisionId: 'c8eDxMdMJJKDfpEMF', file: 'msgfmt:ui-tests', line: 0, func: 'function()' },
+    keyOrderB: { key: 'keyOrderB', lang: 'en', text: 'keyOrderB', ctime: 1453884079148, mtime: 1453884079148, revisionId: 'c8eDxMdMJJKDfpEMG', file: 'msgfmt:ui-tests', line: 0, func: 'function()' }
+  }, {
+    exportedAt: Date.now(),
+    updatedAt: Date.now()
+  });
+
+  var strings = getMfAll().strings;
+  var keys = Object.keys(strings.en);
+
+  // Assert no change in EJSON's behaviour to make sure below remains true
+  if (EJSON.stringify({c:1, a:1, b:1}) !== '{"c":1,"a":1,"b":1}')
+    throw new Error("EJSON behaviour has changed");
+
+  // Must use EJSON since JSON.stringify re-orders the keys
+  test.equal(EJSON.stringify(keys), EJSON.stringify(keys.sort()));
+});