support for rethinkdb. closes #83

petecoop · Feb 28, 2015 · c466f60 · c466f60
1 parent 583ce4d
commit c466f60
Show file tree

Hide file tree

Showing 17 changed files with 129 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@ An Expressjs generator for Yeoman, based on the express command line tool.
  - MongoDB
  - MySQL
  - PostgreSQL
+ - RethinkDB
 
 ## Getting started
 

diff --git a/app/index.js b/app/index.js
@@ -102,7 +102,8 @@ module.exports = generators.Base.extend({
           'None',
           'MongoDB',
           'MySQL',
-          'PostgreSQL'
+          'PostgreSQL',
+          'RethinkDB'
         ],
         store: true
       }];
@@ -176,14 +177,21 @@ module.exports = generators.Base.extend({
       this.sourceRoot(path.join(__dirname, 'templates', 'css', stylesheets));
       this.directory('.', 'public/css');
 
+      // grunt/gulp
+      var buildFile = this.options.buildTool === 'grunt' ? 'Gruntfile.js' : 'gulpfile.js';
+      this.copy(path.join(__dirname, 'templates', 'extras', name + '-shared', buildFile), buildFile);
+
       // sequelize extra stuff
       if (this.options.database === 'mysql' || this.options.database === 'postgresql') {
-        this.copy(path.join(__dirname, 'templates', 'extras', name + suffix, 'model-index.' + this.filetype), 'app/models/index.' + this.filetype);
+        this.copy(path.join(__dirname, 'templates', 'extras', name + suffix, 'sequelize-model-index.' + this.filetype), 'app/models/index.' + this.filetype);
+      }
+
+      //thinky extra stuff
+      if (this.options.database === 'rethinkdb') {
+        this.copy(path.join(__dirname, 'templates', 'extras', name + suffix, 'thinky-model-index.' + this.filetype), 'app/models/index.' + this.filetype);
+        this.copy(path.join(__dirname, 'templates', 'extras', name + suffix, 'thinky-config.' + this.filetype), 'config/thinky.' + this.filetype);
       }
 
-      // grunt/gulp
-      var buildFile = this.options.buildTool === 'grunt' ? 'Gruntfile.js' : 'gulpfile.js';
-      this.copy(path.join(__dirname, 'templates', 'extras', name + '-shared', buildFile), buildFile);
     },
     assetsDirs: function () {
       this.mkdir('public');

diff --git a/...ates/extras/mvc-coffee/model-index.coffee → ...s/mvc-coffee/sequelize-model-index.coffee b/...ates/extras/mvc-coffee/model-index.coffee → ...s/mvc-coffee/sequelize-model-index.coffee
diff --git a/app/templates/extras/mvc-coffee/thinky-config.coffee b/app/templates/extras/mvc-coffee/thinky-config.coffee
@@ -0,0 +1,5 @@
+config = require('./config')
+
+thinky = require('thinky')(config.db)
+
+module.exports = thinky
diff --git a/app/templates/extras/mvc-coffee/thinky-model-index.coffee b/app/templates/extras/mvc-coffee/thinky-model-index.coffee
@@ -0,0 +1,13 @@
+config = require('../../config/config')
+glob = require('glob')
+thinky = require('../../config/thinky')
+
+models =
+  r: thinky.r
+
+files = glob.sync config.root + '/app/models/!(index)*.js'
+files.forEach (file) ->
+  model = require file
+  models[model.getTableName()] = model;
+
+module.exports = models;
diff --git a/app/templates/extras/mvc/model-index.js → ...lates/extras/mvc/sequelize-model-index.js b/app/templates/extras/mvc/model-index.js → ...lates/extras/mvc/sequelize-model-index.js
diff --git a/app/templates/extras/mvc/thinky-config.js b/app/templates/extras/mvc/thinky-config.js
@@ -0,0 +1,5 @@
+var config = require('./config');
+
+var thinky = require('thinky')(config.db);
+
+module.exports = thinky;
diff --git a/app/templates/extras/mvc/thinky-model-index.js b/app/templates/extras/mvc/thinky-model-index.js
@@ -0,0 +1,14 @@
+var config = require('../../config/config'),
+  glob = require('glob'),
+  thinky = require('../../config/thinky');
+
+var models = {
+  r: thinky.r
+};
+var files = glob.sync(config.root + '/app/models/!(index)*.js');
+files.forEach(function (file) {
+  var model = require(file);
+  models[model.getTableName()] = model;
+});
+
+module.exports = models;
diff --git a/app/templates/mvc-coffee/app/controllers/home.coffee b/app/templates/mvc-coffee/app/controllers/home.coffee
@@ -3,22 +3,24 @@ router = express.Router()<% if(options.viewEngine == 'marko'){ %>
 marko = require 'marko'<% } %><% if(options.database == 'mongodb'){ %>
 mongoose = require 'mongoose'
 Article  = mongoose.model 'Article'<% } %><% if(options.database == 'mysql' || options.database == 'postgresql'){ %>
-db = require '../models'<% } %>
+db = require '../models'<% } %><% if(options.database == 'rethinkdb'){ %>
+models = require('../models')
+Article = models.Article<% } %>
 
 module.exports = (app) ->
   app.use '/', router
 <% if(options.viewEngine == 'marko'){ %>
 indexTemplate = marko.load require.resolve '../views/index.marko'<% } %>
-router.get '/', (req, res, next) ->
-<% if(options.database == 'mongodb'){ %>
+router.get '/', (req, res, next) -><% if(options.database == 'mongodb'){ %>
   Article.find (err, articles) ->
     return next(err) if err<% } %><% if(options.database == 'mysql' || options.database == 'postgresql'){ %>
-  db.Article.findAll().success (articles) -><% } %><% if(options.viewEngine == 'marko'){ %>
+  db.Article.findAll().success (articles) -><% } %><% if(options.database == 'rethinkdb'){ %>
+  Article.run().then (articles) -><% } %><% if(options.viewEngine == 'marko'){ %>
     indexTemplate.render
-      title: 'Generator-Express MVC',
+      $global: locals: req.app.locals
+      title: 'Generator-Express MVC'
       articles: articles
     , res<% } else { %>
     res.render 'index',
-      $global: locals: req.app.locals
       title: 'Generator-Express MVC'
       articles: articles<% } %>
diff --git a/app/templates/mvc-coffee/app/models/article.coffee b/app/templates/mvc-coffee/app/models/article.coffee
@@ -25,4 +25,19 @@ module.exports = (sequelize, DataTypes) ->
       associate (models) ->
         # example on how to add relations
         # Article.hasMany models.Comments
+<% } %><% if(options.database == 'rethinkdb'%>
+thinky = require('../../config/thinky')
+r = thinky.r
+type = thinky.type
+
+Article = thinky.createModel 'Article',
+  title: String
+  url: String
+  text: String
+
+module.exports = Article
+
+# example on hour to add relations
+# Comment = require('./comment')
+# Article.hasMany(Comment, 'comments', 'id', 'article_id')
 <% } %>
diff --git a/app/templates/mvc-coffee/config/config.coffee b/app/templates/mvc-coffee/config/config.coffee
@@ -10,7 +10,8 @@ config =
     port: 3000<% if(options.database == 'mongodb'){ %>
     db: 'mongodb://localhost/<%= _.slugify(appname) %>-development'<% } %><% if(options.database == 'mysql'){ %>
     db: 'mysql://localhost/<%= _.slugify(appname) %>-development'<% } %><% if(options.database == 'postgresql'){ %>
-    db: 'postgres://localhost/<%= _.slugify(appname) %>-development'<% } %>
+    db: 'postgres://localhost/<%= _.slugify(appname) %>-development'<% } %><% if(options.database == 'rethinkdb'){ %>
+    db: db: '<%= _.slugify(appname) %>_development'<% } %>
 
   test:
     root: rootPath
