feat(match API): implemented match method

provided `match` method for the first release

Author: MauroJr

README.md

@@ -4,52 +4,4 @@
 
 ## What is it?
 
-A functional route parsing, matching, and reversing library for Javascript in Node and the browser. Its api is inspired by [route-parser](https://github.com/rcs/route-parser), but is implemented in a functional way, don't relay in 'this' keyword.
-
-
-# Product Name
-> Short blurb about what your product does.
-[![NPM Version][npm-image]][npm-url]
-[![Build Status][travis-image]][travis-url]
-[![Downloads Stats][npm-downloads]][npm-url]
-One to two paragraph statement about your product and what it does.
-![](header.png)
-## Installation
-OS X & Linux:
-```sh
-npm install my-crazy-module --save
-```
-Windows:
-```sh
-edit autoexec.bat
-```
-## Usage example
-A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
-## Development setup
-Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
-```sh
-make install
-npm test
-```
-## Release History
-* 0.2.1
-    * CHANGE: Update docs (module code remains unchanged)
-* 0.2.0
-    * CHANGE: Remove `setDefaultXYZ()`
-    * ADD: Add `init()`
-* 0.1.1
-    * FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!)
-* 0.1.0
-    * The first proper release
-    * CHANGE: Rename `foo()` to `bar()`
-* 0.0.1
-    * Work in progress
-## Meta
-Your Name – [@YourTwitter](https://twitter.com/dbader_org) – YourEmail@example.com
-Distributed under the XYZ license. See ``LICENSE`` for more information.
-[https://github.com/yourname/github-link](https://github.com/dbader/)
-[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/datadog-metrics
-[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
-[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
-[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics
+A 10X FASTER and functional route parser, for Javascript in Node and the browser. Its api is inspired by [route-parser](https://github.com/rcs/route-parser), but is implemented in a functional way, don't relay in 'this' keyword.

src/index.js

@@ -5,6 +5,7 @@ const NAMED_SEGMENT = ':';
 const ASSIGNMENT = '=';
 const OR_SIGN = '|';
 const MATCH_ANY = '*';
+const REGEX_MATCH_ANY = /^\/?([a-zA-Z0-9-_/])\/?$/;
 const REGEX_SPACES = /\s/;
 const VALID_SEGMENT = /^[a-z0-9_-]+$/i;
 const ANY_VALID_SEGMENT = '[a-zA-Z0-9_-]+';
@@ -17,9 +18,9 @@ module.exports = RouteParser;
 function RouteParser(route = '') {
   const { regex, path } = compileRoute(route);
 
-  return Object.freeze({ parse });
+  return Object.freeze({ match });
 
-  function parse(route = '') {
+  function match(route = '') {
     const regexResult = regex.exec(route);
 
     if (regexResult === null) return false;
@@ -33,6 +34,10 @@ function RouteParser(route = '') {
 }
 
 function compileRoute(route) {
+  if (route === MATCH_ANY || route === DELIMETER) {
+    return REGEX_MATCH_ANY;
+  }
+
   try {
     const segments = route
       .replace(REGEX_SPACES, '')
@@ -51,7 +56,7 @@ function createRegex(segments) {
     regexGroups.push(`(${segment[1] || segment[0]})`);
     return segment[0];
   });
-  const regex = new RegExp(`^${regexGroups.join(DELIMETER)}$`);
+  const regex = new RegExp(`^/?${regexGroups.join(DELIMETER)}$`);
 
   return { path, regex };
 }

test/index.test.js

@@ -10,27 +10,27 @@ describe('Route Parser', function () {
     it('should create a route parser with a `parse` method', function () {
       const route = RouteParser('my/test/:route');
 
-      expect(typeof route.parse).to.be.equal('function');
+      expect(typeof route.match).to.be.equal('function');
     });
 
     it('should parse a valid route', function () {
       const route = RouteParser('my/test/:route');
-      const parsedRoute = route.parse('my/test/my-route');
+      const parsedRoute = route.match('my/test/my-route');
 
       expect(parsedRoute.route).to.be.equal('my-route');
     });
 
     it('should parse a valid route with options', function () {
       const route = RouteParser('my/:action=(test|build)/:route');
-      const parsedRoute = route.parse('my/test/my-route');
+      const parsedRoute = route.match('my/test/my-route');
 
       expect(parsedRoute.route).to.be.equal('my-route');
       expect(parsedRoute.action).to.be.equal('test');
     });
 
     it('should parse a valid route with splat operator', function () {
       const route = RouteParser('*/:action=(test|build)/:route');
-      const parsedRoute = route.parse('my/test/my-route');
+      const parsedRoute = route.match('my/test/my-route');
 
       expect(parsedRoute['0']).to.be.equal('my');
     });