[feat] Add Archtype, Extend functionality of Model config.

Author: scott-wyatt

archetype/config/index.js

@@ -0,0 +1,2 @@
+exports.stores = require('./stores')
+exports.models = require('./models')

archetype/config/models.js

@@ -0,0 +1,29 @@
+/**
+ * Models Configuration
+ *
+ * @see {@link http://trailsjs.io/doc/trailpack/config
+ */
+module.exports = {
+  /**
+   * The default store if not defined by model
+   */
+  defaultStore: 'sqlitedev',
+  /**
+   * The default migration strategy if not defined by the store or model
+   * ENUM: none, safe, drop, alter,
+   */
+  migrate: 'drop'
+
+  /**
+   * You can also define model by model which store, migration, etc it will use.
+   * A la carte model definitions
+   * eg:
+   *
+   * Test: {
+   *   store: 'sqlitedev',
+   *   migrate: 'drop',
+   *   tableName: 'test',
+   *   options: {}
+   * }
+   */
+}

archetype/config/stores.js

@@ -0,0 +1,29 @@
+/**
+ * Stores Configuration
+ *
+ * @see {@link http://trailsjs.io/doc/trailpack/config
+ */
+module.exports = {
+  /**
+   * Define the database stores. A store is typically a single database.
+   *
+   * Use the SQLite3 by default for development purposes.
+   *
+   * Set production connection info in config/env/production.js
+   */
+
+
+  /**
+   * Define a store called "sqlitedev" which uses SQLite3 to persist data.
+   */
+  sqlitedev: {
+    database: 'dev',
+    storage: './.tmp/dev.sqlite',
+    host: '127.0.0.1',
+    dialect: 'sqlite'
+    /**
+     * The default migration strategy for this store.
+     migrate: 'drop'
+    */
+  }
+}

index.js

@@ -11,12 +11,16 @@ module.exports = class SequelizeTrailpack extends Trailpack {
    * Validate the database config, and api.model definitions
    */
   async validate() {
-    const stores = _.get(this.app.config, 'database.stores')
+    const stores = this.app.config.get('stores')
+    const models = this.app.config.get('models')
+
     if (stores && Object.keys(stores).length === 0) {
-      this.app.config.log.logger.warn('No store configured at config.database.stores, models will be ignored')
+      this.app.config.log.logger.warn('No store configured at config.stores, models will be ignored')
     }
+
     return Promise.all([
-      lib.Validator.validateStoresConfig(stores)
+      lib.Validator.validateStoresConfig(stores),
+      lib.Validator.validateModelsConfig(models)
     ])
   }
 

lib/schemas.js

@@ -6,6 +6,11 @@ module.exports = {
     orm: joi.string()
   }).unknown(),
 
+  modelsConfig: joi.object().keys({
+    defaultStore: joi.string(),
+    migrate: joi.string()
+  }).unknown(),
+
   models: joi.object().keys({
     autoPK: joi.boolean(),
     autoCreatedAt: joi.boolean(),

lib/transformer.js

@@ -13,6 +13,8 @@ module.exports = {
     // const models = app.models
 
     return _.mapValues(app.models, (model, modelName) => {
+
+      const configOverrides = app.config.get(`models.${modelName}`) || {}
       const config = model.constructor.config(app, Sequelize) || {}
       const schema = model.constructor.schema(app, Sequelize) || {}
 
@@ -42,22 +44,22 @@ module.exports = {
         },
         tableName: {
           enumerable: false,
-          value: config.tableName || modelName.toLowerCase(),
+          value: configOverrides.tableName || config.tableName || modelName.toLowerCase(),
           writable: false
         },
         store: {
           enumerable: false,
-          value: config.store || app.config.get('models.defaultStore'),
+          value: configOverrides.store || config.store || app.config.get('models.defaultStore'),
           writable: false
         },
         migrate: {
           enumerable: false,
-          value: config.migrate || app.config.get('models.migrate'),
+          value: configOverrides.migrate || config.migrate || app.config.get('models.migrate'),
           writable: false
         },
         options: {
           enumerable: false,
-          value: config.options,
+          value: configOverrides.options || config.options,
           writable: true
         },
         config: {

lib/validator.js

@@ -7,6 +7,15 @@ module.exports = {
       joi.validate(config, lib.Schemas.storesConfig, (err, value) => {
         if (err) return reject(err)
 
+        return resolve(value)
+      })
+    })
+  },
+  validateModelsConfig (config) {
+    return new Promise((resolve, reject) => {
+      joi.validate(config, lib.Schemas.modelsConfig, (err, value) => {
+        if (err) return reject(err)
+
         return resolve(value)
       })
     })

test/app.js

@@ -178,7 +178,20 @@ module.exports = _.defaultsDeep({
             afterValidate: Sequelize.INTEGER
           }
         }
-      }
+      },
+      Override: class Override extends Model {
+        static config() {
+          return {
+            store: 'teststore',
+            tableName: 'shouldoverride'
+          }
+        }
+        static schema(app, Sequelize) {
+          return {
+            status: Sequelize.STRING
+          }
+        }
+      },
     }
   },
   config: {
@@ -189,7 +202,10 @@ module.exports = _.defaultsDeep({
     },
     models: {
       defaultStore: 'teststore',
-      migrate: 'drop'
+      migrate: 'drop',
+      Override: {
+        tableName: 'override'
+      }
     },
     stores: {
       teststore: {

test/lib/transformer.test.js

@@ -22,6 +22,7 @@ describe('lib.Transformer', () => {
 
       assert.equal(models.User.store, 'teststore')
       assert.equal(models.Role.store, 'storeoverride')
+      assert.equal(models.Override.tableName, 'override')
     })
   })