path-to-regexp 0.1.3 → 0.1.7

package/History.md

@@ -1,3 +1,23 @@
+0.1.7 / 2015-07-28
+==================
+
+  * Fixed regression with escaped round brackets and matching groups.
+
+0.1.6 / 2015-06-19
+==================
+
+  * Replace `index` feature by outputting all parameters, unnamed and named.
+
+0.1.5 / 2015-05-08
+==================
+
+  * Add an index property for position in match result.
+
+0.1.4 / 2015-03-05
+==================
+
+  * Add license information
+
 0.1.3 / 2014-07-06
 ==================
 

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/Readme.md

@@ -1,13 +1,15 @@
-
 # Path-to-RegExp
 
-  Turn an Express-style path string such as `/user/:name` into a regular expression.
+Turn an Express-style path string such as `/user/:name` into a regular expression.
+
+**Note:** This is a legacy branch. You should upgrade to `1.x`.
 
 ## 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
@@ -30,4 +32,4 @@ You can see a live demo of this library in use at [express-route-tester](http://
 
 ## License
 
-  MIT
+  MIT

package/index.js

@@ -4,6 +4,11 @@
 
 module.exports = pathtoRegexp;
 
+/**
+ * Match matching groups in a regular expression.
+ */
+var MATCHING_GROUP_REGEXP = /\((?!\?)/g;
+
 /**
  * Normalize the given path string,
  * returning a regular expression.
@@ -22,12 +27,25 @@ module.exports = pathtoRegexp;
 
 function pathtoRegexp(path, keys, options) {
   options = options || {};
+  keys = keys || [];
   var strict = options.strict;
   var end = options.end !== false;
   var flags = options.sensitive ? '' : 'i';
-  keys = keys || [];
+  var extraOffset = 0;
+  var keysOffset = keys.length;
+  var i = 0;
+  var name = 0;
+  var m;
 
   if (path instanceof RegExp) {
+    while (m = MATCHING_GROUP_REGEXP.exec(path.source)) {
+      keys.push({
+        name: name++,
+        optional: false,
+        offset: m.index
+      });
+    }
+
     return path;
   }
 
@@ -45,23 +63,64 @@ function pathtoRegexp(path, keys, options) {
   path = ('^' + path + (strict ? '' : path[path.length - 1] === '/' ? '?' : '/?'))
     .replace(/\/\(/g, '/(?:')
     .replace(/([\/\.])/g, '\\$1')
-    .replace(/(\\\/)?(\\\.)?:(\w+)(\(.*?\))?(\*)?(\?)?/g, function (match, slash, format, key, capture, star, optional) {
+    .replace(/(\\\/)?(\\\.)?:(\w+)(\(.*?\))?(\*)?(\?)?/g, function (match, slash, format, key, capture, star, optional, offset) {
       slash = slash || '';
       format = format || '';
       capture = capture || '([^\\/' + format + ']+?)';
       optional = optional || '';
 
-      keys.push({ name: key, optional: !!optional });
+      keys.push({
+        name: key,
+        optional: !!optional,
+        offset: offset + extraOffset
+      });
 
-      return ''
+      var result = ''
         + (optional ? '' : slash)
         + '(?:'
         + format + (optional ? slash : '') + capture
         + (star ? '((?:[\\/' + format + '].+?)?)' : '')
         + ')'
         + optional;
+
+      extraOffset += result.length - match.length;
+
+      return result;
     })
-    .replace(/\*/g, '(.*)');
+    .replace(/\*/g, function (star, index) {
+      var len = keys.length
+
+      while (len-- > keysOffset && keys[len].offset > index) {
+        keys[len].offset += 3; // Replacement length minus asterisk length.
+      }
+
+      return '(.*)';
+    });
+
+  // This is a workaround for handling unnamed matching groups.
+  while (m = MATCHING_GROUP_REGEXP.exec(path)) {
+    var escapeCount = 0;
+    var index = m.index;
+
+    while (path.charAt(--index) === '\\') {
+      escapeCount++;
+    }
+
+    // It's possible to escape the bracket.
+    if (escapeCount % 2 === 1) {
+      continue;
+    }
+
+    if (keysOffset + i === keys.length || keys[keysOffset + i].offset > m.index) {
+      keys.splice(keysOffset + i, 0, {
+        name: name++, // Unnamed matching groups must be consistently linear.
+        optional: false,
+        offset: m.index
+      });
+    }
+
+    i++;
+  }
 
   // If the path is non-ending, match until the end or a slash.
   path += (end ? '$' : (path[path.length - 1] === '/' ? '' : '(?=\\/|$)'));

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "path-to-regexp",
   "description": "Express style path to RegExp utility",
-  "version": "0.1.3",
+  "version": "0.1.7",
+  "files": [
+    "index.js",
+    "LICENSE"
+  ],
   "scripts": {
     "test": "istanbul cover _mocha -- -R spec"
   },
@@ -14,6 +18,7 @@
       "path-to-regexp": "index.js"
     }
   },
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/component/path-to-regexp.git"

package/.npmignore

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

package/component.json

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

package/test.js

@@ -1,616 +0,0 @@
-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 do strict matches with trailing slashes', 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.ok(!m);
-
-      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 match trailing slashes in non-ending non-strict mode', function () {
-      var params = [];
-      var re = pathToRegExp('/route/', params, { end: false });
-      var m;
-
-      assert.equal(params.length, 0);
-
-      m = re.exec('/route/');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route/');
-
-      m = re.exec('/route/test');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route');
-
-      m = re.exec('/route');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route');
-
-      m = re.exec('/route//');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route/');
-    });
-
-    it('should match trailing slashing in non-ending strict mode', function () {
-      var params = [];
-      var re = pathToRegExp('/route/', params, { end: false, strict: true });
-
-      assert.equal(params.length, 0);
-
-      m = re.exec('/route/');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route/');
-
-      m = re.exec('/route/test');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route/');
-
-      m = re.exec('/route');
-
-      assert.ok(!m);
-
-      m = re.exec('/route//');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route/');
-    });
-
-    it('should not match trailing slashes in non-ending strict mode', function () {
-      var params = [];
-      var re = pathToRegExp('/route', params, { end: false, strict: true });
-
-      assert.equal(params.length, 0);
-
-      m = re.exec('/route');
-
-      assert.equal(m.length, 1);
-      assert.equal(m[0], '/route');
-
-      m = re.exec('/route/');
-
-      assert.ok(m.length, 1);
-      assert.equal(m[0], '/route');
-    });
-
-    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.test('/test'));
-      assert.ok(re.test('/route'));
-      assert.ok(!re.test('/else'));
-    });
-
-    it('should match parts properly', function () {
-      var params = [];
-      var re = pathToRegExp(['/:test', '/test/:route'], 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, 'route');
-      assert.equal(params[1].optional, false);
-
-      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('/test/path');
-
-      assert.equal(m.length, 3);
-      assert.equal(m[0], '/test/path');
-      assert.equal(m[1], undefined);
-      assert.equal(m[2], 'path');
-    });
-  });
-});