@@ -19,7 +20,8 @@ config =
     port: 3000<% if(options.database == 'mongodb'){ %>
     db: 'mongodb://localhost/<%= _.slugify(appname) %>-test'<% } %><% if(options.database == 'mysql'){ %>
     db: 'mysql://localhost/<%= _.slugify(appname) %>-test'<% } %><% if(options.database == 'postgresql'){ %>
-    db: 'postgres://localhost/<%= _.slugify(appname) %>-test'<% } %>
+    db: 'postgres://localhost/<%= _.slugify(appname) %>-test'<% } %><% if(options.database == 'rethinkdb'){ %>
+    db: db: '<%= _.slugify(appname) %>_test'<% } %>
 
   production:
     root: rootPath
@@ -28,6 +30,7 @@ config =
     port: 3000<% if(options.database == 'mongodb'){ %>
     db: 'mongodb://localhost/<%= _.slugify(appname) %>-production'<% } %><% if(options.database == 'mysql'){ %>
     db: 'mysql://localhost/<%= _.slugify(appname) %>-production'<% } %><% if(options.database == 'postgresql'){ %>
-    db: 'postgres://localhost/<%= _.slugify(appname) %>-production'<% } %>
+    db: 'postgres://localhost/<%= _.slugify(appname) %>-production'<% } %><% if(options.database == 'rethinkdb'){ %>
+    db: db: '<%= _.slugify(appname) %>_production'<% } %>
 
 module.exports = config[env]
