src/smartxml/smartxml.test.js

   1 define([
   2     'libs/chai',
   3     'libs/sinon',
   4     'libs/underscore',
   5     './smartxml.js'
   6 ], function(chai, sinon, _, smartxml) {
   7
   8 'use strict';
   9 /*jshint expr:true */
  10 /* global describe, it, beforeEach, Node, DOMParser */
  11
  12 var expect = chai.expect;
  13
  14
  15 var getDocumentFromXML = function(xml) {
  16     return smartxml.documentFromXML(xml);
  17 };
  18
  19 var elementNodeFromParams = function(params) {
  20     return smartxml.elementNodeFromXML('<' + params.tag + '></' + params.tag + '>');
  21 };
  22
  23 var elementNodeFromXML = function(xml) {
  24     return smartxml.elementNodeFromXML(xml);
  25 };
  26
  27
  28 describe('smartxml', function() {
  29
  30     describe('Basic Document properties', function() {
  31         it('exposes its root element', function() {
  32             var doc = getDocumentFromXML('<div></div>');
  33             expect(doc.root.getTagName()).to.equal('div');
  34         });
  35
  36         it('can resets its content entirely', function() {
  37             var doc = getDocumentFromXML('<div></div>');
  38
  39             expect(doc.root.getTagName()).to.equal('div');
  40
  41             doc.loadXML('<header></header>');
  42             expect(doc.root.getTagName()).to.equal('header');
  43         });
  44
  45         it('knows if it contains an ElementNode in its tree', function() {
  46             var doc = getDocumentFromXML('<root><a></a>text</root>'),
  47                 root = doc.root,
  48                 a = root.contents()[0],
  49                 text = root.contents()[1];
  50
  51             expect(doc.containsNode(root)).to.equal(true, 'contains its root');
  52             expect(doc.containsNode(a)).to.equal(true, 'contains Element Node');
  53             expect(doc.containsNode(text)).to.equal(true, 'contains Text Node');
  54         });
  55
  56         it('creates text nodes', function() {
  57             var doc = getDocumentFromXML('<div></div>'),
  58                 emptyTextNode = doc.createDocumentNode({text:''}),
  59                 nonEmptyTextNode = doc.createDocumentNode({text: 'alice'});
  60             expect(emptyTextNode.getText()).to.equal('', 'empty ok');
  61             expect(nonEmptyTextNode.getText()).to.equal('alice', 'non empty ok');
  62         });
  63
  64         it('creates nodes from xml strings', function() {
  65             var doc = getDocumentFromXML('<div></div>'),
  66                 node = doc.createDocumentNode('<a>Alice<b></b></a>');
  67             expect(node.getTagName()).to.equal('a');
  68             expect(node.contents().length).to.equal(2);
  69             expect(node.contents()[0].getText()).to.equal('Alice');
  70             expect(node.contents()[1].getTagName()).to.equal('b');
  71         });
  72     });
  73
  74     describe('DocumentNode', function() {
  75         it('can be cloned', function() {
  76             var doc = getDocumentFromXML('<div>Alice</div>'),
  77                 text = doc.root.contents()[0],
  78                 clone, suffix;
  79
  80             [doc.root, text].forEach(function(node) {
  81                 suffix = ' (' + (node.nodeType === Node.TEXT_NODE ? 'text' : 'element')  + ')';
  82                 clone = node.clone();
  83                 expect(doc.containsNode(clone)).to.equal(false, 'clone is not contained in a document' + suffix);
  84                 expect(node.sameNode(clone)).to.equal(false, 'clone is not same node as its originator' + suffix);
  85                 expect(node.nativeNode.isEqualNode(clone.nativeNode)).to.equal(true, 'clone is identical as its originator' + suffix);
  86             });
  87         });
  88
  89         it('can be cloned with its contents and its contents data', function() {
  90             var doc = getDocumentFromXML('<root><div></div></root>'),
  91                 root = doc.root,
  92                 div = root.contents()[0];
  93
  94             var ClonableObject = function(arg) {
  95                 this.arg = arg;
  96             };
  97             ClonableObject.prototype.clone = function() {
  98                 return new ClonableObject(this.arg);
  99             };
 100
 101             div.setData('key', 'value');
 102             div.setData('clonableObject', new ClonableObject('test'));
 103
 104             var rootClone = root.clone(),
 105                 divClone = rootClone.contents()[0],
 106                 stringClone = divClone.getData('key'),
 107                 objClone = divClone.getData('clonableObject');
 108
 109             expect(stringClone).to.equal('value');
 110             expect(objClone.arg).to.equal('test', 'clonable object got copied');
 111             expect(objClone !== div.getData('clonableObject')).to.be.equal(true, 'copy of the clonable object is a new object');
 112         });
 113
 114         it('knows its path in the document tree', function() {
 115             var doc = getDocumentFromXML('<root><a><b><c></c>text</b></a></root>'),
 116                 root = doc.root,
 117                 a = root.contents()[0],
 118                 b = a.contents()[0],
 119                 text = b.contents()[1];
 120
 121             expect(root.getPath()).to.eql([], 'path of the root element is empty');
 122             expect(a.getPath()).to.eql([0]);
 123             expect(b.getPath()).to.eql([0, 0]);
 124             expect(text.getPath()).to.eql([0,0,1]);
 125
 126             /* Paths relative to a given ancestor */
 127             expect(text.getPath(root)).to.eql([0,0,1]);
 128             expect(text.getPath(a)).to.eql([0,1]);
 129             expect(text.getPath(b)).to.eql([1]);
 130         });
 131     });
 132
 133     describe('Basic ElementNode properties', function() {
 134         it('exposes node contents', function() {
 135             var node = elementNodeFromXML('<node>Some<node>text</node>is here</node>'),
 136                 contents = node.contents();
 137
 138             expect(contents).to.have.length(3);
 139             expect(contents[0].nodeType).to.equal(Node.TEXT_NODE, 'text node 1');
 140             expect(contents[1].nodeType).to.equal(Node.ELEMENT_NODE, 'element node 1');
 141             expect(contents[2].nodeType).to.equal(Node.TEXT_NODE, 'text node 2');
 142         });
 143
 144         describe('Storing custom data', function() {
 145             var node;
 146
 147             beforeEach(function() {
 148                 node = elementNodeFromXML('<div></div>');
 149             });
 150
 151             it('can append single value', function() {
 152                 node.setData('key', 'value');
 153                 expect(node.getData('key')).to.equal('value');
 154             });
 155
 156             it('can overwrite the whole data', function() {
 157                 node.setData('key1', 'value1');
 158                 node.setData({key2: 'value2'});
 159                 expect(node.getData('key2')).to.equal('value2');
 160             });
 161
 162             it('can fetch the whole data at once', function() {
 163                 node.setData({key1: 'value1', key2: 'value2'});
 164                 expect(node.getData()).to.eql({key1: 'value1', key2: 'value2'});
 165             });
 166         });
 167
 168         describe('Changing node tag', function() {
 169
 170             it('can change tag name', function() {
 171                 var node = elementNodeFromXML('<div></div>');
 172                 node.setTag('span');
 173                 expect(node.getTagName()).to.equal('span');
 174             });
 175
 176             it('emits nodeTagChange event', function() {
 177                 var node = elementNodeFromXML('<div></div>'),
 178                     spy = sinon.spy();
 179
 180                 node.document.on('change', spy);
 181                 node.setTag('span');
 182                 var event = spy.args[0][0];
 183
 184                 expect(event.type).to.equal('nodeTagChange');
 185                 expect(event.meta.node.sameNode(node)).to.be.true;
 186                 expect(event.meta.oldTagName).to.equal('div');
 187             });
 188
 189             describe('Implementation specific expectations', function() {
 190                 // DOM specifies ElementNode tag as a read-only property, so
 191                 // changing it in a seamless way is a little bit tricky. For this reason
 192                 // the folowing expectations are required, despite the fact that they actually are
 193                 // motivated by implemetation details.
 194
 195                 it('keeps node in the document', function() {
 196                     var doc = getDocumentFromXML('<div><header></header></div>'),
 197                         header = doc.root.contents()[0];
 198                     header.setTag('span');
 199                     expect(header.parent().sameNode(doc.root)).to.be.true;
 200                 });
 201                 it('keeps custom data', function() {
 202                     var node = elementNodeFromXML('<div></div>');
 203
 204                     node.setData('key', 'value');
 205                     node.setTag('header');
 206
 207                     expect(node.getTagName()).to.equal('header');
 208                     expect(node.getData()).to.eql({key: 'value'});
 209                 });
 210
 211                 it('can change document root tag name', function() {
 212                     var doc = getDocumentFromXML('<div></div>');
 213                     doc.root.setTag('span');
 214                     expect(doc.root.getTagName()).to.equal('span');
 215                 });
 216
 217                 it('keeps contents', function() {
 218                     var node = elementNodeFromXML('<div><div></div></div>');
 219                     node.setTag('header');
 220                     expect(node.contents()).to.have.length(1);
 221                 });
 222             });
 223
 224         describe('Setting node attributes', function() {
 225             it('can set node attribute', function() {
 226                 var node = elementNodeFromXML('<div></div>');
 227
 228                 node.setAttr('key', 'value');
 229                 expect(node.getAttr('key')).to.equal('value');
 230             });
 231             it('emits nodeAttrChange event', function() {
 232                 var node = elementNodeFromXML('<div key="value1"></div>'),
 233                     spy = sinon.spy();
 234
 235                 node.document.on('change', spy);
 236                 node.setAttr('key', 'value2');
 237                 var event = spy.args[0][0];
 238
 239                 expect(event.type).to.equal('nodeAttrChange');
 240                 expect(event.meta.node.sameNode(node)).to.be.true;
 241                 expect(event.meta.attr).to.equal('key');
 242                 expect(event.meta.oldVal).to.equal('value1');
 243             });
 244         });
 245
 246         });
 247     });
 248
 249     describe('Basic TextNode properties', function() {
 250         it('can have its text set', function() {
 251             var node = elementNodeFromXML('<div>Alice</div>'),
 252                 textNode = node.contents()[0];
 253
 254             textNode.setText('Cat');
 255             expect(textNode.getText()).to.equal('Cat');
 256         });
 257
 258         it('emits nodeTextChange', function() {
 259             var node = elementNodeFromXML('<div>Alice</div>'),
 260                 textNode = node.contents()[0],
 261                 spy = sinon.spy();
 262
 263             textNode.document.on('change', spy);
 264             textNode.setText('Cat');
 265
 266             var event = spy.args[0][0];
 267             expect(event.type).to.equal('nodeTextChange');
 268         });
 269
 270         it('puts NodeElement after itself', function() {
 271             var node = elementNodeFromXML('<div>Alice</div>'),
 272                 textNode = node.contents()[0],
 273                 returned = textNode.after({tagName:'div'});
 274             expect(returned.sameNode(node.contents()[1])).to.be.true;
 275         });
 276
 277         it('puts NodeElement before itself', function() {
 278             var node = elementNodeFromXML('<div>Alice</div>'),
 279                 textNode = node.contents()[0],
 280                 returned = textNode.before({tagName:'div'});
 281             expect(returned.sameNode(node.contents()[0])).to.be.true;
 282         });
 283
 284         describe('Wrapping TextNode contents', function() {
 285
 286             it('wraps DocumentTextElement', function() {
 287                 var node = elementNodeFromXML('<section>Alice</section>'),
 288                     textNode = node.contents()[0];
 289
 290                 var returned = textNode.wrapWith({tagName: 'header'}),
 291                     parent = textNode.parent(),
 292                     parent2 = node.contents()[0];
 293
 294                 expect(returned.sameNode(parent)).to.be.equal(true, 'wrapper is a parent');
 295                 expect(returned.sameNode(parent2)).to.be.equal(true, 'wrapper has a correct parent');
 296                 expect(returned.getTagName()).to.equal('header');
 297             });
 298
 299             describe('wrapping part of DocumentTextElement', function() {
 300                 [{start: 5, end: 12}, {start: 12, end: 5}].forEach(function(offsets) {
 301                     it('wraps in the middle ' + offsets.start + '/' + offsets.end, function() {
 302                         var node = elementNodeFromXML('<section>Alice has a cat</section>'),
 303                             textNode = node.contents()[0];
 304
 305                         var returned = textNode.wrapWith({tagName: 'header', attrs: {'attr1': 'value1'}, start: offsets.start, end: offsets.end}),
 306                             contents = node.contents();
 307
 308                         expect(contents.length).to.equal(3);
 309
 310                         expect(contents[0].nodeType).to.be.equal(Node.TEXT_NODE, 'first node is text node');
 311                         expect(contents[0].getText()).to.equal('Alice');
 312
 313                         expect(contents[1].sameNode(returned)).to.be.true;
 314                         expect(returned.getTagName()).to.equal('header');
 315                         expect(returned.getAttr('attr1')).to.equal('value1');
 316                         expect(contents[1].contents().length).to.equal(1, 'wrapper has one node inside');
 317                         expect(contents[1].contents()[0].getText()).to.equal(' has a ');
 318
 319                         expect(contents[2].nodeType).to.be.equal(Node.TEXT_NODE, 'third node is text node');
 320                         expect(contents[2].getText()).to.equal('cat');
 321                     });
 322                 });
 323
 324                 it('wraps whole text inside DocumentTextElement if offsets span entire content', function() {
 325                     var node = elementNodeFromXML('<section>Alice has a cat</section>'),
 326                          textNode = node.contents()[0];
 327
 328                     textNode.wrapWith({tagName: 'header', start: 0, end: 15});
 329
 330                     var contents = node.contents();
 331                     expect(contents.length).to.equal(1);
 332                     expect(contents[0].getTagName()).to.equal('header');
 333                     expect(contents[0].contents()[0].getText()).to.equal('Alice has a cat');
 334                 });
 335             });
 336         });
 337
 338         describe('Dividing text node into two with element node', function() {
 339                 it('can divide text node with element node, splitting text node into two', function() {
 340                     var doc = getDocumentFromXML('<div>Alice has a cat</div>'),
 341                         text = doc.root.contents()[0];
 342
 343                     var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 5}),
 344                         contents = doc.root.contents(),
 345                         lhsText = contents[0],
 346                         rhsText = contents[2];
 347
 348                     expect(lhsText.getText()).to.equal('Alice');
 349                     expect(returned.sameNode(contents[1]));
 350                     expect(rhsText.getText()).to.equal(' has a cat');
 351                 });
 352
 353                 it('treats dividing at the very end as appending after it', function() {
 354                     var doc = getDocumentFromXML('<div>Alice has a cat</div>'),
 355                         text = doc.root.contents()[0];
 356
 357
 358                     var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 15}),
 359                         contents = doc.root.contents(),
 360                         textNode = contents[0],
 361                         elementNode = contents[1];
 362
 363                     expect(contents.length).to.equal(2);
 364                     expect(textNode.getText()).to.equal('Alice has a cat');
 365                     expect(returned.sameNode(elementNode)).to.be.true;
 366                     expect(elementNode.getTagName()).to.equal('aside');
 367                 });
 368
 369                 it('treats dividing at the very beginning as prepending before it', function() {
 370                     var doc = getDocumentFromXML('<div>Alice has a cat</div>'),
 371                         text = doc.root.contents()[0];
 372
 373                     var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 0}),
 374                         contents = doc.root.contents(),
 375                         textNode = contents[1],
 376                         elementNode = contents[0];
 377
 378                     expect(contents.length).to.equal(2);
 379                     expect(textNode.getText()).to.equal('Alice has a cat');
 380                     expect(returned.sameNode(elementNode)).to.be.true;
 381                     expect(elementNode.getTagName()).to.equal('aside');
 382                 });
 383         });
 384     });
 385
 386     describe('Manipulations', function() {
 387
 388         describe('detaching nodes', function() {
 389             it('can detach document root node', function() {
 390                 var doc = getDocumentFromXML('<div></div>');
 391
 392                 doc.root.detach();
 393                 expect(doc.root).to.equal(null);
 394             });
 395         });
 396
 397         describe('replacing node with another one', function() {
 398             it('replaces node with another one', function() {
 399                 var doc = getDocumentFromXML('<div><a></a></div>'),
 400                     a = doc.root.contents()[0];
 401
 402                 var c = a.replaceWith({tagName: 'b', attrs: {b:'1'}});
 403
 404                 expect(doc.root.contents()[0].sameNode(c));
 405                 expect(c.getTagName()).to.equal('b');
 406                 expect(c.getAttr('b')).to.equal('1');
 407             });
 408             it('can replace document root', function() {
 409                 var doc = getDocumentFromXML('<div></div>');
 410
 411                 var header = doc.root.replaceWith({tagName: 'header'});
 412
 413                 expect(doc.root.sameNode(header)).to.be.true;
 414                 expect(doc.containsNode(header)).to.be.true;
 415             });
 416         });
 417
 418         it('merges adjacent text nodes resulting from detaching an element node in between', function() {
 419             var doc = getDocumentFromXML('<div>Alice <span>has</span>a cat</div>'),
 420                 span = doc.root.contents()[1];
 421
 422             span.detach();
 423
 424             var rootContents = doc.root.contents();
 425             expect(rootContents).to.have.length(1, 'one child left');
 426             expect(rootContents[0].getText()).to.equal('Alice a cat');
 427         });
 428
 429         it('inserts node at index', function() {
 430             var doc = getDocumentFromXML('<div><a></a><b></b><c></c></div>'),
 431                 b = doc.root.contents()[1];
 432
 433             var inserted = doc.root.insertAtIndex({tagName: 'test'}, 1);
 434
 435             expect(doc.root.contents()[1].sameNode(inserted)).to.equal(true, 'inserted node returned');
 436             expect(b.getIndex()).to.equal(2, 'b node shifted right');
 437         });
 438
 439         it('appends node when inserting node at index out of range', function() {
 440             var doc = getDocumentFromXML('<div></div>');
 441
 442             var test1 = doc.root.insertAtIndex({tagName: 'test1'}, 0),
 443                 test2 = doc.root.insertAtIndex({tagName: 'test1'}, 10);
 444
 445             expect(doc.root.contents()[0].sameNode(test1)).to.equal(true, 'inserting at index 0 of empty nodes appends node');
 446             expect(doc.root.contents().length).to.equal(1, 'inserting at index out of range does nothing');
 447             expect(test2).to.equal(undefined, 'inserting at index out of range returns undefined');
 448         });
 449
 450         it('appends element node to another element node', function() {
 451             var node1 = elementNodeFromParams({tag: 'div'}),
 452                 node2 = elementNodeFromParams({tag: 'a'}),
 453                 node3 = elementNodeFromParams({tag: 'p'});
 454             node1.append(node2);
 455             node1.append(node3);
 456             expect(node1.contents()[0].sameNode(node2)).to.be.true;
 457             expect(node1.contents()[1].sameNode(node3)).to.be.true;
 458         });
 459
 460         it('prepends element node to another element node', function() {
 461             var node1 = elementNodeFromParams({tag: 'div'}),
 462                 node2 = elementNodeFromParams({tag: 'a'}),
 463                 node3 = elementNodeFromParams({tag: 'p'});
 464             node1.prepend(node2);
 465             node1.prepend(node3);
 466             expect(node1.contents()[0].sameNode(node3)).to.be.true;
 467             expect(node1.contents()[1].sameNode(node2)).to.be.true;
 468         });
 469
 470         describe('adding text nodes', function() {
 471             it('merges text nodes on append', function() {
 472                 var doc = getDocumentFromXML('<root>text1</root>'),
 473                     returned;
 474                 returned = doc.root.append({text: 'text2'});
 475                 expect(doc.root.contents().length).to.equal(1);
 476                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 477                 expect(doc.root.contents()[0].getText()).to.equal('text1text2');
 478             });
 479
 480             it('merges text nodes on prepend', function() {
 481                 var doc = getDocumentFromXML('<root>text1</root>'),
 482                     returned;
 483                 returned = doc.root.prepend({text: 'text2'});
 484                 expect(doc.root.contents().length).to.equal(1);
 485                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 486                 expect(doc.root.contents()[0].getText()).to.equal('text2text1');
 487             });
 488
 489             it('merges text nodes on before text node', function() {
 490                 var doc = getDocumentFromXML('<root>text1</root>'),
 491                     textNode = doc.root.contents()[0],
 492                     returned;
 493                 returned = textNode.before({text: 'text2'});
 494                 expect(doc.root.contents().length).to.equal(1);
 495                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 496                 expect(doc.root.contents()[0].getText()).to.equal('text2text1');
 497             });
 498
 499             it('merges text nodes on after text node', function() {
 500                 var doc = getDocumentFromXML('<root>text1</root>'),
 501                     textNode = doc.root.contents()[0],
 502                     returned;
 503                 returned = textNode.after({text: 'text2'});
 504                 expect(doc.root.contents().length).to.equal(1);
 505                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 506                 expect(doc.root.contents()[0].getText()).to.equal('text1text2');
 507             });
 508
 509             it('merges text nodes on before element node', function() {
 510                 var doc = getDocumentFromXML('<root>text1<div></div></root>'),
 511                     textNode = doc.root.contents()[0],
 512                     div = doc.root.contents()[1],
 513                     returned;
 514                 returned = div.before({text: 'text2'});
 515                 expect(doc.root.contents().length).to.equal(2);
 516                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 517                 expect(textNode.getText()).to.equal('text1text2');
 518             });
 519
 520             it('merges text nodes on after element node', function() {
 521                 var doc = getDocumentFromXML('<root><div></div>text1</root>'),
 522                     textNode = doc.root.contents()[1],
 523                     div = doc.root.contents()[0],
 524                     returned;
 525                 returned = div.after({text: 'text2'});
 526                 expect(doc.root.contents().length).to.equal(2);
 527                 expect(returned.sameNode(doc.root.contents()[1])).to.equal(true, 'modified node returned');
 528                 expect(textNode.getText()).to.equal('text2text1');
 529             });
 530         });
 531
 532         it('wraps element node with another element node', function() {
 533             var node = elementNodeFromXML('<div></div>'),
 534                 wrapper = elementNodeFromXML('<wrapper></wrapper>');
 535
 536             node.wrapWith(wrapper);
 537             expect(node.parent().sameNode(wrapper)).to.be.true;
 538         });
 539
 540         it('unwraps element node contents', function() {
 541             var node = elementNodeFromXML('<div>Alice <div>has <span>propably</span> a cat</div>!</div>'),
 542                 outerDiv = node.contents()[1];
 543
 544             outerDiv.unwrapContent();
 545
 546             expect(node.contents().length).to.equal(3);
 547             expect(node.contents()[0].getText()).to.equal('Alice has ');
 548             expect(node.contents()[1].getTagName()).to.equal('span');
 549             expect(node.contents()[2].getText()).to.equal(' a cat!');
 550         });
 551
 552         it('unwrap single element node from its parent', function() {
 553             var doc = getDocumentFromXML('<div><a><b></b></a></div>'),
 554                 div = doc.root,
 555                 a = div.contents()[0],
 556                 b = a.contents()[0];
 557
 558             var parent = b.unwrap();
 559
 560             expect(parent.sameNode(div)).to.equal(true, 'returns new parent');
 561             expect(div.contents()).to.have.length(1, 'root contains only one node');
 562             expect(div.contents()[0].sameNode(b)).to.equal(true, 'node got unwrapped');
 563         });
 564
 565         it('unwrap single text node from its parent', function() {
 566             var doc = getDocumentFromXML('<div>Some <span>text</span>!</div>'),
 567                 div = doc.root,
 568                 span = div.contents()[1],
 569                 text = span.contents()[0];
 570
 571             var parent = text.unwrap();
 572
 573             expect(parent.sameNode(div)).to.equal(true, 'returns new parent');
 574             expect(div.contents()).to.have.length(1, 'root contains only one node');
 575             expect(div.contents()[0].getText()).to.equal('Some text!');
 576         });
 577
 578         describe('Wrapping text', function() {
 579             it('wraps text spanning multiple sibling TextNodes', function() {
 580                 var section = elementNodeFromXML('<section>Alice has a <span>small</span> cat</section>'),
 581                     wrapper = section.wrapText({
 582                         _with: {tagName: 'span', attrs: {'attr1': 'value1'}},
 583                         offsetStart: 6,
 584                         offsetEnd: 4,
 585                         textNodeIdx: [0,2]
 586                     });
 587
 588                 expect(section.contents().length).to.equal(2);
 589                 expect(section.contents()[0].nodeType).to.equal(Node.TEXT_NODE);
 590                 expect(section.contents()[0].getText()).to.equal('Alice ');
 591
 592                 var wrapper2 = section.contents()[1];
 593                 expect(wrapper2.sameNode(wrapper)).to.be.true;
 594                 expect(wrapper.getTagName()).to.equal('span');
 595
 596                 var wrapperContents = wrapper.contents();
 597                 expect(wrapperContents.length).to.equal(3);
 598                 expect(wrapperContents[0].getText()).to.equal('has a ');
 599
 600                 expect(wrapperContents[1].nodeType).to.equal(Node.ELEMENT_NODE);
 601                 expect(wrapperContents[1].contents().length).to.equal(1);
 602                 expect(wrapperContents[1].contents()[0].getText()).to.equal('small');
 603             });
 604         });
 605
 606         describe('Wrapping Nodes', function() {
 607             it('wraps multiple sibling nodes', function() {
 608                 var section = elementNodeFromXML('<section>Alice<div>has</div><div>a cat</div></section>'),
 609                     aliceText = section.contents()[0],
 610                     firstDiv = section.contents()[1],
 611                     lastDiv = section.contents()[section.contents().length -1];
 612
 613                 var returned = section.document.wrapNodes({
 614                         node1: aliceText,
 615                         node2: lastDiv,
 616                         _with: {tagName: 'header'}
 617                     });
 618
 619                 var sectionContentss = section.contents(),
 620                     header = sectionContentss[0],
 621                     headerContents = header.contents();
 622
 623                 expect(sectionContentss).to.have.length(1);
 624                 expect(header.sameNode(returned)).to.equal(true, 'wrapper returned');
 625                 expect(header.parent().sameNode(section)).to.be.true;
 626                 expect(headerContents).to.have.length(3);
 627                 expect(headerContents[0].sameNode(aliceText)).to.equal(true, 'first node wrapped');
 628                 expect(headerContents[1].sameNode(firstDiv)).to.equal(true, 'second node wrapped');
 629                 expect(headerContents[2].sameNode(lastDiv)).to.equal(true, 'third node wrapped');
 630             });
 631
 632             it('wraps multiple sibling Elements - middle case', function() {
 633                 var section = elementNodeFromXML('<section><div></div><div></div><div></div><div></div></section>'),
 634                     div2 = section.contents()[1],
 635                     div3 = section.contents()[2];
 636
 637                 section.document.wrapNodes({
 638                         node1: div2,
 639                         node2: div3,
 640                         _with: {tagName: 'header'}
 641                     });
 642
 643                 var sectionContentss = section.contents(),
 644                     header = sectionContentss[1],
 645                     headerChildren = header.contents();
 646
 647                 expect(sectionContentss).to.have.length(3);
 648                 expect(headerChildren).to.have.length(2);
 649                 expect(headerChildren[0].sameNode(div2)).to.equal(true, 'first node wrapped');
 650                 expect(headerChildren[1].sameNode(div3)).to.equal(true, 'second node wrapped');
 651             });
 652         });
 653
 654     });
 655
 656     var getTextNodes = function(text, doc) {
 657         /* globals Node */
 658         var toret = [];
 659         var search = function(node) {
 660             node.contents().forEach(function(node) {
 661                 if(node.nodeType === Node.TEXT_NODE) {
 662                     if(node.getText() === text) {
 663                         toret.push(node);
 664                     }
 665                 } else {
 666                     search(node);
 667                 }
 668             });
 669         };
 670         search(doc.root);
 671         return toret;
 672     };
 673
 674     var getTextNode = function(text, doc) {
 675         var nodes = getTextNodes(text, doc),
 676             error;
 677         if(nodes.length === 0) {
 678             error = 'Text not found';
 679         } else if(nodes.length > 1) {
 680             error = 'Text not unique';
 681         } else if(nodes[0].getText() !== text) {
 682             error = 'I was trying to cheat your test :(';
 683         }
 684         if(error) {
 685             throw new Error(error);
 686         }
 687         return nodes[0];
 688     };
 689
 690     describe('Removing arbitrary text', function() {
 691         it('removes within single text element', function() {
 692             var doc = getDocumentFromXML('<div>Alice</div>'),
 693                 text = getTextNode('Alice', doc);
 694             doc.deleteText({
 695                 from: {
 696                     node: text,
 697                     offset: 1
 698                 },
 699                 to: {
 700                     node: text,
 701                     offset: 4
 702                 }
 703             });
 704             expect(doc.root.contents().length).to.equal(1);
 705             expect(doc.root.contents()[0].getText()).to.equal('Ae');
 706         });
 707         it('removes across elements - 1', function() {
 708             var doc = getDocumentFromXML('<div><a>aaa</a><b>bbb</b></div>');
 709
 710             doc.deleteText({
 711                 from: {
 712                     node: getTextNode('aaa', doc),
 713                     offset: 2
 714                 },
 715                 to: {
 716                     node: getTextNode('bbb', doc),
 717                     offset: 2
 718                 }
 719             });
 720
 721             var contents = doc.root.contents();
 722             expect(contents.length).to.equal(2);
 723             expect(contents[0].contents()[0].getText()).to.equal('aa');
 724             expect(contents[1].contents()[0].getText()).to.equal('b');
 725         });
 726         it('removes across elements - 2', function() {
 727             var doc = getDocumentFromXML('<a><b><c>ccc</c></b>xxx</a>');
 728             doc.deleteText({
 729                 from: {
 730                     node: getTextNode('ccc', doc),
 731                     offset: 2
 732                 },
 733                 to: {
 734                     node: getTextNode('xxx', doc),
 735                     offset: 2
 736                 }
 737             });
 738
 739             var contents = doc.root.contents();
 740             expect(contents.length).to.equal(2);
 741             expect(contents[0].getTagName()).to.equal('b');
 742             expect(contents[1].getText()).to.equal('x');
 743
 744             var bContents = contents[0].contents();
 745             expect(bContents.length).to.equal(1);
 746             expect(bContents[0].getTagName()).to.equal('c');
 747             expect(bContents[0].contents().length).to.equal(1);
 748             expect(bContents[0].contents()[0].getText()).to.equal('cc');
 749         });
 750         it('remove across elements - 3 (merged text nodes)', function() {
 751             var doc = getDocumentFromXML('<div>Alice <span>has</span> a cat</div>');
 752             doc.deleteText({
 753                 from: {
 754                     node: getTextNode('Alice ', doc),
 755                     offset: 1
 756                 },
 757                 to: {
 758                     node: getTextNode(' a cat', doc),
 759                     offset: 3
 760                 }
 761             });
 762             var contents = doc.root.contents();
 763             expect(contents.length).to.equal(1);
 764             expect(contents[0].getText()).to.equal('Acat');
 765         });
 766         it('remove across elements - 4', function() {
 767             var doc = getDocumentFromXML('<div>Alice <div>has <span>a</span> cat</div></div>');
 768             doc.deleteText({
 769                 from: {
 770                     node: getTextNode('Alice ', doc),
 771                     offset: 1
 772                 },
 773                 to: {
 774                     node: getTextNode(' cat', doc),
 775                     offset: 1
 776                 }
 777             });
 778             var contents = doc.root.contents();
 779             expect(contents.length).to.equal(2);
 780             expect(contents[0].getText()).to.equal('A');
 781             expect(contents[1].getTagName()).to.equal('div');
 782             expect(contents[1].contents().length).to.equal(1);
 783             expect(contents[1].contents()[0].getText()).to.equal('cat');
 784         });
 785         it('removes across elements - 5 (whole document)', function() {
 786             var doc = getDocumentFromXML('<div>Alice <div>has <span>a</span> cat</div>!!!</div>');
 787             doc.deleteText({
 788                 from: {
 789                     node: getTextNode('Alice ', doc),
 790                     offset: 0
 791                 },
 792                 to: {
 793                     node: getTextNode('!!!', doc),
 794                     offset: 3
 795                 }
 796             });
 797
 798             expect(doc.root.getTagName()).to.equal('div');
 799             expect(doc.root.contents().length).to.equal(1);
 800             expect(doc.root.contents()[0].getText()).to.equal('');
 801         });
 802         it('removes nodes in between', function() {
 803             var doc = getDocumentFromXML('<div><a>aaa<x>!</x></a>xxx<x></x><b><x>!</x>bbb</b></div>');
 804             doc.deleteText({
 805                 from: {
 806                     node: getTextNode('aaa', doc),
 807                     offset: 2
 808                 },
 809                 to: {
 810                     node: getTextNode('bbb', doc),
 811                     offset: 2
 812                 }
 813             });
 814
 815             var contents = doc.root.contents();
 816             expect(contents.length).to.equal(2, 'two nodes survived');
 817             expect(contents[0].getTagName()).to.equal('a');
 818             expect(contents[1].getTagName()).to.equal('b');
 819             expect(contents[0].contents().length).to.equal(1);
 820             expect(contents[0].contents()[0].getText()).to.equal('aa');
 821             expect(contents[1].contents().length).to.equal(1);
 822             expect(contents[1].contents()[0].getText()).to.equal('b');
 823         });
 824     });
 825
 826     describe('Splitting text', function() {
 827
 828         it('splits TextNode\'s parent into two ElementNodes', function() {
 829             var doc = getDocumentFromXML('<section><header>Some header</header></section>'),
 830                 section = doc.root,
 831                 text = section.contents()[0].contents()[0];
 832
 833             var returnedValue = text.split({offset: 5});
 834             expect(section.contents().length).to.equal(2, 'section has two children');
 835
 836             var header1 = section.contents()[0];
 837             var header2 = section.contents()[1];
 838
 839             expect(header1.getTagName()).to.equal('header', 'first section child ok');
 840             expect(header1.contents().length).to.equal(1, 'first header has one child');
 841             expect(header1.contents()[0].getText()).to.equal('Some ', 'first header has correct content');
 842             expect(header2.getTagName()).to.equal('header', 'second section child ok');
 843             expect(header2.contents().length).to.equal(1, 'second header has one child');
 844             expect(header2.contents()[0].getText()).to.equal('header', 'second header has correct content');
 845
 846             expect(returnedValue.first.sameNode(header1)).to.equal(true, 'first node returned');
 847             expect(returnedValue.second.sameNode(header2)).to.equal(true, 'second node returned');
 848         });
 849
 850         it('leaves empty copy of ElementNode if splitting at the very beginning', function() {
 851                 var doc = getDocumentFromXML('<section><header>Some header</header></section>'),
 852                 section = doc.root,
 853                 text = section.contents()[0].contents()[0];
 854
 855                 text.split({offset: 0});
 856
 857                 var header1 = section.contents()[0];
 858                 var header2 = section.contents()[1];
 859
 860                 expect(header1.contents().length).to.equal(0);
 861                 expect(header2.contents()[0].getText()).to.equal('Some header');
 862         });
 863
 864         it('leaves empty copy of ElementNode if splitting at the very end', function() {
 865                 var doc = getDocumentFromXML('<section><header>Some header</header></section>'),
 866                 section = doc.root,
 867                 text = section.contents()[0].contents()[0];
 868
 869                 text.split({offset: 11});
 870
 871                 var header1 = section.contents()[0];
 872                 var header2 = section.contents()[1];
 873
 874                 expect(header1.contents()[0].getText()).to.equal('Some header');
 875                 expect(header2.contents().length).to.equal(0);
 876         });
 877
 878         it('keeps TextNodes\'s parent\'s children elements intact', function() {
 879             var doc = getDocumentFromXML('<section><header>A <span>fancy</span> and <span>nice</span> header</header></section>'),
 880                 section = doc.root,
 881                 header = section.contents()[0],
 882                 textAnd = header.contents()[2];
 883
 884             textAnd.split({offset: 2});
 885
 886             var sectionContents = section.contents();
 887             expect(sectionContents.length).to.equal(2, 'Section has two children');
 888             expect(sectionContents[0].getTagName()).to.equal('header', 'First section node is a header');
 889             expect(sectionContents[1].getTagName()).to.equal('header', 'Second section node is a header');
 890
 891             var firstHeaderContents = sectionContents[0].contents();
 892             expect(firstHeaderContents.length).to.equal(3, 'First header has three children');
 893             expect(firstHeaderContents[0].getText()).to.equal('A ', 'First header starts with a text');
 894             expect(firstHeaderContents[1].getTagName()).to.equal('span', 'First header has span in the middle');
 895             expect(firstHeaderContents[2].getText()).to.equal(' a', 'First header ends with text');
 896
 897             var secondHeaderContents = sectionContents[1].contents();
 898             expect(secondHeaderContents.length).to.equal(3, 'Second header has three children');
 899             expect(secondHeaderContents[0].getText()).to.equal('nd ', 'Second header starts with text');
 900             expect(secondHeaderContents[1].getTagName()).to.equal('span', 'Second header has span in the middle');
 901             expect(secondHeaderContents[2].getText()).to.equal(' header', 'Second header ends with text');
 902         });
 903     });
 904
 905     describe('Events', function() {
 906         it('emits nodeDetached event on node detach', function() {
 907             var node = elementNodeFromXML('<div><div></div></div>'),
 908                 innerNode = node.contents()[0],
 909                 spy = sinon.spy();
 910             node.document.on('change', spy);
 911
 912             var detached = innerNode.detach(),
 913                 event = spy.args[0][0];
 914
 915             expect(event.type).to.equal('nodeDetached');
 916             expect(event.meta.node.sameNode(detached, 'detached node in event meta'));
 917             expect(event.meta.parent.sameNode(node), 'original parent node in event meta');
 918         }),
 919
 920         it('emits nodeAdded event when appending new node', function() {
 921             var node = elementNodeFromXML('<div></div>'),
 922                 spy = sinon.spy();
 923             node.document.on('change', spy);
 924
 925             var appended = node.append({tagName:'div'}),
 926                 event = spy.args[0][0];
 927             expect(event.type).to.equal('nodeAdded');
 928             expect(event.meta.node.sameNode(appended)).to.be.true;
 929         });
 930
 931         it('emits nodeMoved when appending aready existing node', function() {
 932             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 933                 a = node.contents()[0],
 934                 b = node.contents()[1],
 935                 spy = sinon.spy();
 936             node.document.on('change', spy);
 937
 938             var appended = a.append(b),
 939                 event = spy.args[0][0];
 940
 941             expect(spy.callCount).to.equal(1);
 942             expect(event.type).to.equal('nodeMoved');
 943             expect(event.meta.node.sameNode(appended)).to.be.true;
 944             expect(node.document.root.sameNode(event.meta.parent)).to.equal(true, 'previous parent attached to event meta');
 945         });
 946
 947         it('emits nodeAdded event when prepending new node', function() {
 948             var node = elementNodeFromXML('<div></div>'),
 949                 spy = sinon.spy();
 950             node.document.on('change', spy);
 951
 952             var prepended = node.prepend({tagName:'div'}),
 953                 event = spy.args[0][0];
 954             expect(event.type).to.equal('nodeAdded');
 955             expect(event.meta.node.sameNode(prepended)).to.be.true;
 956         });
 957
 958         it('emits nodeMoved when prepending aready existing node', function() {
 959             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 960                 a = node.contents()[0],
 961                 b = node.contents()[1],
 962                 spy = sinon.spy();
 963             node.document.on('change', spy);
 964
 965             var prepended = a.prepend(b),
 966                 event = spy.args[0][0];
 967             expect(spy.callCount).to.equal(1);
 968             expect(event.type).to.equal('nodeMoved');
 969             expect(event.meta.node.sameNode(prepended)).to.be.true;
 970         });
 971
 972         it('emits nodeAdded event when inserting node after another', function() {
 973             var node = elementNodeFromXML('<div><a></a></div>').contents()[0],
 974                 spy = sinon.spy();
 975             node.document.on('change', spy);
 976
 977             var inserted = node.after({tagName:'div'}),
 978                 event = spy.args[0][0];
 979             expect(event.type).to.equal('nodeAdded');
 980             expect(event.meta.node.sameNode(inserted)).to.be.true;
 981         });
 982
 983         it('emits nodeMoved when inserting aready existing node after another', function() {
 984             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 985                 a = node.contents()[0],
 986                 b = node.contents()[1],
 987                 spy = sinon.spy();
 988             node.document.on('change', spy);
 989             var inserted = b.after(a),
 990                 event = spy.args[0][0];
 991
 992             expect(spy.callCount).to.equal(1);
 993             expect(event.type).to.equal('nodeMoved');
 994             expect(event.meta.node.sameNode(inserted)).to.be.true;
 995         });
 996
 997         it('emits nodeAdded event when inserting node before another', function() {
 998             var node = elementNodeFromXML('<div><a></a></div>').contents()[0],
 999                 spy = sinon.spy();
1000             node.document.on('change', spy);
1001
1002             var inserted = node.before({tagName:'div'}),
1003                 event = spy.args[0][0];
1004             expect(event.type).to.equal('nodeAdded');
1005             expect(event.meta.node.sameNode(inserted)).to.be.true;
1006         });
1007
1008         it('emits nodeAdded when inserting aready existing node before another', function() {
1009             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
1010                 a = node.contents()[0],
1011                 b = node.contents()[1],
1012                 spy = sinon.spy();
1013             node.document.on('change', spy);
1014             var inserted = a.before(b),
1015                 event = spy.args[0][0];
1016
1017             expect(spy.callCount).to.equal(1);
1018             expect(event.type).to.equal('nodeMoved');
1019             expect(event.meta.node.sameNode(inserted)).to.be.true;
1020         });
1021
1022         it('emits nodeDetached and nodeAdded when replacing root node with another', function() {
1023             var doc = getDocumentFromXML('<a></a>'),
1024                 oldRoot = doc.root,
1025                 spy = sinon.spy();
1026
1027             doc.on('change', spy);
1028
1029             doc.root.replaceWith({tagName: 'b'});
1030
1031             expect(spy.callCount).to.equal(2);
1032
1033             var event1 = spy.args[0][0],
1034                 event2 = spy.args[1][0];
1035
1036             expect(event1.type).to.equal('nodeDetached');
1037             expect(event1.meta.node.sameNode(oldRoot)).to.equal(true, 'root node in nodeDetached event metadata');
1038             expect(event2.type).to.equal('nodeAdded');
1039             expect(event2.meta.node.sameNode(doc.root)).to.equal(true, 'new root node in nodelAdded event meta');
1040         });
1041
1042
1043         ['append', 'prepend', 'before', 'after'].forEach(function(insertionMethod) {
1044             it('emits nodeDetached for node moved from a document tree to out of document node ' + insertionMethod, function() {
1045                 var doc = getDocumentFromXML('<div><a></a></div>'),
1046                     a = doc.root.contents()[0],
1047                     spy = sinon.spy();
1048
1049                 doc.on('change', spy);
1050
1051                 var newNode = doc.createDocumentNode({tagName: 'b'}),
1052                     newNodeInner = newNode.append({tagName:'c'});
1053
1054                 newNodeInner[insertionMethod](a);
1055
1056                 var event = spy.args[0][0];
1057                 expect(event.type).to.equal('nodeDetached');
1058                 expect(event.meta.node.sameNode(a));
1059             });
1060
1061             it('doesn\'t emit nodeDetached event for already out of document node moved to out of document node' + insertionMethod, function() {
1062                 var doc = getDocumentFromXML('<div><a></a></div>'),
1063                     spy = sinon.spy();
1064
1065                 doc.on('change', spy);
1066
1067                 var newNode = doc.createDocumentNode({tagName: 'b'});
1068                 newNode.append({tagName:'c'});
1069
1070                 expect(spy.callCount).to.equal(0);
1071             });
1072         });
1073
1074
1075     });
1076
1077     describe('Traversing', function() {
1078         describe('Basic', function() {
1079             it('can access node parent', function() {
1080                 var doc = getDocumentFromXML('<a><b></b></a>'),
1081                     a = doc.root,
1082                     b = a.contents()[0];
1083
1084                 expect(a.parent()).to.equal(null, 'parent of a root is null');
1085                 expect(b.parent().sameNode(a)).to.be.true;
1086             });
1087             it('can access node parents', function() {
1088                 var doc = getDocumentFromXML('<a><b><c></c></b></a>'),
1089                     a = doc.root,
1090                     b = a.contents()[0],
1091                     c = b.contents()[0];
1092
1093                 var parents = c.parents();
1094                 // @@
1095                 expect(parents[0].sameNode(b)).to.be.true;
1096                 expect(parents[1].sameNode(a)).to.be.true;
1097             });
1098         });
1099
1100         describe('finding sibling parents of two elements', function() {
1101             it('returns elements themself if they have direct common parent', function() {
1102                 var doc = getDocumentFromXML('<section><div><div>A</div><div>B</div></div></section>'),
1103                     wrappingDiv = doc.root.contents()[0],
1104                     divA = wrappingDiv.contents()[0],
1105                     divB = wrappingDiv.contents()[1];
1106
1107                 var siblingParents = doc.getSiblingParents({node1: divA, node2: divB});
1108
1109                 expect(siblingParents.node1.sameNode(divA)).to.equal(true, 'divA');
1110                 expect(siblingParents.node2.sameNode(divB)).to.equal(true, 'divB');
1111             });
1112
1113             it('returns sibling parents - example 1', function() {
1114                 var doc = getDocumentFromXML('<section>Alice <span>has a cat</span></section>'),
1115                     aliceText = doc.root.contents()[0],
1116                     span = doc.root.contents()[1],
1117                     spanText = span.contents()[0];
1118
1119                 var siblingParents = doc.getSiblingParents({node1: aliceText, node2: spanText});
1120
1121                 expect(siblingParents.node1.sameNode(aliceText)).to.equal(true, 'aliceText');
1122                 expect(siblingParents.node2.sameNode(span)).to.equal(true, 'span');
1123             });
1124
1125             it('returns node itself for two same nodes', function() {
1126                 var doc = getDocumentFromXML('<section><div></div></section>'),
1127                     div = doc.root.contents()[0];
1128
1129                 var siblingParents = doc.getSiblingParents({node1: div, node2: div});
1130                 expect(!!siblingParents.node1 && !!siblingParents.node2).to.equal(true, 'nodes defined');
1131                 expect(siblingParents.node1.sameNode(div)).to.be.equal(true, 'node1');
1132                 expect(siblingParents.node2.sameNode(div)).to.be.equal(true, 'node2');
1133             });
1134         });
1135     });
1136
1137     describe('Serializing document to WLXML', function() {
1138         it('keeps document intact when no changes have been made', function() {
1139             var xmlIn = '<section>Alice<div>has</div>a <span class="uri" meta-uri="http://cat.com">cat</span>!</section>',
1140                 doc = getDocumentFromXML(xmlIn),
1141                 xmlOut = doc.toXML();
1142
1143             var parser = new DOMParser(),
1144                 input = parser.parseFromString(xmlIn, 'application/xml').childNodes[0],
1145                 output = parser.parseFromString(xmlOut, 'application/xml').childNodes[0];
1146
1147             expect(input.isEqualNode(output)).to.be.true;
1148         });
1149
1150         it('keeps entities intact', function() {
1151             var xmlIn = '<section>&lt; &gt;</section>',
1152                 doc = getDocumentFromXML(xmlIn),
1153                 xmlOut = doc.toXML();
1154             expect(xmlOut).to.equal(xmlIn);
1155         });
1156         it('keeps entities intact when they form html/xml', function() {
1157             var xmlIn = '<section>&lt;abc&gt;</section>',
1158                 doc = getDocumentFromXML(xmlIn),
1159                 xmlOut = doc.toXML();
1160             expect(xmlOut).to.equal(xmlIn);
1161         });
1162     });
1163
1164     describe('Extension API', function() {
1165         var doc, extension, elementNode, textNode;
1166
1167         beforeEach(function() {
1168             doc = getDocumentFromXML('<section>Alice<div class="test_class"></div></section>');
1169             elementNode = doc.root;
1170             textNode = doc.root.contents()[0];
1171             extension = {};
1172
1173             expect(elementNode.testTransformation).to.be.undefined;
1174             expect(textNode.testTransformation).to.be.undefined;
1175             expect(doc.testTransformation).to.be.undefined;
1176
1177             expect(doc.testMethod).to.be.undefined;
1178             expect(elementNode.testMethod).to.be.undefined;
1179             expect(textNode.testMethod).to.be.undefined;
1180             expect(elementNode.elementTestMethod).to.be.undefined;
1181             expect(textNode.textTestMethod).to.be.undefined;
1182         });
1183
1184         it('allows adding method to a document', function() {
1185             extension = {document: {methods: {
1186                 testMethod: function() { return this; }
1187             }}};
1188
1189             doc.registerExtension(extension);
1190             expect(doc.testMethod()).to.equal(doc, 'context is set to a document instance');
1191         });
1192
1193         it('allows adding transformation to a document', function() {
1194             extension = {document: {transformations: {
1195                 testTransformation: function() { return this; },
1196                 testTransformation2: {impl: function() { return this;}}
1197             }}};
1198
1199             doc.registerExtension(extension);
1200             expect(doc.testTransformation()).to.equal(doc, 'context is set to a document instance');
1201             expect(doc.testTransformation2()).to.equal(doc, 'context is set to a document instance');
1202         });
1203
1204         it('allows adding method to a DocumentNode instance', function() {
1205             extension = {
1206                 documentNode: {
1207                     methods: {
1208                         testMethod: function() { return this; }
1209                     }
1210                 },
1211                 textNode: {
1212                     methods: {
1213                         textTestMethod: function() { return this; }
1214                     }
1215                 },
1216                 elementNode: {
1217                     methods: {
1218                         elementTestMethod: function() { return this; }
1219                     }
1220                 }
1221             };
1222
1223             doc.registerExtension(extension);
1224
1225             /* refresh */
1226             elementNode = doc.root;
1227             textNode = doc.root.contents()[0];
1228
1229             expect(elementNode.testMethod().sameNode(elementNode)).to.equal(true, 'context is set to a node instance');
1230             expect(textNode.testMethod().sameNode(textNode)).to.equal(true, 'context is set to a node instance');
1231
1232             expect(elementNode.elementTestMethod().sameNode(elementNode)).to.be.true;
1233             expect(elementNode.textTestMethod).to.be.undefined;
1234
1235             expect(textNode.textTestMethod().sameNode(textNode)).to.be.true;
1236             expect(textNode.elementTestMethod).to.be.undefined;
1237         });
1238
1239         it('allows adding transformation to a DocumentNode', function() {
1240             extension = {
1241                 documentNode: {
1242                     transformations: {
1243                         testTransformation: function() { return this; },
1244                         testTransformation2: {impl: function() { return this;}}
1245                     }
1246                 },
1247                 textNode: {
1248                     transformations: {
1249                         textTestTransformation: function() { return this; }
1250                     }
1251                 },
1252                 elementNode: {
1253                     transformations: {
1254                         elementTestTransformation: function() { return this; }
1255                     }
1256                 }
1257             };
1258
1259             doc.registerExtension(extension);
1260
1261             /* refresh */
1262             elementNode = doc.root;
1263             textNode = doc.root.contents()[0];
1264
1265             expect(elementNode.testTransformation().sameNode(elementNode)).to.equal(true, '1');
1266             expect(elementNode.testTransformation2().sameNode(elementNode)).to.equal(true, '2');
1267             expect(textNode.testTransformation().sameNode(textNode)).to.equal(true, '3');
1268             expect(textNode.testTransformation2().sameNode(textNode)).to.equal(true, '4');
1269
1270             expect(elementNode.elementTestTransformation().sameNode(elementNode)).to.be.true;
1271             expect(elementNode.textTestTransformation).to.be.undefined;
1272
1273             expect(textNode.textTestTransformation().sameNode(textNode)).to.be.true;
1274             expect(textNode.elementTestTransfomation).to.be.undefined;
1275         });
1276
1277         it('allows text/element node methods and transformations to access node and transormations on document node', function() {
1278
1279             var doc = getDocumentFromXML('<div>text</div>');
1280
1281             doc.registerExtension({
1282                 documentNode: {
1283                     methods: {
1284                         test: function() {
1285                             return 'super';
1286                         }
1287                     },
1288                     transformations: {
1289                         testT: function() {
1290                             return 'super_trans';
1291                         }
1292                     }
1293                 },
1294                 elementNode: {
1295                     methods: {
1296                         test: function() {
1297                             return 'element_sub_' + this.__super__.test();
1298                         }
1299                     },
1300                     transformations: {
1301                         testT: function() {
1302                             return 'element_trans_sub_' + this.__super__.testT();
1303                         }
1304                     }
1305                 },
1306                 textNode: {
1307                     methods: {
1308                         test: function() {
1309                             return 'text_sub_' + this.__super__.test();
1310                         }
1311                     },
1312                     transformations: {
1313                         testT: function() {
1314                             return 'text_trans_sub_' + this.__super__.testT();
1315                         }
1316                     }
1317                 }
1318             });
1319
1320             var textNode = doc.root.contents()[0];
1321
1322             expect(doc.root.test()).to.equal('element_sub_super');
1323             expect(textNode.test()).to.equal('text_sub_super');
1324             expect(doc.root.testT()).to.equal('element_trans_sub_super_trans');
1325             expect(textNode.testT()).to.equal('text_trans_sub_super_trans');
1326         });
1327     });
1328
1329     describe('Undo/redo', function() {
1330
1331         it('smoke tests', function() {
1332             var doc = getDocumentFromXML('<div>Alice</div>'),
1333                 textNode = doc.root.contents()[0];
1334
1335             expect(doc.undoStack).to.have.length(0);
1336
1337             textNode.wrapWith({tagName: 'span', start:1, end:2});
1338             expect(doc.undoStack).to.have.length(1, '1');
1339             expect(doc.toXML()).to.equal('<div>A<span>l</span>ice</div>');
1340
1341             doc.undo();
1342             expect(doc.undoStack).to.have.length(0, '2');
1343             expect(doc.toXML()).to.equal('<div>Alice</div>');
1344
1345             doc.redo();
1346             expect(doc.undoStack).to.have.length(1, '3');
1347             expect(doc.toXML()).to.equal('<div>A<span>l</span>ice</div>');
1348
1349             doc.undo();
1350             expect(doc.undoStack).to.have.length(0, '4');
1351             expect(doc.toXML()).to.equal('<div>Alice</div>');
1352
1353             doc.undo();
1354             expect(doc.undoStack).to.have.length(0, '5');
1355             expect(doc.toXML()).to.equal('<div>Alice</div>');
1356         });
1357
1358         it('smoke tests 2', function() {
1359             var doc = getDocumentFromXML('<div>Alice</div>'),
1360                 textNode = doc.root.contents()[0],
1361                 path = textNode.getPath();
1362
1363             textNode.setText('Alice ');
1364             textNode.setText('Alice h');
1365             textNode.setText('Alice ha');
1366             textNode.setText('Alice has');
1367
1368             expect(textNode.getText()).to.equal('Alice has');
1369
1370             doc.undo();
1371             expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '1');
1372
1373             doc.undo();
1374             expect(doc.root.contents()[0].getText()).to.equal('Alice h', '2');
1375
1376             doc.redo();
1377             expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '3');
1378
1379             doc.redo();
1380             expect(doc.root.contents()[0].getText()).to.equal('Alice has', '4');
1381
1382             doc.undo();
1383             doc.undo();
1384             textNode = doc.getNodeByPath(path);
1385             textNode.setText('Cat');
1386             doc.undo();
1387             textNode = doc.getNodeByPath(path);
1388             expect(textNode.getText()).to.equal('Alice h');
1389         });
1390
1391
1392         var sampleMethod = function(val) {
1393             this._$.attr('x', val);
1394             this.triggerChangeEvent();
1395         };
1396
1397         var transformations = {
1398             'unaware': sampleMethod,
1399             'returning change root': {
1400                 impl: sampleMethod,
1401                 getChangeRoot: function() {
1402                     return this.context;
1403                 }
1404             },
1405             'implementing undo operation': {
1406                 impl: function(t, val) {
1407                     t.oldVal = this.getAttr('x');
1408                     sampleMethod.call(this, val);
1409                 },
1410                 undo: function(t) {
1411                     this.setAttr('x', t.oldVal);
1412                 }
1413             }
1414         };
1415
1416         _.pairs(transformations).forEach(function(pair) {
1417             var name = pair[0],
1418                 transformaton = pair[1];
1419
1420             describe(name + ' transformation: ', function() {
1421                 var doc, node, nodePath;
1422
1423                 beforeEach(function() {
1424                     doc = getDocumentFromXML('<div><test x="old"></test></div>');
1425
1426                     doc.registerExtension({elementNode: {transformations: {
1427                         test: transformaton
1428                     }}});
1429
1430                     node = doc.root.contents()[0];
1431                     nodePath = node.getPath();
1432                 });
1433
1434                 it('transforms as expected', function() {
1435                     node.test('new');
1436                     expect(node.getAttr('x')).to.equal('new');
1437                 });
1438
1439                 it('can be undone', function() {
1440                     node.test('new');
1441                     doc.undo();
1442                     node = doc.getNodeByPath(nodePath);
1443                     expect(node.getAttr('x')).to.equal('old');
1444                 });
1445
1446                 it('can be undone and then redone', function() {
1447                     node.test('new');
1448                     doc.undo();
1449                     doc.redo();
1450                     node = doc.getNodeByPath(nodePath);
1451                     expect(node.getAttr('x')).to.equal('new');
1452                 });
1453
1454                 it('handles a sample scenario', function() {
1455                     doc.root.contents()[0].test('1');
1456                     doc.root.contents()[0].test('2');
1457                     doc.root.contents()[0].test('3');
1458                     doc.root.contents()[0].test('4');
1459                     doc.root.contents()[0].test('5');
1460
1461                     expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'after initial transformations');
1462                     doc.undo();
1463                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 1.1');
1464                     doc.undo();
1465                     expect(doc.root.contents()[0].getAttr('x')).to.equal('3', 'undo 1.2');
1466                     doc.redo();
1467                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'redo 1.1');
1468                     doc.redo();
1469                     expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'redo 1.2');
1470                     doc.undo();
1471                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 2.1');
1472                     doc.root.contents()[0].test('10');
1473                     expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'additional transformation');
1474                     expect(doc.redoStack.length).to.equal(0, 'transformation cleared redo stack');
1475                     doc.redo();
1476                     expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'empty redoStack so redo was noop');
1477                     doc.undo();
1478                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undoing additional transformation');
1479                     doc.redo();
1480                     expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'redoing additional transformation');
1481                 });
1482             });
1483         });
1484
1485         it('smoke tests nested transformations', function() {
1486             var doc = getDocumentFromXML('<div></div>');
1487
1488             doc.registerExtension({elementNode: {transformations: {
1489                 nested: function(v) {
1490                     this._$.attr('innerAttr', v);
1491                     this.triggerChangeEvent();
1492                 },
1493                 outer: function(v) {
1494                     this.nested(v);
1495                     this._$.attr('outerAttr', v);
1496                     this.triggerChangeEvent();
1497                 }
1498             }}});
1499
1500             doc.root.outer('test1');
1501             doc.root.outer('test2');
1502
1503             expect(doc.root.getAttr('innerAttr')).to.equal('test2');
1504             expect(doc.root.getAttr('outerAttr')).to.equal('test2');
1505
1506             doc.undo();
1507
1508             expect(doc.root.getAttr('innerAttr')).to.equal('test1');
1509             expect(doc.root.getAttr('outerAttr')).to.equal('test1');
1510
1511             doc.undo();
1512
1513             expect(doc.root.getAttr('innerAttr')).to.equal(undefined);
1514             expect(doc.root.getAttr('outerAttr')).to.equal(undefined);
1515
1516             doc.redo();
1517
1518             expect(doc.root.getAttr('innerAttr')).to.equal('test1');
1519             expect(doc.root.getAttr('outerAttr')).to.equal('test1');
1520
1521             doc.redo();
1522
1523             expect(doc.root.getAttr('innerAttr')).to.equal('test2');
1524             expect(doc.root.getAttr('outerAttr')).to.equal('test2');
1525
1526         });
1527
1528         it('ignores transformation if document didn\'t emit change event', function() {
1529             var doc = getDocumentFromXML('<div></div>');
1530
1531             doc.registerExtension({elementNode: {transformations: {
1532                 test: function() {
1533                     // empty
1534                 }
1535             }}});
1536
1537             doc.root.test();
1538             expect(doc.undoStack.length).to.equal(0);
1539
1540         });
1541
1542         describe('Transactions', function() {
1543             it('allows to undo/redo series of transformations at once', function() {
1544                 var doc = getDocumentFromXML('<div></div>');
1545
1546                 doc.registerExtension({
1547                     elementNode: {transformations: {
1548                         test: function(v) {
1549                             this.setAttr('test', v);
1550                         }
1551                     }}
1552                 });
1553
1554                 doc.startTransaction();
1555                 doc.root.test('1');
1556                 doc.root.test('2');
1557                 doc.root.test('3');
1558                 doc.endTransaction();
1559
1560                 doc.undo();
1561                 expect(doc.root.getAttr('test'), '1');
1562                 doc.redo();
1563                 expect(doc.root.getAttr('test'), '3');
1564                 doc.undo();
1565                 expect(doc.root.getAttr('test'), '1');
1566                 doc.redo();
1567                 expect(doc.root.getAttr('test'), '3');
1568             });
1569
1570             it('ignores empty transactions', function() {
1571                 var doc = getDocumentFromXML('<div></div>');
1572                 doc.startTransaction();
1573                 doc.endTransaction();
1574                 expect(doc.undoStack).to.have.length(0, 'empty transaction doesn\'t get pushed into undo stack');
1575             });
1576
1577             it('doesn\'t break on optimizations', function() {
1578                 // This is a smoke test checking if optimizations made to transaction undoing
1579                 // doesnt't break anything.
1580                 var doc = getDocumentFromXML('<div smart="1" unaware="1"></div>');
1581
1582                 doc.registerExtension({
1583                     elementNode: {transformations: {
1584                         unaware: function(v) {
1585                             this.setAttr('unware', v);
1586                             this.triggerChangeEvent();
1587                         },
1588                         smart: {
1589                             impl: function(t, v) {
1590                                 t.oldVal = this.getAttr('smart');
1591                                 this.setAttr('smart', v);
1592                                 this.triggerChangeEvent();
1593                             },
1594                             undo: function(t) {
1595                                 this.setAttr('smart', t.oldVal);
1596                                 this.triggerChangeEvent();
1597                             }
1598                         }
1599                     }}
1600                 });
1601
1602                 doc.startTransaction();
1603                 doc.root.smart('2');
1604                 doc.root.unaware('2');
1605                 doc.root.smart('3');
1606                 doc.root.unaware('3');
1607                 doc.endTransaction();
1608
1609                 doc.undo();
1610
1611                 expect(doc.root.getAttr('smart')).to.equal('1');
1612                 expect(doc.root.getAttr('unaware')).to.equal('1');
1613             });
1614         });
1615
1616         describe('Regression tests', function() {
1617             it('redos correctly after running its own undo followed by unaware transformation undo', function() {
1618                 var doc = getDocumentFromXML('<section t="0"></section>');
1619
1620                 doc.registerExtension({elementNode: {transformations: {
1621                     unaware: function() {
1622                         this.triggerChangeEvent();
1623                     },
1624                     test: {
1625                         impl: function() {
1626                             this._$.attr('t', 1);
1627                             this.triggerChangeEvent();
1628                         },
1629                         undo: function() {
1630                             this._$.attr('t', 0);
1631                         }
1632                     }
1633                 }}});
1634                 doc.root.unaware();
1635                 doc.root.test();
1636                 doc.undo();
1637                 doc.undo();
1638                 doc.redo();
1639                 doc.redo();
1640                 expect(doc.root.getAttr('t')).to.equal('1');
1641             });
1642         });
1643     });
1644
1645 });
1646
1647 });