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