diff --git a/app/templates/mvc-shared/package.json b/app/templates/mvc-shared/package.json
@@ -15,11 +15,11 @@
     "method-override": "~2.3.0",
     "glob": "~4.4.1"<% if(options.database == 'mongodb'){ %>,
     "mongoose": "~3.8.20"<% } %><% if(options.database == 'mysql'){ %>,
-    "sequelize": "~2.0.0-rc7",
+    "sequelize": "~2.0.3",
     "mysql": "~2.5.3"<% } %><% if(options.database == 'postgresql'){ %>,
-    "sequelize": "~2.0.0-rc7",
-    "lodash": "~2.4.1",
-    "pg": "~4.3.0"<% } %><% if(options.viewEngine == 'jade'){ %>,
+    "sequelize": "~2.0.3",
+    "pg": "~4.3.0"<% } %><% if(options.database == 'rethinkdb'){ %>,
+    "thinky": "~1.16.6"<% } %><% if(options.viewEngine == 'jade'){ %>,
     "jade": "~1.9.1"<% } %><% if(options.viewEngine == 'ejs'){ %>,
     "ejs": "~2.3.1"<% } %><% if(options.viewEngine == 'swig'){ %>,
     "swig": "~1.4.2"<% } %><% if(options.viewEngine == 'handlebars'){ %>,

diff --git a/app/templates/mvc/app/controllers/home.js b/app/templates/mvc/app/controllers/home.js
@@ -4,25 +4,27 @@ var express = require('express'),
   mongoose = require('mongoose'),
   Article = mongoose.model('Article');<% } %><% if(options.database == 'mysql' || options.database == 'postgresql'){ %>
   db = require('../models');<% } %><% if(options.database == 'none'){ %>
-  Article = require('../models/article');<% } %>
+  Article = require('../models/article');<% } %><% if(options.database == 'rethinkdb'){ %>
+  models = require('../models'),
+  Article = models.Article;<% } %>
 
 module.exports = function (app) {
   app.use('/', router);
 };
 <% if(options.viewEngine == 'marko'){ %>
 var indexTemplate = marko.load(require.resolve('../views/index.marko'));<% } %>
