feat(route:resource): resource members & coll accepts callback

resource members and collections accepts callback to further chain methods to attach middleware or
bind action

Author: thetutlage

src/Route/ResourceCollection.js

@@ -0,0 +1,85 @@
+'use strict'
+
+/**
+ * adonis-framework
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+const helpers = require('./helpers')
+const util = require('../../lib/util')
+
+class ResourceCollection {
+
+  constructor (route) {
+    this.route = route
+  }
+
+  /**
+   * binds action to the route, it will override
+   * the old action
+   *
+   * @param  {String|Function} action
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  bindAction (action) {
+    this.route.handler = action
+    return this
+  }
+
+  /**
+   * @see this.middleware
+   */
+  middlewares () {
+    return this.middleware.apply(this, arguments)
+  }
+
+  /**
+   * appends middlewares to the route
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  middleware () {
+    helpers.appendMiddleware(
+      this.route,
+      util.spread.apply(this, arguments)
+    )
+    return this
+  }
+
+  /**
+   * assign name to the route
+   *
+   * @param  {String} name
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  as (name) {
+    this.route.name = name
+    return this
+  }
+
+  /**
+   * return json representation of the route
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  toJSON () {
+    return this.route
+  }
+
+}
+
+module.exports = ResourceCollection

src/Route/ResourceMember.js

@@ -0,0 +1,85 @@
+'use strict'
+
+/**
+ * adonis-framework
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+const helpers = require('./helpers')
+const util = require('../../lib/util')
+
+class ResourceMember {
+
+  constructor (route) {
+    this.route = route
+  }
+
+  /**
+   * binds action to the route, it will override
+   * the old action
+   *
+   * @param  {String|Function} action
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  bindAction (action) {
+    this.route.handler = action
+    return this
+  }
+
+  /**
+   * @see this.middleware
+   */
+  middlewares () {
+    return this.middleware.apply(this, arguments)
+  }
+
+  /**
+   * appends middlewares to the route
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  middleware () {
+    helpers.appendMiddleware(
+      this.route,
+      util.spread.apply(this, arguments)
+    )
+    return this
+  }
+
+  /**
+   * assign name to the route
+   *
+   * @param  {String} name
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  as (name) {
+    this.route.name = name
+    return this
+  }
+
+  /**
+   * return json representation of the route
+   *
+   * @return {Object}
+   *
+   * @public
+   */
+  toJSON () {
+    return this.route
+  }
+
+}
+
+module.exports = ResourceMember

src/Route/resource.js

@@ -11,6 +11,8 @@ const helpers = require('./helpers')
 const CatLog = require('cat-log')
 const logger = new CatLog('adonis:framework')
 const util = require('../../lib/util')
+const ResourceMember = require('./ResourceMember')
+const ResourceCollection = require('./ResourceCollection')
 const NE = require('node-exceptions')
 
 /**
@@ -45,14 +47,17 @@ class Resource {
    * @param  {String}       route
    * @param  {String}       handler
    * @param  {String}       name
-   * @return {void}
+   *
+   * @return {Object}
    *
    * @private
    */
   _registerRoute (verb, route, handler, name) {
     const resourceName = (this.basename === '/' || !this.basename) ? name : `${this.basename}.${name}`
     this.RouteHelper.route(route, verb, `${handler}.${name}`).as(resourceName)
-    this.routes.push(this.RouteHelper._lastRoute())
+    const registeredRoute = this.RouteHelper._lastRoute()
+    this.routes.push(registeredRoute)
+    return registeredRoute
   }
 
   /**
@@ -188,50 +193,56 @@ class Resource {
   /**
    * add a member route to the resource
    *
-   * @param  {String} action - the handle action method
-   *
    * @param  {String} route - Route and action to be added to the resource
    * @param  {Mixed}  [verbs=['GET', 'HEAD']]  - An array of verbs
+   * @param {Function} [callback]
+   *
    * @return {Object} - reference to resource instance for chaining
    *
    * @example
    * Route.resource('...').addMember('completed')
    *
    * @public
    */
-  addMember (route, verbs) {
+  addMember (route, verbs, callback) {
     if (_.isEmpty(route)) {
       throw new NE.InvalidArgumentException('action argument must be present')
     }
 
     verbs = verbs || ['GET', 'HEAD']
     verbs = _.isArray(verbs) ? verbs : [verbs]
-    this._registerRoute(verbs, `${this.pattern}/:id/${route}`, this.handler, route)
+    const registeredRoute = this._registerRoute(verbs, `${this.pattern}/:id/${route}`, this.handler, route)
+    if (typeof (callback) === 'function') {
+      callback(new ResourceMember(registeredRoute))
+    }
     return this
   }
 
   /**
    * add a collection route to the resource
    *
-   * @param  {String} action - the handle action method
-   *
    * @param  {String} route - Route and action to be added to the resource
    * @param  {Mixed}  [verbs=['GET', 'HEAD']]  - An array of verbs
+   * @param {Function} [callback]
+   *
    * @return {Object} - reference to resource instance for chaining
    *
    * @example
    * Route.resource('...').addCollection('completed')
    *
    * @public
    */
-  addCollection (route, verbs) {
+  addCollection (route, verbs, callback) {
     if (_.isEmpty(route)) {
       throw new NE.InvalidArgumentException('action argument must be present')
     }
 
     verbs = verbs || ['GET', 'HEAD']
     verbs = _.isArray(verbs) ? verbs : [verbs]
-    this._registerRoute(verbs, `${this.pattern}/${route}`, this.handler, route)
+    const registeredRoute = this._registerRoute(verbs, `${this.pattern}/${route}`, this.handler, route)
+    if (typeof (callback) === 'function') {
+      callback(new ResourceCollection(registeredRoute))
+    }
     return this
   }