2.0 rc

.travis.yml

@@ -8,6 +8,7 @@ node_js:
   - 4
   - 5
   - 6
+  - 7
 compiler:
   - gcc
 env:

index.js

@@ -3,6 +3,8 @@
 
 const events = require('events')
 const lib = require('./lib')
+const i18next = require('i18next')
+const NOOP = function () { }
 
 /**
  * The Trails Application. Merges the configuration and API resources
@@ -12,26 +14,32 @@ module.exports = class TrailsApp extends events.EventEmitter {
 
   /**
    * @param pkg The application package.json
+   * @param app.api The application api (api/ folder)
+   * @param app.config The application configuration (config/ folder)
    *
    * Initialize the Trails Application and its EventEmitter parentclass. Set
    * some necessary default configuration.
    */
   constructor (app) {
     super()
 
-    if (!process.env.NODE_ENV) {
-      process.env.NODE_ENV = 'development'
-    }
     if (!app.pkg) {
       throw new lib.Errors.PackageNotDefinedError()
     }
+    if (!app.api && !(app && app.api)) {
+      throw new lib.Errors.ApiNotDefinedError()
+    }
 
-    lib.Trails.validateConfig(app.config)
+    if (!process.env.NODE_ENV) {
+      process.env.NODE_ENV = 'development'
+    }
+
+    const processEnv = Object.freeze(JSON.parse(JSON.stringify(process.env)))
 
     Object.defineProperties(this, {
       env: {
         enumerable: false,
-        value: Object.freeze(JSON.parse(JSON.stringify(process.env)))
+        value: processEnv
       },
       pkg: {
         enumerable: false,
@@ -44,7 +52,7 @@ module.exports = class TrailsApp extends events.EventEmitter {
         value: process.versions
       },
       config: {
-        value: lib.Trails.buildConfig(app.config),
+        value: lib.Trails.buildConfig(app.config, processEnv),
         configurable: true
       },
       api: {
@@ -87,34 +95,64 @@ module.exports = class TrailsApp extends events.EventEmitter {
         enumerable: false,
         writable: true,
         value: { }
+      },
+      models: {
+        enumerable: true,
+        writable: false,
+        value: { }
+      },
+      services: {
+        enumerable: true,
+        writable: false,
+        value: { }
+      },
+      controllers: {
+        enumerable: true,
+        writable: false,
+        value: { }
+      },
+      policies: {
+        enumerable: true,
+        writable: false,
+        value: { }
+      },
+      translate: {
+        enumerable: false,
+        writable: true
       }
     })
 
+    lib.Trails.validateConfig(app.config)
+    lib.Core.createDefaultPaths(this)
     this.setMaxListeners(this.config.main.maxListeners)
+
+    Object.assign(this.models, lib.Core.bindMethods(this, 'models'))
+    Object.assign(this.services, lib.Core.bindMethods(this, 'services'))
+    Object.assign(this.controllers, lib.Core.bindMethods(this, 'controllers'))
+    Object.assign(this.policies, lib.Core.bindMethods(this, 'policies'))
+
     this.config.main.packs.forEach(Pack => new Pack(this))
-    delete this.config.env // Delete env config, now it has been merge
+    this.loadedPacks = Object.keys(this.packs).map(name => this.packs[name])
+
+    delete this.config.env
   }
 
   /**
-   * Start the App. Load all Trailpacks. The "api" property is required, here,
-   * if not provided to the constructor.
+   * Start the App. Load all Trailpacks.
    *
-   * @param app.api The application api (api/ folder)
-   * @param app.config The application configuration (config/ folder)
    * @return Promise
    */
-  start (app) {
-    if (!this.api && !(app && app.api)) {
-      throw new lib.Errors.ApiNotDefinedError()
-    }
-    this.api || (this.api = app && app.api)
-
-    this.loadedPacks = Object.keys(this.packs).map(name => this.packs[name])
-    lib.Trails.bindEvents(this)
+  start () {
+    lib.Trails.bindListeners(this)
     lib.Trailpack.bindTrailpackPhaseListeners(this, this.loadedPacks)
     lib.Trailpack.bindTrailpackMethodListeners(this, this.loadedPacks)
 
-    this.emit('trails:start')
+    i18next.init(this.config.i18n, (err, t) => {
+      if (err) throw err
+
+      this.translate = t
+      this.emit('trails:start')
+    })
 
     return this.after('trails:ready')
       .then(() => {
@@ -138,7 +176,7 @@ module.exports = class TrailsApp extends events.EventEmitter {
     }
 
     this.emit('trails:stop')
-    lib.Trails.unbindEvents(this)
+    lib.Trails.unbindListeners(this)
 
     return Promise.all(
       this.loadedPacks.map(pack => {
@@ -161,34 +199,49 @@ module.exports = class TrailsApp extends events.EventEmitter {
   }
 
   /**
-   * Extend the once emiter reader for accept multi valid events
+   * Resolve Promise once ANY of the events in the list have emitted. Also
+   * accepts a callback.
+   * @return Promise
    */
-  onceAny (events, handler) {
-    const self = this
-
-    if (!events)
-      return
-    if (!Array.isArray(events))
+  onceAny (events, handler = NOOP) {
+    if (!Array.isArray(events)) {
       events = [events]
+    }
 
-    function cb (e) {
-      self.removeListener(e, cb)
-      handler.apply(this, Array.prototype.slice.call(arguments, 0))
+    let resolveCallback
+    const handlerWrapper = (...args) => {
+      handler(args)
+      return args
     }
 
-    events.forEach(e => {
-      this.addListener(e, cb)
+    return Promise.race(events.map(eventName => {
+      return new Promise(resolve => {
+        resolveCallback = resolve
+        this.once(eventName, resolveCallback)
+      })
+    }))
+    .then(handlerWrapper)
+    .then(args => {
+      events.forEach(eventName => this.removeListener(eventName, resolveCallback))
+      return args
     })
   }
 
   /**
-   * Resolve Promise once all events in the list have emitted
+   * Resolve Promise once all events in the list have emitted. Also accepts
+   * a callback.
    * @return Promise
    */
-  after (events) {
+  after (events, handler = NOOP) {
     if (!Array.isArray(events)) {
       events = [ events ]
     }
+
+    const handlerWrapper = (args) => {
+      handler(args)
+      return args
+    }
+
     return Promise.all(events.map(eventName => {
       return new Promise(resolve => {
         if (eventName instanceof Array){
@@ -199,6 +252,7 @@ module.exports = class TrailsApp extends events.EventEmitter {
         }
       })
     }))
+    .then(handlerWrapper)
   }
 
   /**
@@ -208,4 +262,8 @@ module.exports = class TrailsApp extends events.EventEmitter {
   get log () {
     return this.config.log.logger
   }
+
+  get __ () {
+    return this.translate
+  }
 }

lib/core.js

@@ -0,0 +1,98 @@
+'use strict'
+
+const fs = require('fs')
+const isPlainObject = require('lodash.isplainobject')
+const mapValues = require('lodash.mapvalues')
+const forEach = require('lodash.foreach')
+const includes = require('lodash.includes')
+const isFunction = require('lodash.isFunction')
+
+const Core = module.exports = {
+
+  reservedMethods: [
+    'app',
+    'api',
+    'log',
+    '__',
+    'constructor',
+    'undefined',
+    'methods',
+    'config',
+    'schema'
+  ],
+
+  /**
+   * Bind the context of API resource methods.
+   */
+  bindMethods (app, resource) {
+    return mapValues(app.api[resource], (Resource, resourceName) => {
+      if (isPlainObject(Resource)) {
+        throw new Error(`${resourceName} should be a class. It is a regular object`)
+      }
+
+      const obj = new Resource(app)
+
+      obj.methods = Core.getClassMethods(obj)
+      forEach(obj.methods, method => {
+        obj[method] = obj[method].bind(obj)
+      })
+      return obj
+    })
+  },
+
+  /**
+   * Traverse protoype chain and aggregate all class method names
+   */
+  getClassMethods (obj) {
+    const props = [ ]
+    const objectRoot = new Object()
+
+    while (!obj.isPrototypeOf(objectRoot)) {
+      Object.getOwnPropertyNames(obj).forEach(prop => {
+        if (props.indexOf(prop) === -1 &&
+            !includes(Core.reservedMethods, prop) &&
+            isFunction(obj[prop])) {
+
+          props.push(prop)
+        }
+      })
+      obj = Object.getPrototypeOf(obj)
+    }
+
+    return props
+  },
+
+  /**
+   * create paths if they don't exist
+   */
+  createDefaultPaths (app) {
+    const paths = app.config.main.paths
+
+    return Promise.all(Object.keys(paths).map(pathName => {
+      const dir = paths[pathName]
+      if (Array.isArray(dir)) {
+        dir.map(item => {
+          pathCreate(item.path, pathName)
+        })
+      }
+      else {
+        pathCreate(dir, pathName)
+      }
+    }))
+    function pathCreate(dir, pathName) {
+      try {
+        const stats = fs.statSync(dir)
+
+        if (!stats.isDirectory()) {
+          app.log.error('The path "', pathName, '" is not a directory.')
+          app.log.error('config.main.paths should only contain paths to directories')
+          return Promise.reject()
+        }
+      }
+      catch (e) {
+        fs.mkdirSync(dir)
+      }
+    }
+  }
+
+}

lib/index.js

@@ -5,3 +5,5 @@ exports.Trailpack = require('./trailpack')
 exports.Trails = require('./trails')
 exports.Errors = require('./errors')
 exports.Pathfinder = require('./pathfinder')
+exports.Core = require('./core')
+exports.Schemas = require('./schemas')