path-to-regexp 0.0.1 → 0.1.2

package/.npmignore

@@ -1 +1,2 @@
-test
+node_modules
+coverage

package/History.md

@@ -0,0 +1,11 @@
+
+0.1.0 / 2014-03-06
+==================
+
+  * add options.end
+
+0.0.2 / 2013-02-10
+==================
+
+  * Update to match current express
+  * add .license property to component.json

package/Readme.md

@@ -3,6 +3,31 @@
 
   Turn an Express-style path string such as `/user/:name` into a regular expression.
 
+## Usage
+
+```javascript
+var pathToRegexp = require('path-to-regexp');
+```
+### pathToRegexp(path, keys, options)
+
+ - **path** A string in the express format, an array of such strings, or a regular expression
+ - **keys** An array to be populated with the keys present in the url.  Once the function completes, this will be an array of strings.
+ - **options**
+   - **options.sensitive** Defaults to false, set this to true to make routes case sensitive
+   - **options.strict** Defaults to false, set this to true to make the trailing slash matter.
+   - **options.end** Defaults to true, set this to false to only match the prefix of the URL.
+
+```javascript
+var keys = [];
+var exp = pathToRegexp('/foo/:bar', keys);
+//keys = ['bar']
+//exp = /^\/foo\/(?:([^\/]+?))\/?$/i
+```
+
+## Live Demo
+
+You can see a live demo of this library in use at [express-route-tester](http://forbeslindesay.github.com/express-route-tester/).
+
 ## License
 
   MIT

package/component.json

@@ -0,0 +1,15 @@
+{
+  "name": "path-to-regexp",
+  "description": "Express style path to RegExp utility",
+  "version": "0.1.0",
+  "keywords": [
+    "express",
+    "regexp",
+    "route",
+    "routing"
+  ],
+  "scripts": [
+    "index.js"
+  ],
+  "license": "MIT"
+}

package/index.js

@@ -1,4 +1,3 @@
-
 /**
  * Expose `pathtoRegexp`.
  */
@@ -25,6 +24,7 @@ function pathtoRegexp(path, keys, options) {
   options = options || {};
   var sensitive = options.sensitive;
   var strict = options.strict;
+  var end = options.end !== false;
   keys = keys || [];
 
   if (path instanceof RegExp) return path;
@@ -32,21 +32,25 @@ function pathtoRegexp(path, keys, options) {
 
   path = path
     .concat(strict ? '' : '/?')
-    .replace(/\/\(/g, '(?:/')
-    .replace(/\+/g, '__plus__')
-    .replace(/(\/)?(\.)?:(\w+)(?:(\(.*?\)))?(\?)?/g, function(_, slash, format, key, capture, optional){
-      keys.push({ name: key, optional: !! optional });
+    .replace(/\/\(/g, '/(?:')
+    .replace(/([\/\.])/g, '\\$1')
+    .replace(/(\\\/)?(\\\.)?:(\w+)(\(.*?\))?(\*)?(\?)?/g, function (match, slash, format, key, capture, star, optional) {
       slash = slash || '';
+      format = format || '';
+      capture = capture || '([^/' + format + ']+?)';
+      optional = optional || '';
+
+      keys.push({ name: key, optional: !!optional });
+
       return ''
         + (optional ? '' : slash)
         + '(?:'
-        + (optional ? slash : '')
-        + (format || '') + (capture || (format && '([^/.]+?)' || '([^/]+?)')) + ')'
-        + (optional || '');
+        + format + (optional ? slash : '') + capture
+        + (star ? '((?:[\\/' + format + '].+?)?)' : '')
+        + ')'
+        + optional;
     })
-    .replace(/([\/.])/g, '\\$1')
-    .replace(/__plus__/g, '(.+)')
     .replace(/\*/g, '(.*)');
 
-  return new RegExp('^' + path + '$', sensitive ? '' : 'i');
-};
+  return new RegExp('^' + path + (end ? '$' : '(?=\/|$)'), sensitive ? '' : 'i');
+};

package/package.json

@@ -1,11 +1,25 @@
 {
   "name": "path-to-regexp",
   "description": "Express style path to RegExp utility",
-  "version": "0.0.1",
-  "keywords": ["express", "regexp"],
+  "version": "0.1.2",
+  "scripts": {
+    "test": "istanbul cover _mocha -- -R spec"
+  },
+  "keywords": [
+    "express",
+    "regexp"
+  ],
   "component": {
     "scripts": {
       "path-to-regexp": "index.js"
     }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/component/path-to-regexp.git"
+  },
+  "devDependencies": {
+    "mocha": "^1.17.1",
+    "istanbul": "^0.2.6"
   }
 }

package/test.js

@@ -0,0 +1,510 @@
+var pathToRegExp = require('./');
+var assert = require('assert');
+
+describe('path-to-regexp', function () {
+  describe('strings', function () {
+    it('should match simple paths', function () {
+      var params = [];
+      var m = pathToRegExp('/test', params).exec('/test');
+
+      assert.equal(params.length, 0);
+
+      assert.equal(m.length, 1);
+      assert.equal(m[0], '/test');
+    });
+
+    it('should match express format params', function () {
+      var params = [];
+      var m = pathToRegExp('/:test', params).exec('/pathname');
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/pathname');
+      assert.equal(m[1], 'pathname');
+    });
+
+    it('should do strict matches', function () {
+      var params = [];
+      var re = pathToRegExp('/:test', params, { strict: true });
+      var m;
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      m = re.exec('/route');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/route');
+      assert.equal(m[1], 'route');
+
+      m = re.exec('/route/');
+
+      assert.ok(!m);
+    });
+
+    it('should allow optional express format params', function () {
+      var params = [];
+      var re = pathToRegExp('/:test?', params);
+      var m;
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, true);
+
+      m = re.exec('/route');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/route');
+      assert.equal(m[1], 'route');
+
+      m = re.exec('/');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/');
+      assert.equal(m[1], undefined);
+    });
+
+    it('should allow express format param regexps', function () {
+      var params = [];
+      var m = pathToRegExp('/:page(\\d+)', params).exec('/56');
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'page');
+      assert.equal(params[0].optional, false);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/56');
+      assert.equal(m[1], '56');
+    });
+
+    it('should match without a prefixed slash', function () {
+      var params = [];
+      var m = pathToRegExp(':test', params).exec('string');
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], 'string');
+      assert.equal(m[1], 'string');
+    });
+
+    it('should not match format parts', function () {
+      var params = [];
+      var m = pathToRegExp('/:test.json', params).exec('/route.json');
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/route.json');
+      assert.equal(m[1], 'route');
+    });
+
+    it('should match format parts', function () {
+      var params = [];
+      var re = pathToRegExp('/:test.:format', params);
+      var m;
+
+      assert.equal(params.length, 2);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+      assert.equal(params[1].name, 'format');
+      assert.equal(params[1].optional, false);
+
+      m = re.exec('/route.json');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/route.json');
+      assert.equal(m[1], 'route');
+      assert.equal(m[2], 'json');
+
+      m = re.exec('/route');
+
+      assert.ok(!m);
+    });
+
+    it('should match route parts with a trailing format', function () {
+      var params = [];
+      var m = pathToRegExp('/:test.json', params).exec('/route.json');
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/route.json');
+      assert.equal(m[1], 'route');
+    });
+
+    it('should match optional trailing routes', function () {
+      var params = [];
+      var m = pathToRegExp('/test*', params).exec('/test/route');
+
+      assert.equal(params.length, 0);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/test/route');
+      assert.equal(m[1], '/route');
+    });
+
+    it('should match optional trailing routes after a param', function () {
+      var params = [];
+      var re = pathToRegExp('/:test*', params);
+      var m;
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      m = re.exec('/test/route');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/test/route');
+      assert.equal(m[1], 'test');
+      assert.equal(m[2], '/route');
+
+      m = re.exec('/testing');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/testing');
+      assert.equal(m[1], 'testing');
+      assert.equal(m[2], '');
+    });
+
+    it('should match optional trailing routes before a format', function () {
+      var params = [];
+      var re = pathToRegExp('/test*.json', params);
+      var m;
+
+      assert.equal(params.length, 0);
+
+      m = re.exec('/test.json');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/test.json');
+      assert.equal(m[1], '');
+
+      m = re.exec('/testing.json');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/testing.json');
+      assert.equal(m[1], 'ing');
+
+      m = re.exec('/test/route.json');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/test/route.json');
+      assert.equal(m[1], '/route');
+    });
+
+    it('should match optional trailing routes after a param and before a format', function () {
+      var params = [];
+      var re = pathToRegExp('/:test*.json', params);
+      var m;
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      m = re.exec('/testing.json');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/testing.json');
+      assert.equal(m[1], 'testing');
+      assert.equal(m[2], '');
+
+      m = re.exec('/test/route.json');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/test/route.json');
+      assert.equal(m[1], 'test');
+      assert.equal(m[2], '/route');
+
+      m = re.exec('.json');
+
+      assert.ok(!m);
+    });
+
+    it('should match optional trailing routes between a normal param and a format param', function () {
+      var params = [];
+      var re = pathToRegExp('/:test*.:format', params);
+      var m;
+
+      assert.equal(params.length, 2);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+      assert.equal(params[1].name, 'format');
+      assert.equal(params[1].optional, false);
+
+      m = re.exec('/testing.json');
+
+      assert.equal(m.length, 4);
+      assert.equal(m[0], '/testing.json');
+      assert.equal(m[1], 'testing');
+      assert.equal(m[2], '');
+      assert.equal(m[3], 'json');
+
+      m = re.exec('/test/route.json');
+
+      assert.equal(m.length, 4);
+      assert.equal(m[0], '/test/route.json');
+      assert.equal(m[1], 'test');
+      assert.equal(m[2], '/route');
+      assert.equal(m[3], 'json');
+
+      m = re.exec('/test');
+
+      assert.ok(!m);
+
+      m = re.exec('.json');
+
+      assert.ok(!m);
+    });
+
+    it('should match optional trailing routes after a param and before an optional format param', function () {
+      var params = [];
+      var re = pathToRegExp('/:test*.:format?', params);
+      var m;
+
+      assert.equal(params.length, 2);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+      assert.equal(params[1].name, 'format');
+      assert.equal(params[1].optional, true);
+
+      m = re.exec('/testing.json');
+
+      assert.equal(m.length, 4);
+      assert.equal(m[0], '/testing.json');
+      assert.equal(m[1], 'testing');
+      assert.equal(m[2], '');
+      assert.equal(m[3], 'json');
+
+      m = re.exec('/test/route.json');
+
+      assert.equal(m.length, 4);
+      assert.equal(m[0], '/test/route.json');
+      assert.equal(m[1], 'test');
+      assert.equal(m[2], '/route');
+      assert.equal(m[3], 'json');
+
+      m = re.exec('/test');
+
+      assert.equal(m.length, 4);
+      assert.equal(m[0], '/test');
+      assert.equal(m[1], 'test');
+      assert.equal(m[2], '');
+      assert.equal(m[3], undefined);
+
+      m = re.exec('.json');
+
+      assert.ok(!m);
+    });
+
+    it('should match optional trailing routes inside optional express param', function () {
+      var params = [];
+      var re = pathToRegExp('/:test*?', params);
+      var m;
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, true);
+
+      m = re.exec('/test/route');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/test/route');
+      assert.equal(m[1], 'test');
+      assert.equal(m[2], '/route');
+
+      m = re.exec('/test');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/test');
+      assert.equal(m[1], 'test');
+      assert.equal(m[2], '');
+
+      m = re.exec('/');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/');
+      assert.equal(m[1], undefined);
+      assert.equal(m[2], undefined);
+    });
+
+    it('should do case insensitive matches', function () {
+      var m = pathToRegExp('/test').exec('/TEST');
+
+      assert.equal(m[0], '/TEST');
+    });
+
+    it('should do case sensitive matches', function () {
+      var re = pathToRegExp('/test', null, { sensitive: true });
+      var m;
+
+      m = re.exec('/test');
+
+      assert.equal(m.length, 1);
+      assert.equal(m[0], '/test');
+
+      m = re.exec('/TEST');
+
+      assert.ok(!m);
+    });
+
+    it('should do non-ending matches', function () {
+      var params = [];
+      var m = pathToRegExp('/:test', params, { end: false }).exec('/test/route');
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/test');
+      assert.equal(m[1], 'test');
+    });
+
+    it('should match trailing slashes in non-ending non-strict mode', function () {
+      var params = [];
+      var re = pathToRegExp('/:test', params, { end: false });
+      var m;
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      m = re.exec('/test/');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/test/');
+      assert.equal(m[1], 'test');
+    });
+
+    it('should not match trailing slashes in non-ending strict mode', function () {
+      var params = [];
+      var re = pathToRegExp('/:test', params, { end: false, strict: true });
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      m = re.exec('/test/');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/test');
+      assert.equal(m[1], 'test');
+    });
+
+    it('should match text after an express param', function () {
+      var params = [];
+      var re = pathToRegExp('/(:test)route', params);
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      m = re.exec('/route');
+
+      assert.ok(!m);
+
+      m = re.exec('/testroute');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/testroute');
+      assert.equal(m[1], 'test');
+
+      m = re.exec('testroute');
+
+      assert.ok(!m);
+    });
+
+    it('should match text after an optional express param', function () {
+      var params = [];
+      var re = pathToRegExp('/(:test?)route', params);
+      var m;
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, true);
+
+      m = re.exec('/route');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/route');
+      assert.equal(m[1], undefined);
+
+      m = re.exec('/testroute');
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/testroute');
+      assert.equal(m[1], 'test');
+
+      m = re.exec('route');
+
+      assert.ok(!m);
+    });
+
+    it('should match optional formats', function () {
+      var params = [];
+      var re = pathToRegExp('/:test.:format?', params);
+      var m;
+
+      assert.equal(params.length, 2);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+      assert.equal(params[1].name, 'format');
+      assert.equal(params[1].optional, true);
+
+      m = re.exec('/route');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/route');
+      assert.equal(m[1], 'route');
+      assert.equal(m[2], undefined);
+
+      m = re.exec('/route.json');
+
+      assert.equal(m.length, 3);
+      assert.equal(m[0], '/route.json');
+      assert.equal(m[1], 'route');
+      assert.equal(m[2], 'json');
+    });
+
+    it('should match full paths with format by default', function () {
+      var params = [];
+      var m = pathToRegExp('/:test', params).exec('/test.json');
+
+      assert.equal(params.length, 1);
+      assert.equal(params[0].name, 'test');
+      assert.equal(params[0].optional, false);
+
+      assert.equal(m.length, 2);
+      assert.equal(m[0], '/test.json');
+      assert.equal(m[1], 'test.json');
+    });
+  });
+
+  describe('regexps', function () {
+    it('should return the regexp', function () {
+      assert.deepEqual(pathToRegExp(/.*/), /.*/);
+    });
+  });
+
+  describe('arrays', function () {
+    it('should join arrays parts', function () {
+      var re = pathToRegExp(['/test', '/route']);
+
+      assert.ok(re.exec('/test'));
+      assert.ok(re.exec('/route'));
+      assert.ok(!re.exec('/else'));
+    });
+  });
+});