src/smartxml/smartxml.test.js

   1 define([
   2     'libs/chai',
   3     'libs/sinon',
   4     './smartxml.js'
   5 ], function(chai, sinon, smartxml) {
   6
   7 'use strict';
   8 /*jshint expr:true */
   9 /* global describe, it, beforeEach */
  10
  11 var expect = chai.expect;
  12
  13
  14 var getDocumentFromXML = function(xml) {
  15     return smartxml.documentFromXML(xml);
  16 };
  17
  18 var elementNodeFromParams = function(params) {
  19     return smartxml.elementNodeFromXML('<' + params.tag + '></' + params.tag + '>');
  20 };
  21
  22 var elementNodeFromXML = function(xml) {
  23     return smartxml.elementNodeFromXML(xml);
  24 };
  25
  26
  27 describe('smartxml', function() {
  28
  29     describe('Basic Document properties', function() {
  30         it('exposes its root element', function() {
  31             var doc = getDocumentFromXML('<div></div>');
  32             expect(doc.root.getTagName()).to.equal('div');
  33         });
  34
  35         it('can resets its content entirely', function() {
  36             var doc = getDocumentFromXML('<div></div>');
  37
  38             expect(doc.root.getTagName()).to.equal('div');
  39
  40             doc.loadXML('<header></header>');
  41             expect(doc.root.getTagName()).to.equal('header');
  42         });
  43
  44         it('knows if it contains an ElementNode in its tree', function() {
  45             var doc = getDocumentFromXML('<root><a></a>text</root>'),
  46                 root = doc.root,
  47                 a = root.contents()[0],
  48                 text = root.contents()[1];
  49
  50             expect(doc.containsNode(root)).to.equal(true, 'contains its root');
  51             expect(doc.containsNode(a)).to.equal(true, 'contains Element Node');
  52             expect(doc.containsNode(text)).to.equal(true, 'contains Text Node');
  53         });
  54     });
  55
  56     describe('Basic ElementNode properties', function() {
  57         it('exposes node contents', function() {
  58             var node = elementNodeFromXML('<node>Some<node>text</node>is here</node>'),
  59                 contents = node.contents();
  60
  61             expect(contents).to.have.length(3);
  62             expect(contents[0].nodeType).to.equal(Node.TEXT_NODE, 'text node 1');
  63             expect(contents[1].nodeType).to.equal(Node.ELEMENT_NODE, 'element node 1');
  64             expect(contents[2].nodeType).to.equal(Node.TEXT_NODE, 'text node 2');
  65         });
  66
  67         describe('Storing custom data', function() {
  68             var node;
  69
  70             beforeEach(function() {
  71                 node = elementNodeFromXML('<div></div>');
  72             });
  73
  74             it('can append single value', function() {
  75                 node.setData('key', 'value');
  76                 expect(node.getData('key')).to.equal('value');
  77             });
  78
  79             it('can overwrite the whole data', function() {
  80                 node.setData('key1', 'value1');
  81                 node.setData({key2: 'value2'});
  82                 expect(node.getData('key2')).to.equal('value2');
  83             });
  84
  85             it('can fetch the whole data at once', function() {
  86                 node.setData({key1: 'value1', key2: 'value2'});
  87                 expect(node.getData()).to.eql({key1: 'value1', key2: 'value2'});
  88             });
  89         });
  90
  91         describe('Changing node tag', function() {
  92
  93             it('can change tag name', function() {
  94                 var node = elementNodeFromXML('<div></div>');
  95                 node.setTag('span');
  96                 expect(node.getTagName()).to.equal('span');
  97             });
  98
  99             it('emits nodeTagChange event', function() {
 100                 var node = elementNodeFromXML('<div></div>'),
 101                     spy = sinon.spy();
 102
 103                 node.document.on('change', spy);
 104                 node.setTag('span');
 105                 var event = spy.args[0][0];
 106
 107                 expect(event.type).to.equal('nodeTagChange');
 108                 expect(event.meta.node.sameNode(node)).to.be.true;
 109                 expect(event.meta.oldTagName).to.equal('div');
 110             });
 111
 112             describe('Implementation specific expectations', function() {
 113                 // DOM specifies ElementNode tag as a read-only property, so
 114                 // changing it in a seamless way is a little bit tricky. For this reason
 115                 // the folowing expectations are required, despite the fact that they actually are
 116                 // motivated by implemetation details.
 117
 118                 it('keeps node in the document', function() {
 119                     var doc = getDocumentFromXML('<div><header></header></div>'),
 120                         header = doc.root.contents()[0];
 121                     header.setTag('span');
 122                     expect(header.parent().sameNode(doc.root)).to.be.true;
 123                 });
 124                 it('keeps custom data', function() {
 125                     var node = elementNodeFromXML('<div></div>');
 126
 127                     node.setData('key', 'value');
 128                     node.setTag('header');
 129
 130                     expect(node.getTagName()).to.equal('header');
 131                     expect(node.getData()).to.eql({key: 'value'});
 132                 });
 133
 134                 it('can change document root tag name', function() {
 135                     var doc = getDocumentFromXML('<div></div>');
 136                     doc.root.setTag('span');
 137                     expect(doc.root.getTagName()).to.equal('span');
 138                 });
 139
 140                 it('keeps contents', function() {
 141                     var node = elementNodeFromXML('<div><div></div></div>');
 142                     node.setTag('header');
 143                     expect(node.contents()).to.have.length(1);
 144                 });
 145             });
 146
 147         describe('Setting node attributes', function() {
 148             it('can set node attribute', function() {
 149                 var node = elementNodeFromXML('<div></div>');
 150
 151                 node.setAttr('key', 'value');
 152                 expect(node.getAttr('key')).to.equal('value');
 153             });
 154             it('emits nodeAttrChange event', function() {
 155                 var node = elementNodeFromXML('<div key="value1"></div>'),
 156                     spy = sinon.spy();
 157
 158                 node.document.on('change', spy);
 159                 node.setAttr('key', 'value2');
 160                 var event = spy.args[0][0];
 161
 162                 expect(event.type).to.equal('nodeAttrChange');
 163                 expect(event.meta.node.sameNode(node)).to.be.true;
 164                 expect(event.meta.attr).to.equal('key');
 165                 expect(event.meta.oldVal).to.equal('value1');
 166             });
 167         });
 168
 169         });
 170     });
 171
 172     describe('Basic TextNode properties', function() {
 173         it('can have its text set', function() {
 174             var node = elementNodeFromXML('<div>Alice</div>'),
 175                 textNode = node.contents()[0];
 176
 177             textNode.setText('Cat');
 178             expect(textNode.getText()).to.equal('Cat');
 179         });
 180
 181         it('emits nodeTextChange', function() {
 182             var node = elementNodeFromXML('<div>Alice</div>'),
 183                 textNode = node.contents()[0],
 184                 spy = sinon.spy();
 185
 186             textNode.document.on('change', spy);
 187             textNode.setText('Cat');
 188
 189             var event = spy.args[0][0];
 190             expect(event.type).to.equal('nodeTextChange');
 191         });
 192
 193         it('puts NodeElement after itself', function() {
 194             var node = elementNodeFromXML('<div>Alice</div>'),
 195                 textNode = node.contents()[0],
 196                 returned = textNode.after({tagName:'div'});
 197             expect(returned.sameNode(node.contents()[1])).to.be.true;
 198         });
 199
 200         it('puts NodeElement before itself', function() {
 201             var node = elementNodeFromXML('<div>Alice</div>'),
 202                 textNode = node.contents()[0],
 203                 returned = textNode.before({tagName:'div'});
 204             expect(returned.sameNode(node.contents()[0])).to.be.true;
 205         });
 206
 207         describe('Wrapping TextNode contents', function() {
 208
 209             it('wraps DocumentTextElement', function() {
 210                 var node = elementNodeFromXML('<section>Alice</section>'),
 211                     textNode = node.contents()[0];
 212
 213                 var returned = textNode.wrapWith({tagName: 'header'}),
 214                     parent = textNode.parent(),
 215                     parent2 = node.contents()[0];
 216
 217                 expect(returned.sameNode(parent)).to.be.equal(true, 'wrapper is a parent');
 218                 expect(returned.sameNode(parent2)).to.be.equal(true, 'wrapper has a correct parent');
 219                 expect(returned.getTagName()).to.equal('header');
 220             });
 221
 222             describe('wrapping part of DocumentTextElement', function() {
 223                 [{start: 5, end: 12}, {start: 12, end: 5}].forEach(function(offsets) {
 224                     it('wraps in the middle ' + offsets.start + '/' + offsets.end, function() {
 225                         var node = elementNodeFromXML('<section>Alice has a cat</section>'),
 226                             textNode = node.contents()[0];
 227
 228                         var returned = textNode.wrapWith({tagName: 'header', attrs: {'attr1': 'value1'}, start: offsets.start, end: offsets.end}),
 229                             contents = node.contents();
 230
 231                         expect(contents.length).to.equal(3);
 232
 233                         expect(contents[0].nodeType).to.be.equal(Node.TEXT_NODE, 'first node is text node');
 234                         expect(contents[0].getText()).to.equal('Alice');
 235
 236                         expect(contents[1].sameNode(returned)).to.be.true;
 237                         expect(returned.getTagName()).to.equal('header');
 238                         expect(returned.getAttr('attr1')).to.equal('value1');
 239                         expect(contents[1].contents().length).to.equal(1, 'wrapper has one node inside');
 240                         expect(contents[1].contents()[0].getText()).to.equal(' has a ');
 241
 242                         expect(contents[2].nodeType).to.be.equal(Node.TEXT_NODE, 'third node is text node');
 243                         expect(contents[2].getText()).to.equal('cat');
 244                     });
 245                 });
 246
 247                 it('wraps whole text inside DocumentTextElement if offsets span entire content', function() {
 248                     var node = elementNodeFromXML('<section>Alice has a cat</section>'),
 249                          textNode = node.contents()[0];
 250
 251                     textNode.wrapWith({tagName: 'header', start: 0, end: 15});
 252
 253                     var contents = node.contents();
 254                     expect(contents.length).to.equal(1);
 255                     expect(contents[0].getTagName()).to.equal('header');
 256                     expect(contents[0].contents()[0].getText()).to.equal('Alice has a cat');
 257                 });
 258             });
 259         });
 260
 261     });
 262
 263     describe('Manipulations', function() {
 264
 265         it('merges adjacent text nodes resulting from detaching an element node in between', function() {
 266             var doc = getDocumentFromXML('<div>Alice <span>has</span>a cat</div>'),
 267                 span = doc.root.contents()[1];
 268
 269             span.detach();
 270
 271             var rootContents = doc.root.contents();
 272             expect(rootContents).to.have.length(1, 'one child left');
 273             expect(rootContents[0].getText()).to.equal('Alice a cat');
 274         });
 275
 276         it('appends element node to another element node', function() {
 277             var node1 = elementNodeFromParams({tag: 'div'}),
 278                 node2 = elementNodeFromParams({tag: 'a'}),
 279                 node3 = elementNodeFromParams({tag: 'p'});
 280             node1.append(node2);
 281             node1.append(node3);
 282             expect(node1.contents()[0].sameNode(node2)).to.be.true;
 283             expect(node1.contents()[1].sameNode(node3)).to.be.true;
 284         });
 285
 286         it('prepends element node to another element node', function() {
 287             var node1 = elementNodeFromParams({tag: 'div'}),
 288                 node2 = elementNodeFromParams({tag: 'a'}),
 289                 node3 = elementNodeFromParams({tag: 'p'});
 290             node1.prepend(node2);
 291             node1.prepend(node3);
 292             expect(node1.contents()[0].sameNode(node3)).to.be.true;
 293             expect(node1.contents()[1].sameNode(node2)).to.be.true;
 294         });
 295
 296         it('wraps element node with another element node', function() {
 297             var node = elementNodeFromXML('<div></div>'),
 298                 wrapper = elementNodeFromXML('<wrapper></wrapper>');
 299
 300             node.wrapWith(wrapper);
 301             expect(node.parent().sameNode(wrapper)).to.be.true;
 302         });
 303
 304         it('unwraps element node contents', function() {
 305             var node = elementNodeFromXML('<div>Alice <div>has <span>propably</span> a cat</div>!</div>'),
 306                 outerDiv = node.contents()[1];
 307
 308             outerDiv.unwrapContent();
 309
 310             expect(node.contents().length).to.equal(3);
 311             expect(node.contents()[0].getText()).to.equal('Alice has ');
 312             expect(node.contents()[1].getTagName()).to.equal('span');
 313             expect(node.contents()[2].getText()).to.equal(' a cat!');
 314         });
 315
 316         it('unwrap single node from its parent', function() {
 317             var doc = getDocumentFromXML('<div><a><b></b></a></div>'),
 318                 div = doc.root,
 319                 a = div.contents()[0],
 320                 b = a.contents()[0];
 321
 322             var parent = b.unwrap();
 323
 324             expect(parent.sameNode(div)).to.equal(true, 'returns new parent');
 325             expect(div.contents()).to.have.length(1, 'root contains only one node');
 326             expect(div.contents()[0].sameNode(b)).to.equal(true, 'node got unwrapped');
 327         });
 328
 329         describe('Wrapping text', function() {
 330             it('wraps text spanning multiple sibling TextNodes', function() {
 331                 var section = elementNodeFromXML('<section>Alice has a <span>small</span> cat</section>'),
 332                     wrapper = section.wrapText({
 333                         _with: {tagName: 'span', attrs: {'attr1': 'value1'}},
 334                         offsetStart: 6,
 335                         offsetEnd: 4,
 336                         textNodeIdx: [0,2]
 337                     });
 338
 339                 expect(section.contents().length).to.equal(2);
 340                 expect(section.contents()[0].nodeType).to.equal(Node.TEXT_NODE);
 341                 expect(section.contents()[0].getText()).to.equal('Alice ');
 342
 343                 var wrapper2 = section.contents()[1];
 344                 expect(wrapper2.sameNode(wrapper)).to.be.true;
 345                 expect(wrapper.getTagName()).to.equal('span');
 346
 347                 var wrapperContents = wrapper.contents();
 348                 expect(wrapperContents.length).to.equal(3);
 349                 expect(wrapperContents[0].getText()).to.equal('has a ');
 350
 351                 expect(wrapperContents[1].nodeType).to.equal(Node.ELEMENT_NODE);
 352                 expect(wrapperContents[1].contents().length).to.equal(1);
 353                 expect(wrapperContents[1].contents()[0].getText()).to.equal('small');
 354             });
 355         });
 356
 357         describe('Wrapping Nodes', function() {
 358             it('wraps multiple sibling nodes', function() {
 359                 var section = elementNodeFromXML('<section>Alice<div>has</div><div>a cat</div></section>'),
 360                     aliceText = section.contents()[0],
 361                     firstDiv = section.contents()[1],
 362                     lastDiv = section.contents()[section.contents().length -1];
 363
 364                 var returned = section.document.wrapNodes({
 365                         element1: aliceText,
 366                         element2: lastDiv,
 367                         _with: {tagName: 'header'}
 368                     });
 369
 370                 var sectionContents = section.contents(),
 371                     header = sectionContents[0],
 372                     headerContents = header.contents();
 373
 374                 expect(sectionContents).to.have.length(1);
 375                 expect(header.sameNode(returned)).to.equal(true, 'wrapper returned');
 376                 expect(header.parent().sameNode(section)).to.be.true;
 377                 expect(headerContents).to.have.length(3);
 378                 expect(headerContents[0].sameNode(aliceText)).to.equal(true, 'first node wrapped');
 379                 expect(headerContents[1].sameNode(firstDiv)).to.equal(true, 'second node wrapped');
 380                 expect(headerContents[2].sameNode(lastDiv)).to.equal(true, 'third node wrapped');
 381             });
 382
 383             it('wraps multiple sibling Elements - middle case', function() {
 384                 var section = elementNodeFromXML('<section><div></div><div></div><div></div><div></div></section>'),
 385                     div2 = section.contents()[1],
 386                     div3 = section.contents()[2];
 387
 388                 section.document.wrapNodes({
 389                         element1: div2,
 390                         element2: div3,
 391                         _with: {tagName: 'header'}
 392                     });
 393
 394                 var sectionContents = section.contents(),
 395                     header = sectionContents[1],
 396                     headerChildren = header.contents();
 397
 398                 expect(sectionContents).to.have.length(3);
 399                 expect(headerChildren).to.have.length(2);
 400                 expect(headerChildren[0].sameNode(div2)).to.equal(true, 'first node wrapped');
 401                 expect(headerChildren[1].sameNode(div3)).to.equal(true, 'second node wrapped');
 402             });
 403         });
 404
 405     });
 406
 407     describe('Events', function() {
 408         it('emits nodeDetached event on node detach', function() {
 409             var node = elementNodeFromXML('<div><div></div></div>'),
 410                 innerNode = node.contents()[0],
 411                 spy = sinon.spy();
 412             node.document.on('change', spy);
 413
 414             var detached = innerNode.detach(),
 415                 event = spy.args[0][0];
 416
 417             expect(event.type).to.equal('nodeDetached');
 418             expect(event.meta.node.sameNode(detached, 'detached node in event meta'));
 419             expect(event.meta.parent.sameNode(node), 'original parent node in event meta');
 420         }),
 421
 422         it('emits nodeAdded event when appending new node', function() {
 423             var node = elementNodeFromXML('<div></div>'),
 424                 spy = sinon.spy();
 425             node.document.on('change', spy);
 426
 427             var appended = node.append({tagName:'div'}),
 428                 event = spy.args[0][0];
 429             expect(event.type).to.equal('nodeAdded');
 430             expect(event.meta.node.sameNode(appended)).to.be.true;
 431         });
 432
 433         it('emits nodeMoved when appending aready existing node', function() {
 434             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 435                 a = node.contents()[0],
 436                 b = node.contents()[1],
 437                 spy = sinon.spy();
 438             node.document.on('change', spy);
 439
 440             var appended = a.append(b),
 441                 event = spy.args[0][0];
 442
 443             expect(spy.callCount).to.equal(1);
 444             expect(event.type).to.equal('nodeMoved');
 445             expect(event.meta.node.sameNode(appended)).to.be.true;
 446         });
 447
 448         it('emits nodeAdded event when prepending new node', function() {
 449             var node = elementNodeFromXML('<div></div>'),
 450                 spy = sinon.spy();
 451             node.document.on('change', spy);
 452
 453             var prepended = node.prepend({tagName:'div'}),
 454                 event = spy.args[0][0];
 455             expect(event.type).to.equal('nodeAdded');
 456             expect(event.meta.node.sameNode(prepended)).to.be.true;
 457         });
 458
 459         it('emits nodeMoved when prepending aready existing node', function() {
 460             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 461                 a = node.contents()[0],
 462                 b = node.contents()[1],
 463                 spy = sinon.spy();
 464             node.document.on('change', spy);
 465
 466             var prepended = a.prepend(b),
 467                 event = spy.args[0][0];
 468             expect(spy.callCount).to.equal(1);
 469             expect(event.type).to.equal('nodeMoved');
 470             expect(event.meta.node.sameNode(prepended)).to.be.true;
 471         });
 472
 473         it('emits nodeAdded event when inserting node after another', function() {
 474             var node = elementNodeFromXML('<div><a></a></div>').contents()[0],
 475                 spy = sinon.spy();
 476             node.document.on('change', spy);
 477
 478             var inserted = node.after({tagName:'div'}),
 479                 event = spy.args[0][0];
 480             expect(event.type).to.equal('nodeAdded');
 481             expect(event.meta.node.sameNode(inserted)).to.be.true;
 482         });
 483
 484         it('emits nodeMoved when inserting aready existing node after another', function() {
 485             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 486                 a = node.contents()[0],
 487                 b = node.contents()[1],
 488                 spy = sinon.spy();
 489             node.document.on('change', spy);
 490             var inserted = b.after(a),
 491                 event = spy.args[0][0];
 492
 493             expect(spy.callCount).to.equal(1);
 494             expect(event.type).to.equal('nodeMoved');
 495             expect(event.meta.node.sameNode(inserted)).to.be.true;
 496         });
 497
 498         it('emits nodeAdded event when inserting node before another', function() {
 499             var node = elementNodeFromXML('<div><a></a></div>').contents()[0],
 500                 spy = sinon.spy();
 501             node.document.on('change', spy);
 502
 503             var inserted = node.before({tagName:'div'}),
 504                 event = spy.args[0][0];
 505             expect(event.type).to.equal('nodeAdded');
 506             expect(event.meta.node.sameNode(inserted)).to.be.true;
 507         });
 508
 509         it('emits nodeAdded when inserting aready existing node before another', function() {
 510             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 511                 a = node.contents()[0],
 512                 b = node.contents()[1],
 513                 spy = sinon.spy();
 514             node.document.on('change', spy);
 515             var inserted = a.before(b),
 516                 event = spy.args[0][0];
 517
 518             expect(spy.callCount).to.equal(1);
 519             expect(event.type).to.equal('nodeMoved');
 520             expect(event.meta.node.sameNode(inserted)).to.be.true;
 521         });
 522     });
 523
 524     describe('Traversing', function() {
 525         describe('Basic', function() {
 526             it('can access node parent', function() {
 527                 var doc = getDocumentFromXML('<a><b></b></a>'),
 528                     a = doc.root,
 529                     b = a.contents()[0];
 530
 531                 expect(a.parent()).to.equal(null, 'parent of a root is null');
 532                 expect(b.parent().sameNode(a)).to.be.true;
 533             });
 534             it('can access node parents', function() {
 535                 var doc = getDocumentFromXML('<a><b><c></c></b></a>'),
 536                     a = doc.root,
 537                     b = a.contents()[0],
 538                     c = b.contents()[0];
 539
 540                 var parents = c.parents();
 541                 expect(parents).to.eql([b,a]);
 542             });
 543         });
 544
 545         describe('finding sibling parents of two elements', function() {
 546             it('returns elements themself if they have direct common parent', function() {
 547                 var doc = getDocumentFromXML('<section><div><div>A</div><div>B</div></div></section>'),
 548                     wrappingDiv = doc.root.contents()[0],
 549                     divA = wrappingDiv.contents()[0],
 550                     divB = wrappingDiv.contents()[1];
 551
 552                 var siblingParents = doc.getSiblingParents({node1: divA, node2: divB});
 553
 554                 expect(siblingParents.node1.sameNode(divA)).to.equal(true, 'divA');
 555                 expect(siblingParents.node2.sameNode(divB)).to.equal(true, 'divB');
 556             });
 557
 558             it('returns sibling parents - example 1', function() {
 559                 var doc = getDocumentFromXML('<section>Alice <span>has a cat</span></section>'),
 560                     aliceText = doc.root.contents()[0],
 561                     span = doc.root.contents()[1],
 562                     spanText = span.contents()[0];
 563
 564                 var siblingParents = doc.getSiblingParents({node1: aliceText, node2: spanText});
 565
 566                 expect(siblingParents.node1.sameNode(aliceText)).to.equal(true, 'aliceText');
 567                 expect(siblingParents.node2.sameNode(span)).to.equal(true, 'span');
 568             });
 569         });
 570     });
 571
 572     describe('Serializing document to WLXML', function() {
 573         it('keeps document intact when no changes have been made', function() {
 574             var xmlIn = '<section>Alice<div>has</div>a <span class="uri" meta-uri="http://cat.com">cat</span>!</section>',
 575                 doc = getDocumentFromXML(xmlIn),
 576                 xmlOut = doc.toXML();
 577
 578             var parser = new DOMParser(),
 579                 input = parser.parseFromString(xmlIn, 'application/xml').childNodes[0],
 580                 output = parser.parseFromString(xmlOut, 'application/xml').childNodes[0];
 581
 582             expect(input.isEqualNode(output)).to.be.true;
 583         });
 584
 585         it('keeps entities intact', function() {
 586             var xmlIn = '<section>&lt; &gt;</section>',
 587                 doc = getDocumentFromXML(xmlIn),
 588                 xmlOut = doc.toXML();
 589             expect(xmlOut).to.equal(xmlIn);
 590         });
 591         it('keeps entities intact when they form html/xml', function() {
 592             var xmlIn = '<section>&lt;abc&gt;</section>',
 593                 doc = getDocumentFromXML(xmlIn),
 594                 xmlOut = doc.toXML();
 595             expect(xmlOut).to.equal(xmlIn);
 596         });
 597     });
 598
 599 });
 600
 601 });