Merge pull request #50 from Shuhrat/diff-refactor

Some refactoring

Author: eGavr

lib/diff-logger.js

@@ -1,39 +1,72 @@
 require('colors');
 
-exports.log = function(diff, options) {
+/**
+ * Returns readable diff text
+ * @param {Object[]} diff
+ * @param {Object} [options]
+ * @param {Number} [options.charsAroundDiff=20]
+ * @returns {String}
+ */
+function getDiffText(diff, options) {
+    options = options || {
+        charsAroundDiff: 20
+    };
 
-    options = options || { showCharacters: 20 };
+    if (options.showCharacters) {
+        console.log('Option "showCharacters" is deprecated, please use "charsAroundDiff"');
+        options.charsAroundDiff = options.showCharacters;
+    }
 
-    var showCharacters = options.showCharacters;
+    var charsAroundDiff = options.charsAroundDiff,
+        output = '';
 
-    showCharacters = showCharacters > 0 ? showCharacters : 20;
-
-    var output = '';
+    if (charsAroundDiff > 0) {
+        charsAroundDiff = 20;
+    }
 
     if (diff.length === 1 && !diff[0].added && !diff[0].removed) return output;
 
     diff.forEach(function(part) {
-        var color = part.added ? 'green' :
-                part.removed ? 'red' : 'grey',
-            indexOfPart = diff.indexOf(part);
+        var index = diff.indexOf(part),
+            partValue = part.value,
+            color = 'grey';
 
-        if (color !== 'grey') {
+        if (part.added) color = 'green';
+        if (part.removed) color = 'red';
 
-            output += (!indexOfPart ? '\n' : '') +  part.value[color];
+        if (color !== 'grey') {
+            output += (!index ? '\n' : '') +  partValue[color];
 
             return;
         }
 
-        if (part.value.length < showCharacters * 2) {
-            output += (indexOfPart ? '' : '\n') + part.value.grey;
+        if (partValue.length < charsAroundDiff * 2) {
+            output += (index ? '' : '\n') + partValue.grey;
         } else {
-            indexOfPart && (output += part.value.substr(0, showCharacters).grey);
+            index && (output += partValue.substr(0, charsAroundDiff).grey);
 
-            if (indexOfPart < diff.length - 1) {
-                output += '\n...\n' + part.value.substr(part.value.length - showCharacters, showCharacters).grey;
+            if (index < diff.length - 1) {
+                output += '\n...\n' + partValue.substr(partValue.length - charsAroundDiff, charsAroundDiff).grey;
             }
         }
     });
 
-    console.log('Differences:' + output);
+    return output;
 }
+
+/**
+ * Logs diff of the given HTML docs to the console
+ * @param {Object[]} diff
+ * @param {Object} [options]
+ * @param {Number} [options.charsAroundDiff=20]
+ */
+function log(diff, options) {
+    var diffText = getDiffText(diff, options);
+
+    console.log(diffText);
+}
+
+module.exports = {
+    getDiffText: getDiffText,
+    log: log
+};

lib/index.js

@@ -6,12 +6,12 @@ var utils = require('./utils'),
     _ = require('lodash');
 
 /**
- * Converts HTML to DOM Tree
- * @param {String} HTML
+ * Converts HTML document to AST Tree
+ * @param {String} HTMLDoc
  * @param {Object} options
  * @returns {AST}
  */
-function htmlToAST(HTML, options) {
+function htmlToAST(HTMLDoc, options) {
     var parser,
         parserHandler;
 
@@ -20,13 +20,13 @@ function htmlToAST(HTML, options) {
     }, options);
 
     parser = new htmlParser.Parser(parserHandler);
-    parser.parseComplete(HTML);
+    parser.parseComplete(HTMLDoc);
 
     return parserHandler.dom;
 }
 
 /**
- *
+ * Recursively sorts the arttibutes value of the AST leafs
  * @param {AST} tree
  * @param {Object} options
  * @returns {AST}
@@ -77,7 +77,7 @@ function modifyASTTree(tree, options) {
  * @param {String[]} [options.compareHtmlAttrsAsJSON]
  * @param {Boolean} [options.verbose]
  * @param {Boolean} [options.ignoreWhitespace=true]
- * @param {Boolean} [options.bem=true]
+ * @param {Boolean} [options.bem=false]
  * @constructor
  */
 var HtmlDiff = function(options) {
@@ -116,7 +116,7 @@ HtmlDiff.prototype.tokenize = function(value) {
  * @param {String[]} [options.compareHtmlAttrsAsJSON]
  * @param {Boolean} [options.verbose]
  * @param {Boolean} [options.ignoreWhitespace=true]
- * @param {Boolean} [options.bem=true]
+ * @param {Boolean} [options.bem=false]
  * @constructor
  */
 var HtmlDiffer = function(options) {