feat: push splats to the end of a children list

Author: troch

README.md

@@ -1,2 +1,49 @@
+[![Build Status](https://travis-ci.org/troch/route-node.svg?branch=master)](https://travis-ci.org/troch/route-node)
+
 # route-node
-A package to create a tree of named routes
+
+A package to create a tree (trie) of named routes. It is similar to [routington](https://www.npmjs.com/package/routington) except that nodes are not added by splitting path by segment ("/"). Instead the trie is built with the supplied nodes, meaning each node is a valid route.
+
+## Install
+
+    $ npm install route-node --save
+
+## Usage
+
+```javascript
+var RootNode = require('route-node');
+
+// Create nodes
+var usersNode = new RouteNode('users', '/users', [
+    new RouteNode('list', '/list'),
+    new RouteNode('view', '/view/:id')
+]);
+
+var ordersNode = new RouteNode('orders', '/orders', [
+    new RouteNode('pending', '/pending'),
+    new RouteNode('completed', '/completed'),
+    new RouteNode('view', '/view/:id')
+]);
+
+// Creating a top node
+var rootNode = new RouteNode('', '', [
+    ordersNode,
+    usersNode
+]);
+
+// Add nodes programmatically
+rootNode.add(new RouteNode('home', '/home'));
+
+rootNode.getPath('users.view');                // => "/users/view/:id"
+rootNode.buildPath('users.view', {id: 1});     // => "/users/view/1"
+
+rootNode.matchPath('/users/view/1');           // => {name: "users.view", params: {id: "1"}}
+```
+
+## Related packages
+
+- [routington](https://www.npmjs.com/package/routington)
+
+## Based on
+
+- [parth-parser](https://www.npmjs.com/package/path-parser) for parsing, matching and building paths.

index.js

@@ -65,6 +65,10 @@ var RouteNode = (function () {
             }
 
             this.children.push(route);
+            // Push greedy splats to the bottom of the pile
+            this.children.sort(function (childA, childB) {
+                return childA.hasSplatParam ? -1 : 1;
+            });
         }
     }, {
         key: '_findRouteByName',
@@ -92,13 +96,14 @@ var RouteNode = (function () {
             return matched ? segments : [];
         }
     }, {
-        key: 'matchRoute',
-        value: function matchRoute(path) {
+        key: 'matchPath',
+        value: function matchPath(path) {
             var segments = [];
 
             var matchChildren = function matchChildren(node, pathSegment, matched) {
                 var _loop = function (i) {
                     var child = node.children[i];
+                    // Partially match path
                     var match = child.parser.partialMatch(pathSegment);
                     if (match) {
                         // Append name and extend params
@@ -114,7 +119,7 @@ var RouteNode = (function () {
                                 v: matched
                             };
                         }
-                        // If no children to match against but segment left
+                        // If no children to match against but unmatched path left
                         if (!child.children.length) {
                             return {
                                 v: false

lib/RouteNode.js

@@ -35,6 +35,8 @@ export default class RouteNode {
         }
 
         this.children.push(route)
+            // Push greedy splats to the bottom of the pile
+        this.children.sort((childA, childB) => childA.hasSplatParam ? -1 : 1)
     }
 
     _findRouteByName(routeName) {
@@ -59,7 +61,7 @@ export default class RouteNode {
         return matched ? segments : []
     }
 
-    matchRoute(path) {
+    matchPath(path) {
         let segments = []
 
         let matchChildren = (node, pathSegment, matched) => {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "route-node",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "A package to create a tree of named routes#",
   "main": "index.js",
   "scripts": {
@@ -28,6 +28,6 @@
     "mocha": "^2.2.5"
   },
   "dependencies": {
-    "path-parser": "0.0.2"
+    "path-parser": "~0.0.3"
   }
 }

test/main.js

@@ -80,24 +80,44 @@ describe('RouteNode', function () {
         }).should.throw();
     });
 
-    it('should find a nested route by path', function () {
+    it('should find a nested route by matching a path', function () {
         var node = getRoutes();
         // Building paths
-        node.matchRoute('/users/view/1').should.eql({name: 'users.view', params: {id: '1'}});
-        node.matchRoute('/users/profile/1').should.be.false;
-        node.matchRoute('/users/view/profile/1').should.be.false;
+        node.matchPath('/users/view/1').should.eql({name: 'users.view', params: {id: '1'}});
+        node.matchPath('/users/profile/1').should.be.false;
+        node.matchPath('/users/view/profile/1').should.be.false;
+    });
+
+    it('should find a nested route by matching a path with a splat', function () {
+        var node = getRoutesWithSplat();
+        // Building paths
+        node.matchPath('/users/view/1').should.eql({name: 'users.view', params: {id: '1'}});
+        node.matchPath('/users/profile/1').should.eql({name: 'users.splat', params: {id: 'profile/1'}});
+        node.matchPath('/users/view/profile/1').should.be.false;
     });
 });
 
 
 function getRoutes() {
     var usersNode = new RouteNode('users', '/users', [
-            new RouteNode('list', '/list'),
-            new RouteNode('view', '/view/:id')
-        ])
+        new RouteNode('list', '/list'),
+        new RouteNode('view', '/view/:id')
+    ]);
 
     return new RouteNode('', '', [
         new RouteNode('home', '/home'),
         usersNode
     ]);
 }
+
+function getRoutesWithSplat() {
+    var usersNode = new RouteNode('users', '/users', [
+        new RouteNode('splat', '/*id'),
+        new RouteNode('list', '/list'),
+        new RouteNode('view', '/view/:id')
+    ]);
+
+    return new RouteNode('', '', [
+        usersNode
+    ]);
+}