f64754fd31d44b9c600a7720cc920a33e167ec95
[fnpeditor.git] / src / editor / modules / documentCanvas / canvas / canvas.test.js
1 define([
2 'libs/jquery',
3 'libs/chai',
4 'libs/sinon',
5 'modules/documentCanvas/canvas/canvas',
6 'modules/documentCanvas/canvas/utils',
7 'modules/documentCanvas/canvas/documentElement',
8 'wlxml/wlxml',
9 ], function($, chai, sinon, canvas, utils, documentElement, wlxml) {
10     
11 'use strict';
12 /* global describe, it, beforeEach, afterEach */
13
14 var expect = chai.expect;
15
16 var getCanvasFromXML = function(xml, elements) {
17     return canvas.fromXMLDocument(getDocumentFromXML(xml), elements);
18 };
19
20 var getDocumentFromXML = function(xml) {
21     return wlxml.WLXMLDocumentFromXML(xml);
22 };
23
24 var wait = function(callback, timeout) {
25     /* globals window */
26     return window.setTimeout(callback, timeout || 0.5);
27 };
28
29
30 describe('wtf', function() {
31     it('wtf!', function() {
32         var c = getCanvasFromXML('<section>Alice</section>'),
33             doc = c.wlxmlDocument;
34
35         var txtNode = doc.root.contents()[0];
36         txtNode.wrapWith({tagName: 'header', start: 1, end: 2});
37         expect(c.doc().children().length).to.equal(3);
38     });
39 });
40
41 describe('new Canvas', function() {
42     it('abc', function() {
43         var doc = wlxml.WLXMLDocumentFromXML('<section>Alice <span>has</span> a cat!</div>'),
44             c = canvas.fromXMLDocument(doc);
45
46         expect(c.doc().children()).to.have.length(3);
47         expect(c.doc().children()[0].canvas).to.equal(c);
48         expect(c.doc().children()[0].wlxmlNode.sameNode(doc.root));
49     });
50 });
51
52 describe('Handling empty text nodes', function() {
53     it('puts zero width space into node with about to be remove text', function(done) {
54         var c = getCanvasFromXML('<section>Alice</section>'),
55             textElement = c.doc().children()[0];
56         textElement.setText('');
57
58         /* Wait for MutationObserver to kick in. */
59         wait(function() {
60             expect(textElement.getText({raw:true})).to.equal(utils.unicode.ZWS, 'ZWS in canvas');
61             expect(c.wlxmlDocument.root.contents()[0].getText()).to.equal('', 'empty string in a document');
62             done();
63         });
64     });
65 });
66
67 describe('Handling changes to the document', function() {
68     it('replaces the whole canvas content when document root node replaced', function() {
69         var doc = getDocumentFromXML('<section></section>'),
70             c = canvas.fromXMLDocument(doc);
71
72         var header = doc.root.replaceWith({tagName: 'header'});
73         expect(c.doc().wlxmlNode.sameNode(header)).to.equal(true);
74     });
75 });
76
77 describe('Listening to document changes', function() {
78
79     it('Handling element node moved', function() {
80         var doc = getDocumentFromXML('<section><a></a><b></b></section>'),
81             a = doc.root.contents()[0],
82             b = doc.root.contents()[1],
83             c = canvas.fromXMLDocument(doc);
84
85         a.before(b);
86         var sectionChildren = c.doc().children();
87         expect(sectionChildren.length).to.equal(2);
88         expect(sectionChildren[0].wlxmlNode.getTagName()).to.equal('b');
89         expect(sectionChildren[1].wlxmlNode.getTagName()).to.equal('a');
90     });
91
92     it('Handling text node moved', function() {
93         var doc = getDocumentFromXML('<section><a></a>Alice</section>'),
94             a = doc.root.contents()[0],
95             textNode = doc.root.contents()[1],
96             c = canvas.fromXMLDocument(doc);
97
98         a.before(textNode);
99         var sectionChildren = c.doc().children();
100         expect(sectionChildren.length).to.equal(2);
101         expect(sectionChildren[0].getText()).to.equal('Alice');
102         expect(sectionChildren[1].wlxmlNode.getTagName()).to.equal('a');
103     });
104
105     it('Handles nodeTagChange event', function() {
106
107         var doc = wlxml.WLXMLDocumentFromXML('<section><div>Alice</div></section>'),
108             c = canvas.fromXMLDocument(doc);
109
110         doc.root.contents()[0].setTag('header');
111
112         var headerNode = doc.root.contents()[0],
113             headerElement = c.doc().children()[0];
114
115         expect(headerElement.wlxmlNode.getTagName()).to.equal('header', 'element ok');
116
117         /* Make sure we handle invalidation of reference to wlxmlNode after changing its tag */
118         expect(headerNode.getData('canvasElement').sameNode(headerElement)).to.equal(true, 'node->element');
119         expect(headerElement.wlxmlNode.sameNode(headerNode)).to.equal(true, 'element->node');
120     });
121
122     it('Handles nodeDetached event for an empty text node', function(done) {
123         var doc = wlxml.WLXMLDocumentFromXML('<section><div>A<span>b</span></div></section>'),
124             aTextNode = doc.root.contents()[0].contents()[0],
125             aTextElement;
126
127         canvas.fromXMLDocument(doc);
128         aTextElement = utils.getElementForNode(aTextNode);
129
130         aTextElement.setText('');
131
132         wait(function() {
133             var parent = aTextElement.parent();
134             expect(aTextElement.getText({raw:true})).to.equal(utils.unicode.ZWS, 'canvas represents this as empty node');
135             aTextElement.wlxmlNode.detach();
136             expect(parent.children().length).to.equal(1);
137             expect(parent.children()[0].wlxmlNode.getTagName()).to.equal('span');
138             done();
139         });
140     });
141 });
142
143 describe('Displaying span nodes', function() {
144     it('inlines a span element with a text', function() {
145         var c = getCanvasFromXML('<section><span>Alice</span></section>'),
146             spanElement = c.doc().children()[0];
147         expect(spanElement.isBlock()).to.equal(false);
148     });
149     it('renders non-span element as a block', function() {
150         var c = getCanvasFromXML('<section><span></span></section>'),
151             element = c.doc().children()[0],
152             node = element.wlxmlNode;
153
154         expect(element.isBlock()).to.equal(false, 'initially inline');
155         node = node.setTag('div');
156         expect(node.getData('canvasElement').isBlock()).to.equal(true, 'block');
157     });
158
159     it('inlines a span element if its block content gets removed', function() {
160         var c = getCanvasFromXML('<section><span>Alice <div>has</div> a cat!</span></section>'),
161             spanElement = c.doc().children()[0],
162             divNode = spanElement.wlxmlNode.contents()[1];
163
164         expect(spanElement.isBlock()).to.equal(true, 'initially a block');
165         divNode.detach();
166         expect(spanElement.isBlock()).to.equal(false, 'inlined after removing inner block');
167         
168         spanElement.wlxmlNode.append({tagName: 'div'});
169
170         expect(spanElement.isBlock()).to.equal(true, 'block again after bringing back inner block');
171     });
172
173     it('keeps showing element as a block after changing its node tag to span if it contains elements of non-span nodes', function() {
174         var c = getCanvasFromXML('<section><div><div></div></div></section>'),
175             outerDivElement = c.doc().children()[0],
176             outerDivNode = outerDivElement.wlxmlNode;
177         outerDivNode = outerDivNode.setTag('span');
178         expect(c.doc().children()[0].isBlock()).to.equal(true);
179     });
180 });
181
182
183 describe('Default document changes handling', function() {
184     it('handles added node', function() {
185         var c = getCanvasFromXML('<section></section>');
186         c.wlxmlDocument.root.append({tagName:'div'});
187         expect(c.doc().children().length).to.equal(1);
188         c.wlxmlDocument.root.prepend({tagName:'div'});
189         expect(c.doc().children().length).to.equal(2);
190
191         var node = c.wlxmlDocument.root.contents()[1];
192         node.before({tagName: 'div'});
193         expect(c.doc().children().length).to.equal(3);
194         node.after({tagName: 'div'});
195         expect(c.doc().children().length).to.equal(4);
196     });
197
198     it('handles attribute value change for a class attribute', function() {
199         var c = getCanvasFromXML('<section></section>');
200         c.wlxmlDocument.root.setAttr('class', 'test');
201         expect(c.doc().wlxmlNode.getClass()).to.equal('test');
202     });
203
204     it('handles detached node', function() {
205         var c = getCanvasFromXML('<section><div></div></section>');
206         c.wlxmlDocument.root.contents()[0].detach();
207         expect(c.doc().children().length).to.equal(0);
208     });
209
210     it('handles moved node', function() {
211         var doc = getDocumentFromXML('<section><a></a><b></b></section>'),
212             a = doc.root.contents()[0],
213             b = doc.root.contents()[1],
214             c = canvas.fromXMLDocument(doc);
215
216         a.before(b);
217         var sectionChildren = c.doc().children();
218         expect(sectionChildren.length).to.equal(2);
219         expect(sectionChildren[0].wlxmlNode.getTagName()).to.equal('b');
220         expect(sectionChildren[1].wlxmlNode.getTagName()).to.equal('a');
221     });
222
223     it('handles moving text node to another parent', function() {
224         var c = getCanvasFromXML('<section>Alice<div><span>has</span></div>a cat.</section>'),
225             doc = c.wlxmlDocument,
226             text = doc.root.contents()[0],
227             div = doc.root.contents()[1];
228         
229         div.append(text);
230         
231         var sectionChildren = c.doc().children();
232         expect(sectionChildren.length).to.equal(2);
233         expect(sectionChildren[0].wlxmlNode.sameNode(div)).to.equal(true);
234         expect(sectionChildren[1].getText()).to.equal('a cat.');
235
236         expect(div.contents().length).to.equal(2);
237         expect(div.contents()[0].getTagName()).to.equal('span');
238         expect(div.contents()[1].getText()).to.equal('Alice');
239     });
240
241     it('handles change in a text node', function() {
242         var c = getCanvasFromXML('<section>Alice</section>');
243         c.wlxmlDocument.root.contents()[0].setText('cat');
244         expect(c.doc().children()[0].getText()).to.equal('cat');
245     });
246 });
247     
248 describe('Custom elements based on wlxml class attribute', function() {
249     it('allows custom rendering', function() {
250         var prototype = $.extend({}, documentElement.DocumentNodeElement.prototype, {
251                 init: function() {
252                     this._container().append('<test></test>');
253                 }
254             }),
255             c = getCanvasFromXML('<section><div class="testClass"></div></section>', [
256             {tag: 'div', klass: 'testClass', prototype: prototype}
257         ]);
258
259         expect(c.doc().children()[0]._container().children('test').length).to.equal(1); // @!
260     });
261
262     it('allows handling changes to internal structure of rendered node', function() {
263         var prototype = $.extend({}, documentElement.DocumentNodeElement.prototype, {
264                 init: function() {
265                     this.header = $('<h1>');
266                     this._container().append(this.header);
267                     this.refresh2();
268                 },
269                 refresh2: function() {
270                     this.header.text(this.wlxmlNode.contents().length);
271                 },
272                 onNodeAdded: function(event) {
273                     void(event);
274                     this.refresh2();
275                 }
276         });
277
278         var c = getCanvasFromXML('<section><div class="testClass"><a></a></div></section>', [
279             {tag: 'div', klass: 'testClass', prototype: prototype}
280         ]);
281
282         var node = c.wlxmlDocument.root.contents()[0],
283             element = node.getData('canvasElement');
284
285         var header = element.dom.find('h1');
286         expect(header.text()).to.equal('1', 'just <a>');
287
288         node.append({tagName: 'div'});
289
290         expect(header.text()).to.equal('2', 'added div');
291     });
292
293     describe('Handling unknown class', function() {
294         it('Inherits default behavior', function() {
295             var c = getCanvasFromXML('<section><div class="unknown">Hi!</div></section>');
296             expect(c.doc().children()[0].children()[0].getText()).to.equal('Hi!');
297         });
298     });
299 });
300
301 describe('Cursor', function() {
302     /* globals Node */
303     var getSelection;
304
305     var findTextNode = function(inside, text) {
306         var nodes = inside.find(':not(iframe)').addBack().contents().filter(function() {
307             return this.nodeType === Node.TEXT_NODE && this.data === text;
308         });
309         if(nodes.length) {
310             return nodes[0];
311         }
312         return null;
313     };
314
315     beforeEach(function() {
316         /* globals window */
317         getSelection = sinon.stub(window, 'getSelection');
318     });
319
320     afterEach(function() {
321         getSelection.restore();
322     });
323
324     it('returns position when browser selection collapsed', function() {
325         var c = getCanvasFromXML('<section>Alice has a cat</section>'),
326             dom = c.doc().dom,
327             text = findTextNode(dom, 'Alice has a cat');
328
329         expect(text.nodeType).to.equal(Node.TEXT_NODE, 'correct node selected');
330         expect($(text).text()).to.equal('Alice has a cat');
331
332         getSelection.returns({
333             anchorNode: text,
334             focusNode: text,
335             anchorOffset: 5,
336             focusOffset: 5,
337             isCollapsed: true
338         });
339         var cursor = c.getCursor(),
340             position = cursor.getPosition();
341
342         expect(cursor.isSelecting()).to.equal(false, 'cursor is not selecting anything');
343         expect(position.element.getText()).to.equal('Alice has a cat');
344         expect(position.offset).to.equal(5);
345         expect(position.offsetAtEnd).to.equal(false, 'offset is not at end');
346
347         getSelection.returns({
348             anchorNode: text,
349             focusNode: text,
350             anchorOffset: 15,
351             focusOffset: 15,
352             isCollapsed: true
353         });
354
355         expect(cursor.getPosition().offsetAtEnd).to.equal(true, 'offset at end');
356     });
357
358     it('recognizes selection start and end on document order', function() {
359         var c = getCanvasFromXML('<section><span>Alice</span><span>has a cat</span><div>abc<span>...</span>cde</div></section>'),
360             dom = c.doc().dom,
361             textFirst = findTextNode(dom, 'Alice'),
362             textSecond = findTextNode(dom, 'has a cat'),
363             textAbc = findTextNode(dom, 'abc'),
364             textCde = findTextNode(dom, 'cde');
365
366         var check = function(label, expected) {
367             var cursor = c.getCursor();
368             label = label + ': ';
369             expect(cursor.getSelectionStart().element.getText()).to.equal(expected.start.text, label + 'start element ok');
370             expect(cursor.getSelectionStart().offset).to.equal(expected.start.offset, label + 'start offset ok');
371             expect(cursor.getSelectionEnd().element.getText()).to.equal(expected.end.text, label + 'end element ok');
372             expect(cursor.getSelectionEnd().offset).to.equal(expected.end.offset, label + 'end offset ok');
373         };
374
375         getSelection.returns({
376             anchorNode: textFirst,
377             focusNode: textFirst,
378             anchorOffset: 1,
379             focusOffset: 3,
380             isCollapsed: false
381         });
382
383         check('same element, anchor first', {
384             start: {text: 'Alice', offset: 1},
385             end: {text: 'Alice', offset:3}
386         });
387
388
389         getSelection.returns({
390             anchorNode: textFirst,
391             focusNode: textFirst,
392             anchorOffset: 3,
393             focusOffset: 1,
394             isCollapsed: false
395         });
396
397         check('same element, anchor second', {
398             start: {text: 'Alice', offset: 1},
399             end: {text: 'Alice', offset:3}
400         });
401
402
403         getSelection.returns({
404             anchorNode: textAbc,
405             focusNode: textCde,
406             anchorOffset: 3,
407             focusOffset: 1,
408             isCollapsed: false
409         });
410
411         check('same parent, anchor first', {
412             start: {text: 'abc', offset: 3},
413             end: {text: 'cde', offset:1}
414         });
415
416
417         getSelection.returns({
418             anchorNode: textCde,
419             focusNode: textAbc,
420             anchorOffset: 1,
421             focusOffset: 3,
422             isCollapsed: false
423         });
424
425         check('same parent, anchor second', {
426             start: {text: 'abc', offset: 3},
427             end: {text: 'cde', offset:1}
428         });
429
430
431         getSelection.returns({
432             anchorNode: textFirst,
433             focusNode: textSecond,
434             anchorOffset: 1,
435             focusOffset: 3,
436             isCollapsed: false
437         });
438
439         check('different parents, anchor first', {
440             start: {text: 'Alice', offset: 1},
441             end: {text: 'has a cat', offset:3}
442         });
443
444
445         getSelection.returns({
446             anchorNode: textSecond,
447             focusNode: textFirst,
448             anchorOffset: 3,
449             focusOffset: 1,
450             isCollapsed: false
451         });
452
453         check('different parents, anchor second', {
454             start: {text: 'Alice', offset: 1},
455             end: {text: 'has a cat', offset:3}
456         });
457     });
458
459     it('returns boundries of selection when browser selection not collapsed', function() {
460         var c = getCanvasFromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
461             dom = c.doc().dom,
462             text = {
463                 alice: findTextNode(dom, 'Alice '),
464                 has: findTextNode(dom, 'has'),
465                 cat: findTextNode(dom, ' cat')
466             },
467             cursor = c.getCursor(),
468             aliceElement = c.getDocumentElement(text.alice),
469             catElement = c.getDocumentElement(text.cat);
470
471         [
472             {focus: text.alice, focusOffset: 1, anchor: text.cat,   anchorOffset: 2, selectionAnchor: catElement},
473             {focus: text.cat,   focusOffset: 2, anchor: text.alice, anchorOffset: 1, selectionAnchor: aliceElement}
474         ].forEach(function(s, idx) {
475             getSelection.returns({isColapsed: false, anchorNode: s.anchor, anchorOffset: s.anchorOffset, focusNode: s.focus, focusOffset: s.focusOffset});
476
477             var selectionStart = cursor.getSelectionStart(),
478                 selectionEnd = cursor.getSelectionEnd(),
479                 selectionAnchor = cursor.getSelectionAnchor();
480
481             expect(cursor.isSelecting()).to.equal(true, 'cursor is selecting');
482             expect(selectionStart.element.sameNode(aliceElement)).to.equal(true, '"Alice" is the start of the selection ' + idx);
483             expect(selectionStart.offset).to.equal(1, '"Alice" offset ok' + idx);
484             expect(selectionEnd.element.sameNode(catElement)).to.equal(true, '"Cat" is the start of the selection ' + idx);
485             expect(selectionEnd.offset).to.equal(2, '"Cat" offset ok' + idx);
486             expect(selectionAnchor.element.sameNode(s.selectionAnchor)).to.equal(true, 'anchor ok');
487             expect(selectionAnchor.offset).to.equal(s.anchorOffset, 'anchor offset ok');
488         });
489     });
490
491     it('recognizes when browser selection boundries lies in sibling DocumentTextElements', function() {
492         var c = getCanvasFromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
493             dom = c.doc().dom,
494             text = {
495                 alice: findTextNode(dom, 'Alice '),
496                 has: findTextNode(dom, 'has'),
497                 a: findTextNode(dom, ' a '),
498                 big: findTextNode(dom, 'big'),
499                 cat: findTextNode(dom, ' cat'),
500             },
501             cursor = c.getCursor();
502
503         expect($(text.alice).text()).to.equal('Alice ');
504         expect($(text.has).text()).to.equal('has');
505         expect($(text.a).text()).to.equal(' a ');
506         expect($(text.big).text()).to.equal('big');
507         expect($(text.cat).text()).to.equal(' cat');
508
509         getSelection.returns({anchorNode: text.alice, focusNode: text.a});
510         expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "a" are children');
511
512         getSelection.returns({anchorNode: text.alice, focusNode: text.cat});
513         expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "cat" are children');
514
515         getSelection.returns({anchorNode: text.alice, focusNode: text.has});
516         expect(cursor.isSelectingSiblings()).to.equal(false, '"Alice" and "has" are not children');
517
518         getSelection.returns({anchorNode: text.has, focusNode: text.big});
519         expect(cursor.isSelectingSiblings()).to.equal(false, '"has" and "big" are not children');
520     });
521 });
522
523 });