Merge pull request #329 from fabien/feature/include-scope

Enable include scope for belongsTo

lib/include.js

@@ -167,7 +167,7 @@ Inclusion.include = function (objects, include, cb) {
       
       var related; // relation accessor function
       
-      if (relation.multiple && scope) {
+      if ((relation.multiple || relation.type === 'belongsTo') && scope) {
         var includeScope = {};
         var filter = scope.conditions();
         
@@ -183,6 +183,7 @@ Inclusion.include = function (objects, include, cb) {
         }
         
         utils.mergeQuery(filter, includeScope, {fields: false});
+        
         related = inst[relationName].bind(inst, filter);
       } else {
         related = inst[relationName].bind(inst);

lib/relation-definition.js

@@ -1250,10 +1250,14 @@ BelongsTo.prototype.related = function (refresh, params) {
   var fk = this.definition.keyFrom;
   var modelInstance = this.modelInstance;
   var discriminator;
+  var scopeQuery = null;
   
   if (arguments.length === 1) {
     params = refresh;
     refresh = false;
+  } else if (arguments.length === 2
+    && typeof refresh === 'object' && typeof params === 'function') {
+    scopeQuery = refresh;
   } else if (arguments.length > 2) {
     throw new Error('Method can\'t be called with more than two arguments');
   }
@@ -1303,6 +1307,12 @@ BelongsTo.prototype.related = function (refresh, params) {
     
       this.definition.applyScope(modelInstance, query);
       
+      if (scopeQuery) mergeQuery(query, scopeQuery);
+      
+      if (Array.isArray(query.fields) && query.fields.indexOf(pk) === -1) {
+          query.fields.push(pk); // always include the pk
+      }
+      
       modelTo.findOne(query, function (err, inst) {
         if (err) {
           return cb(err);

test/include.test.js

@@ -156,7 +156,24 @@ describe('include', function () {
     });
   });
   
-  it('should fetch Users with include scope on Posts', function (done) {
+  it('should fetch Users with include scope on Posts - belongsTo', function (done) {
+      Post.find({
+        include: { relation: 'author', scope:{ fields: ['name'] }}
+      }, function (err, posts) {
+        should.not.exist(err);
+        should.exist(posts);
+        posts.length.should.equal(5);
+        
+        var author = posts[0].author();
+        author.name.should.equal('User A');
+        author.should.have.property('id');
+        author.should.not.have.property('age');
+        
+        done();
+      });
+    });
+  
+  it('should fetch Users with include scope on Posts - hasMany', function (done) {
     User.find({
       include: {relation: 'posts', scope:{
         order: 'title DESC'
@@ -186,7 +203,7 @@ describe('include', function () {
     });
   });
   
-  it('should fetch Users with include scope on Passports', function (done) {
+  it('should fetch Users with include scope on Passports - hasMany', function (done) {
     User.find({
       include: {relation: 'passports', scope:{
         where: { number: '2' }
@@ -253,37 +270,44 @@ describe('include', function () {
   });
 
   it('should support hasAndBelongsToMany', function (done) {
-
+    Assembly.create({name: 'car'}, function (err, assembly) {
-    Assembly.destroyAll(function(err) {
+      Part.create({partNumber: 'engine'}, function (err, part) {
-      Part.destroyAll(function(err) {
+        assembly.parts.add(part, function (err, data) {
-        Assembly.relations.parts.modelThrough.destroyAll(function(err) {
+          assembly.parts(function (err, parts) {
-        Assembly.create({name: 'car'}, function (err, assembly) {
+            should.not.exist(err);
-          Part.create({partNumber: 'engine'}, function (err, part) {
+            should.exists(parts);
-            assembly.parts.add(part, function (err, data) {
+            parts.length.should.equal(1);
-              assembly.parts(function (err, parts) {
+            parts[0].partNumber.should.equal('engine');
-                should.not.exist(err);
+            
-                should.exists(parts);
+            // Create a part
-                parts.length.should.equal(1);
+            assembly.parts.create({partNumber: 'door'}, function (err, part4) {
-                parts[0].partNumber.should.equal('engine');
+              
-
+              Assembly.find({include: 'parts'}, function (err, assemblies) {
-                // Create a part
+                assemblies.length.should.equal(1);
-                assembly.parts.create({partNumber: 'door'}, function (err, part4) {
+                assemblies[0].parts().length.should.equal(2);
-
+                done();
-                  Assembly.find({include: 'parts'}, function (err, assemblies) {
-                    assemblies.length.should.equal(1);
-                    assemblies[0].parts.length.should.equal(2);
-                    done();
-                  });
-
-                });
               });
+              
             });
           });
         });
-        });
       });
     });
   });
+  
+  // Not implemented correctly, see: loopback-datasource-juggler/issues/166
+  //
+  // it('should support include scope on hasAndBelongsToMany', function (done) {
+  //   Assembly.find({include: { relation: 'parts', scope: {
+  //     where: { partNumber: 'engine' }
+  //   }}}, function (err, assemblies) {
+  //     assemblies.length.should.equal(1);
+  //     var parts = assemblies[0].parts();
+  //     parts.should.have.length(1);
+  //     parts[0].partNumber.should.equal('engine');
+  //     done();
+  //   });
+  // });
 
 });