.travis.yml

@@ -1,10 +1,8 @@
 language: node_js
 node_js:
-  - "4"
-  - "3"
-  - "2"
-  - "1"
-  - "0.12"
+  - "6"
+  - "7"
+  - "8"
 notifications:
   email:
     on_success: never

history.md

@@ -1,5 +1,40 @@
 # History
 
+## 7.3.0
+
+- Router#url() now accepts query parameters to add to generated urls [#396](https://github.com/alexmingoia/koa-router/pull/396)
+
+## 7.2.1
+
+- Respond to CORS preflights with 200, 0 length body [#359](https://github.com/alexmingoia/koa-router/issues/359)
+
+## 7.2.0
+
+- Fix a bug in Router#url and append Router object to ctx. [#350](https://github.com/alexmingoia/koa-router/pull/350)
+- Adds `_matchedRouteName` to context [#337](https://github.com/alexmingoia/koa-router/pull/337)
+- Respond to CORS preflights with 200, 0 length body [#359](https://github.com/alexmingoia/koa-router/issues/359)
+
+## 7.1.1
+
+- Fix bug where param handlers were run out of order [#282](https://github.com/alexmingoia/koa-router/pull/282)
+
+## 7.1.0
+
+- Backports: merge 5.4 work into the 7.x upstream. See 5.4.0 updates for more details.
+
+## 7.0.1
+
+- Fix: allowedMethods should be ctx.method not this.method [#215](https://github.com/alexmingoia/koa-router/pull/215)
+
+## 7.0.0
+
+- The API has changed to match the new promise-based middleware
+  signature of koa 2. See the
+  [koa 2.x readme](https://github.com/koajs/koa/tree/2.0.0-alpha.3) for more
+  information.
+- Middleware is now always run in the order declared by `.use()` (or `.get()`,
+  etc.), which matches Express 4 API.
+
 ## 5.4.0
 
 - Expose matched route at `ctx._matchedRoute`.
@@ -9,7 +44,7 @@
 - Register multiple routes with array of paths [#203](https://github.com/alexmingoia/koa-router/issue/143).
 - Improved router.url() [#143](https://github.com/alexmingoia/koa-router/pull/143)
 - Adds support for named routes and regular expressions
-  [#152](https://github.com/alexmingoia/koa-router/pulls/152)
+  [#152](https://github.com/alexmingoia/koa-router/pull/152)
 - Add support for custom throw functions for 405 and 501 responses [#206](https://github.com/alexmingoia/koa-router/pull/206)
 
 ## 5.2.3

lib/README_tpl.hbs

@@ -1,6 +1,6 @@
 # koa-router
 
-[![NPM version](http://img.shields.io/npm/v/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![NPM Downloads](https://img.shields.io/npm/dm/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![Node.js Version](https://img.shields.io/node/v/koa-router.svg?style=flat)](http://nodejs.org/download/) [![Build Status](http://img.shields.io/travis/alexmingoia/koa-router.svg?style=flat)](http://travis-ci.org/alexmingoia/koa-router) [![Tips](https://img.shields.io/gratipay/alexmingoia.svg?style=flat)](https://www.gratipay.com/alexmingoia/) [![Gitter Chat](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat)](https://gitter.im/alexmingoia/koa-router/)
+[![NPM version](https://img.shields.io/npm/v/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![NPM Downloads](https://img.shields.io/npm/dm/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![Node.js Version](https://img.shields.io/node/v/koa-router.svg?style=flat)](http://nodejs.org/download/) [![Build Status](https://img.shields.io/travis/alexmingoia/koa-router.svg?style=flat)](http://travis-ci.org/alexmingoia/koa-router) [![Tips](https://img.shields.io/gratipay/alexmingoia.svg?style=flat)](https://www.gratipay.com/alexmingoia/) [![Gitter Chat](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat)](https://gitter.im/alexmingoia/koa-router/)
 
 > Router middleware for [koa](https://github.com/koajs/koa)
 
@@ -14,7 +14,16 @@
 * Nestable routers.
 * ES7 async/await support.
 
-{{#module name="koa-router"}}{{>body}}{{/module}}## Installation
+{{#module name="koa-router"}}{{>body}}{{/module}}## Migrating to 7 / Koa 2
+
+- The API has changed to match the new promise-based middleware
+  signature of koa 2. See the
+  [koa 2.x readme](https://github.com/koajs/koa/tree/2.0.0-alpha.3) for more
+  information.
+- Middleware is now always run in the order declared by `.use()` (or `.get()`,
+  etc.), which matches Express 4 API.
+
+## Installation
 
 Install using [npm](https://www.npmjs.org/):
 

lib/layer.js

@@ -1,5 +1,6 @@
 var debug = require('debug')('koa-router');
 var pathToRegExp = require('path-to-regexp');
+var uri = require('urijs');
 
 module.exports = Layer;
 
@@ -92,6 +93,7 @@ Layer.prototype.params = function (path, captures, existingParams) {
  */
 
 Layer.prototype.captures = function (path) {
+  if (this.opts.ignoreCaptures) return [];
   return path.match(this.regexp).slice(1);
 };
 
@@ -111,27 +113,42 @@ Layer.prototype.captures = function (path) {
  * @private
  */
 
-Layer.prototype.url = function (params) {
+Layer.prototype.url = function (params, options) {
   var args = params;
-  var url = this.path;
+  var url = this.path.replace('\(\.\*\)', '');
   var toPath = pathToRegExp.compile(url);
+  var replaced;
 
-  // argument is of form { key: val }
   if (typeof params != 'object') {
     args = Array.prototype.slice.call(arguments);
+    if (typeof args[args.length - 1] == 'object') {
+      options = args[args.length - 1];
+      args = args.slice(0, args.length - 1);
+    }
   }
 
+  var tokens = pathToRegExp.parse(url);
+  var replace = {};
+
   if (args instanceof Array) {
-    var tokens = pathToRegExp.parse(url);
-    var replace = {};
     for (var len = tokens.length, i=0, j=0; i<len; i++) {
       if (tokens[i].name) replace[tokens[i].name] = args[j++];
     }
-    return toPath(replace);
+  } else if (tokens.some(token => token.name)) {
+    replace = params;
+  } else {
+    options = params;
   }
-  else {
-    return toPath(params);
+
+  replaced = toPath(replace);
+
+  if (options && options.query) {
+    var replaced = new uri(replaced)
+    replaced.search(options.query);
+    return replaced.toString();
   }
+
+  return replaced;
 };
 
 /**
@@ -141,13 +158,13 @@ Layer.prototype.url = function (params) {
  *
  * ```javascript
  * router
- *   .param('user', function *(id, next) {
- *     this.user = users[id];
- *     if (!user) return this.status = 404;
- *     yield next;
+ *   .param('user', function (id, ctx, next) {
+ *     ctx.user = users[id];
+ *     if (!user) return ctx.status = 404;
+ *     next();
  *   })
- *   .get('/users/:user', function *(next) {
- *     this.body = this.user;
+ *   .get('/users/:user', function (ctx, next) {
+ *     ctx.body = ctx.user;
  *   });
  * ```
  *
@@ -160,13 +177,8 @@ Layer.prototype.url = function (params) {
 Layer.prototype.param = function (param, fn) {
   var stack = this.stack;
   var params = this.paramNames;
-  var middleware = function *(next) {
-    next = fn.call(this, this.params[param], next);
-    if (typeof next.next === 'function') {
-      yield *next;
-    } else {
-      yield Promise.resolve(next);
-    }
+  var middleware = function (ctx, next) {
+    return fn.call(this, ctx.params[param], ctx, next);
   };
   middleware.param = param;
 

package.json

@@ -10,35 +10,37 @@
     "lib"
   ],
   "author": "Alex Mingoia <talk@alexmingoia.com>",
-  "version": "5.4.0",
+  "version": "7.3.0",
   "keywords": [
     "koa",
     "middleware",
     "router",
     "route"
   ],
   "dependencies": {
-    "debug": "^2.2.0",
+    "debug": "^3.1.0",
     "http-errors": "^1.3.1",
+    "koa-compose": "^3.0.0",
     "methods": "^1.0.1",
-    "path-to-regexp": "^1.1.1"
+    "path-to-regexp": "^1.1.1",
+    "urijs": "^1.19.0"
   },
   "devDependencies": {
+    "expect.js": "^0.3.1",
     "gulp": "^3.8.11",
     "gulp-mocha": "^2.0.0",
     "jsdoc-to-markdown": "^1.1.1",
-    "expect.js": "^0.3.1",
-    "koa": "^0.20.0",
+    "koa": "2.2.0",
     "mocha": "^2.0.1",
     "should": "^6.0.3",
     "supertest": "^1.0.1"
   },
   "scripts": {
-    "test": "[ \"${TRAVIS_NODE_VERSION}\" = \"0.12\" ] && NODE_ENV=test node --harmony-generators node_modules/gulp/bin/gulp.js test || NODE_ENV=test node node_modules/gulp/bin/gulp.js test",
+    "test": "NODE_ENV=test node node_modules/gulp/bin/gulp.js test",
     "docs": "NODE_ENV=test node node_modules/gulp/bin/gulp.js docs"
   },
   "engines": {
-    "node": "> 0.12"
+    "node": ">= 4"
   },
   "license": "MIT"
 }

test/lib/layer.js

@@ -2,7 +2,7 @@
  * Route tests
  */
 
-var koa = require('koa')
+var Koa = require('koa')
   , http = require('http')
   , request = require('supertest')
   , Router = require('../../lib/router')
@@ -11,18 +11,18 @@ var koa = require('koa')
 
 describe('Layer', function() {
   it('composes multiple callbacks/middlware', function(done) {
-    var app = koa();
+    var app = new Koa();
     var router = new Router();
     app.use(router.routes());
     router.get(
       '/:category/:title',
-      function *(next) {
-        this.status = 500;
-        yield next;
+      function (ctx, next) {
+        ctx.status = 500;
+        return next();
       },
-      function *(next) {
-        this.status = 204;
-        yield next;
+      function (ctx, next) {
+        ctx.status = 204;
+        return next();
       }
     );
     request(http.createServer(app.callback()))
@@ -36,15 +36,15 @@ describe('Layer', function() {
 
   describe('Layer#match()', function() {
     it('captures URL path parameters', function(done) {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
       app.use(router.routes());
-      router.get('/:category/:title', function *(next) {
-        this.should.have.property('params');
-        this.params.should.be.type('object');
-        this.params.should.have.property('category', 'match');
-        this.params.should.have.property('title', 'this');
-        this.status = 204;
+      router.get('/:category/:title', function (ctx) {
+        ctx.should.have.property('params');
+        ctx.params.should.be.type('object');
+        ctx.params.should.have.property('category', 'match');
+        ctx.params.should.have.property('title', 'this');
+        ctx.status = 204;
       });
       request(http.createServer(app.callback()))
       .get('/match/this')
@@ -56,15 +56,15 @@ describe('Layer', function() {
     });
 
     it('return orginal path parameters when decodeURIComponent throw error', function(done) {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
       app.use(router.routes());
-      router.get('/:category/:title', function *(next) {
-        this.should.have.property('params');
-        this.params.should.be.type('object');
-        this.params.should.have.property('category', '100%');
-        this.params.should.have.property('title', '101%');
-        this.status = 204;
+      router.get('/:category/:title', function (ctx) {
+        ctx.should.have.property('params');
+        ctx.params.should.be.type('object');
+        ctx.params.should.have.property('category', '100%');
+        ctx.params.should.have.property('title', '101%');
+        ctx.status = 204;
       });
       request(http.createServer(app.callback()))
       .get('/100%/101%')
@@ -73,19 +73,19 @@ describe('Layer', function() {
     });
 
     it('populates ctx.captures with regexp captures', function(done) {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
       app.use(router.routes());
-      router.get(/^\/api\/([^\/]+)\/?/i, function *(next) {
-        this.should.have.property('captures');
-        this.captures.should.be.instanceOf(Array);
-        this.captures.should.have.property(0, '1');
-        yield next;
-      }, function *(next) {
-        this.should.have.property('captures');
-        this.captures.should.be.instanceOf(Array);
-        this.captures.should.have.property(0, '1');
-        this.status = 204;
+      router.get(/^\/api\/([^\/]+)\/?/i, function (ctx, next) {
+        ctx.should.have.property('captures');
+        ctx.captures.should.be.instanceOf(Array);
+        ctx.captures.should.have.property(0, '1');
+        return next();
+      }, function (ctx) {
+        ctx.should.have.property('captures');
+        ctx.captures.should.be.instanceOf(Array);
+        ctx.captures.should.have.property(0, '1');
+        ctx.status = 204;
       });
       request(http.createServer(app.callback()))
       .get('/api/1')
@@ -97,19 +97,19 @@ describe('Layer', function() {
     });
 
     it('return orginal ctx.captures when decodeURIComponent throw error', function(done) {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
       app.use(router.routes());
-      router.get(/^\/api\/([^\/]+)\/?/i, function *(next) {
-        this.should.have.property('captures');
-        this.captures.should.be.type('object');
-        this.captures.should.have.property(0, '101%');
-        yield next;
-      }, function *(next) {
-        this.should.have.property('captures');
-        this.captures.should.be.type('object');
-        this.captures.should.have.property(0, '101%');
-        this.status = 204;
+      router.get(/^\/api\/([^\/]+)\/?/i, function (ctx, next) {
+        ctx.should.have.property('captures');
+        ctx.captures.should.be.type('object');
+        ctx.captures.should.have.property(0, '101%');
+        return next();
+      }, function (ctx, next) {
+        ctx.should.have.property('captures');
+        ctx.captures.should.be.type('object');
+        ctx.captures.should.have.property(0, '101%');
+        ctx.status = 204;
       });
       request(http.createServer(app.callback()))
       .get('/api/101%')
@@ -121,19 +121,19 @@ describe('Layer', function() {
     });
 
     it('populates ctx.captures with regexp captures include undefiend', function(done) {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
       app.use(router.routes());
-      router.get(/^\/api(\/.+)?/i, function *(next) {
-        this.should.have.property('captures');
-        this.captures.should.be.type('object');
-        this.captures.should.have.property(0, undefined);
-        yield next;
-      }, function *(next) {
-        this.should.have.property('captures');
-        this.captures.should.be.type('object');
-        this.captures.should.have.property(0, undefined);
-        this.status = 204;
+      router.get(/^\/api(\/.+)?/i, function (ctx, next) {
+        ctx.should.have.property('captures');
+        ctx.captures.should.be.type('object');
+        ctx.captures.should.have.property(0, undefined);
+        return next();
+      }, function (ctx) {
+        ctx.should.have.property('captures');
+        ctx.captures.should.be.type('object');
+        ctx.captures.should.have.property(0, undefined);
+        ctx.status = 204;
       });
       request(http.createServer(app.callback()))
       .get('/api')
@@ -145,7 +145,7 @@ describe('Layer', function() {
     });
 
     it('should throw friendly error message when handle not exists', function() {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
       app.use(router.routes());
       var notexistHandle = undefined;
@@ -165,15 +165,15 @@ describe('Layer', function() {
 
   describe('Layer#param()', function() {
     it('composes middleware for param fn', function(done) {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
-      var route = new Layer('/users/:user', ['GET'], [function *(next) {
-        this.body = this.user;
+      var route = new Layer('/users/:user', ['GET'], [function (ctx) {
+        ctx.body = ctx.user;
       }]);
-      route.param('user', function *(id, next) {
-        this.user = { name: 'alex' };
-        if (!id) return this.status = 404;
-        yield next;
+      route.param('user', function (id, ctx, next) {
+        ctx.user = { name: 'alex' };
+        if (!id) return ctx.status = 404;
+        return next();
       });
       router.stack.push(route);
       app.use(router.middleware());
@@ -189,20 +189,20 @@ describe('Layer', function() {
     });
 
     it('ignores params which are not matched', function(done) {
-      var app = koa();
+      var app = new Koa();
       var router = new Router();
-      var route = new Layer('/users/:user', ['GET'], [function *(next) {
-        this.body = this.user;
+      var route = new Layer('/users/:user', ['GET'], [function (ctx) {
+        ctx.body = ctx.user;
       }]);
-      route.param('user', function *(id, next) {
-        this.user = { name: 'alex' };
-        if (!id) return this.status = 404;
-        yield next;
+      route.param('user', function (id, ctx, next) {
+        ctx.user = { name: 'alex' };
+        if (!id) return ctx.status = 404;
+        return next();
       });
-      route.param('title', function *(id, next) {
-        this.user = { name: 'mark' };
-        if (!id) return this.status = 404;
-        yield next;
+      route.param('title', function (id, ctx, next) {
+        ctx.user = { name: 'mark' };
+        if (!id) return ctx.status = 404;
+        return next();
       });
       router.stack.push(route);
       app.use(router.middleware());
@@ -220,15 +220,15 @@ describe('Layer', function() {
 
   describe('Layer#url()', function() {
     it('generates route URL', function() {
-      var route = new Layer('/:category/:title', ['get'], [function* () {}], 'books');
+      var route = new Layer('/:category/:title', ['get'], [function () {}], 'books');
       var url = route.url({ category: 'programming', title: 'how-to-node' });
       url.should.equal('/programming/how-to-node');
       url = route.url('programming', 'how-to-node');
       url.should.equal('/programming/how-to-node');
     });
 
     it('escapes using encodeURIComponent()', function() {
-      var route = new Layer('/:category/:title', ['get'], [function *() {}], 'books');
+      var route = new Layer('/:category/:title', ['get'], [function () {}], 'books');
       var url = route.url({ category: 'programming', title: 'how to node' });
       url.should.equal('/programming/how%20to%20node');
     });