-router.get('/', function (req, res, next) {
-<% if(options.database == 'mongodb'){ %>
+router.get('/', function (req, res, next) {<% if(options.database == 'mongodb'){ %>
   Article.find(function (err, articles) {
     if (err) return next(err);<% } %><% if(options.database == 'mysql' || options.database == 'postgresql'){ %>
-  db.Article.findAll().success(function (articles) {<% } %><% if(options.database == 'none'){ %>
+  db.Article.findAll().success(function (articles) {<% } %><% if(options.database == 'rethinkdb'){ %>
+  Article.run().then(function (articles) {<% } %><% if(options.database == 'none'){ %>
   var articles = [new Article(), new Article()];<% } %><% if(options.viewEngine == 'marko'){ %>
     indexTemplate.render({
+      $global: {locals: req.app.locals},
       title: 'Generator-Express MVC',
       articles: articles
     }, res);<% } else { %>
     res.render('index', {
-      $global: {locals: req.app.locals},
       title: 'Generator-Express MVC',
       articles: articles
     });<% } %><% if(options.database !== 'none'){ %>

diff --git a/app/templates/mvc/app/models/article.js b/app/templates/mvc/app/models/article.js
@@ -42,4 +42,20 @@ function Article (opts) {
 }
 
 module.exports = Article;
+<% } %><% if(options.database == 'rethinkdb'){%>
+var thinky = require('../../config/thinky'),
+  r = thinky.r,
+  type = thinky.type;
+
+var Article = thinky.createModel('Article', {
+  title: String,
+  url: String,
+  text: String
+});
+
+module.exports = Article;
+
+// example on hour to add relations
+// var Comment = require('./comment');
+// Article.hasMany(Comment, 'comments', 'id', 'article_id');
 <% } %>
diff --git a/app/templates/mvc/config/config.js b/app/templates/mvc/config/config.js
@@ -11,7 +11,8 @@ var config = {
     port: 3000,<% if(options.database == 'mongodb'){ %>
     db: 'mongodb://localhost/<%= _.slugify(appname) %>-development'<% } %><% if(options.database == 'mysql'){ %>
     db: 'mysql://localhost/<%= _.slugify(appname) %>-development'<% } %><% if(options.database == 'postgresql'){ %>
-    db: 'postgres://localhost/<%= _.slugify(appname) %>-development'<% } %>
+    db: 'postgres://localhost/<%= _.slugify(appname) %>-development'<% } %><% if(options.database == 'rethinkdb'){ %>
+    db: {db: '<%= _.slugify(appname) %>_development'}<% } %>
   },
 
   test: {
@@ -22,7 +23,8 @@ var config = {
     port: 3000,<% if(options.database == 'mongodb'){ %>
     db: 'mongodb://localhost/<%= _.slugify(appname) %>-test'<% } %><% if(options.database == 'mysql'){ %>
     db: 'mysql://localhost/<%= _.slugify(appname) %>-test'<% } %><% if(options.database == 'postgresql'){ %>
-    db: 'postgres://localhost/<%= _.slugify(appname) %>-test'<% } %>
+    db: 'postgres://localhost/<%= _.slugify(appname) %>-test'<% } %><% if(options.database == 'rethinkdb'){ %>
+    db: {db: '<%= _.slugify(appname) %>_test'}<% } %>
   },
 
   production: {
@@ -33,7 +35,8 @@ var config = {
     port: 3000,<% if(options.database == 'mongodb'){ %>
     db: 'mongodb://localhost/<%= _.slugify(appname) %>-production'<% } %><% if(options.database == 'mysql'){ %>
     db: 'mysql://localhost/<%= _.slugify(appname) %>-production'<% } %><% if(options.database == 'postgresql'){ %>
-    db: 'postgres://localhost/<%= _.slugify(appname) %>-production'<% } %>
+    db: 'postgres://localhost/<%= _.slugify(appname) %>-production'<% } %><% if(options.database == 'rethinkdb'){ %>
+    db: {db: '<%= _.slugify(appname) %>_production'}<% } %>
   }
 };
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "generator-express",
-  "version": "2.5.9",
+  "version": "2.5.10",
   "description": "A nodejs express generator for Yeoman",
   "keywords": [
     "yeoman-generator",

diff --git a/test/test-creation.js b/test/test-creation.js
@@ -468,4 +468,19 @@ describe('Express generator', function () {
       runGenerationTest.call(this, expected, 'mvc', 'jade', 'less', false, 'mysql', 'grunt', done);
     });
   });
+
+  describe('MVC generator with RethinkDB', function () {
+    var expected = [
+      'app/models/index.js',
+      'config/thinky.js'
+    ];
+
+    it('creates expected files', function (done) {
+      runGenerationTest.call(this, expected, 'mvc', 'jade', 'none', false, 'rethinkdb', 'grunt', done);
+    });
+
+    it('works with coffee', function (done) {
+      runGenerationTest.call(this, expected, 'mvc', 'jade', 'none', true, 'rethinkdb', 'grunt', done);
+    });
+  });
 });