Merge pull request #64 from bem/move-to-htmlparser2

eGavr · eGavr · commit 9b91f3d69fed · 2014-07-23T20:54:00.000+04:00
Move to htmlparser2
diff --git a/README.md b/README.md
@@ -84,7 +84,6 @@ var html1 = fs.readFileSync('1.html', 'utf-8'),
 var options = {
     ignoreHtmlAttrs: [],
     compareHtmlAttrsAsJSON: [],
-    verbose: true,
     ignoreWhitespace: true,
     bem: false
 }
@@ -106,9 +105,7 @@ where ```options``` is the ```Object```:
 
 * ```compareHtmlAttrsAsJSON: [ Array ]``` - sets what respective attributes' content will be compared as ```JSONs```, not as ```Strings```
 
-* ```verbose: Boolean``` - see [here](https://github.com/tautologistics/node-htmlparser#option-verbose)
-
-* ```ignoreWhitespace: Boolean``` - see [here](https://github.com/tautologistics/node-htmlparser#option-ignorewhitespace)
+* ```ignoreWhitespace: Boolean``` - if is set ```true```, ```html-differ``` will consider all groups of ```spaces```, ```new lines```, ```tabs``` as one ```space```
 
 * ```bem: Boolean``` - predefined options for BEM
 
@@ -119,10 +116,6 @@ Options for BEM are predefined:
 
 * ```compareHtmlAttrsAsJSON: ['data-bem', 'onclick', 'ondblclick']```
 
-* ```verbose: true```
-
-* ```ignoreWhitespace: true```
-
 * ```charsAroundDiff: 40```
 
 
@@ -139,7 +132,7 @@ Options:
   -h, --help : Help
   -v, --version : Shows the version number
   --config=CONFIG : Path to configuration JSON-file
-  --chars-around-diff=CHARSAROUNDDIFF : The number of characters around the diff
+  --chars-around-diff=CHARSAROUNDDIFF : The number of characters around the diff (default: 40)
 
 Arguments:
   PATH1 : Path to the 1-st html-file (required)
@@ -162,7 +155,6 @@ Study the following ```config.json```:
 {
     "ignoreHtmlAttrs": [],
     "compareHtmlAttrsAsJSON": [],
-    "verbose": true,
     "ignoreWhitespace": true,
     "bem": false
 }
diff --git a/lib/index.js b/lib/index.js
@@ -1,7 +1,7 @@
 var utils = require('./utils'),
 
     diff = require('diff'),
-    htmlParser = require('htmlparser'),
+    htmlParser = require('htmlparser2'),
     AST2Html = require('htmlparser-to-html'),
     _ = require('lodash');
 
@@ -15,7 +15,7 @@ function htmlToAST(HTMLDoc, options) {
     var parser,
         parserHandler;
 
-    parserHandler = new htmlParser.DefaultHandler(function(err) {
+    parserHandler = new htmlParser.DomHandler(function(err) {
         if (err) console.log(err);
     }, options);
 
diff --git a/lib/utils.js b/lib/utils.js
@@ -58,7 +58,6 @@ exports.defaults = function(options) {
         ignoreHtmlAttrs: [],
         compareHtmlAttrsAsJSON: [],
 
-        verbose: true,
         ignoreWhitespace: true,
 
         bem: false
diff --git a/package.json b/package.json
@@ -30,13 +30,13 @@
   "dependencies": {
     "vow": "0.4.3",
     "vow-fs": "0.3.1",
-    "htmlparser": "1.7.7",
     "htmlparser-to-html": "0.0.5",
     "coa": "0.4.0",
     "diff": "1.0.8",
     "colors": "0.6.2",
     "lodash": "2.4.1",
-    "istanbul": "0.3.0"
+    "istanbul": "0.3.0",
+    "htmlparser2": "3.7.3"
   },
   "devDependencies": {
     "mocha": "1.18.2",
diff --git a/test/diffHtml.js b/test/diffHtml.js
@@ -12,55 +12,13 @@ function readFiles(f1, f2) {
 
 describe('\'diffHtml\'', function () {
 
-    it('must not be diffs', function () {
-        var htmlDiffer = new HtmlDiffer(),
-
-            files = readFiles('1.html', '_1.html'),
-
-            res = [ {
-                value: '<!DOCTYPE html>\n<html>\n<head lang="en">\n    <meta charset="UTF-8">\n    <title></title>\n</head>\n<body>\nText\n</body>\n</html>\n'
-            } ];
-
-        htmlDiffer.diffHtml(files.html1, files.html2).must.be.eql(res);
-    });
-
-    it('must be diffs', function () {
-        var htmlDiffer = new HtmlDiffer(),
-
-            files = readFiles('2.html', '_2.html'),
-
-            res = [ {
-                value: '<!DOCTYPE html><html><head lang="en"><meta charset="UTF-8"><title></title></head><body>\n',
-                added: undefined,
-                removed: undefined
-            }, {
-                value: '!',
-                added: true,
-                removed: undefined
-            }, {
-                value: 'Text',
-                added: undefined,
-                removed: undefined
-            }, {
-                value: '!',
-                added: true,
-                removed: undefined
-            }, {
-                value: '\n</body></html>',
-                added: undefined,
-                removed: undefined
-            } ];
-
-        htmlDiffer.diffHtml(files.html1, files.html2).must.be.eql(res);
-    });
-
     it('must set options', function () {
-        var htmlDiffer = new HtmlDiffer({ ignoreHtmlAttrs: ['id', 'for'] }),
+        var htmlDiffer = new HtmlDiffer({ ignoreHtmlAttrs: ['id', 'for'], ignoreWhitespace: true }),
 
             files = readFiles('3.html', '_3.html'),
 
             res = [ {
-                value: '<html><head><title>Test</title></head><body><label for="">label for input</label><input id=""></body></html>',
+                value: '<html> <head> <title>Test</title> </head> <body> <label for="">label for input</label> <input id=""> </body> </html> ',
                 added: undefined,
                 removed: undefined
             } ];
diff --git a/test/fixtures/9.html b/test/fixtures/9.html
@@ -5,9 +5,9 @@
     <title></title>
 </head>
 <body>
-   <label for="random">label for input</label>
-   <input id="random">
-   <div onclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}" ondblclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}"></div>
-   <div data-bem="{&quot;a&quot;:{&quot;a&quot;:{&quot;x&quot;:&quot;xx&quot;,&quot;y&quot;:&quot;yy&quot;},&quot;b&quot;:&quot;bb&quot;,&quot;c&quot;:&quot;cc&quot;},&quot;b&quot;:&quot;bb&quot;}">
+    <label for="random">label for input</label>
+    <input id="random">
+    <div onclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}" ondblclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}"></div>
+    <div data-bem="{&quot;a&quot;:{&quot;a&quot;:{&quot;x&quot;:&quot;xx&quot;,&quot;y&quot;:&quot;yy&quot;},&quot;b&quot;:&quot;bb&quot;,&quot;c&quot;:&quot;cc&quot;},&quot;b&quot;:&quot;bb&quot;}">
 </body>
 </html>
diff --git a/test/fixtures/_9.html b/test/fixtures/_9.html
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <html>
 <head lang="en">
-<meta charset="UTF-8">
-<title></title>
+    <meta charset="UTF-8">
+    <title></title>
 </head>
 <body>
-<label for="sfsdfksdf">label for input</label>
-<input id="sfsdfksdf">
-<div onclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}" ondblclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}"></div>
-<div data-bem="{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:{&quot;c&quot;:&quot;cc&quot;,&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:{&quot;y&quot;:&quot;yy&quot;,&quot;x&quot;:&quot;xx&quot;}}}">
+    <label for="sfsdfksdf">label for input</label>
+    <input id="sfsdfksdf">
+    <div onclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}" ondblclick="return {&quot;a&quot;:{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:&quot;function() { return true; }&quot;}}"></div>
+    <div data-bem="{&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:{&quot;c&quot;:&quot;cc&quot;,&quot;b&quot;:&quot;bb&quot;,&quot;a&quot;:{&quot;y&quot;:&quot;yy&quot;,&quot;x&quot;:&quot;xx&quot;}}}">
 </body>
 </html>
diff --git a/test/getDiffText.js b/test/getDiffText.js
@@ -12,7 +12,7 @@ describe('\'diffHtml\'', function () {
                 removed: undefined
             } ];
 
-        diffLoger.getDiffText(inp, { charsAroundDiff: 20 } ).must.be.equal('');
+        diffLoger.getDiffText(inp, { charsAroundDiff: 20 }).must.be.equal('');
     });
 
     it('must return a diff string', function () {
@@ -41,7 +41,7 @@ describe('\'diffHtml\'', function () {
 
             out = '\n...\n' + 'texttexttexttexttext'.grey + '!'.inverse.green + 'Text'.grey + '!'.inverse.green + 'texttexttexttext'.grey;
 
-        diffLoger.getDiffText(inp, { charsAroundDiff: 20 } ).must.be.eql(out);
+        diffLoger.getDiffText(inp, { charsAroundDiff: 20 }).must.be.eql(out);
     });
 
     it('must consider negative value of \'charsAroundDiff\' option', function () {
@@ -51,7 +51,7 @@ describe('\'diffHtml\'', function () {
                 removed: undefined
             } ];
 
-        diffLoger.getDiffText(inp, { charsAroundDiff: -5 } ).must.be.equal('');
+        diffLoger.getDiffText(inp, { charsAroundDiff: -5 }).must.be.equal('');
     });
 
 
@@ -70,7 +70,7 @@ describe('\'diffHtml\'', function () {
 
             out = '\n' + 'texttexttexttexttexttexttexttexttexttexttext'.inverse.green + 'ololoololoololoololoololoololoololoololoolol'.inverse.red;
 
-        diffLoger.getDiffText(inp, { charsAroundDiff: 20 } ).must.be.eql(out);
+        diffLoger.getDiffText(inp, { charsAroundDiff: 20 }).must.be.eql(out);
     });
 
     it('must return a diff on the beginning of the input', function () {
@@ -128,7 +128,7 @@ describe('\'diffHtml\'', function () {
 
             out = '\n...\n' + 'texttexttexttexttext'.grey + 'text'.inverse.red + 'texttexttexttexttext'.grey + '\n...\n' + 'texttexttexttexttext'.grey + '!'.inverse.green + 'text'.grey + '!'.inverse.green + 'texttexttexttexttext'.grey;
 
-        diffLoger.getDiffText(inp, { charsAroundDiff: 20 } ).must.be.eql(out);
+        diffLoger.getDiffText(inp, { charsAroundDiff: 20 }).must.be.eql(out);
     });
 
 });
diff --git a/test/isEqual.js b/test/isEqual.js
@@ -61,7 +61,7 @@ describe('\'isEqual\'', function () {
     });
 
     it('must ignore space characters', function () {
-        var htmlDiffer = new HtmlDiffer({ ignoreWhitespaces: true }),
+        var htmlDiffer = new HtmlDiffer({ ignoreWhitespace: true }),
 
             files = readFiles('7.html', '_7.html');
 
