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     describe('Regression tests', function() {
 248         it('handles moving node after its next neighbour correctly', function() {
 249             var c = getCanvasFromXML('<section><a></a><b></b></section>'),
 250                 doc = c.wlxmlDocument,
 251                 a = doc.root.contents()[0],
 252                 b = doc.root.contents()[1];
 253             b.after(a);
 254             var sectionChildren = c.doc().children();
 255             expect(sectionChildren[0].wlxmlNode.getTagName()).to.equal('b');
 256             expect(sectionChildren[1].wlxmlNode.getTagName()).to.equal('a');
 257         });
 258     });
 259 });
 260
 261 describe('Custom elements based on wlxml class attribute', function() {
 262     it('allows custom rendering', function() {
 263         var prototype = $.extend({}, documentElement.DocumentNodeElement.prototype, {
 264                 init: function() {
 265                     this._container().append('<test></test>');
 266                 }
 267             }),
 268             c = getCanvasFromXML('<section><div class="testClass"></div></section>', [
 269             {tag: 'div', klass: 'testClass', prototype: prototype}
 270         ]);
 271
 272         expect(c.doc().children()[0]._container().children('test').length).to.equal(1); // @!
 273     });
 274
 275     it('allows handling changes to internal structure of rendered node', function() {
 276         var prototype = $.extend({}, documentElement.DocumentNodeElement.prototype, {
 277                 init: function() {
 278                     this.header = $('<h1>');
 279                     this._container().append(this.header);
 280                     this.refresh2();
 281                 },
 282                 refresh2: function() {
 283                     this.header.text(this.wlxmlNode.contents().length);
 284                 },
 285                 onNodeAdded: function(event) {
 286                     void(event);
 287                     this.refresh2();
 288                 }
 289         });
 290
 291         var c = getCanvasFromXML('<section><div class="testClass"><a></a></div></section>', [
 292             {tag: 'div', klass: 'testClass', prototype: prototype}
 293         ]);
 294
 295         var node = c.wlxmlDocument.root.contents()[0],
 296             element = node.getData('canvasElement');
 297
 298         var header = element.dom.find('h1');
 299         expect(header.text()).to.equal('1', 'just <a>');
 300
 301         node.append({tagName: 'div'});
 302
 303         expect(header.text()).to.equal('2', 'added div');
 304     });
 305
 306     describe('Handling unknown class', function() {
 307         it('Inherits default behavior', function() {
 308             var c = getCanvasFromXML('<section><div class="unknown">Hi!</div></section>');
 309             expect(c.doc().children()[0].children()[0].getText()).to.equal('Hi!');
 310         });
 311     });
 312 });
 313
 314 describe('Cursor', function() {
 315     /* globals Node */
 316     var getSelection;
 317
 318     var findTextNode = function(inside, text) {
 319         var nodes = inside.find(':not(iframe)').addBack().contents().filter(function() {
 320             return this.nodeType === Node.TEXT_NODE && this.data === text;
 321         });
 322         if(nodes.length) {
 323             return nodes[0];
 324         }
 325         return null;
 326     };
 327
 328     beforeEach(function() {
 329         /* globals window */
 330         getSelection = sinon.stub(window, 'getSelection');
 331     });
 332
 333     afterEach(function() {
 334         getSelection.restore();
 335     });
 336
 337     it('returns position when browser selection collapsed', function() {
 338         var c = getCanvasFromXML('<section>Alice has a cat</section>'),
 339             dom = c.doc().dom,
 340             text = findTextNode(dom, 'Alice has a cat');
 341
 342         expect(text.nodeType).to.equal(Node.TEXT_NODE, 'correct node selected');
 343         expect($(text).text()).to.equal('Alice has a cat');
 344
 345         getSelection.returns({
 346             anchorNode: text,
 347             focusNode: text,
 348             anchorOffset: 5,
 349             focusOffset: 5,
 350             isCollapsed: true
 351         });
 352         var cursor = c.getCursor(),
 353             position = cursor.getPosition();
 354
 355         expect(cursor.isSelecting()).to.equal(false, 'cursor is not selecting anything');
 356         expect(position.element.getText()).to.equal('Alice has a cat');
 357         expect(position.offset).to.equal(5);
 358         expect(position.offsetAtEnd).to.equal(false, 'offset is not at end');
 359
 360         getSelection.returns({
 361             anchorNode: text,
 362             focusNode: text,
 363             anchorOffset: 15,
 364             focusOffset: 15,
 365             isCollapsed: true
 366         });
 367
 368         expect(cursor.getPosition().offsetAtEnd).to.equal(true, 'offset at end');
 369     });
 370
 371     it('recognizes selection start and end on document order', function() {
 372         var c = getCanvasFromXML('<section><span>Alice</span><span>has a cat</span><div>abc<span>...</span>cde</div></section>'),
 373             dom = c.doc().dom,
 374             textFirst = findTextNode(dom, 'Alice'),
 375             textSecond = findTextNode(dom, 'has a cat'),
 376             textAbc = findTextNode(dom, 'abc'),
 377             textCde = findTextNode(dom, 'cde');
 378
 379         var check = function(label, expected) {
 380             var cursor = c.getCursor();
 381             label = label + ': ';
 382             expect(cursor.getSelectionStart().element.getText()).to.equal(expected.start.text, label + 'start element ok');
 383             expect(cursor.getSelectionStart().offset).to.equal(expected.start.offset, label + 'start offset ok');
 384             expect(cursor.getSelectionEnd().element.getText()).to.equal(expected.end.text, label + 'end element ok');
 385             expect(cursor.getSelectionEnd().offset).to.equal(expected.end.offset, label + 'end offset ok');
 386         };
 387
 388         getSelection.returns({
 389             anchorNode: textFirst,
 390             focusNode: textFirst,
 391             anchorOffset: 1,
 392             focusOffset: 3,
 393             isCollapsed: false
 394         });
 395
 396         check('same element, anchor first', {
 397             start: {text: 'Alice', offset: 1},
 398             end: {text: 'Alice', offset:3}
 399         });
 400
 401
 402         getSelection.returns({
 403             anchorNode: textFirst,
 404             focusNode: textFirst,
 405             anchorOffset: 3,
 406             focusOffset: 1,
 407             isCollapsed: false
 408         });
 409
 410         check('same element, anchor second', {
 411             start: {text: 'Alice', offset: 1},
 412             end: {text: 'Alice', offset:3}
 413         });
 414
 415
 416         getSelection.returns({
 417             anchorNode: textAbc,
 418             focusNode: textCde,
 419             anchorOffset: 3,
 420             focusOffset: 1,
 421             isCollapsed: false
 422         });
 423
 424         check('same parent, anchor first', {
 425             start: {text: 'abc', offset: 3},
 426             end: {text: 'cde', offset:1}
 427         });
 428
 429
 430         getSelection.returns({
 431             anchorNode: textCde,
 432             focusNode: textAbc,
 433             anchorOffset: 1,
 434             focusOffset: 3,
 435             isCollapsed: false
 436         });
 437
 438         check('same parent, anchor second', {
 439             start: {text: 'abc', offset: 3},
 440             end: {text: 'cde', offset:1}
 441         });
 442
 443
 444         getSelection.returns({
 445             anchorNode: textFirst,
 446             focusNode: textSecond,
 447             anchorOffset: 1,
 448             focusOffset: 3,
 449             isCollapsed: false
 450         });
 451
 452         check('different parents, anchor first', {
 453             start: {text: 'Alice', offset: 1},
 454             end: {text: 'has a cat', offset:3}
 455         });
 456
 457
 458         getSelection.returns({
 459             anchorNode: textSecond,
 460             focusNode: textFirst,
 461             anchorOffset: 3,
 462             focusOffset: 1,
 463             isCollapsed: false
 464         });
 465
 466         check('different parents, anchor second', {
 467             start: {text: 'Alice', offset: 1},
 468             end: {text: 'has a cat', offset:3}
 469         });
 470     });
 471
 472     it('returns boundries of selection when browser selection not collapsed', function() {
 473         var c = getCanvasFromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
 474             dom = c.doc().dom,
 475             text = {
 476                 alice: findTextNode(dom, 'Alice '),
 477                 has: findTextNode(dom, 'has'),
 478                 cat: findTextNode(dom, ' cat')
 479             },
 480             cursor = c.getCursor(),
 481             aliceElement = c.getDocumentElement(text.alice),
 482             catElement = c.getDocumentElement(text.cat);
 483
 484         [
 485             {focus: text.alice, focusOffset: 1, anchor: text.cat,   anchorOffset: 2, selectionAnchor: catElement},
 486             {focus: text.cat,   focusOffset: 2, anchor: text.alice, anchorOffset: 1, selectionAnchor: aliceElement}
 487         ].forEach(function(s, idx) {
 488             getSelection.returns({isColapsed: false, anchorNode: s.anchor, anchorOffset: s.anchorOffset, focusNode: s.focus, focusOffset: s.focusOffset});
 489
 490             var selectionStart = cursor.getSelectionStart(),
 491                 selectionEnd = cursor.getSelectionEnd(),
 492                 selectionAnchor = cursor.getSelectionAnchor();
 493
 494             expect(cursor.isSelecting()).to.equal(true, 'cursor is selecting');
 495             expect(selectionStart.element.sameNode(aliceElement)).to.equal(true, '"Alice" is the start of the selection ' + idx);
 496             expect(selectionStart.offset).to.equal(1, '"Alice" offset ok' + idx);
 497             expect(selectionEnd.element.sameNode(catElement)).to.equal(true, '"Cat" is the start of the selection ' + idx);
 498             expect(selectionEnd.offset).to.equal(2, '"Cat" offset ok' + idx);
 499             expect(selectionAnchor.element.sameNode(s.selectionAnchor)).to.equal(true, 'anchor ok');
 500             expect(selectionAnchor.offset).to.equal(s.anchorOffset, 'anchor offset ok');
 501         });
 502     });
 503
 504     it('recognizes when browser selection boundries lies in sibling DocumentTextElements', function() {
 505         var c = getCanvasFromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
 506             dom = c.doc().dom,
 507             text = {
 508                 alice: findTextNode(dom, 'Alice '),
 509                 has: findTextNode(dom, 'has'),
 510                 a: findTextNode(dom, ' a '),
 511                 big: findTextNode(dom, 'big'),
 512                 cat: findTextNode(dom, ' cat'),
 513             },
 514             cursor = c.getCursor();
 515
 516         expect($(text.alice).text()).to.equal('Alice ');
 517         expect($(text.has).text()).to.equal('has');
 518         expect($(text.a).text()).to.equal(' a ');
 519         expect($(text.big).text()).to.equal('big');
 520         expect($(text.cat).text()).to.equal(' cat');
 521
 522         getSelection.returns({anchorNode: text.alice, focusNode: text.a});
 523         expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "a" are children');
 524
 525         getSelection.returns({anchorNode: text.alice, focusNode: text.cat});
 526         expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "cat" are children');
 527
 528         getSelection.returns({anchorNode: text.alice, focusNode: text.has});
 529         expect(cursor.isSelectingSiblings()).to.equal(false, '"Alice" and "has" are not children');
 530
 531         getSelection.returns({anchorNode: text.has, focusNode: text.big});
 532         expect(cursor.isSelectingSiblings()).to.equal(false, '"has" and "big" are not children');
 533     });
 534 });
 535
 536 });