feat: support optional trailing slashes when matching

Issue router5/router5#16

Author: troch

modules/RouteNode.js

@@ -103,18 +103,31 @@ export default class RouteNode {
         return matched ? segments : null
     }
 
-    getSegmentsMatchingPath(path) {
+    getSegmentsMatchingPath(path, trailingSlash = false) {
         let matchChildren = (nodes, pathSegment, segments) => {
             // for (child of node.children) {
             for (let i in nodes) {
                 let child = nodes[i]
                 // Partially match path
                 let match = child.parser.partialMatch(pathSegment)
+                let remainingPath
+
+                if (!match && trailingSlash) {
+                    // Try with optional trailing slash
+                    match = child.parser.match(pathSegment, true)
+                    remainingPath = ''
+                } else if (match) {
+                    // Remove consumed segment from path
+                    let consumedPath = child.parser.build(match)
+                    remainingPath = pathSegment.replace(consumedPath, '')
+                    if (trailingSlash && remainingPath === '/' && !/\/$/.test(consumedPath)) {
+                        remainingPath = ''
+                    }
+                }
+
                 if (match) {
                     segments.push(child)
                     Object.keys(match).forEach(param => segments.params[param] = match[param])
-                    // Remove consumed segment from path
-                    let remainingPath = pathSegment.replace(child.parser.build(match), '')
                     // If fully matched
                     if (!remainingPath.length) {
                         return segments
@@ -154,15 +167,15 @@ export default class RouteNode {
     }
 
     getMatchPathFromSegments(segments) {
-        if (!segments) return null
+        if (!segments || !segments.length) return null
 
         let name = segments.map(segment => segment.name).join('.')
         let params = segments.params
 
         return {name, params}
     }
 
-    matchPath(path) {
-        return this.getMatchPathFromSegments(this.getSegmentsMatchingPath(path))
+    matchPath(path, trailingSlash = false) {
+        return this.getMatchPathFromSegments(this.getSegmentsMatchingPath(path, trailingSlash))
     }
 }

package.json

@@ -32,6 +32,6 @@
     "async": "^1.3.0"
   },
   "dependencies": {
-    "path-parser": "~0.1.1"
+    "path-parser": "~0.2.1"
   }
 }

test/main.js

@@ -165,13 +165,30 @@ describe('RouteNode', function () {
         rootNode.matchPath('/abc').should.eql({name: 'id', params: {id: 'abc'}});
         rootNode.matchPath('/section/abc').should.eql({name: 'section', params: {id: 'abc'}});
     });
+
+    it('should match paths with optional trailing slashes', function () {
+        var rootNode = getRoutes();
+        should.not.exists(rootNode.matchPath('/users/list/'));
+        rootNode.matchPath('/users/list', true).should.eql({name: 'users.list', params: {}});
+        rootNode.matchPath('/users/list').should.eql({name: 'users.list', params: {}});
+        rootNode.matchPath('/users/list/', true).should.eql({name: 'users.list', params: {}});
+        should.not.exists(rootNode.matchPath('/users/list//', true));
+
+        var rootNode = getRoutes(true);
+        should.not.exists(rootNode.matchPath('/users/list'));
+        rootNode.matchPath('/users/list', true).should.eql({name: 'users.list', params: {}});
+        rootNode.matchPath('/users/list/', true).should.eql({name: 'users.list', params: {}});
+        rootNode.matchPath('/users/list/').should.eql({name: 'users.list', params: {}});
+        should.not.exists(rootNode.matchPath('/users/list//', true));
+    });
 });
 
 
-function getRoutes() {
+function getRoutes(trailingSlash) {
+    var suffix = trailingSlash ? '/' : '';
     var usersNode = new RouteNode('users', '/users', [
-        new RouteNode('list', '/list'),
-        new RouteNode('view', '/view/:id')
+        new RouteNode('list', '/list' + suffix),
+        new RouteNode('view', '/view/:id' + suffix)
     ]);
 
     return new RouteNode('', '', [