Change node: add bool/num types to change mode

Closes #835 #835 #835

nodes/core/logic/15-change.html

@@ -128,21 +128,37 @@
                     selectField.append($("<option></option>").val(selectOptions[i].v).text(selectOptions[i].l));
                 }
 
-                var propertyName = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-name",type:"text"}).appendTo(row1).typedInput({types:['msg','flow','global']});
+                var propertyName = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-name",type:"text"})
-                var finalspan = $('<span/>',{style:"float: right; margin-right: 10px;"}).appendTo(row1);
+                    .appendTo(row1)
-                var deleteButton = $('<a/>',{href:"#",class:"editor-button editor-button-small", style:"margin-top: 7px; margin-left: 5px;"}).appendTo(finalspan);
+                    .typedInput({types:['msg','flow','global']});
+                var finalspan = $('<span/>',{style:"float: right; margin-right: 10px;"})
+                    .appendTo(row1);
+                var deleteButton = $('<a/>',{href:"#",class:"editor-button editor-button-small", style:"margin-top: 7px; margin-left: 5px;"})
+                    .appendTo(finalspan);
                 $('<i/>',{class:"fa fa-remove"}).appendTo(deleteButton);
 
 
-                $('<div/>',{style:"display: inline-block;text-align:right; width:120px;padding-right: 10px; box-sizing: border-box;"}).text(to).appendTo(row2);
+                $('<div/>',{style:"display: inline-block;text-align:right; width:120px;padding-right: 10px; box-sizing: border-box;"})
-                var propertyValue = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-value",type:"text"}).appendTo(row2).typedInput({default:'str',types:['msg','flow','global','str','num','bool','json']});
+                    .text(to)
+                    .appendTo(row2);
+                var propertyValue = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-value",type:"text"})
+                    .appendTo(row2)
+                    .typedInput({default:'str',types:['msg','flow','global','str','num','bool','json']});
                 var row3_1 = $('<div/>').appendTo(row3);
-                $('<div/>',{style:"display: inline-block;text-align:right; width:120px;padding-right: 10px; box-sizing: border-box;"}).text(search).appendTo(row3_1);
+                $('<div/>',{style:"display: inline-block;text-align:right; width:120px;padding-right: 10px; box-sizing: border-box;"})
-                var fromValue = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-search-value",type:"text"}).appendTo(row3_1).typedInput({default:'str',types:['msg','flow','global','str','re']});
+                    .text(search)
+                    .appendTo(row3_1);
+                var fromValue = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-search-value",type:"text"})
+                    .appendTo(row3_1)
+                    .typedInput({default:'str',types:['msg','flow','global','str','re','num','bool']});
 
                 var row3_2 = $('<div/>',{style:"margin-top:8px;"}).appendTo(row3);
