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('replacing node with another one', function() {
 389             it('replaces node with another one', function() {
 390                 var doc = getDocumentFromXML('<div><a></a></div>'),
 391                     a = doc.root.contents()[0];
 392
 393                 var c = a.replaceWith({tagName: 'b', attrs: {b:'1'}});
 394
 395                 expect(doc.root.contents()[0].sameNode(c));
 396                 expect(c.getTagName()).to.equal('b');
 397                 expect(c.getAttr('b')).to.equal('1');
 398             });
 399             it('can replace document root', function() {
 400                 var doc = getDocumentFromXML('<div></div>');
 401
 402                 var header = doc.root.replaceWith({tagName: 'header'});
 403
 404                 expect(doc.root.sameNode(header)).to.be.true;
 405                 expect(doc.containsNode(header)).to.be.true;
 406             });
 407         });
 408
 409         it('merges adjacent text nodes resulting from detaching an element node in between', function() {
 410             var doc = getDocumentFromXML('<div>Alice <span>has</span>a cat</div>'),
 411                 span = doc.root.contents()[1];
 412
 413             span.detach();
 414
 415             var rootContents = doc.root.contents();
 416             expect(rootContents).to.have.length(1, 'one child left');
 417             expect(rootContents[0].getText()).to.equal('Alice a cat');
 418         });
 419
 420         it('inserts node at index', function() {
 421             var doc = getDocumentFromXML('<div><a></a><b></b><c></c></div>'),
 422                 b = doc.root.contents()[1];
 423
 424             var inserted = doc.root.insertAtIndex({tagName: 'test'}, 1);
 425
 426             expect(doc.root.contents()[1].sameNode(inserted)).to.equal(true, 'inserted node returned');
 427             expect(b.getIndex()).to.equal(2, 'b node shifted right');
 428         });
 429
 430         it('appends node when inserting node at index out of range', function() {
 431             var doc = getDocumentFromXML('<div></div>');
 432
 433             var test1 = doc.root.insertAtIndex({tagName: 'test1'}, 0),
 434                 test2 = doc.root.insertAtIndex({tagName: 'test1'}, 10);
 435
 436             expect(doc.root.contents()[0].sameNode(test1)).to.equal(true, 'inserting at index 0 of empty nodes appends node');
 437             expect(doc.root.contents().length).to.equal(1, 'inserting at index out of range does nothing');
 438             expect(test2).to.equal(undefined, 'inserting at index out of range returns undefined');
 439         });
 440
 441         it('appends element node to another element node', function() {
 442             var node1 = elementNodeFromParams({tag: 'div'}),
 443                 node2 = elementNodeFromParams({tag: 'a'}),
 444                 node3 = elementNodeFromParams({tag: 'p'});
 445             node1.append(node2);
 446             node1.append(node3);
 447             expect(node1.contents()[0].sameNode(node2)).to.be.true;
 448             expect(node1.contents()[1].sameNode(node3)).to.be.true;
 449         });
 450
 451         it('prepends element node to another element node', function() {
 452             var node1 = elementNodeFromParams({tag: 'div'}),
 453                 node2 = elementNodeFromParams({tag: 'a'}),
 454                 node3 = elementNodeFromParams({tag: 'p'});
 455             node1.prepend(node2);
 456             node1.prepend(node3);
 457             expect(node1.contents()[0].sameNode(node3)).to.be.true;
 458             expect(node1.contents()[1].sameNode(node2)).to.be.true;
 459         });
 460
 461         describe('adding text nodes', function() {
 462             it('merges text nodes on append', function() {
 463                 var doc = getDocumentFromXML('<root>text1</root>'),
 464                     returned;
 465                 returned = doc.root.append({text: 'text2'});
 466                 expect(doc.root.contents().length).to.equal(1);
 467                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 468                 expect(doc.root.contents()[0].getText()).to.equal('text1text2');
 469             });
 470
 471             it('merges text nodes on prepend', function() {
 472                 var doc = getDocumentFromXML('<root>text1</root>'),
 473                     returned;
 474                 returned = doc.root.prepend({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('text2text1');
 478             });
 479
 480             it('merges text nodes on before text node', function() {
 481                 var doc = getDocumentFromXML('<root>text1</root>'),
 482                     textNode = doc.root.contents()[0],
 483                     returned;
 484                 returned = textNode.before({text: 'text2'});
 485                 expect(doc.root.contents().length).to.equal(1);
 486                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 487                 expect(doc.root.contents()[0].getText()).to.equal('text2text1');
 488             });
 489
 490             it('merges text nodes on after text node', function() {
 491                 var doc = getDocumentFromXML('<root>text1</root>'),
 492                     textNode = doc.root.contents()[0],
 493                     returned;
 494                 returned = textNode.after({text: 'text2'});
 495                 expect(doc.root.contents().length).to.equal(1);
 496                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 497                 expect(doc.root.contents()[0].getText()).to.equal('text1text2');
 498             });
 499
 500             it('merges text nodes on before element node', function() {
 501                 var doc = getDocumentFromXML('<root>text1<div></div></root>'),
 502                     textNode = doc.root.contents()[0],
 503                     div = doc.root.contents()[1],
 504                     returned;
 505                 returned = div.before({text: 'text2'});
 506                 expect(doc.root.contents().length).to.equal(2);
 507                 expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
 508                 expect(textNode.getText()).to.equal('text1text2');
 509             });
 510
 511             it('merges text nodes on after element node', function() {
 512                 var doc = getDocumentFromXML('<root><div></div>text1</root>'),
 513                     textNode = doc.root.contents()[1],
 514                     div = doc.root.contents()[0],
 515                     returned;
 516                 returned = div.after({text: 'text2'});
 517                 expect(doc.root.contents().length).to.equal(2);
 518                 expect(returned.sameNode(doc.root.contents()[1])).to.equal(true, 'modified node returned');
 519                 expect(textNode.getText()).to.equal('text2text1');
 520             });
 521         });
 522
 523         it('wraps element node with another element node', function() {
 524             var node = elementNodeFromXML('<div></div>'),
 525                 wrapper = elementNodeFromXML('<wrapper></wrapper>');
 526
 527             node.wrapWith(wrapper);
 528             expect(node.parent().sameNode(wrapper)).to.be.true;
 529         });
 530
 531         it('unwraps element node contents', function() {
 532             var node = elementNodeFromXML('<div>Alice <div>has <span>propably</span> a cat</div>!</div>'),
 533                 outerDiv = node.contents()[1];
 534
 535             outerDiv.unwrapContent();
 536
 537             expect(node.contents().length).to.equal(3);
 538             expect(node.contents()[0].getText()).to.equal('Alice has ');
 539             expect(node.contents()[1].getTagName()).to.equal('span');
 540             expect(node.contents()[2].getText()).to.equal(' a cat!');
 541         });
 542
 543         it('unwrap single element node from its parent', function() {
 544             var doc = getDocumentFromXML('<div><a><b></b></a></div>'),
 545                 div = doc.root,
 546                 a = div.contents()[0],
 547                 b = a.contents()[0];
 548
 549             var parent = b.unwrap();
 550
 551             expect(parent.sameNode(div)).to.equal(true, 'returns new parent');
 552             expect(div.contents()).to.have.length(1, 'root contains only one node');
 553             expect(div.contents()[0].sameNode(b)).to.equal(true, 'node got unwrapped');
 554         });
 555
 556         it('unwrap single text node from its parent', function() {
 557             var doc = getDocumentFromXML('<div>Some <span>text</span>!</div>'),
 558                 div = doc.root,
 559                 span = div.contents()[1],
 560                 text = span.contents()[0];
 561
 562             var parent = text.unwrap();
 563
 564             expect(parent.sameNode(div)).to.equal(true, 'returns new parent');
 565             expect(div.contents()).to.have.length(1, 'root contains only one node');
 566             expect(div.contents()[0].getText()).to.equal('Some text!');
 567         });
 568
 569         describe('Wrapping text', function() {
 570             it('wraps text spanning multiple sibling TextNodes', function() {
 571                 var section = elementNodeFromXML('<section>Alice has a <span>small</span> cat</section>'),
 572                     wrapper = section.wrapText({
 573                         _with: {tagName: 'span', attrs: {'attr1': 'value1'}},
 574                         offsetStart: 6,
 575                         offsetEnd: 4,
 576                         textNodeIdx: [0,2]
 577                     });
 578
 579                 expect(section.contents().length).to.equal(2);
 580                 expect(section.contents()[0].nodeType).to.equal(Node.TEXT_NODE);
 581                 expect(section.contents()[0].getText()).to.equal('Alice ');
 582
 583                 var wrapper2 = section.contents()[1];
 584                 expect(wrapper2.sameNode(wrapper)).to.be.true;
 585                 expect(wrapper.getTagName()).to.equal('span');
 586
 587                 var wrapperContents = wrapper.contents();
 588                 expect(wrapperContents.length).to.equal(3);
 589                 expect(wrapperContents[0].getText()).to.equal('has a ');
 590
 591                 expect(wrapperContents[1].nodeType).to.equal(Node.ELEMENT_NODE);
 592                 expect(wrapperContents[1].contents().length).to.equal(1);
 593                 expect(wrapperContents[1].contents()[0].getText()).to.equal('small');
 594             });
 595         });
 596
 597         describe('Wrapping Nodes', function() {
 598             it('wraps multiple sibling nodes', function() {
 599                 var section = elementNodeFromXML('<section>Alice<div>has</div><div>a cat</div></section>'),
 600                     aliceText = section.contents()[0],
 601                     firstDiv = section.contents()[1],
 602                     lastDiv = section.contents()[section.contents().length -1];
 603
 604                 var returned = section.document.wrapNodes({
 605                         node1: aliceText,
 606                         node2: lastDiv,
 607                         _with: {tagName: 'header'}
 608                     });
 609
 610                 var sectionContentss = section.contents(),
 611                     header = sectionContentss[0],
 612                     headerContents = header.contents();
 613
 614                 expect(sectionContentss).to.have.length(1);
 615                 expect(header.sameNode(returned)).to.equal(true, 'wrapper returned');
 616                 expect(header.parent().sameNode(section)).to.be.true;
 617                 expect(headerContents).to.have.length(3);
 618                 expect(headerContents[0].sameNode(aliceText)).to.equal(true, 'first node wrapped');
 619                 expect(headerContents[1].sameNode(firstDiv)).to.equal(true, 'second node wrapped');
 620                 expect(headerContents[2].sameNode(lastDiv)).to.equal(true, 'third node wrapped');
 621             });
 622
 623             it('wraps multiple sibling Elements - middle case', function() {
 624                 var section = elementNodeFromXML('<section><div></div><div></div><div></div><div></div></section>'),
 625                     div2 = section.contents()[1],
 626                     div3 = section.contents()[2];
 627
 628                 section.document.wrapNodes({
 629                         node1: div2,
 630                         node2: div3,
 631                         _with: {tagName: 'header'}
 632                     });
 633
 634                 var sectionContentss = section.contents(),
 635                     header = sectionContentss[1],
 636                     headerChildren = header.contents();
 637
 638                 expect(sectionContentss).to.have.length(3);
 639                 expect(headerChildren).to.have.length(2);
 640                 expect(headerChildren[0].sameNode(div2)).to.equal(true, 'first node wrapped');
 641                 expect(headerChildren[1].sameNode(div3)).to.equal(true, 'second node wrapped');
 642             });
 643         });
 644
 645     });
 646
 647     var getTextNodes = function(text, doc) {
 648         /* globals Node */
 649         var toret = [];
 650         var search = function(node) {
 651             node.contents().forEach(function(node) {
 652                 if(node.nodeType === Node.TEXT_NODE) {
 653                     if(node.getText() === text) {
 654                         toret.push(node);
 655                     }
 656                 } else {
 657                     search(node);
 658                 }
 659             });
 660         };
 661         search(doc.root);
 662         return toret;
 663     };
 664
 665     var getTextNode = function(text, doc) {
 666         var nodes = getTextNodes(text, doc),
 667             error;
 668         if(nodes.length === 0) {
 669             error = 'Text not found';
 670         } else if(nodes.length > 1) {
 671             error = 'Text not unique';
 672         } else if(nodes[0].getText() !== text) {
 673             error = 'I was trying to cheat your test :(';
 674         }
 675         if(error) {
 676             throw new Error(error);
 677         }
 678         return nodes[0];
 679     };
 680
 681     describe('Removing arbitrary text', function() {
 682         it('removes within single text element', function() {
 683             var doc = getDocumentFromXML('<div>Alice</div>'),
 684                 text = getTextNode('Alice', doc);
 685             doc.deleteText({
 686                 from: {
 687                     node: text,
 688                     offset: 1
 689                 },
 690                 to: {
 691                     node: text,
 692                     offset: 4
 693                 }
 694             });
 695             expect(doc.root.contents().length).to.equal(1);
 696             expect(doc.root.contents()[0].getText()).to.equal('Ae');
 697         });
 698         it('removes across elements - 1', function() {
 699             var doc = getDocumentFromXML('<div><a>aaa</a><b>bbb</b></div>');
 700
 701             doc.deleteText({
 702                 from: {
 703                     node: getTextNode('aaa', doc),
 704                     offset: 2
 705                 },
 706                 to: {
 707                     node: getTextNode('bbb', doc),
 708                     offset: 2
 709                 }
 710             });
 711
 712             var contents = doc.root.contents();
 713             expect(contents.length).to.equal(2);
 714             expect(contents[0].contents()[0].getText()).to.equal('aa');
 715             expect(contents[1].contents()[0].getText()).to.equal('b');
 716         });
 717         it('removes across elements - 2', function() {
 718             var doc = getDocumentFromXML('<a><b><c>ccc</c></b>xxx</a>');
 719             doc.deleteText({
 720                 from: {
 721                     node: getTextNode('ccc', doc),
 722                     offset: 2
 723                 },
 724                 to: {
 725                     node: getTextNode('xxx', doc),
 726                     offset: 2
 727                 }
 728             });
 729
 730             var contents = doc.root.contents();
 731             expect(contents.length).to.equal(2);
 732             expect(contents[0].getTagName()).to.equal('b');
 733             expect(contents[1].getText()).to.equal('x');
 734
 735             var bContents = contents[0].contents();
 736             expect(bContents.length).to.equal(1);
 737             expect(bContents[0].getTagName()).to.equal('c');
 738             expect(bContents[0].contents().length).to.equal(1);
 739             expect(bContents[0].contents()[0].getText()).to.equal('cc');
 740         });
 741         it('remove across elements - 3 (merged text nodes)', function() {
 742             var doc = getDocumentFromXML('<div>Alice <span>has</span> a cat</div>');
 743             doc.deleteText({
 744                 from: {
 745                     node: getTextNode('Alice ', doc),
 746                     offset: 1
 747                 },
 748                 to: {
 749                     node: getTextNode(' a cat', doc),
 750                     offset: 3
 751                 }
 752             });
 753             var contents = doc.root.contents();
 754             expect(contents.length).to.equal(1);
 755             expect(contents[0].getText()).to.equal('Acat');
 756         });
 757         it('remove across elements - 4', function() {
 758             var doc = getDocumentFromXML('<div>Alice <div>has <span>a</span> cat</div></div>');
 759             doc.deleteText({
 760                 from: {
 761                     node: getTextNode('Alice ', doc),
 762                     offset: 1
 763                 },
 764                 to: {
 765                     node: getTextNode(' cat', doc),
 766                     offset: 1
 767                 }
 768             });
 769             var contents = doc.root.contents();
 770             expect(contents.length).to.equal(2);
 771             expect(contents[0].getText()).to.equal('A');
 772             expect(contents[1].getTagName()).to.equal('div');
 773             expect(contents[1].contents().length).to.equal(1);
 774             expect(contents[1].contents()[0].getText()).to.equal('cat');
 775         });
 776         it('removes nodes in between', function() {
 777             var doc = getDocumentFromXML('<div><a>aaa<x>!</x></a>xxx<x></x><b><x>!</x>bbb</b></div>');
 778             doc.deleteText({
 779                 from: {
 780                     node: getTextNode('aaa', doc),
 781                     offset: 2
 782                 },
 783                 to: {
 784                     node: getTextNode('bbb', doc),
 785                     offset: 2
 786                 }
 787             });
 788
 789             var contents = doc.root.contents();
 790             expect(contents.length).to.equal(2, 'two nodes survived');
 791             expect(contents[0].getTagName()).to.equal('a');
 792             expect(contents[1].getTagName()).to.equal('b');
 793             expect(contents[0].contents().length).to.equal(1);
 794             expect(contents[0].contents()[0].getText()).to.equal('aa');
 795             expect(contents[1].contents().length).to.equal(1);
 796             expect(contents[1].contents()[0].getText()).to.equal('b');
 797         });
 798     });
 799
 800     describe('Splitting text', function() {
 801
 802         it('splits TextNode\'s parent into two ElementNodes', function() {
 803             var doc = getDocumentFromXML('<section><header>Some header</header></section>'),
 804                 section = doc.root,
 805                 text = section.contents()[0].contents()[0];
 806
 807             var returnedValue = text.split({offset: 5});
 808             expect(section.contents().length).to.equal(2, 'section has two children');
 809
 810             var header1 = section.contents()[0];
 811             var header2 = section.contents()[1];
 812
 813             expect(header1.getTagName()).to.equal('header', 'first section child ok');
 814             expect(header1.contents().length).to.equal(1, 'first header has one child');
 815             expect(header1.contents()[0].getText()).to.equal('Some ', 'first header has correct content');
 816             expect(header2.getTagName()).to.equal('header', 'second section child ok');
 817             expect(header2.contents().length).to.equal(1, 'second header has one child');
 818             expect(header2.contents()[0].getText()).to.equal('header', 'second header has correct content');
 819
 820             expect(returnedValue.first.sameNode(header1)).to.equal(true, 'first node returned');
 821             expect(returnedValue.second.sameNode(header2)).to.equal(true, 'second node returned');
 822         });
 823
 824         it('leaves empty copy of ElementNode if splitting at the very beginning', function() {
 825                 var doc = getDocumentFromXML('<section><header>Some header</header></section>'),
 826                 section = doc.root,
 827                 text = section.contents()[0].contents()[0];
 828
 829                 text.split({offset: 0});
 830
 831                 var header1 = section.contents()[0];
 832                 var header2 = section.contents()[1];
 833
 834                 expect(header1.contents().length).to.equal(0);
 835                 expect(header2.contents()[0].getText()).to.equal('Some header');
 836         });
 837
 838         it('leaves empty copy of ElementNode if splitting at the very end', function() {
 839                 var doc = getDocumentFromXML('<section><header>Some header</header></section>'),
 840                 section = doc.root,
 841                 text = section.contents()[0].contents()[0];
 842
 843                 text.split({offset: 11});
 844
 845                 var header1 = section.contents()[0];
 846                 var header2 = section.contents()[1];
 847
 848                 expect(header1.contents()[0].getText()).to.equal('Some header');
 849                 expect(header2.contents().length).to.equal(0);
 850         });
 851
 852         it('keeps TextNodes\'s parent\'s children elements intact', function() {
 853             var doc = getDocumentFromXML('<section><header>A <span>fancy</span> and <span>nice</span> header</header></section>'),
 854                 section = doc.root,
 855                 header = section.contents()[0],
 856                 textAnd = header.contents()[2];
 857
 858             textAnd.split({offset: 2});
 859
 860             var sectionContents = section.contents();
 861             expect(sectionContents.length).to.equal(2, 'Section has two children');
 862             expect(sectionContents[0].getTagName()).to.equal('header', 'First section node is a header');
 863             expect(sectionContents[1].getTagName()).to.equal('header', 'Second section node is a header');
 864
 865             var firstHeaderContents = sectionContents[0].contents();
 866             expect(firstHeaderContents.length).to.equal(3, 'First header has three children');
 867             expect(firstHeaderContents[0].getText()).to.equal('A ', 'First header starts with a text');
 868             expect(firstHeaderContents[1].getTagName()).to.equal('span', 'First header has span in the middle');
 869             expect(firstHeaderContents[2].getText()).to.equal(' a', 'First header ends with text');
 870
 871             var secondHeaderContents = sectionContents[1].contents();
 872             expect(secondHeaderContents.length).to.equal(3, 'Second header has three children');
 873             expect(secondHeaderContents[0].getText()).to.equal('nd ', 'Second header starts with text');
 874             expect(secondHeaderContents[1].getTagName()).to.equal('span', 'Second header has span in the middle');
 875             expect(secondHeaderContents[2].getText()).to.equal(' header', 'Second header ends with text');
 876         });
 877     });
 878
 879     describe('Events', function() {
 880         it('emits nodeDetached event on node detach', function() {
 881             var node = elementNodeFromXML('<div><div></div></div>'),
 882                 innerNode = node.contents()[0],
 883                 spy = sinon.spy();
 884             node.document.on('change', spy);
 885
 886             var detached = innerNode.detach(),
 887                 event = spy.args[0][0];
 888
 889             expect(event.type).to.equal('nodeDetached');
 890             expect(event.meta.node.sameNode(detached, 'detached node in event meta'));
 891             expect(event.meta.parent.sameNode(node), 'original parent node in event meta');
 892         }),
 893
 894         it('emits nodeAdded event when appending new node', function() {
 895             var node = elementNodeFromXML('<div></div>'),
 896                 spy = sinon.spy();
 897             node.document.on('change', spy);
 898
 899             var appended = node.append({tagName:'div'}),
 900                 event = spy.args[0][0];
 901             expect(event.type).to.equal('nodeAdded');
 902             expect(event.meta.node.sameNode(appended)).to.be.true;
 903         });
 904
 905         it('emits nodeMoved when appending aready existing node', function() {
 906             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 907                 a = node.contents()[0],
 908                 b = node.contents()[1],
 909                 spy = sinon.spy();
 910             node.document.on('change', spy);
 911
 912             var appended = a.append(b),
 913                 event = spy.args[0][0];
 914
 915             expect(spy.callCount).to.equal(1);
 916             expect(event.type).to.equal('nodeMoved');
 917             expect(event.meta.node.sameNode(appended)).to.be.true;
 918         });
 919
 920         it('emits nodeAdded event when prepending new node', function() {
 921             var node = elementNodeFromXML('<div></div>'),
 922                 spy = sinon.spy();
 923             node.document.on('change', spy);
 924
 925             var prepended = node.prepend({tagName:'div'}),
 926                 event = spy.args[0][0];
 927             expect(event.type).to.equal('nodeAdded');
 928             expect(event.meta.node.sameNode(prepended)).to.be.true;
 929         });
 930
 931         it('emits nodeMoved when prepending 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 prepended = a.prepend(b),
 939                 event = spy.args[0][0];
 940             expect(spy.callCount).to.equal(1);
 941             expect(event.type).to.equal('nodeMoved');
 942             expect(event.meta.node.sameNode(prepended)).to.be.true;
 943         });
 944
 945         it('emits nodeAdded event when inserting node after another', function() {
 946             var node = elementNodeFromXML('<div><a></a></div>').contents()[0],
 947                 spy = sinon.spy();
 948             node.document.on('change', spy);
 949
 950             var inserted = node.after({tagName:'div'}),
 951                 event = spy.args[0][0];
 952             expect(event.type).to.equal('nodeAdded');
 953             expect(event.meta.node.sameNode(inserted)).to.be.true;
 954         });
 955
 956         it('emits nodeMoved when inserting aready existing node after another', function() {
 957             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 958                 a = node.contents()[0],
 959                 b = node.contents()[1],
 960                 spy = sinon.spy();
 961             node.document.on('change', spy);
 962             var inserted = b.after(a),
 963                 event = spy.args[0][0];
 964
 965             expect(spy.callCount).to.equal(1);
 966             expect(event.type).to.equal('nodeMoved');
 967             expect(event.meta.node.sameNode(inserted)).to.be.true;
 968         });
 969
 970         it('emits nodeAdded event when inserting node before another', function() {
 971             var node = elementNodeFromXML('<div><a></a></div>').contents()[0],
 972                 spy = sinon.spy();
 973             node.document.on('change', spy);
 974
 975             var inserted = node.before({tagName:'div'}),
 976                 event = spy.args[0][0];
 977             expect(event.type).to.equal('nodeAdded');
 978             expect(event.meta.node.sameNode(inserted)).to.be.true;
 979         });
 980
 981         it('emits nodeAdded when inserting aready existing node before another', function() {
 982             var node = elementNodeFromXML('<div><a></a><b></b></div>'),
 983                 a = node.contents()[0],
 984                 b = node.contents()[1],
 985                 spy = sinon.spy();
 986             node.document.on('change', spy);
 987             var inserted = a.before(b),
 988                 event = spy.args[0][0];
 989
 990             expect(spy.callCount).to.equal(1);
 991             expect(event.type).to.equal('nodeMoved');
 992             expect(event.meta.node.sameNode(inserted)).to.be.true;
 993         });
 994
 995         it('emits nodeDetached and nodeAdded when replacing root node with another', function() {
 996             var doc = getDocumentFromXML('<a></a>'),
 997                 oldRoot = doc.root,
 998                 spy = sinon.spy();
 999
1000             doc.on('change', spy);
1001
1002             doc.root.replaceWith({tagName: 'b'});
1003
1004             expect(spy.callCount).to.equal(2);
1005
1006             var event1 = spy.args[0][0],
1007                 event2 = spy.args[1][0];
1008
1009             expect(event1.type).to.equal('nodeDetached');
1010             expect(event1.meta.node.sameNode(oldRoot)).to.equal(true, 'root node in nodeDetached event metadata');
1011             expect(event2.type).to.equal('nodeAdded');
1012             expect(event2.meta.node.sameNode(doc.root)).to.equal(true, 'new root node in nodelAdded event meta');
1013         });
1014
1015
1016         ['append', 'prepend', 'before', 'after'].forEach(function(insertionMethod) {
1017             it('emits nodeDetached for node moved from a document tree to out of document node ' + insertionMethod, function() {
1018                 var doc = getDocumentFromXML('<div><a></a></div>'),
1019                     a = doc.root.contents()[0],
1020                     spy = sinon.spy();
1021
1022                 doc.on('change', spy);
1023
1024                 var newNode = doc.createDocumentNode({tagName: 'b'}),
1025                     newNodeInner = newNode.append({tagName:'c'});
1026
1027                 newNodeInner[insertionMethod](a);
1028
1029                 var event = spy.args[0][0];
1030                 expect(event.type).to.equal('nodeDetached');
1031                 expect(event.meta.node.sameNode(a));
1032             });
1033
1034             it('doesn\'t emit nodeDetached event for already out of document node moved to out of document node' + insertionMethod, function() {
1035                 var doc = getDocumentFromXML('<div><a></a></div>'),
1036                     spy = sinon.spy();
1037
1038                 doc.on('change', spy);
1039
1040                 var newNode = doc.createDocumentNode({tagName: 'b'});
1041                 newNode.append({tagName:'c'});
1042
1043                 expect(spy.callCount).to.equal(0);
1044             });
1045         });
1046
1047
1048     });
1049
1050     describe('Traversing', function() {
1051         describe('Basic', function() {
1052             it('can access node parent', function() {
1053                 var doc = getDocumentFromXML('<a><b></b></a>'),
1054                     a = doc.root,
1055                     b = a.contents()[0];
1056
1057                 expect(a.parent()).to.equal(null, 'parent of a root is null');
1058                 expect(b.parent().sameNode(a)).to.be.true;
1059             });
1060             it('can access node parents', function() {
1061                 var doc = getDocumentFromXML('<a><b><c></c></b></a>'),
1062                     a = doc.root,
1063                     b = a.contents()[0],
1064                     c = b.contents()[0];
1065
1066                 var parents = c.parents();
1067                 // @@
1068                 expect(parents[0].sameNode(b)).to.be.true;
1069                 expect(parents[1].sameNode(a)).to.be.true;
1070             });
1071         });
1072
1073         describe('finding sibling parents of two elements', function() {
1074             it('returns elements themself if they have direct common parent', function() {
1075                 var doc = getDocumentFromXML('<section><div><div>A</div><div>B</div></div></section>'),
1076                     wrappingDiv = doc.root.contents()[0],
1077                     divA = wrappingDiv.contents()[0],
1078                     divB = wrappingDiv.contents()[1];
1079
1080                 var siblingParents = doc.getSiblingParents({node1: divA, node2: divB});
1081
1082                 expect(siblingParents.node1.sameNode(divA)).to.equal(true, 'divA');
1083                 expect(siblingParents.node2.sameNode(divB)).to.equal(true, 'divB');
1084             });
1085
1086             it('returns sibling parents - example 1', function() {
1087                 var doc = getDocumentFromXML('<section>Alice <span>has a cat</span></section>'),
1088                     aliceText = doc.root.contents()[0],
1089                     span = doc.root.contents()[1],
1090                     spanText = span.contents()[0];
1091
1092                 var siblingParents = doc.getSiblingParents({node1: aliceText, node2: spanText});
1093
1094                 expect(siblingParents.node1.sameNode(aliceText)).to.equal(true, 'aliceText');
1095                 expect(siblingParents.node2.sameNode(span)).to.equal(true, 'span');
1096             });
1097         });
1098     });
1099
1100     describe('Serializing document to WLXML', function() {
1101         it('keeps document intact when no changes have been made', function() {
1102             var xmlIn = '<section>Alice<div>has</div>a <span class="uri" meta-uri="http://cat.com">cat</span>!</section>',
1103                 doc = getDocumentFromXML(xmlIn),
1104                 xmlOut = doc.toXML();
1105
1106             var parser = new DOMParser(),
1107                 input = parser.parseFromString(xmlIn, 'application/xml').childNodes[0],
1108                 output = parser.parseFromString(xmlOut, 'application/xml').childNodes[0];
1109
1110             expect(input.isEqualNode(output)).to.be.true;
1111         });
1112
1113         it('keeps entities intact', function() {
1114             var xmlIn = '<section>&lt; &gt;</section>',
1115                 doc = getDocumentFromXML(xmlIn),
1116                 xmlOut = doc.toXML();
1117             expect(xmlOut).to.equal(xmlIn);
1118         });
1119         it('keeps entities intact when they form html/xml', function() {
1120             var xmlIn = '<section>&lt;abc&gt;</section>',
1121                 doc = getDocumentFromXML(xmlIn),
1122                 xmlOut = doc.toXML();
1123             expect(xmlOut).to.equal(xmlIn);
1124         });
1125     });
1126
1127     describe('Extension API', function() {
1128         var doc, extension, elementNode, textNode;
1129
1130         beforeEach(function() {
1131             doc = getDocumentFromXML('<section>Alice<div class="test_class"></div></section>');
1132             elementNode = doc.root;
1133             textNode = doc.root.contents()[0];
1134             extension = {};
1135
1136             expect(elementNode.testTransformation).to.be.undefined;
1137             expect(textNode.testTransformation).to.be.undefined;
1138             expect(doc.testTransformation).to.be.undefined;
1139
1140             expect(doc.testMethod).to.be.undefined;
1141             expect(elementNode.testMethod).to.be.undefined;
1142             expect(textNode.testMethod).to.be.undefined;
1143             expect(elementNode.elementTestMethod).to.be.undefined;
1144             expect(textNode.textTestMethod).to.be.undefined;
1145         });
1146
1147         it('allows adding method to a document', function() {
1148             extension = {document: {methods: {
1149                 testMethod: function() { return this; }
1150             }}};
1151
1152             doc.registerExtension(extension);
1153             expect(doc.testMethod()).to.equal(doc, 'context is set to a document instance');
1154         });
1155
1156         it('allows adding transformation to a document', function() {
1157             extension = {document: {transformations: {
1158                 testTransformation: function() { return this; },
1159                 testTransformation2: {impl: function() { return this;}}
1160             }}};
1161
1162             doc.registerExtension(extension);
1163             expect(doc.testTransformation()).to.equal(doc, 'context is set to a document instance');
1164             expect(doc.testTransformation2()).to.equal(doc, 'context is set to a document instance');
1165         });
1166
1167         it('allows adding method to a DocumentNode instance', function() {
1168             extension = {
1169                 documentNode: {
1170                     methods: {
1171                         testMethod: function() { return this; }
1172                     }
1173                 },
1174                 textNode: {
1175                     methods: {
1176                         textTestMethod: function() { return this; }
1177                     }
1178                 },
1179                 elementNode: {
1180                     methods: {
1181                         elementTestMethod: function() { return this; }
1182                     }
1183                 }
1184             };
1185
1186             doc.registerExtension(extension);
1187
1188             /* refresh */
1189             elementNode = doc.root;
1190             textNode = doc.root.contents()[0];
1191
1192             expect(elementNode.testMethod().sameNode(elementNode)).to.equal(true, 'context is set to a node instance');
1193             expect(textNode.testMethod().sameNode(textNode)).to.equal(true, 'context is set to a node instance');
1194
1195             expect(elementNode.elementTestMethod().sameNode(elementNode)).to.be.true;
1196             expect(elementNode.textTestMethod).to.be.undefined;
1197
1198             expect(textNode.textTestMethod().sameNode(textNode)).to.be.true;
1199             expect(textNode.elementTestMethod).to.be.undefined;
1200         });
1201
1202         it('allows adding transformation to a DocumentNode', function() {
1203             extension = {
1204                 documentNode: {
1205                     transformations: {
1206                         testTransformation: function() { return this; },
1207                         testTransformation2: {impl: function() { return this;}}
1208                     }
1209                 },
1210                 textNode: {
1211                     transformations: {
1212                         textTestTransformation: function() { return this; }
1213                     }
1214                 },
1215                 elementNode: {
1216                     transformations: {
1217                         elementTestTransformation: function() { return this; }
1218                     }
1219                 }
1220             };
1221
1222             doc.registerExtension(extension);
1223
1224             /* refresh */
1225             elementNode = doc.root;
1226             textNode = doc.root.contents()[0];
1227
1228             expect(elementNode.testTransformation().sameNode(elementNode)).to.equal(true, '1');
1229             expect(elementNode.testTransformation2().sameNode(elementNode)).to.equal(true, '2');
1230             expect(textNode.testTransformation().sameNode(textNode)).to.equal(true, '3');
1231             expect(textNode.testTransformation2().sameNode(textNode)).to.equal(true, '4');
1232
1233             expect(elementNode.elementTestTransformation().sameNode(elementNode)).to.be.true;
1234             expect(elementNode.textTestTransformation).to.be.undefined;
1235
1236             expect(textNode.textTestTransformation().sameNode(textNode)).to.be.true;
1237             expect(textNode.elementTestTransfomation).to.be.undefined;
1238         });
1239
1240         it('allows text/element node methods and transformations to access node and transormations on document node', function() {
1241
1242             var doc = getDocumentFromXML('<div>text</div>');
1243
1244             doc.registerExtension({
1245                 documentNode: {
1246                     methods: {
1247                         test: function() {
1248                             return 'super';
1249                         }
1250                     },
1251                     transformations: {
1252                         testT: function() {
1253                             return 'super_trans';
1254                         }
1255                     }
1256                 },
1257                 elementNode: {
1258                     methods: {
1259                         test: function() {
1260                             return 'element_sub_' + this.__super__.test();
1261                         }
1262                     },
1263                     transformations: {
1264                         testT: function() {
1265                             return 'element_trans_sub_' + this.__super__.testT();
1266                         }
1267                     }
1268                 },
1269                 textNode: {
1270                     methods: {
1271                         test: function() {
1272                             return 'text_sub_' + this.__super__.test();
1273                         }
1274                     },
1275                     transformations: {
1276                         testT: function() {
1277                             return 'text_trans_sub_' + this.__super__.testT();
1278                         }
1279                     }
1280                 }
1281             });
1282
1283             var textNode = doc.root.contents()[0];
1284
1285             expect(doc.root.test()).to.equal('element_sub_super');
1286             expect(textNode.test()).to.equal('text_sub_super');
1287             expect(doc.root.testT()).to.equal('element_trans_sub_super_trans');
1288             expect(textNode.testT()).to.equal('text_trans_sub_super_trans');
1289         });
1290     });
1291
1292     describe('Undo/redo', function() {
1293
1294         it('smoke tests', function() {
1295             var doc = getDocumentFromXML('<div>Alice</div>'),
1296                 textNode = doc.root.contents()[0];
1297
1298             expect(doc.undoStack).to.have.length(0);
1299
1300             textNode.wrapWith({tagName: 'span', start:1, end:2});
1301             expect(doc.undoStack).to.have.length(1, '1');
1302             expect(doc.toXML()).to.equal('<div>A<span>l</span>ice</div>');
1303
1304             doc.undo();
1305             expect(doc.undoStack).to.have.length(0, '2');
1306             expect(doc.toXML()).to.equal('<div>Alice</div>');
1307
1308             doc.redo();
1309             expect(doc.undoStack).to.have.length(1, '3');
1310             expect(doc.toXML()).to.equal('<div>A<span>l</span>ice</div>');
1311
1312             doc.undo();
1313             expect(doc.undoStack).to.have.length(0, '4');
1314             expect(doc.toXML()).to.equal('<div>Alice</div>');
1315
1316             doc.undo();
1317             expect(doc.undoStack).to.have.length(0, '5');
1318             expect(doc.toXML()).to.equal('<div>Alice</div>');
1319         });
1320
1321         it('smoke tests 2', function() {
1322             var doc = getDocumentFromXML('<div>Alice</div>'),
1323                 textNode = doc.root.contents()[0],
1324                 path = textNode.getPath();
1325
1326             textNode.setText('Alice ');
1327             textNode.setText('Alice h');
1328             textNode.setText('Alice ha');
1329             textNode.setText('Alice has');
1330
1331             expect(textNode.getText()).to.equal('Alice has');
1332
1333             doc.undo();
1334             expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '1');
1335
1336             doc.undo();
1337             expect(doc.root.contents()[0].getText()).to.equal('Alice h', '2');
1338
1339             doc.redo();
1340             expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '3');
1341
1342             doc.redo();
1343             expect(doc.root.contents()[0].getText()).to.equal('Alice has', '4');
1344
1345             doc.undo();
1346             doc.undo();
1347             textNode = doc.getNodeByPath(path);
1348             textNode.setText('Cat');
1349             doc.undo();
1350             textNode = doc.getNodeByPath(path);
1351             expect(textNode.getText()).to.equal('Alice h');
1352         });
1353
1354
1355         var sampleMethod = function(val) {
1356             this._$.attr('x', val);
1357             this.triggerChangeEvent();
1358         };
1359
1360         var transformations = {
1361             'unaware': sampleMethod,
1362             'returning change root': {
1363                 impl: sampleMethod,
1364                 getChangeRoot: function() {
1365                     return this.context;
1366                 }
1367             },
1368             'implementing undo operation': {
1369                 impl: function(t, val) {
1370                     t.oldVal = this.getAttr('x');
1371                     sampleMethod.call(this, val);
1372                 },
1373                 undo: function(t) {
1374                     this.setAttr('x', t.oldVal);
1375                 }
1376             }
1377         };
1378
1379         _.pairs(transformations).forEach(function(pair) {
1380             var name = pair[0],
1381                 transformaton = pair[1];
1382
1383             describe(name + ' transformation: ', function() {
1384                 var doc, node, nodePath;
1385
1386                 beforeEach(function() {
1387                     doc = getDocumentFromXML('<div><test x="old"></test></div>');
1388
1389                     doc.registerExtension({elementNode: {transformations: {
1390                         test: transformaton
1391                     }}});
1392
1393                     node = doc.root.contents()[0];
1394                     nodePath = node.getPath();
1395                 });
1396
1397                 it('transforms as expected', function() {
1398                     node.test('new');
1399                     expect(node.getAttr('x')).to.equal('new');
1400                 });
1401
1402                 it('can be undone', function() {
1403                     node.test('new');
1404                     doc.undo();
1405                     node = doc.getNodeByPath(nodePath);
1406                     expect(node.getAttr('x')).to.equal('old');
1407                 });
1408
1409                 it('can be undone and then redone', function() {
1410                     node.test('new');
1411                     doc.undo();
1412                     doc.redo();
1413                     node = doc.getNodeByPath(nodePath);
1414                     expect(node.getAttr('x')).to.equal('new');
1415                 });
1416
1417                 it('handles a sample scenario', function() {
1418                     doc.root.contents()[0].test('1');
1419                     doc.root.contents()[0].test('2');
1420                     doc.root.contents()[0].test('3');
1421                     doc.root.contents()[0].test('4');
1422                     doc.root.contents()[0].test('5');
1423
1424                     expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'after initial transformations');
1425                     doc.undo();
1426                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 1.1');
1427                     doc.undo();
1428                     expect(doc.root.contents()[0].getAttr('x')).to.equal('3', 'undo 1.2');
1429                     doc.redo();
1430                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'redo 1.1');
1431                     doc.redo();
1432                     expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'redo 1.2');
1433                     doc.undo();
1434                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 2.1');
1435                     doc.root.contents()[0].test('10');
1436                     expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'additional transformation');
1437                     expect(doc.redoStack.length).to.equal(0, 'transformation cleared redo stack');
1438                     doc.redo();
1439                     expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'empty redoStack so redo was noop');
1440                     doc.undo();
1441                     expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undoing additional transformation');
1442                     doc.redo();
1443                     expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'redoing additional transformation');
1444                 });
1445             });
1446         });
1447
1448         it('smoke tests nested transformations', function() {
1449             var doc = getDocumentFromXML('<div></div>');
1450
1451             doc.registerExtension({elementNode: {transformations: {
1452                 nested: function(v) {
1453                     this._$.attr('innerAttr', v);
1454                     this.triggerChangeEvent();
1455                 },
1456                 outer: function(v) {
1457                     this.nested(v);
1458                     this._$.attr('outerAttr', v);
1459                     this.triggerChangeEvent();
1460                 }
1461             }}});
1462
1463             doc.root.outer('test1');
1464             doc.root.outer('test2');
1465
1466             expect(doc.root.getAttr('innerAttr')).to.equal('test2');
1467             expect(doc.root.getAttr('outerAttr')).to.equal('test2');
1468
1469             doc.undo();
1470
1471             expect(doc.root.getAttr('innerAttr')).to.equal('test1');
1472             expect(doc.root.getAttr('outerAttr')).to.equal('test1');
1473
1474             doc.undo();
1475
1476             expect(doc.root.getAttr('innerAttr')).to.equal(undefined);
1477             expect(doc.root.getAttr('outerAttr')).to.equal(undefined);
1478
1479             doc.redo();
1480
1481             expect(doc.root.getAttr('innerAttr')).to.equal('test1');
1482             expect(doc.root.getAttr('outerAttr')).to.equal('test1');
1483
1484             doc.redo();
1485
1486             expect(doc.root.getAttr('innerAttr')).to.equal('test2');
1487             expect(doc.root.getAttr('outerAttr')).to.equal('test2');
1488
1489         });
1490
1491         it('ignores transformation if document didn\'t emit change event', function() {
1492             var doc = getDocumentFromXML('<div></div>');
1493
1494             doc.registerExtension({elementNode: {transformations: {
1495                 test: function() {
1496                     // empty
1497                 }
1498             }}});
1499
1500             doc.root.test();
1501             expect(doc.undoStack.length).to.equal(0);
1502
1503         });
1504
1505         describe('Transactions', function() {
1506             it('allows to undo/redo series of transformations at once', function() {
1507                 var doc = getDocumentFromXML('<div></div>');
1508
1509                 doc.registerExtension({
1510                     elementNode: {transformations: {
1511                         test: function(v) {
1512                             this.setAttr('test', v);
1513                         }
1514                     }}
1515                 });
1516
1517                 doc.startTransaction();
1518                 doc.root.test('1');
1519                 doc.root.test('2');
1520                 doc.root.test('3');
1521                 doc.endTransaction();
1522
1523                 doc.undo();
1524                 expect(doc.root.getAttr('test'), '1');
1525                 doc.redo();
1526                 expect(doc.root.getAttr('test'), '3');
1527                 doc.undo();
1528                 expect(doc.root.getAttr('test'), '1');
1529                 doc.redo();
1530                 expect(doc.root.getAttr('test'), '3');
1531             });
1532
1533             it('ignores empty transactions', function() {
1534                 var doc = getDocumentFromXML('<div></div>');
1535                 doc.startTransaction();
1536                 doc.endTransaction();
1537                 expect(doc.undoStack).to.have.length(0, 'empty transaction doesn\'t get pushed into undo stack');
1538             });
1539
1540             it('doesn\'t break on optimizations', function() {
1541                 // This is a smoke test checking if optimizations made to transaction undoing
1542                 // doesnt't break anything.
1543                 var doc = getDocumentFromXML('<div smart="1" unaware="1"></div>');
1544
1545                 doc.registerExtension({
1546                     elementNode: {transformations: {
1547                         unaware: function(v) {
1548                             this.setAttr('unware', v);
1549                             this.triggerChangeEvent();
1550                         },
1551                         smart: {
1552                             impl: function(t, v) {
1553                                 t.oldVal = this.getAttr('smart');
1554                                 this.setAttr('smart', v);
1555                                 this.triggerChangeEvent();
1556                             },
1557                             undo: function(t) {
1558                                 this.setAttr('smart', t.oldVal);
1559                                 this.triggerChangeEvent();
1560                             }
1561                         }
1562                     }}
1563                 });
1564
1565                 doc.startTransaction();
1566                 doc.root.smart('2');
1567                 doc.root.unaware('2');
1568                 doc.root.smart('3');
1569                 doc.root.unaware('3');
1570                 doc.endTransaction();
1571
1572                 doc.undo();
1573
1574                 expect(doc.root.getAttr('smart')).to.equal('1');
1575                 expect(doc.root.getAttr('unaware')).to.equal('1');
1576             });
1577         });
1578     });
1579
1580 });
1581
1582 });