feat(request): add match method to match an array of patterns to current url

match method will be helpful when, we want to find whether the current url belongs to a given route
pattern. It can used to ingore some filters on array of routes

Author: thetutlage

src/Request/index.js

@@ -9,6 +9,7 @@
 const nodeReq = require('node-req')
 const nodeCookie = require('node-cookie')
 const File = require('../File')
+const pathToRegexp = require('path-to-regexp')
 const _ = require('lodash')
 const CatLog = require('cat-log')
 const log = new CatLog('adonis:framework')
@@ -352,8 +353,8 @@ class Request {
    * @description converts a file object to file instance
    * if already is not an instance
    * @method _toFileInstance
-   * @param  {Object}        file [description]
-   * @return {Object}             [description]
+   * @param  {Object}        file
+   * @return {Object}
    * @private
    */
   _toFileInstance (file) {
@@ -367,8 +368,8 @@ class Request {
    * @description converts an uploaded file to file
    * instance
    * @method file
-   * @param  {String} key [description]
-   * @return {Object}     [description]
+   * @param  {String} key
+   * @return {Object}
    * @public
    */
   file (key) {
@@ -415,8 +416,8 @@ class Request {
    * @description flash an object of messages to upcoming
    * request
    * @method flash
-   * @param  {Object} values [description]
-   * @return {void}        [description]
+   * @param  {Object} values
+   * @return {void}
    * @public
    */
   * flash (values) {
@@ -430,9 +431,9 @@ class Request {
    * @description return values set via flash from
    * request session
    * @method old
-   * @param  {String} key          [description]
-   * @param  {Mixed} defaultValue [description]
-   * @return {Mixed}              [description]
+   * @param  {String} key
+   * @param  {Mixed} defaultValue
+   * @return {Mixed}
    * @public
    */
   old (key, defaultValue) {
@@ -478,6 +479,22 @@ class Request {
     const args = _.isArray(arguments[0]) ? arguments[0] : _.toArray(arguments)
     yield this.flash(this.except(args))
   }
+
+  /**
+   * @description tells whether a given pattern matches the
+   * current url or not
+   * @method match
+   * @param  {String} pattern
+   * @return {Boolean}
+   * @public
+   */
+  match () {
+    const args = _.isArray(arguments[0]) ? arguments[0] : _.toArray(arguments)
+    const url = this.url()
+    const pattern = pathToRegexp(args, [])
+    return pattern.test(url)
+  }
+
 }
 
 module.exports = Request

test/unit/request.spec.js

@@ -566,6 +566,76 @@ describe('Request', function () {
     expect(res.body.file).to.equal(true)
   })
 
+  it('should return true when a pattern matches the current route url', function * () {
+    const server = http.createServer(function (req, res) {
+      const request = new Request(req, res, Config)
+      const matches = request.match('/user/:id/profile')
+      res.writeHead(200, {"Content-type":"application/json"})
+      res.end(JSON.stringify({matches}),'utf8')
+    })
+
+    const res = yield supertest(server).get("/user/1/profile").expect(200).end()
+    expect(res.body.matches).to.equal(true)
+  })
+
+  it('should return false when a pattern does not matches the current route url', function * () {
+    const server = http.createServer(function (req, res) {
+      const request = new Request(req, res, Config)
+      const matches = request.match('/user')
+      res.writeHead(200, {"Content-type":"application/json"})
+      res.end(JSON.stringify({matches}),'utf8')
+    })
+
+    const res = yield supertest(server).get("/user/1/profile").expect(200).end()
+    expect(res.body.matches).to.equal(false)
+  })
+
+  it('should return true when any of the paths inside array matches the current route url', function * () {
+    const server = http.createServer(function (req, res) {
+      const request = new Request(req, res, Config)
+      const matches = request.match(['/user', '/user/1/profile'])
+      res.writeHead(200, {"Content-type":"application/json"})
+      res.end(JSON.stringify({matches}),'utf8')
+    })
+    const res = yield supertest(server).get("/user/1/profile").expect(200).end()
+    expect(res.body.matches).to.equal(true)
+  })
+
+  it('should return false when none of the paths inside array matches the current route url', function * () {
+    const server = http.createServer(function (req, res) {
+      const request = new Request(req, res, Config)
+      const matches = request.match(['/user', '/user/1', '/1/profile'])
+      res.writeHead(200, {"Content-type":"application/json"})
+      res.end(JSON.stringify({matches}),'utf8')
+    })
+    const res = yield supertest(server).get("/user/1/profile").expect(200).end()
+    expect(res.body.matches).to.equal(false)
+  })
+
+  it('should return true when any of the paths from any of the arguments matches the current route url', function * () {
+    const server = http.createServer(function (req, res) {
+      const request = new Request(req, res, Config)
+      const matches = request.match('/user', '/user/1/profile')
+      res.writeHead(200, {"Content-type":"application/json"})
+      res.end(JSON.stringify({matches}),'utf8')
+    })
+
+    const res = yield supertest(server).get("/user/1/profile").expect(200).end()
+    expect(res.body.matches).to.equal(true)
+  })
+
+  it('should return false when any of the paths from any of the arguments does not matches the current route url', function * () {
+    const server = http.createServer(function (req, res) {
+      const request = new Request(req, res, Config)
+      const matches = request.match('/user', '/user/1', '/user/profile')
+      res.writeHead(200, {"Content-type":"application/json"})
+      res.end(JSON.stringify({matches}),'utf8')
+    })
+
+    const res = yield supertest(server).get("/user/1/profile").expect(200).end()
+    expect(res.body.matches).to.equal(false)
+  })
+
   it('should return an empty file instance when file is not uploaded', function * () {
     const server = http.createServer(function (req, res) {
       var form = new formidable.IncomingForm();