mqtt-pattern 1.0.0 → 1.2.0

package/README.md

@@ -21,6 +21,13 @@ var params = MQTTPattern.exec(pattern, topic);
 	data: ["rate", "bmp"]
 }
 
+var filled = MQTTPattern.fill(pattern, params);
+// filled will be
+"device/fitbit/undefined/rate/bmp"
+
+MQTTPattern.clean("hello/+param1/world/#param2");
+// hello/+/world/#
+
 ```
 
 ## Installing
@@ -46,6 +53,9 @@ Useful if you know in advance that your `topic` will be valid and want to extrac
 If the `topic` doesn't match, or the `pattern` doesn't contain named wildcards, returns an empty object.
 Do not use this for validation.
 
+### `fill(pattern : String, params: Object) : String`
+Reverse of `extract`, traverse the `pattern` and fill in params with keys in an object. Missing keys for `+` params are set to `undefined`. Missing keys for `#` params yeid empty strings.
+
 ## How params work
 
 MQTT defines two types of "wildcards", one for matching a single section of the path (`+`), and one for zero or more sections of the path (`#`).

package/index.js

@@ -7,6 +7,8 @@ module.exports = {
 	matches: matches,
 	extract: extract,
 	exec: exec,
+	fill: fill,
+	clean: clean
 };
 
 function exec(pattern, topic) {
@@ -26,7 +28,10 @@ function matches(pattern, topic) {
 		var patternChar = currentPattern[0];
 		var currentTopic = topicSegments[i];
 
-		if(!currentTopic) return false;
+		if(!currentTopic && !currentPattern)
+			continue;
+
+		if(!currentTopic && currentPattern !== ALL) return false;
 
 		// Only allow # at end
 		if(patternChar === ALL)
@@ -38,6 +43,34 @@ function matches(pattern, topic) {
 	return patternLength === topicLength;
 }
 
+function fill(pattern, params){
+	var patternSegments = pattern.split(SEPARATOR);
+	var patternLength = patternSegments.length;
+
+	var result = [];
+
+	for (var i = 0; i < patternLength; i++) {
+		var currentPattern = patternSegments[i];
+		var patternChar = currentPattern[0];
+		var patternParam = currentPattern.slice(1);
+		var paramValue = params[patternParam];
+
+		if(patternChar === ALL){
+			// Check that it isn't undefined
+			if(paramValue !== void 0)
+				result.push([].concat(paramValue).join(SEPARATOR)); // Ensure it's an array
+
+			// Since # wildcards are always at the end, break out of the loop
+			break;
+		} else if (patternChar === SINGLE)
+			// Coerce param into a string, missing params will be undefined
+			result.push("" + paramValue);
+		else result.push(currentPattern);
+	}
+
+	return result.join(SEPARATOR);
+}
+
 
 function extract(pattern, topic) {
 	var params = {};
@@ -63,3 +96,26 @@ function extract(pattern, topic) {
 
 	return params;
 }
+
+
+function clean(pattern) {
+	var patternSegments = pattern.split(SEPARATOR);
+	var patternLength = patternSegments.length;
+
+	var cleanedSegments = [];
+
+	for(var i = 0; i < patternLength; i++){
+		var currentPattern = patternSegments[i];
+		var patternChar = currentPattern[0];
+
+		if(patternChar === ALL){
+			cleanedSegments.push(ALL);
+		} else if(patternChar === SINGLE){
+			cleanedSegments.push(SINGLE);
+		} else {
+			cleanedSegments.push(currentPattern);
+		}
+	}
+
+	return cleanedSegments.join('/');
+}

package/package.json

@@ -1,33 +1,33 @@
-{
-  "name": "mqtt-pattern",
-  "version": "1.0.0",
-  "description": "Fast library for matching MQTT patterns with named wildcards",
-  "main": "index.js",
-  "scripts": {
-    "test": "node test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/RangerMauve/mqtt-pattern.git"
-  },
-  "keywords": [
-    "mqtt",
-    "pattern",
-    "match",
-    "topic"
-  ],
-  "author": "rangermauve",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/RangerMauve/mqtt-pattern/issues"
-  },
-  "homepage": "https://github.com/RangerMauve/mqtt-pattern#readme",
-  "devDependencies": {
-    "eslint": "^3.19.0",
-    "eslint-plugin-node": "^4.2.2",
-    "tape": "^4.6.3"
-  },
-  "dependencies": {
-    "mqtt-match": "^1.0.2"
-  }
-}
+{
+  "name": "mqtt-pattern",
+  "version": "1.2.0",
+  "description": "Fast library for matching MQTT patterns with named wildcards",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RangerMauve/mqtt-pattern.git"
+  },
+  "keywords": [
+    "mqtt",
+    "pattern",
+    "match",
+    "topic"
+  ],
+  "author": "rangermauve",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/RangerMauve/mqtt-pattern/issues"
+  },
+  "homepage": "https://github.com/RangerMauve/mqtt-pattern#readme",
+  "devDependencies": {
+    "eslint": "^3.19.0",
+    "eslint-plugin-node": "^4.2.2",
+    "tape": "^4.6.3"
+  },
+  "dependencies": {
+    "mqtt-match": "^1.0.2"
+  }
+}

