├── .gitignore
├── samples
├── actual.xml
└── expected.xml
├── lib
├── normalize_newlines.js
├── collapse_spaces.js
├── node_types.js
├── reporters
│ └── groupingReporter.js
├── revxpath.js
├── canonizer.js
├── compare.js
└── collector.js
├── .travis.yml
├── index.js
├── CHANGELOG.md
├── package.json
├── LICENSE
├── test
├── test-reporter.js
├── test-normalize_newlines.js
├── test-revxpath.js
├── test-canonize.js
├── test-collector.js
└── test-compare.js
├── bin
└── domcompare
└── README.md
/.gitignore:
--------------------------------------------------------------------------------
1 | lib-cov
2 | lcov.info
3 | *.seed
4 | *.log
5 | *.csv
6 | *.dat
7 | *.out
8 | *.pid
9 | *.gz
10 |
11 | pids
12 | logs
13 | results
14 |
15 | .idea
16 | node_modules
17 | npm-debug.log
18 |
--------------------------------------------------------------------------------
/samples/actual.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | text content
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/samples/expected.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | text content
5 |
6 |
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/lib/normalize_newlines.js:
--------------------------------------------------------------------------------
1 | (function(){
2 |
3 | "use strict";
4 |
5 | module.exports = function normalizeNewlines(str) {
6 | // First replace all CR+LF newlines then replace CR newlines
7 | return str.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
8 | };
9 |
10 | })();
11 |
--------------------------------------------------------------------------------
/lib/collapse_spaces.js:
--------------------------------------------------------------------------------
1 | (function(){
2 |
3 | "use strict";
4 |
5 | module.exports = function collapseSpaces(str) {
6 | // Replace all whitespace with the space character and then collapse all white space to one space character
7 | return str.replace(/\s/g, ' ').replace(/\s\s+/g, ' ');
8 | };
9 |
10 | })();
11 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 |
3 | node_js:
4 | - "12"
5 | - "11"
6 | - "10"
7 | - "9"
8 | - "8"
9 | - "7"
10 | - "6"
11 | - "5.1"
12 | - "5.0"
13 | - "4.2"
14 | - "4.1"
15 | - "4.0"
16 |
17 | script: npm test && npm run-script test-cov && (cat lcov.info | ./node_modules/.bin/coveralls) && (rm -rf lib-cov lcov.info)
18 |
--------------------------------------------------------------------------------
/lib/node_types.js:
--------------------------------------------------------------------------------
1 | (function(){
2 |
3 | "use strict";
4 |
5 | module.exports = {
6 | ELEMENT_NODE: 1,
7 | ATTRIBUTE_NODE: 2,
8 | TEXT_NODE: 3,
9 | CDATA_SECTION_NODE: 4,
10 | ENTITY_REFERENCE_NODE: 5,
11 | ENTITY_NODE: 6,
12 | PROCESSING_INSTRUCTION_NODE: 7,
13 | COMMENT_NODE: 8,
14 | DOCUMENT_NODE: 9,
15 | DOCUMENT_TYPE_NODE: 10,
16 | DOCUMENT_FRAGMENT_NODE: 11,
17 | NOTATION_NODE: 12
18 | };
19 |
20 | })();
--------------------------------------------------------------------------------
/lib/reporters/groupingReporter.js:
--------------------------------------------------------------------------------
1 | (function() {
2 |
3 | "use strict";
4 |
5 | module.exports = {
6 | report: function(res) {
7 | var _res = this.getDifferences(res);
8 | return Object.keys(_res).map(function(path){
9 | return [path, "\n\t", _res[path].join('\n\t')].join('');
10 | }.bind(this)).join('\n');
11 | },
12 | getDifferences: function(res) {
13 | var _res = {};
14 | res.getDifferences().forEach(function(f){
15 | (_res[f.node] = (_res[f.node] || [])).push(f.message);
16 | }.bind(this));
17 | return _res;
18 | }
19 | };
20 |
21 | })();
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | (function(){
2 |
3 | "use strict";
4 |
5 | var libPrefix = process.env.COVER ? './lib-cov' : './lib';
6 |
7 | module.exports = process.browser ? {
8 | compare: require('./lib/compare'),
9 | XMLSerializer: require('./lib/canonizer'),
10 | revXPath: require('./lib/revxpath'),
11 | GroupingReporter: require('./lib/reporters/groupingReporter.js')
12 | } :
13 | {
14 | compare: require(libPrefix + '/compare'),
15 | XMLSerializer: require(libPrefix + '/canonizer'),
16 | revXPath: require(libPrefix + '/revxpath'),
17 | GroupingReporter: require(libPrefix + '/reporters/groupingReporter.js')
18 | };
19 |
20 | })();
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # CHANGELOG
2 |
3 | ## v0.6.0, 14.10.2019
4 |
5 | * Fixed [#43](https://github.com/Olegas/dom-compare/issues/43). Thanks to @Sh33pman
6 |
7 | ## v0.5.0, 21.09.2019
8 |
9 | * Added `normalizeNewlines` option. See docs for details. Thanks to @jordandh
10 |
11 | ## v0.4.0, 05.09.2019
12 |
13 | * Added `collapseSpaces` option. See docs for details. Thanks to @jordandh
14 |
15 | ## v0.3.1, 01.05.2017
16 |
17 | * Added support for document fragments. Closing #26
18 |
19 | ## v0.3.0, 27.04.2017
20 |
21 | * **BREAKING CHANGES**. Fixed a typo in groupingReporter.getDifferences method. Thanks to @jonathanp
22 |
23 | ## v0.2.1, 25.04.2015
24 |
25 | * Browserify support
26 | * Fixed dependencies versions to make all test pass
27 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "dom-compare",
3 | "description": "Library to compare two DOM trees",
4 | "version": "0.6.0",
5 | "author": "Oleg Elifantiev ",
6 | "contributors": [],
7 | "keywords": [
8 | "dom",
9 | "comparison"
10 | ],
11 | "bin": {
12 | "domcompare": "bin/domcompare"
13 | },
14 | "dependencies": {
15 | "argparse": "^1.0.10",
16 | "colors": "0.6.2",
17 | "xmldom": "0.1.19"
18 | },
19 | "devDependencies": {
20 | "coveralls": "^3.0.2",
21 | "istanbul": "^0.4.5",
22 | "mocha": "^5.2.0",
23 | "mocha-istanbul": "0.2.0"
24 | },
25 | "scripts": {
26 | "instrument": "istanbul instrument --output lib-cov --no-compact --variable global.__coverage__ lib",
27 | "test-cov": "npm run-script instrument && COVER=1 ISTANBUL_REPORTERS=lcovonly mocha -R mocha-istanbul",
28 | "test": "mocha -R spec"
29 | },
30 | "repository": "git@github.com:Olegas/dom-compare.git",
31 | "engines": {
32 | "node": "*"
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2017 Oleg Elifantiev
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/test/test-reporter.js:
--------------------------------------------------------------------------------
1 | var assert = require("assert");
2 | var xmldom = require("xmldom");
3 | var parser = new xmldom.DOMParser();
4 | var domCompare = require("../");
5 | var compare = domCompare.compare;
6 | var reporter = domCompare.GroupingReporter;
7 |
8 | describe("Differences reporting", function(){
9 |
10 | describe("Grouping reporter", function(){
11 |
12 | it("grouping differences by source node XPath", function(){
13 |
14 | var doc = parser.parseFromString("");
15 | var doc2 = parser.parseFromString("");
16 |
17 | var failures = reporter.getDifferences(compare(doc, doc2));
18 |
19 | assert.equal(3, Object.keys(failures).length);
20 | assert.equal(3, failures['/doc'].length);
21 | assert.equal(2, failures['/doc/node1'].length);
22 | assert.equal(1, failures['/doc/node2'].length);
23 |
24 | // check for results doplication
25 | failures = reporter.getDifferences(compare(doc, doc2));
26 |
27 | assert.equal(3, Object.keys(failures).length);
28 | assert.equal(3, failures['/doc'].length);
29 | assert.equal(2, failures['/doc/node1'].length);
30 | assert.equal(1, failures['/doc/node2'].length);
31 |
32 | });
33 |
34 | });
35 |
36 | });
--------------------------------------------------------------------------------
/test/test-normalize_newlines.js:
--------------------------------------------------------------------------------
1 | var assert = require('assert');
2 | var normalizeNewlines = require('../lib/normalize_newlines');
3 |
4 | describe('normalize_newlines', function () {
5 | it('should transform CR+LF to LF', function() {
6 | var input = '\r\n';
7 | var expected = '\n';
8 | assert.equal(normalizeNewlines(input), expected);
9 | });
10 |
11 | it('should transform CR to LF', function() {
12 | var input = '\r';
13 | var expected = '\n';
14 | assert.equal(normalizeNewlines(input), expected);
15 | });
16 |
17 | it('should transform mixed CR+LF and LF to LF', function() {
18 | var input = '\n\r\n\n\r\n\n';
19 | var expected = '\n\n\n\n\n';
20 | assert.equal(normalizeNewlines(input), expected);
21 | });
22 |
23 | it('should transform mixed CR+LF and CR to LF', function() {
24 | var input = '\r\n\r\n\r \r\n\r';
25 | var expected = '\n\n\n \n\n';
26 | assert.equal(normalizeNewlines(input), expected);
27 | });
28 |
29 | it('should transform mixed CR and LF to LF', function() {
30 | var input = '\n\n\r \n\r';
31 | var expected = '\n\n\n \n\n';
32 | assert.equal(normalizeNewlines(input), expected);
33 | });
34 |
35 | it('should transform mixed CR+LF and CR and LF to LF', function() {
36 | var input = '\n\r\n\r\n\n\r \n\r\n\r';
37 | var expected = '\n\n\n\n\n \n\n\n';
38 | assert.equal(normalizeNewlines(input), expected);
39 | });
40 | });
41 |
--------------------------------------------------------------------------------
/lib/revxpath.js:
--------------------------------------------------------------------------------
1 | (function(){
2 |
3 | "use strict";
4 |
5 | var type = require('./node_types');
6 |
7 | function _describeNode(node) {
8 | var parent = node.parentNode,
9 | myName = node.nodeName,
10 | sameSiblings,
11 | i, l;
12 |
13 | // Find all siblings that have the same name.
14 | if (parent && parent.childNodes && parent.childNodes.length) {
15 | sameSiblings = [];
16 | for(i = 0, l = parent.childNodes.length; i < l; i++) {
17 | if (parent.childNodes[i].nodeName === myName) {
18 | sameSiblings.push(parent.childNodes[i]);
19 | }
20 | }
21 | }
22 |
23 | if(node.nodeType == type.DOCUMENT_NODE)
24 | return "";
25 |
26 | if(sameSiblings && sameSiblings.length > 1) {
27 | if(node.hasAttribute('id'))
28 | return myName + "[@id='" + node.getAttribute('id') + "']";
29 | for(i = 0, l = sameSiblings.length; i < l; i++) {
30 | if(sameSiblings[i] == node)
31 | return myName + "[" + (i + 1) + "]";
32 | }
33 | throw new Error("Node is not found, but should be!");
34 | } else
35 | return myName;
36 | }
37 |
38 | function _processNode(node, res) {
39 |
40 | res.unshift(_describeNode(node));
41 | if(node.parentNode)
42 | _processNode(node.parentNode, res);
43 |
44 | }
45 |
46 | module.exports = function revXPath(node) {
47 |
48 | var res;
49 |
50 | if(!node)
51 | return "";
52 |
53 | if(node.nodeType == type.DOCUMENT_NODE)
54 | return "/";
55 |
56 | _processNode(node, res = []);
57 | return res.join('/');
58 |
59 | };
60 |
61 |
62 | })();
--------------------------------------------------------------------------------
/test/test-revxpath.js:
--------------------------------------------------------------------------------
1 | var assert = require("assert");
2 | var xmldom = require("xmldom");
3 | var parser = new xmldom.DOMParser();
4 | var domCompare = require("../");
5 | var revxpath = domCompare.revXPath;
6 |
7 | describe("Reverse XPath", function(){
8 |
9 | it("Builds a node path by its name", function(){
10 |
11 | var doc = parser.parseFromString("Some Text Part 2
and get the xpath
52 | var path = revxpath(doc.getElementsByTagName('div')[9]);
53 |
54 | assert.equal("/html/body/div[2]/section[2]/div", path);
55 | });
56 |
57 | it("if ID attribute is present, it is used instead of number", function(){
58 |
59 | var doc = parser.parseFromString("