-                $('<div/>',{style:"display: inline-block;text-align:right; width:120px;padding-right: 10px; box-sizing: border-box;"}).text(replace).appendTo(row3_2);
+                $('<div/>',{style:"display: inline-block;text-align:right; width:120px;padding-right: 10px; box-sizing: border-box;"})
-                var toValue = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-replace-value",type:"text"}).appendTo(row3_2).typedInput({default:'str',types:['msg','flow','global','str','num','json']});
+                    .text(replace)
+                    .appendTo(row3_2);
+                var toValue = $('<input/>',{style:"width: 250px",class:"node-input-rule-property-replace-value",type:"text"})
+                    .appendTo(row3_2)
+                    .typedInput({default:'str',types:['msg','flow','global','str','num','bool','json']});
 
                 selectField.change(function() {
                     var width = $("#node-input-rule-container").width();

nodes/core/logic/15-change.js

@@ -64,12 +64,13 @@ module.exports = function(RED) {
             if (!rule.fromt) {
                 rule.fromt = "str";
             }
-            if (rule.t === "change") {
+            if (rule.t === "change" && rule.fromt !== 'msg' && rule.fromt !== 'flow' && rule.fromt !== 'global') {
+                rule.fromRE = rule.from;
                 if (rule.fromt !== 're') {
-                    rule.from = rule.from.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+                    rule.fromRE = rule.fromRE.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
                 }
                 try {
-                    rule.from = new RegExp(rule.from, "g");
+                    rule.fromRE = new RegExp(rule.fromRE, "g");
                 } catch (e) {
                     valid = false;
                     this.error(RED._("change.errors.invalid-from",{error:e.message}));
@@ -93,6 +94,10 @@ module.exports = function(RED) {
             try {
                 var property = rule.p;
                 var value = rule.to;
+                var current;
+                var fromValue;
+                var fromType;
+                var fromRE;
                 if (rule.tot === "msg") {
                     value = RED.util.getMessageProperty(msg,rule.to);
                 } else if (rule.tot === 'flow') {
@@ -100,17 +105,69 @@ module.exports = function(RED) {
                 } else if (rule.tot === 'global') {
                     value = node.context().global.get(rule.to);
                 }
+
+                if (rule.t === 'change') {
+                    if (rule.fromt === 'msg' || rule.fromt === 'flow' || rule.fromt === 'global') {
+                        if (rule.fromt === "msg") {
+                            fromValue = RED.util.getMessageProperty(msg,rule.from);
+                        } else if (rule.tot === 'flow') {
+                            fromValue = node.context().flow.get(rule.from);
+                        } else if (rule.tot === 'global') {
+                            fromValue = node.context().global.get(rule.from);
+                        }
+                        if (typeof fromValue === 'number' || fromValue instanceof Number) {
+                            fromType = 'num';
+                        } else if (typeof fromValue === 'boolean') {
+                            fromType = 'bool'
+                        } else if (fromValue instanceof RegExp) {
+                            fromType = 're';
+                            fromRE = fromValue;
+                        } else if (typeof fromValue === 'string') {
+                            fromType = 'str';
+                            fromRE = fromValue.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+                            try {
+                                fromRE = new RegExp(fromRE, "g");
+                            } catch (e) {
+                                valid = false;
+                                node.error(RED._("change.errors.invalid-from",{error:e.message}));
+                                return
+                            }
+
+                        } else {
+                            node.error(RED._("change.errors.invalid-from",{error:"unsupported type: "+(typeof fromValue)}));
+                            return
+                        }
+                    } else {
+                        fromType = rule.fromt;
+                        fromValue = rule.from;
+                        fromRE = rule.fromRE;
+                    }
+                }
                 if (rule.pt === 'msg') {
                     if (rule.t === 'delete') {
                         RED.util.setMessageProperty(msg,property,undefined);
                     } else if (rule.t === 'set') {
                         RED.util.setMessageProperty(msg,property,value);
                     } else if (rule.t === 'change') {
-                        var current = RED.util.getMessageProperty(msg,property);
+                        current = RED.util.getMessageProperty(msg,property);
                         if (typeof current === 'string') {
-                            current = current.replace(rule.from,value);
+                            if ((fromType === 'num' || fromType === 'bool') && current === fromValue) {
+                                // str representation of exact from number/boolean
+                                // only replace if they match exactly
+                                RED.util.setMessageProperty(msg,property,value);
+                            } else {
+                                current = current.replace(fromRE,value);
                                 RED.util.setMessageProperty(msg,property,current);
                             }
+                        } else if ((typeof current === 'number' || current instanceof Number) && fromType === 'num') {
+                            if (current == Number(fromValue)) {
+                                RED.util.setMessageProperty(msg,property,value);
+                            }
+                        } else if (typeof current === 'boolean' && fromType === 'bool') {
+                            if (current.toString() === fromValue) {
+                                RED.util.setMessageProperty(msg,property,value);
+                            }
+                        }
                     }
                 } else {
                     var target;
@@ -125,16 +182,30 @@ module.exports = function(RED) {
                         } else if (rule.t === 'set') {
                             target.set(property,value);
                         } else if (rule.t === 'change') {
-                            var current = target.get(msg,property);
+                            current = target.get(msg,property);
                             if (typeof current === 'string') {
-                                current = current.replace(rule.from,value);
+                                if ((fromType === 'num' || fromType === 'bool') && current === fromValue) {
+                                    // str representation of exact from number/boolean
+                                    // only replace if they match exactly
+                                    target.set(property,value);
+                                } else {
+                                    current = current.replace(fromRE,value);
                                     target.set(property,current);
                                 }
+                            } else if ((typeof current === 'number' || current instanceof Number) && fromType === 'num') {
+                                if (current == Number(fromValue)) {
+                                    target.set(property,value);
+                                }
+                            } else if (typeof current === 'boolean' && fromType === 'bool') {
+                                if (current.toString() === fromValue) {
+                                    target.set(property,value);
+                                }
+                            }
                         }
                     }
 
                 }
-            } catch(err) {console.log(err.stack)}
+            } catch(err) {/*console.log(err.stack)*/}
             return msg;
         }
         if (valid) {
@@ -142,6 +213,9 @@ module.exports = function(RED) {
             this.on('input', function(msg) {
                 for (var i=0;i<this.rules.length;i++) {
                     msg = applyRule(msg,this.rules[i]);
+                    if (msg === null) {
+                        return;
+                    }
                 }
                 node.send(msg);
             });

test/nodes/core/logic/15-change_spec.js

@@ -51,7 +51,7 @@ describe('change Node', function() {
         helper.load(changeNode, flow, function() {
             //console.log(helper.getNode("c1"));
             helper.getNode("c1").should.have.property("name", "change1");
-            helper.getNode("c1").should.have.property("rules", [ { from: /(?:)/g,fromt: 'str', p: '',pt: 'msg', re: undefined, t: 'change', to: '',tot: 'str' } ]);
+            helper.getNode("c1").should.have.property("rules", [ { from: '', fromRE:/(?:)/g,fromt: 'str', p: '',pt: 'msg', re: undefined, t: 'change', to: '',tot: 'str' } ]);
             done();
         });
     });
@@ -424,7 +424,6 @@ describe('change Node', function() {
             });
         });
 
-
         it('changes the value - new rule format', function(done) {
             var flow = [{"id":"changeNode1","type":"change",rules:[{"t":"change","p":"payload","from":"ABC","to":"123","fromt":"str","tot":"str"}],"name":"changeNode","wires":[["helperNode1"]]},
                         {id:"helperNode1", type:"helper", wires:[]}];
@@ -442,6 +441,96 @@ describe('change Node', function() {
                 changeNode1.receive({payload:"abcABCabc"});
             });
         });
+
+        it('changes the value using msg property', function(done) {
+            var flow = [{"id":"changeNode1","type":"change",rules:[{"t":"change","p":"payload","from":"topic","to":"123","fromt":"msg","tot":"str"}],"name":"changeNode","wires":[["helperNode1"]]},
+                        {id:"helperNode1", type:"helper", wires:[]}];
+            helper.load(changeNode, flow, function() {
+                var changeNode1 = helper.getNode("changeNode1");
+                var helperNode1 = helper.getNode("helperNode1");
+                helperNode1.on("input", function(msg) {
+                    try {
+                        msg.payload.should.equal("abc123abc");
+                        done();
+                    } catch(err) {
+                        done(err);
+                    }
+                });
+                changeNode1.receive({payload:"abcABCabc",topic:"ABC"});
+            });
+        });
+
+        it('changes the value using number - string payload', function(done) {
+            var flow = [{"id":"changeNode1","type":"change",rules:[{"t":"change","p":"payload","from":"123","to":"456","fromt":"num","tot":"str"}],"name":"changeNode","wires":[["helperNode1"]]},
+                        {id:"helperNode1", type:"helper", wires:[]}];
+            helper.load(changeNode, flow, function() {
+                var changeNode1 = helper.getNode("changeNode1");
+                var helperNode1 = helper.getNode("helperNode1");
+                helperNode1.on("input", function(msg) {
+                    try {
+                        msg.payload.should.equal("456");
+                        done();
+                    } catch(err) {
+                        done(err);
+                    }
+                });
+                changeNode1.receive({payload:"123"});
+            });
+        });
+
+        it('changes the value using number - number payload', function(done) {
+            var flow = [{"id":"changeNode1","type":"change",rules:[{"t":"change","p":"payload","from":"123","to":"abc","fromt":"num","tot":"str"}],"name":"changeNode","wires":[["helperNode1"]]},
+                        {id:"helperNode1", type:"helper", wires:[]}];
+            helper.load(changeNode, flow, function() {
+                var changeNode1 = helper.getNode("changeNode1");
+                var helperNode1 = helper.getNode("helperNode1");
+                helperNode1.on("input", function(msg) {
+                    try {
+                        msg.payload.should.equal("abc");
+                        done();
+                    } catch(err) {
+                        done(err);
+                    }
+                });
+                changeNode1.receive({payload:123});
+            });
+        });
+
+        it('changes the value using boolean - string payload', function(done) {
+            var flow = [{"id":"changeNode1","type":"change",rules:[{"t":"change","p":"payload","from":"true","to":"xxx","fromt":"bool","tot":"str"}],"name":"changeNode","wires":[["helperNode1"]]},
+                        {id:"helperNode1", type:"helper", wires:[]}];
+            helper.load(changeNode, flow, function() {
+                var changeNode1 = helper.getNode("changeNode1");
+                var helperNode1 = helper.getNode("helperNode1");
+                helperNode1.on("input", function(msg) {
+                    try {
+                        msg.payload.should.equal("xxx");
+                        done();
+                    } catch(err) {
+                        done(err);
+                    }
+                });
+                changeNode1.receive({payload:"true"});
+            });
+        });
+
+        it('changes the value using boolean - boolean payload', function(done) {
+            var flow = [{"id":"changeNode1","type":"change",rules:[{"t":"change","p":"payload","from":"true","to":"xxx","fromt":"bool","tot":"str"}],"name":"changeNode","wires":[["helperNode1"]]},
+                        {id:"helperNode1", type:"helper", wires:[]}];
+            helper.load(changeNode, flow, function() {
+                var changeNode1 = helper.getNode("changeNode1");
+                var helperNode1 = helper.getNode("helperNode1");
+                helperNode1.on("input", function(msg) {
+                    try {
+                        msg.payload.should.equal("xxx");
+                        done();
+                    } catch(err) {
+                        done(err);
+                    }
+                });
+                changeNode1.receive({payload:true});
+            });
+        });
     });
 
     describe("#delete", function() {