package/test.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var test = require("tape");
 
 var MQTTPattern = require("./");
@@ -23,6 +24,11 @@ test("matches() supports patterns with # at the end", function (t) {
 	t.ok(MQTTPattern.matches("foo/#", "foo/bar/baz"), "Matched topic");
 });
 
+test("matches() supports patterns with # at the end and topic has no children", function (t) {
+	t.plan(1);
+	t.ok(MQTTPattern.matches("foo/bar/#", "foo/bar"), "Matched childless topic");
+});
+
 test("matches() doesn't support # wildcards with more after them", function (t) {
 	t.plan(1);
 	t.notOk(MQTTPattern.matches("#/bar/baz", "foo/bar/baz"), "Didn't match topic");
@@ -53,6 +59,12 @@ test("matches() supports named wildcards", function (t) {
 	t.ok(MQTTPattern.matches("foo/+something/#else", "foo/bar/baz"), "Matched topic");
 });
 
+test("matches() supports leading slashes", function (t){
+	t.plan(2);
+	t.ok(MQTTPattern.matches("/foo/bar", "/foo/bar"), "Matched topic");
+	t.notok(MQTTPattern.matches("/foo/bar", "/bar/foo"), "Didn't match invalid topic");
+});
+
 test("extract() returns empty object of there's nothing to extract", function (t) {
 	t.plan(1);
 	t.deepEqual(MQTTPattern.extract("foo/bar/baz", "foo/bar/baz"), {}, "Extracted empty object");
@@ -99,3 +111,57 @@ test("exec() returns params if they can be parsed", function(t){
 		world: ["baz"]
 	}, "Extracted params");
 });
+
+test("fill() fills in pattern with both types of wildcards", function(t){
+	t.plan(1);
+	t.deepEqual(MQTTPattern.fill("foo/+hello/#world", {
+		hello: "Hello",
+		world: ["the", "world", "wow"],
+	}), "foo/Hello/the/world/wow", "Filled in params");
+});
+
+test("fill() fills missing + params with undefined", function(t){
+	t.plan(1);
+	t.deepEqual(
+		MQTTPattern.fill("foo/+hello", {}),
+		"foo/undefined",
+		"Filled in params"
+	);
+});
+
+test("fill() ignores empty # params", function(t){
+	t.plan(1);
+	t.deepEqual(
+		MQTTPattern.fill("foo/#hello", {}),
+		"foo",
+		"Filled in params"
+	);
+});
+
+test("fill() ignores non-named # params", function (t) {
+	t.plan(1);
+	t.deepEqual(
+		MQTTPattern.fill("foo/#", {}),
+		"foo",
+		"Filled in params"
+	);
+});
+
+test("fill() uses `undefined` for non-named + params", function(t){
+	t.plan(1);
+	t.deepEqual(
+		MQTTPattern.fill("foo/+", {}),
+		"foo/undefined",
+		"Filled in params"
+	);
+});
+
+test("clean() removes parameter names", function(t){
+	t.plan(1);
+	t.equal(MQTTPattern.clean("hello/+param1/world/#param2"), "hello/+/world/#", "Got hello/+/world/#");
+});
+
+test("clean() works when there aren't any parameter names", function(t){
+	t.plan(1);
+	t.equal(MQTTPattern.clean("hello/+/world/#"), "hello/+/world/#", "Got hello/+/world/#");
+});

package/.npmignore

@@ -1,37 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules
-jspm_packages
-
-# Optional npm cache directory
-.npm
-
-# Optional REPL history
-.node_repl_history