Merge pull request #5338 from rocketspacer/feature/alias-query

Query and construct document with aliases with Model.translateAliases

Author: vkarpov15

lib/model.js

@@ -1057,6 +1057,42 @@ Model.base;
 
 Model.discriminators;
 
+/**
+  * Translate any aliases fields/conditions so the final query or document object is pure
+  *
+  * ####Example:
+  *
+  *     Character
+  *       .find(Character.translateAliases({
+  *         '名': 'Eddard Stark' // Alias for 'name'
+  *       })
+  *       .exec(function(err, characters) {})
+  *
+  * ####Note:
+  * Only translate arguments of object type anything else is returned raw
+  *
+  * @param {Object} raw fields/conditions that may contain aliased keys
+  * @return {Object} the translated 'pure' fields/conditions
+  */
+Model.translateAliases = function translateAliases(fields) {
+  var aliases = this.schema.aliases;
+
+  if (typeof fields === 'object') {
+    // Fields is an object (query conditions or document fields)
+    for (var key in fields) {
+      if (aliases[key]) {
+        fields[aliases[key]] = fields[key];
+        delete fields[key];
+      }
+    }
+
+    return fields;
+  } else {
+    // Don't know typeof fields
+    return fields;
+  }
+};
+
 /**
  * Removes the first document that matches `conditions` from the collection.
  * To remove all documents that match `conditions`, set the `justOne` option

lib/schema.js

@@ -75,6 +75,7 @@ function Schema(obj, options) {
 
   this.obj = obj;
   this.paths = {};
+  this.aliases = {};
   this.subpaths = {};
   this.virtuals = {};
   this.singleNestedPaths = {};
@@ -138,7 +139,6 @@ function Schema(obj, options) {
  * Create virtual properties with alias field
  */
 function aliasFields(schema) {
-  // console.log(schema.paths);
   for (var path in schema.paths) {
     if (!schema.paths[path].options) continue;
 
@@ -147,6 +147,11 @@ function aliasFields(schema) {
 
     if (alias) {
       if ('string' === typeof alias && alias.length > 0) {
+        if (schema.aliases[alias])
+          throw new Error('Duplicate alias, alias ' + alias + ' is used more than once');
+        else
+          schema.aliases[alias] = prop;
+
         schema
           .virtual(alias)
           .get((function(p) {

test/model.translateAliases.test.js

@@ -0,0 +1,31 @@
+/**
+ * Test dependencies.
+ */
+
+var start = require('./common'),
+    assert = require('power-assert'),
+    mongoose = start.mongoose;
+
+describe('model translate aliases', function() {
+  it('should translate correctly', function() {
+    var Character = mongoose.model('Character', new mongoose.Schema({
+      name: { type: String, alias: '名' },
+      bio: {
+        age: { type: Number, alias: '年齢' }
+      }
+    }));
+
+    assert.deepEqual(
+      // Translate aliases
+      Character.translateAliases({
+        '名': 'Stark',
+        '年齢': 30
+      }),
+      // How translated aliases suppose to look like
+      {
+        name: 'Stark',
+        'bio.age': 30
+      }
+    );
+  });
+});