Merge pull request #283 from strongloop/feature/add-option-to-scaffold-3.x

Choose dependency version according to loopbackVersion

Author: Janny

common/models/definition.js

@@ -134,7 +134,7 @@ module.exports = function(Definition) {
           config[relation.foreignKey] = fk;
           config[relation.embed.key] = embedId;
           config.facetName = facetName;
-          
+
           debug('addRelatedToCache %s %j', relation.model, config);
           Entity.addToCache(cache, config);
         });

common/models/workspace.js

@@ -33,6 +33,14 @@ module.exports = function(Workspace) {
     var ViewDefinition = app.models.ViewDefinition;
     var TEMPLATE_DIR = path.join(__dirname, '..', '..', 'templates', 'projects');
     var DEFAULT_TEMPLATE = 'api-server';
+    var DEFAULT_LB_VERSION = '2.x';
+    var DEPENDENCIES_3_X = {
+      'loopback': '^3.0.0-alpha.1',
+    };
+    var DEPENDENCIES_2_X = {
+      'loopback': '^2.22.0',
+      'loopback-datasource-juggler': '^2.39.0',
+    };
     var debug = require('debug')('workspace');
 
     /**
@@ -152,6 +160,7 @@ module.exports = function(Workspace) {
       if (!options.root) {
         throw new Error('Non-root components are not supported yet.');
       }
+      var loopbackVersion = options.loopbackVersion || DEFAULT_LB_VERSION;
       var templateName = options.template || DEFAULT_TEMPLATE;
       var name = options.name || templateName;
       var packageName = options.packageName || name;
@@ -169,6 +178,14 @@ module.exports = function(Workspace) {
         return cb(err);
       }
 
+      if (loopbackVersion !== '2.x' && loopbackVersion !== '3.x') {
+        return cb(new Error('Loopback version should be either 2.x or 3.x'));
+      }
+      var defaultDependencies = template.package.dependencies;
+      var loopbackDependencies =
+        loopbackVersion === '2.x' ? DEPENDENCIES_2_X : DEPENDENCIES_3_X;
+      template.package.dependencies = extend(defaultDependencies, loopbackDependencies);
+
       // TODO(bajtos) come up with a more generic approach
       var explorer = 'loopback-component-explorer';
       if (options[explorer] === false) {

templates/projects/empty-server/data.js

@@ -19,10 +19,8 @@ template.package = {
     'compression': '^1.0.3',
     'cors': '^2.5.2',
     'helmet': '^1.3.0',
-    'loopback': '^2.22.0',
     'loopback-boot': '^2.6.5',
     'loopback-component-explorer': '^2.4.0',
-    'loopback-datasource-juggler': '^2.39.0',
     'serve-favicon': '^2.0.1',
   },
   'devDependencies': {

templates/projects/hello-world/files/common/models/message.js

@@ -1,8 +1,8 @@
 module.exports = function(Message) {
-    Message.greet = function(msg, cb) {
-      process.nextTick(function() {
-        msg = msg || 'hello';
-        cb(null, 'Sender says ' + msg + ' to receiver');
-      });
-    };
+  Message.greet = function(msg, cb) {
+    process.nextTick(function() {
+      msg = msg || 'hello';
+      cb(null, 'Sender says ' + msg + ' to receiver');
+    });
+  };
 };

test/end-to-end.js

@@ -11,6 +11,7 @@ var install = require('strong-cached-install');
 var mysql = require('mysql');
 var path = require('path');
 var request = require('supertest');
+var semver = require('semver');
 var debug = require('debug')('test:end-to-end');
 var workspace = require('../');
 var models = workspace.models;
@@ -347,13 +348,13 @@ describe('end-to-end', function() {
     });
 
     it('provides create operation', function(done) {
-      var sample = {title: 'myTitle'};
+      var sample = { title: 'myTitle' };
       request(app)
       .post('/api/Notes')
       .send(sample)
       .expect(200, function(err, res) {
-        if(err) {
-          done(err)
+        if (err) {
+          done(err);
         } else {
           expect(res.body).
             to.have.property('title', 'myTitle');
@@ -363,13 +364,13 @@ describe('end-to-end', function() {
     });
 
     it('provides update operation', function(done) {
-      var sample = {title: 'myTitle'};
+      var sample = { title: 'myTitle' };
       request(app)
       .put('/api/Notes')
       .send(sample)
       .expect(200, function(err, res) {
-        if(err) {
-          done(err)
+        if (err) {
+          done(err);
         } else {
           expect(res.body).
             to.have.property('title', 'myTitle');
@@ -380,15 +381,15 @@ describe('end-to-end', function() {
 
     it('provides delete operation', function(done) {
       var Note = app.models.Note;
-      Note.create({title: 'myTitle'}, function(error, note) {
-        if(error) {
+      Note.create({ title: 'myTitle' }, function(error, note) {
+        if (error) {
           done(error);
         } else {
           request(app)
           .delete('/api/Notes/' + note.id)
           .expect(200, function(err, res) {
-            if(err) {
-              done(err)
+            if (err) {
+              done(err);
             } else {
               expect(res.body).
                 to.have.property('count', 1);
@@ -434,6 +435,69 @@ describe('end-to-end', function() {
     });
   });
 
+  describe('scaffold 3.x loopback project with option 3.x', function(done) {
+    before(resetWorkspace);
+    before(function createWorkspace(done) {
+      var options = { loopbackVersion: '3.x' };
+      givenWorkspaceFromTemplate('empty-server', options, done);
+    });
+
+    it('contains dependencies with 3.x version', function(done) {
+      var dependencies = readPackageJsonSync().dependencies;
+      expect(semver.gtr('3.0.0', dependencies.loopback)).to.be.false;
+      done();
+    });
+  });
+
+  describe('scaffold 2.x loopback project with option 2.x', function(done) {
+    before(resetWorkspace);
+    before(function createWorkspace(done) {
+      var options = { loopbackVersion: '2.x' };
+      givenWorkspaceFromTemplate('empty-server', options, done);
+    });
+
+    it('contains dependencies with 2.x version', function(done) {
+      var dependencies = readPackageJsonSync().dependencies;
+      expect(semver.gtr('3.0.0', dependencies.loopback)).to.be.true;
+      expect(semver.gtr('3.0.0', dependencies['loopback-datasource-juggler']))
+        .to.be.true;
+      done();
+    });
+  });
+
+  describe('scaffold 2.x loopback project with default options', function(done) {
+    before(resetWorkspace);
+    before(function createWorkspace(done) {
+      givenWorkspaceFromTemplate('empty-server', done);
+    });
+
+    it('contains dependencies with 2.x version', function(done) {
+      var dependencies = readPackageJsonSync().dependencies;
+      expect(semver.gtr('3.0.0', dependencies.loopback)).to.be.true;
+      expect(semver.gtr('3.0.0', dependencies['loopback-datasource-juggler']))
+        .to.be.true;
+      done();
+    });
+  });
+
+  describe('Check invalid version', function(done) {
+    before(resetWorkspace);
+
+    it('throws error with invalid version', function(done) {
+      var options = { loopbackVersion: 'invalid-version' };
+      givenWorkspaceFromTemplate('empty-server', options, function(err) {
+        expect(err).to.match(/Loopback version should be either 2\.x or 3\.x/);
+        done();
+      });
+    });
+  });
+
+  function readPackageJsonSync() {
+    var filepath = SANDBOX + '/package.json';
+    var content = fs.readFileSync(filepath, 'utf-8');
+    return JSON.parse(content);
+  }
+
   describe('autoupdate', function() {
     this.timeout(10000);
     var connection;

test/support.js

@@ -107,34 +107,20 @@ givenWorkspaceFromTemplate = function(template, options, cb) {
   });
 };
 
-givenWorkspaceWithCustomDependencies = function(templateName, deps, cb) {
+givenLB2Workspace = function(cb) {
   resetWorkspace(function(err) {
     if (err) return cb(err);
-    givenWorkspaceFromTemplate('empty-server', deps, function(err) {
-      if (err) return cb(err);
-      ConfigFile.loadFromPath('/package.json', function(err, pkgFile) {
-        if (err) return cb(err);
-        for (dep in deps) {
-          pkgFile.data.dependencies[dep] = deps[dep];
-        }
-
-        pkgFile.save(cb());
-      });
-    });
+    var options = { loopbackVersion: '2.x' };
+    givenWorkspaceFromTemplate('empty-server', options, cb);
   });
 };
 
-givenLB2Workspace = function(cb) {
-  givenWorkspaceWithCustomDependencies('empty-server', {
-    loopback: '^2.0.0',
-    'loopback-datasource-juggler': '^2.0.0',
-  }, cb);
-};
-
 givenLB3Workspace = function(cb) {
-  givenWorkspaceWithCustomDependencies('empty-server', {
-    loopback: '^3.0.0-alpha.1',
-  }, cb);
+  resetWorkspace(function(err) {
+    if (err) return cb(err);
+    var options = { loopbackVersion: '3.x' };
+    givenWorkspaceFromTemplate('empty-server', options, cb);
+  });
 };
 
 function findOfType(name, type) {

test/workspace.js

@@ -18,7 +18,7 @@ describe('Workspace', function() {
           'api-server',
           'empty-server',
           'hello-world',
-          'notes'
+          'notes',
         ]);
         done();
       });