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