feat: add debug() method

README.md

@@ -151,6 +151,48 @@ myMatch.test('http://google.com/#aaa'); // true
 myMatch.test('http://google.com/#aaabbb'); // true
 ```
 
+### Debug
+
+You can use `debug()` method to get detailed information about matching of each part of the pattern against each tested URL.
+
+Use it the same way you would use `test()` method. But instead of boolean value, it returns object where keys are tested URLs and values are deconstructed results.
+
+```javascript
+myMatch = new UrlMatch('*://aaa.bbb/');
+myMatch.debug('http://aaa.bbb/');
+/*
+{
+  "*://aaa.bbb/": {
+    "scheme": {
+      "pattern": "*",
+      "value": "http",
+      "result": true
+    },
+    "host": {
+      "pattern": "aaa.bbb",
+      "value": "aaa.bbb",
+      "result": true
+    },
+    "path": {
+      "pattern": "",
+      "value": "",
+      "result": true
+    },
+    "params": {
+      "pattern": null,
+      "value": null,
+      "result": true
+    },
+    "fragment": {
+      "pattern": null,
+      "value": null,
+      "result": true
+    }
+  }
+}
+ */
+```
+
 ## Bug reports, feature requests and contact
 
 If you found any bugs, if you have feature requests or any questions, please, either [file an issue at GitHub](https://github.com/fczbkk/UrlMatch/issues) or send me an e-mail at <a href="mailto:riki@fczbkk.com">riki@fczbkk.com</a>.

src/index.js

@@ -47,4 +47,15 @@ export default class {
     return result;
   }
 
+  debug (content) {
+    let result = {};
+
+    this.patterns.forEach((pattern) => {
+      const pattern_obj = new Pattern(pattern);
+      result[pattern] = pattern_obj.debug(content);
+    });
+
+    return result;
+  }
+
 }

src/pattern.js

@@ -102,6 +102,21 @@ export default class {
     return result;
   }
 
+  debug (url) {
+    const splits = this.split(url);
+    const result = {};
+
+    Object.keys(splits).forEach((key) => {
+      result[key] = {
+        pattern: this.url_parts[key].original_pattern,
+        value: splits[key],
+        result: this.url_parts[key].test(splits[key])
+      }
+    });
+
+    return result;
+  }
+
 }
 
 

test/index.spec.js

@@ -101,4 +101,19 @@ describe('General', function() {
 
   });
 
+  describe('debug', function () {
+
+    it('should return debug object', function () {
+      const pattern = '*://aaa.bbb/';
+      url_match = new UrlMatch(pattern);
+      const result = url_match.debug('http://aaa.bbb/');
+      expect(result[pattern].scheme).toEqual({
+        pattern: '*',
+        value: 'http',
+        result: true
+      });
+    });
+
+  });
+
 });

test/pattern.spec.js

@@ -238,4 +238,15 @@ describe('Pattern', function() {
 
   });
 
+  describe('debug', function () {
+
+    it('should return debug object', function () {
+      pattern = new Pattern('*://aaa.bbb/');
+      const result = pattern.debug('http://aaa.bbb/');
+      expect(result.scheme)
+        .toEqual({pattern: '*', value: 'http', result: true});
+    });
+
+  });
+
 });