added options to skip innerhtml changes of sibling text nodes and changes optiosn argument

Author: johanneswilm

README.md

@@ -82,32 +82,37 @@ if (result) {
 
 diffDOM does not include merging for changes to text nodes. However, it includes hooks so that you can add more advanced handling. Simple overwrite the textDiff function of the diffDOM instance. The functions TEXTDIFF and TEXTPATCH need to be defined in the code:
 ```
-dd = new diffDOM();
-
-dd.textDiff = function (node, currentValue, expectedValue, newValue) {
-    if (currentValue===expectedValue) {
-        // The text node contains the text we expect it to contain, so we simple change the text of it to the new value.
-        node.data = newValue;
-    } else {
-        // The text node currently does not contain what we expected it to contain, so we need to merge.
-        difference = TEXTDIFF(expectedValue, currentValue);
-        node.data = TEXTPATCH(newValue, difference);
+dd = new diffDOM({
+    textDiff: function (node, currentValue, expectedValue, newValue) {
+        if (currentValue===expectedValue) {
+            // The text node contains the text we expect it to contain, so we simple change the text of it to the new value.
+            node.data = newValue;
+        } else {
+            // The text node currently does not contain what we expected it to contain, so we need to merge.
+            difference = TEXTDIFF(expectedValue, currentValue);
+            node.data = TEXTPATCH(newValue, difference);
+        }
+        return true;
     }
-    return true;
-};
+  });
 ```
 
 #### Debugging
 
 For debugging you might want to set a max number of diff changes between two elements before diffDOM gives up. To allow for a maximum of 500 differences between elements when diffing, initialize diffDOM like this:
 ```
-dd = new diffDOM(true, 500);
+dd = new diffDOM({
+    debug: true,
+    diffcap: 500
+  });
 ```
 
 #### Disable value diff detection
 
 For forms that have been filled out by a user in ways that have changed which value is associated with an input field or which options are checked/selected without
 the DOM having been updated, the values are diffed. For use cases in which no changes have been made to any of the form values, one may choose to skip diffing the values. To do this, hand `false` as a third configuration option to diffDOM:
 ```
-dd = new diffDOM(false, 0, false);
+dd = new diffDOM({
+    valueDiffing: false
+  });
 ```

diffDOM.js

@@ -455,13 +455,34 @@
         }
     };
 
-    var diffDOM = function(debug, diffcap, valueDiffing) {
-        if (typeof valueDiffing === 'undefined') {
-            valueDiffing = true;
+    var diffDOM = function(options){
+
+        var defaults = {
+          debug:   false,
+          diffcap:  10,
+          valueDiffing: true, // Whether to take into consideration the values of forms that differ from auto assigned values (when a user fills out a form).
+          siblingTextNodes: true, // Whether to take into consideration sibling text nodes.
+          // diffing text elements can be overwritten for use with diff_match_patch and alike
+          // syntax: textDiff: function (node, currentValue, expectedValue, newValue)
+          textDiff: function() {
+              arguments[0].data = arguments[3];
+              return;
+          }
+        }, i;
+
+        if (typeof options == "undefined") {
+          options = {};
         }
-        if (typeof debug === 'undefined') {
-            debug = false;
-        } else {
+
+        for (i in defaults) {
+            if (typeof options[i] == "undefined") {
+                this[i] = defaults[i];
+            } else {
+                this[i] = options[i];
+            }
+        }
+
+        if (this.debug) {
             ADD_ATTRIBUTE = "add attribute";
             MODIFY_ATTRIBUTE = "modify attribute";
             REMOVE_ATTRIBUTE = "remove attribute";
@@ -494,13 +515,6 @@
             SELECTED = "selected";
         }
 
-
-        if (typeof diffcap === 'undefined') {
-            diffcap = 10;
-        }
-        this.debug = debug;
-        this.diffcap = diffcap;
-        this.valueDiffing = valueDiffing;
     };
     diffDOM.prototype = {
 
@@ -563,6 +577,7 @@
             return false;
         },
         findOuterDiff: function(t1, t2, route) {
+
             var k, diffs = [];
 
             if (t1.nodeName !== t2.nodeName) {
@@ -639,6 +654,13 @@
             return diffs;
         },
         findInnerDiff: function(t1, t2, route) {
+
+            if (!this.siblingTextNodes && !this.valueDiffing) {
+                if (t1.innerHTML === t2.innerHTML) {
+                    return [];
+                }
+            }
+
             var subtrees = markSubTrees(t1, t2),
                 mappings = subtrees.length,
                 diff, diffs, i, last, e1, e2,
@@ -885,12 +907,6 @@
             }
             return node;
         },
-        // diffing text elements can be overwritten for use with diff_match_patch and alike
-        // syntax: textDiff: function (node, currentValue, expectedValue, newValue)
-        textDiff: function() {
-            arguments[0].data = arguments[3];
-            return;
-        },
         applyDiff: function(tree, diff) {
             var node = this.getFromRoute(tree, diff[ROUTE]),
                 newNode, reference, route, group, from, to, child, c, i;

tests/basic.html

@@ -428,7 +428,7 @@ <h1>Test for diffDOM</h1>
   </div>
   <div><span></span>hallo<span></span>
   </div>
-  
+
   <div><select><option></option><option>A</option></select></div>
   <div><select><option>A</option><option></option></select></div>
 
@@ -506,7 +506,10 @@ <h1>Test for diffDOM</h1>
       document.body.lastChild.appendChild(par);
     }
 
-    var dd = new diffDOM(true, 500),
+    var dd = new diffDOM({
+      debug: true,
+      diffcap: 500
+    }),
       tl = new TraceLogger(dd),
       divNodeList, divs = [],
       diffs, t1, i;

tests/extent.html

@@ -121,7 +121,10 @@ <h2>Different</h2>
       return cost;
     }
 
-    var dd = new diffDOM(true, 500),
+    var dd = new diffDOM({
+        debug: true,
+        diffcap: 500
+      }),
       tl = new TraceLogger(dd),
       divNodeList, divs = [],
       diffs, t1, i;

tests/form.html

@@ -111,7 +111,11 @@ <h1>Form element test for diffDOM</h1>
       print("diff operations for " + elTexts[0] + " → " + elTexts[1]);
     }
 
-    var dd = new diffDOM(true, 700, true),
+    var dd = new diffDOM({
+        debug: true,
+        diffcap: 700,
+        valueDiffing: true
+      }),
       tl = new TraceLogger(dd), elements, first, second, third, fourth, theDiff;
 
     // Textarea