modules/documentCanvas/canvas/canvas.test3.js

   1 define([
   2 'libs/chai',
   3 'libs/sinon',
   4 'modules/documentCanvas/canvas/canvas',
   5 'modules/documentCanvas/canvas/documentElement',
   6 'modules/documentCanvas/canvas/utils'
   7 ], function(chai, sinon, canvas, documentElement, utils) {
   8
   9 'use strict';
  10
  11 var expect = chai.expect;
  12
  13
  14 describe('Canvas', function() {
  15
  16     describe('Internal HTML representation of a DocumentNodeElement', function() {
  17         it('is always a div tag', function() {
  18             ['section', 'header', 'span', 'aside', 'figure'].forEach(function(tagName) {
  19                 var dom = canvas.fromXML('<' + tagName + '></' + tagName + '>').doc().dom();
  20                 expect(dom.prop('tagName')).to.equal('DIV', tagName + ' is represented as div');
  21             });
  22         });
  23         it('has wlxml tag put into wlxml-tag attribute of its internal container', function() {
  24             var dom = canvas.fromXML('<section></section>').doc().dom();
  25             expect(dom.children('[document-element-content]').attr('wlxml-tag')).to.equal('section');
  26         });
  27         it('has wlxml class put into wlxml-class attribute of its internal containr, dots replaced with dashes', function() {
  28             var dom = canvas.fromXML('<section class="some.class"></section>').doc().dom();
  29             expect(dom.children('[document-element-content]').attr('wlxml-class')).to.equal('some-class');
  30         });
  31     });
  32
  33     describe('Internal HTML representation of a DocumentTextElement', function() {
  34         it('is text node wrapped in a div with document-text-element attribute set', function() {
  35             var dom = canvas.fromXML('<section>Alice</section>').doc().children()[0].dom();
  36             expect(dom.prop('tagName')).to.equal('DIV');
  37             expect(dom.attr('document-text-element')).to.equal('');
  38             expect(dom.contents().length).to.equal(1);
  39             expect(dom.contents()[0].nodeType).to.equal(Node.TEXT_NODE);
  40             expect($(dom.contents()[0]).text()).to.equal('Alice');
  41         });
  42     });
  43
  44     describe('basic properties', function() {
  45         it('renders empty document when canvas created from empty XML', function() {
  46             var c = canvas.fromXML('');
  47             expect(c.doc()).to.equal(null);
  48         });
  49
  50         it('gives access to its document root node', function() {
  51             var c = canvas.fromXML('<section></section>');
  52             expect(c.doc().getWlxmlTag()).to.equal('section');
  53         });
  54
  55         describe('root element', function() {
  56             it('has no parent', function() {
  57                 var c = canvas.fromXML('<section></section>');
  58                 expect(c.doc().parent()).to.be.null;
  59             });
  60         });
  61
  62         describe('DocumentTextElement', function() {
  63             it('can have its content set', function() {
  64                 var c = canvas.fromXML('<section>Alice</section>'),
  65                     root = c.doc(),
  66                     text = root.children()[0];
  67
  68                 text.setText('a cat');
  69                 expect(root.children()[0].getText()).to.equal('a cat');
  70             });
  71         });
  72
  73         describe('DocumentNodeElement', function() {
  74             it('knows index of its child', function() {
  75                 var c = canvas.fromXML('<section><div></div><header></header><span></span></section>'),
  76                     root = c.doc(),
  77                     child = root.children()[1];
  78                 expect(root.childIndex(child)).to.equal(1);
  79             });
  80
  81             it('knows WLXML tag it renders', function(){
  82                 var c = canvas.fromXML('<section></section>'),
  83                     section = c.doc();
  84                 expect(section.getWlxmlTag()).to.equal('section', 'initial tag is section');
  85                 section.setWlxmlTag('header');
  86                 expect(section.getWlxmlTag()).to.equal('header', 'tag is changed to header');
  87             });
  88
  89             it('knows WLXML class of a WLXML tag it renders', function(){
  90                 var c = canvas.fromXML('<section class="some.class.A"></section>'),
  91                     section = c.doc();
  92                 expect(section.getWlxmlClass()).to.equal('some.class.A');
  93                 section.setWlxmlClass('some.class.B');
  94                 expect(section.getWlxmlClass()).to.equal('some.class.B');
  95                 section.setWlxmlClass(null);
  96                 expect(section.getWlxmlClass()).to.be.undefined;
  97             });
  98
  99
 100
 101             describe('element has meta attributes', function() {
 102                 it('can change its meta attributes', function() {
 103                     var c = canvas.fromXML('<section><span class="uri" meta-uri="someuri"></span></section>'),
 104                     span = c.doc().children()[0];
 105
 106                     expect(span.getWlxmlMetaAttr('uri')).to.equal('someuri');
 107                     span.setWlxmlMetaAttr('uri', 'otheruri');
 108                     expect(span.getWlxmlMetaAttr('uri')).to.equal('otheruri');
 109                 });
 110
 111                 it('changes its meta attributes with class change', function() {
 112                     var c = canvas.fromXML('<section><span class="uri" meta-uri="someuri"></span></section>'),
 113                     span = c.doc().children()[0];
 114
 115                     expect(span.getWlxmlMetaAttr('uri')).to.equal('someuri');
 116                     span.setWlxmlClass('author');
 117                     expect(span.getWlxmlMetaAttr('uri')).to.be.undefined;
 118                 });
 119
 120                 it('keeps meta attribute value on class change if a new class has this attribute', function() {
 121                     var c = canvas.fromXML('<section><span class="uri" meta-uri="someuri"></span></section>'),
 122                     span = c.doc().children()[0];
 123                     span.setWlxmlClass('uri.some.subclass');
 124                     expect(span.getWlxmlMetaAttr('uri')).to.equal('someuri');
 125                 });
 126             });
 127         });
 128
 129         it('returns DocumentNodeElement instance from HTMLElement', function() {
 130             var c = canvas.fromXML('<section></section>'),
 131                 htmlElement = c.doc().dom().get(0),
 132                 element = c.getDocumentElement(htmlElement);
 133             expect(element).to.be.instanceOf(documentElement.DocumentNodeElement);
 134             expect(element.sameNode(c.doc()));
 135         });
 136
 137         it('returns DocumentTextElement instance from Text Node', function() {
 138             var c = canvas.fromXML('<section>Alice</section>'),
 139                 aliceElement = c.doc().children()[0],
 140                 textNode = aliceElement.dom().contents()[0],
 141                 element = c.getDocumentElement(textNode);
 142
 143             expect(textNode.nodeType).to.equal(Node.TEXT_NODE, 'text node selected');
 144             expect($(textNode).text()).to.equal('Alice');
 145
 146             expect(element).to.be.instanceOf(documentElement.DocumentTextElement);
 147             expect(element.sameNode(c.doc().children()[0]));
 148         });
 149     });
 150
 151
 152
 153     describe('document representation api', function() {
 154         describe('document root element', function() {
 155             var c = canvas.fromXML('<section></section>');
 156             it('exists', function() {
 157                 expect(c.doc()).to.be.instanceOf(documentElement.DocumentElement);
 158             });
 159             it('is of type DocumentNodeElement', function() {
 160                 expect(c.doc()).to.be.instanceOf(documentElement.DocumentNodeElement);
 161             });
 162         });
 163
 164         describe('DocumentElements comparison', function() {
 165             it('reports dwo DocumentElements to be the same when they represent the same wlxml document element', function() {
 166                 var c = canvas.fromXML('<section><div></div><div></div></section>'),
 167                     first_div1 = c.doc().children()[0],
 168                     first_div2 = c.doc().children()[0],
 169                     second_div = c.doc().children()[1];
 170                 expect(first_div1.sameNode(first_div1)).to.be.true;
 171                 expect(first_div1.sameNode(first_div2)).to.be.true;
 172                 expect(first_div1.sameNode(second_div)).to.be.false;
 173             });
 174         });
 175
 176         describe('traversing', function() {
 177             it('reports element nodes', function() {
 178                 var c = canvas.fromXML('<section><div></div></section>'),
 179                     children = c.doc().children();
 180                 expect(children.length).to.equal(1);
 181                 expect(children[0]).to.be.instanceOf(documentElement.DocumentNodeElement);
 182
 183                 c = canvas.fromXML('<section><div></div><div></div></section>'),
 184                     children = c.doc().children();
 185                 expect(children.length).to.equal(2);
 186                 expect(children[0]).to.be.instanceOf(documentElement.DocumentNodeElement);
 187                 expect(children[1]).to.be.instanceOf(documentElement.DocumentNodeElement);
 188             });
 189
 190             it('reports text nodes', function() {
 191                 var c = canvas.fromXML('<section>Alice</section>'),
 192                     children = c.doc().children();
 193                 expect(children.length).to.equal(1);
 194                 expect(children[0]).to.be.instanceOf(documentElement.DocumentTextElement);
 195             });
 196
 197             describe('accessing parents', function() {
 198                 it('returns DocumentNodeElement representing parent in wlxml document as DocumentNodeElement parent', function() {
 199                     var c = canvas.fromXML('<section><div></div></section>'),
 200                         div = c.doc().children()[0];
 201                     expect(div.parent().sameNode(c.doc())).to.be.true;
 202                 });
 203                 it('returns DocumentNodeElement representing parent in wlxml document as DocumentTextElement parent', function() {
 204                     var c = canvas.fromXML('<section>Alice</section>'),
 205                         text = c.doc().children()[0];
 206                     expect(text.parent().sameNode(c.doc())).to.be.true;
 207                 });
 208             });
 209
 210             describe('accessing sibling parents of two elements', function() {
 211                 it('returns elements themself if they have direct common parent', function() {
 212                     var c = canvas.fromXML('<section>\
 213                         <div>\
 214                             <div>A</div>\
 215                             <div>B</div>\
 216                         </div>\
 217                     </section>'),
 218                         section = c.doc(),
 219                         wrappingDiv = c.doc().children()[0],
 220                         divA = wrappingDiv.children()[0],
 221                         divB = wrappingDiv.children()[1];
 222
 223                     var siblingParents = c.getSiblingParents({element1: divA, element2: divB});
 224
 225                     expect(siblingParents.element1.sameNode(divA)).to.equal(true, 'divA');
 226                     expect(siblingParents.element2.sameNode(divB)).to.equal(true, 'divB');
 227                 });
 228
 229                 it('returns sibling parents - example 1', function() {
 230                     var c = canvas.fromXML('<section>Alice <span>has a cat</span></section>'),
 231                         section = c.doc(),
 232                         aliceText = section.children()[0],
 233                         span = section.children()[1],
 234                         spanText = span.children()[0];
 235
 236                     var siblingParents = c.getSiblingParents({element1: aliceText, element2: spanText});
 237
 238                     expect(siblingParents.element1.sameNode(aliceText)).to.equal(true, 'aliceText');
 239                     expect(siblingParents.element2.sameNode(span)).to.equal(true, 'span');
 240                 });
 241             })
 242
 243             describe('free text handling', function() {
 244                     it('sees free text', function() {
 245                         var c = canvas.fromXML('<section>Alice <span>has</span> a cat</section>'),
 246                             children = c.doc().children();
 247                         expect(children.length).to.equal(3);
 248                         expect(children[0]).to.be.instanceOf(documentElement.DocumentTextElement);
 249                         expect(children[1]).to.be.instanceOf(documentElement.DocumentNodeElement);
 250                         expect(children[2]).to.be.instanceOf(documentElement.DocumentTextElement);
 251                     });
 252             });
 253
 254             describe('white characters handling', function() {
 255                 it('says empty element node has no children', function() {
 256                     var c = canvas.fromXML('<section></section>');
 257                     expect(c.doc().children().length).to.equal(0);
 258                 });
 259                 it('says element node with one space has one DocumentTextElement', function() {
 260                     var c = canvas.fromXML('<section> </section>');
 261                     expect(c.doc().children().length).to.equal(1);
 262                     expect(c.doc().children()[0]).to.be.instanceOf(documentElement.DocumentTextElement);
 263                     expect(c.doc().children()[0].getText()).to.equal(' ');
 264                 });
 265                 it('ignores white space surrounding block elements', function() {
 266                     var c = canvas.fromXML('<section> <div></div> </section>');
 267                     var children = c.doc().children();
 268                     expect(children.length).to.equal(1);
 269                     expect(children[0]).to.be.instanceOf(documentElement.DocumentNodeElement);
 270                 });
 271                 it('ignores white space between block elements', function() {
 272                     var c = canvas.fromXML('<section><div></div> <div></div></section>');
 273                     var children = c.doc().children();
 274                     expect(children.length === 2);
 275                     [0,1].forEach(function(idx) {
 276                         expect(children[idx]).to.be.instanceOf(documentElement.DocumentNodeElement);
 277                     });
 278                 });
 279
 280                 it('trims white space from the beginning and the end of the block elements', function() {
 281                     var c = canvas.fromXML('<section> Alice <span>has</span> a cat </section>');
 282                     expect(c.doc().children()[0].getText()).to.equal('Alice ');
 283                     expect(c.doc().children()[2].getText()).to.equal(' a cat');
 284                 });
 285
 286                 it('normalizes string of white characters to one space at the inline element boundries', function() {
 287                     var c = canvas.fromXML('<span>   Alice has a cat   </span>');
 288                     expect(c.doc().children()[0].getText()).to.equal(' Alice has a cat ');
 289                 });
 290
 291                 it('normalizes string of white characters to one space before inline element', function() {
 292                     var c = canvas.fromXML('<div>Alice has  <span>a cat</span></div>');
 293                     expect(c.doc().children()[0].getText()).to.equal('Alice has ');
 294                 });
 295
 296                 it('normalizes string of white characters to one space after inline element', function() {
 297                     var c = canvas.fromXML('<div>Alice has <span>a</span>  cat</div>');
 298                     expect(c.doc().children()[2].getText()).to.equal(' cat');
 299                 });
 300             });
 301
 302             describe('getting vertically first text element', function() {
 303                 it('returns the first child if it\'s text element, ignores metadata', function() {
 304                     var c = canvas.fromXML('<section><metadata><dc:author>author</dc:author></metadata>Alice<div>has</div>a cat</section>'),
 305                         first = c.doc().getVerticallyFirstTextElement();
 306
 307                     expect(first.sameNode(c.doc().children()[1])).to.be.true;
 308                 });
 309
 310                 it('looks recursively inside node elements if they precede text element', function() {
 311                     var c = canvas.fromXML('\
 312                             <section>\
 313                                 <div>\
 314                                     <div>\
 315                                         Alice\
 316                                     </div>\
 317                                 </div>\
 318                                 Some text\
 319                             </section>'),
 320                         textAlice = c.doc().children()[0].children()[0].children()[0],
 321                         first = c.doc().getVerticallyFirstTextElement();
 322
 323                     expect(textAlice).to.be.instanceOf(documentElement.DocumentTextElement);
 324                     expect(first.sameNode(textAlice)).to.be.true;
 325                 });
 326             });
 327         });
 328
 329         describe('manipulation api', function() {
 330
 331             describe('Basic Element inserting', function() {
 332                 it('can put new NodeElement at the end', function() {
 333                     var c = canvas.fromXML('<section></section>'),
 334                         appended = c.doc().append({tag: 'header', klass: 'some.class'}),
 335                         children = c.doc().children();
 336
 337                     expect(children.length).to.equal(1);
 338                     expect(children[0].sameNode(appended)).to.be.true;
 339                 });
 340
 341                 it('can put new TextElement at the end', function() {
 342                     var c = canvas.fromXML('<section></section>'),
 343                         appended = c.doc().append({text: 'Alice'}),
 344                         children = c.doc().children();
 345
 346                     expect(children.length).to.equal(1);
 347                     expect(children[0].sameNode(appended)).to.be.true;
 348                     expect(children[0].getText()).to.equal('Alice');
 349                 });
 350
 351                 it('can put new NodeElement at the beginning', function() {
 352                     var c = canvas.fromXML('<section><div></div></section>'),
 353                         prepended = c.doc().prepend({tag: 'header', klass: 'some.class'}),
 354                         children = c.doc().children();
 355
 356                     expect(children).to.have.length(2);
 357                     expect(children[0].sameNode(prepended)).to.be.true;
 358                 });
 359
 360                 it('can put new TextElement at the beginning', function() {
 361                     var c = canvas.fromXML('<section><div></div></section>'),
 362                         prepended = c.doc().prepend({text: 'Alice'}),
 363                         children = c.doc().children();
 364
 365                     expect(children).to.have.length(2)
 366                     expect(children[0].sameNode(prepended)).to.be.true;
 367                     expect(children[0].getText()).to.equal('Alice');
 368                 });
 369
 370                 it('can put new NodeElement after another NodeElement', function() {
 371                     var c = canvas.fromXML('<section><div></div></section>'),
 372                         div = c.doc().children()[0],
 373                         added = div.after({tag: 'header', klass: 'some.class'}),
 374                         children = c.doc().children();
 375                     expect(children.length).to.equal(2);
 376                     expect(children[1].sameNode(added)).to.be.true;
 377                 });
 378
 379                 it('can put new Nodeelement before another element', function() {
 380                     var c = canvas.fromXML('<section><div></div></section>'),
 381                         div = c.doc().children()[0],
 382                         added = div.before({tag: 'header', klass: 'some.class'}),
 383                         children = c.doc().children();
 384                     expect(children.length).to.equal(2);
 385                     expect(children[0].sameNode(added)).to.be.true;
 386                 });
 387
 388                 it('can put new DocumentNodeElement after DocumentTextElement', function() {
 389                     var c = canvas.fromXML('<section>Alice</section>'),
 390                         text = c.doc().children()[0],
 391                         added = text.after({tag: 'p'}),
 392                         children = c.doc().children();
 393
 394                     expect(children.length).to.equal(2);
 395                     expect(children[0]).to.be.instanceOf(documentElement.DocumentTextElement);
 396                     expect(children[0].getText()).to.equal('Alice');
 397                     expect(children[1]).to.be.instanceOf(documentElement.DocumentNodeElement);
 398                     expect(children[1].sameNode(added)).to.be.true;
 399                 });
 400                 it('can put new DocumentNodeElement before DocumentTextElement', function() {
 401                     var c = canvas.fromXML('<section>Alice</section>'),
 402                         text = c.doc().children()[0],
 403                         added = text.before({tag: 'p'}),
 404                         children = c.doc().children();
 405
 406                     expect(children.length).to.equal(2);
 407                     expect(children[0]).to.be.instanceOf(documentElement.DocumentNodeElement);
 408                     expect(children[0].sameNode(added)).to.be.true;
 409                     expect(children[1]).to.be.instanceOf(documentElement.DocumentTextElement);
 410                     expect(children[1].getText()).to.equal('Alice');
 411                 });
 412
 413                 it('can divide DocumentTextElement with a new DocumentNodeElement', function() {
 414                     var c = canvas.fromXML('<section>Alice has a cat</section>'),
 415                         section = c.doc(),
 416                         text = section.children()[0];
 417
 418                     var returned = text.divide({tag: 'aside', klass: 'footnote', offset: 5}),
 419                         sectionChildren = section.children(),
 420                         lhsText = sectionChildren[0],
 421                         rhsText = sectionChildren[2];
 422
 423                     expect(lhsText.getText()).to.equal('Alice');
 424                     expect(returned.sameNode(sectionChildren[1]));
 425                     expect(rhsText.getText()).to.equal(' has a cat');
 426                 });
 427
 428                 it('treats dividing DocumentTextElement at the very end as appending after it', function() {
 429                     var c = canvas.fromXML('<section>Alice has a cat</section>'),
 430                         section = c.doc(),
 431                         text = section.children()[0];
 432
 433                     var returned = text.divide({tag: 'aside', klass: 'footnote', offset: 15}),
 434                         sectionChildren = section.children(),
 435                         textElement = sectionChildren[0],
 436                         nodeElement = sectionChildren[1];
 437
 438                     expect(sectionChildren.length).to.equal(2);
 439                     expect(textElement.getText()).to.equal('Alice has a cat');
 440                     expect(returned.sameNode(nodeElement)).to.be.true;
 441                     expect(nodeElement.getWlxmlTag()).to.equal('aside');
 442                 });
 443
 444                 it('treats dividing DocumentTextElement at the very beginning as appending before it', function() {
 445                     var c = canvas.fromXML('<section>Alice has a cat</section>'),
 446                         section = c.doc(),
 447                         text = section.children()[0];
 448
 449                     var returned = text.divide({tag: 'aside', klass: 'footnote', offset: 0}),
 450                         sectionChildren = section.children(),
 451                         nodeElement = sectionChildren[0],
 452                         textElement = sectionChildren[1];
 453
 454                     expect(sectionChildren.length).to.equal(2);
 455                     expect(textElement.getText()).to.equal('Alice has a cat');
 456                     expect(returned.sameNode(nodeElement)).to.be.true;
 457                     expect(nodeElement.getWlxmlTag()).to.equal('aside');
 458                 });
 459             });
 460
 461             describe('Removing elements', function() {
 462                 it('merges left and right DocumentTextElement sibling of a detached DocumentNodeElement', function() {
 463                     var c = canvas.fromXML('<section>Alice<div>has</div>a cat</section>'),
 464                         section = c.doc(),
 465                         div = section.children()[1];
 466
 467                     div.detach();
 468
 469                     var sectionChildren = section.children(),
 470                         textElement = sectionChildren[0];
 471
 472                     expect(sectionChildren).to.have.length(1);
 473                     expect(textElement.getText()).to.equal('Alicea cat');
 474                 });
 475             });
 476
 477             describe('Splitting text', function() {
 478
 479                 it('splits DocumentTextElement\'s parent into two DocumentNodeElements of the same type', function() {
 480                     var c = canvas.fromXML('<section><header>Some header</header></section>'),
 481                         section = c.doc(),
 482                         text = section.children()[0].children()[0];
 483
 484                     var returnedValue = text.split({offset: 5});
 485                     expect(section.children().length).to.equal(2, 'section has two children');
 486
 487                     var header1 = section.children()[0];
 488                     var header2 = section.children()[1];
 489
 490                     expect(header1.getWlxmlTag()).to.equal('header', 'first section child represents wlxml header');
 491                     expect(header1.children().length).to.equal(1, 'first header has one text child');
 492                     expect(header1.children()[0].getText()).to.equal('Some ', 'first header has correct content');
 493                     expect(header2.getWlxmlTag()).to.equal('header', 'second section child represents wlxml header');
 494                     expect(header2.children().length).to.equal(1, 'second header has one text child');
 495                     expect(header2.children()[0].getText()).to.equal('header', 'second header has correct content');
 496
 497                     expect(returnedValue.first.sameNode(header1)).to.equal(true, 'first node returnde');
 498                     expect(returnedValue.second.sameNode(header2)).to.equal(true, 'second node returned');
 499                 });
 500
 501                 it('leaves empty copy of DocumentNodeElement if splitting at the very beginning', function() {
 502                         var c = canvas.fromXML('<section><header>Some header</header></section>'),
 503                         section = c.doc(),
 504                         text = section.children()[0].children()[0];
 505
 506                         text.split({offset: 0});
 507
 508                         var header1 = section.children()[0];
 509                         var header2 = section.children()[1];
 510
 511                         expect(header1.children().length).to.equal(0);
 512                         expect(header2.children()[0].getText()).to.equal('Some header');
 513                 });
 514
 515                 it('leaves empty copy of DocumentNodeElement if splitting at the very end', function() {
 516                         var c = canvas.fromXML('<section><header>Some header</header></section>'),
 517                         section = c.doc(),
 518                         text = section.children()[0].children()[0];
 519
 520                         text.split({offset: 11});
 521
 522                         var header1 = section.children()[0];
 523                         var header2 = section.children()[1];
 524
 525                         expect(header1.children()[0].getText()).to.equal('Some header');
 526                         expect(header2.children().length).to.equal(0);
 527                 });
 528
 529                 it('keeps DocumentTextElement\'s parent\'s children elements intact', function() {
 530                     var c = canvas.fromXML('\
 531                             <section>\
 532                                 <header>\
 533                                     A <span>fancy</span> and <span>nice</span> header\
 534                                 </header>\
 535                             </section>'),
 536                         section = c.doc(),
 537                         header = section.children()[0],
 538                         textAnd = header.children()[2];
 539
 540                     textAnd.split({offset: 2});
 541
 542                     var sectionChildren = section.children();
 543                     expect(sectionChildren.length).to.equal(2, 'Section has two children');
 544                     expect(sectionChildren[0].getWlxmlTag()).to.equal('header', 'First section element is a wlxml header');
 545                     expect(sectionChildren[1].getWlxmlTag()).to.equal('header', 'Second section element is a wlxml header');
 546
 547                     var firstHeaderChildren = sectionChildren[0].children();
 548                     expect(firstHeaderChildren.length).to.equal(3, 'First header has three children');
 549                     expect(firstHeaderChildren[0].getText()).to.equal('A ', 'First header starts with a text');
 550                     expect(firstHeaderChildren[1].getWlxmlTag()).to.equal('span', 'First header has span in the middle');
 551                     expect(firstHeaderChildren[2].getText()).to.equal(' a', 'First header ends with text');
 552
 553                     var secondHeaderChildren = sectionChildren[1].children();
 554                     expect(secondHeaderChildren.length).to.equal(3, 'Second header has three children');
 555                     expect(secondHeaderChildren[0].getText()).to.equal('nd ', 'Second header starts with text');
 556                     expect(secondHeaderChildren[1].getWlxmlTag()).to.equal('span', 'Second header has span in the middle');
 557                     expect(secondHeaderChildren[2].getText()).to.equal(' header', 'Second header ends with text');
 558                 });
 559             });
 560
 561             describe('wrapping', function() {
 562                 it('wraps DocumentNodeElement', function() {
 563                     var c = canvas.fromXML('<section><div></div></section>'),
 564                         div = c.doc().children()[0];
 565
 566                     var returned = div.wrapWithNodeElement({tag: 'header', klass: 'some.class'}),
 567                         parent = div.parent(),
 568                         parent2 = c.doc().children()[0];
 569
 570                     expect(returned.sameNode(parent)).to.be.true;
 571                     expect(returned.sameNode(parent2)).to.be.true;
 572                     expect(returned.getWlxmlTag()).to.equal('header');
 573                     expect(returned.getWlxmlClass()).to.equal('some.class');
 574                 });
 575                 it('wraps DocumentTextElement', function() {
 576                     var c = canvas.fromXML('<section>Alice</section>'),
 577                         text = c.doc().children()[0];
 578
 579                     var returned = text.wrapWithNodeElement({tag: 'header', klass: 'some.class'}),
 580                         parent = text.parent(),
 581                         parent2 = c.doc().children()[0];
 582
 583                     expect(returned.sameNode(parent)).to.be.true;
 584                     expect(returned.sameNode(parent2)).to.be.true;
 585                     expect(returned.getWlxmlTag()).to.equal('header');
 586                     expect(returned.getWlxmlClass()).to.equal('some.class');
 587                 });
 588
 589                 describe('wrapping part of DocumentTextElement', function() {
 590                     [{start: 5, end: 12}, {start: 12, end: 5}].forEach(function(offsets) {
 591                         it('wraps in the middle ' + offsets.start + '/' + offsets.end, function() {
 592                             var c = canvas.fromXML('<section>Alice has a cat</section>'),
 593                                 text = c.doc().children()[0];
 594
 595                             var returned = text.wrapWithNodeElement({tag: 'header', klass: 'some.class', start: offsets.start, end: offsets.end}),
 596                                 children = c.doc().children();
 597
 598                             expect(children.length).to.equal(3);
 599
 600                             expect(children[0]).to.be.instanceOf(documentElement.DocumentTextElement);
 601                             expect(children[0].getText()).to.equal('Alice');
 602
 603                             expect(children[1].sameNode(returned)).to.be.true;
 604                             expect(returned.getWlxmlTag()).to.equal('header');
 605                             expect(returned.getWlxmlClass()).to.equal('some.class');
 606                             expect(children[1].children().length).to.equal(1);
 607                             expect(children[1].children()[0].getText()).to.equal(' has a ');
 608
 609                             expect(children[2]).to.be.instanceOf(documentElement.DocumentTextElement);
 610                             expect(children[2].getText()).to.equal('cat');
 611                         });
 612                     });
 613
 614                     it('wraps whole text inside DocumentTextElement if offsets span entire content', function() {
 615                          var c = canvas.fromXML('<section>Alice has a cat</section>'),
 616                              text = c.doc().children()[0];
 617
 618                          var returned = text.wrapWithNodeElement({tag: 'header', klass: 'some.class', start: 0, end: 15}),
 619                              children = c.doc().children();
 620
 621                          expect(children.length).to.equal(1);
 622                          expect(children[0]).to.be.instanceOf(documentElement.DocumentNodeElement);
 623                          expect(children[0].children()[0].getText()).to.equal('Alice has a cat');
 624                     });
 625                 });
 626
 627                 it('wraps text spanning multiple sibling DocumentTextNodes', function() {
 628                     var c = canvas.fromXML('<section>Alice has a <span>small</span> cat</section>'),
 629                         section = c.doc(),
 630                         wrapper = c.wrapText({
 631                             inside: section,
 632                             _with: {tag: 'span', klass: 'some.class'},
 633                             offsetStart: 6,
 634                             offsetEnd: 4,
 635                             textNodeIdx: [0,2]
 636                         });
 637
 638                     expect(section.children().length).to.equal(2);
 639                     expect(section.children()[0]).to.be.instanceOf(documentElement.DocumentTextElement);
 640                     expect(section.children()[0].getText()).to.equal('Alice ');
 641
 642                     var wrapper2 = section.children()[1];
 643                     expect(wrapper2.sameNode(wrapper)).to.be.true;
 644
 645                     var wrapperChildren = wrapper.children();
 646                     expect(wrapperChildren.length).to.equal(3);
 647                     expect(wrapperChildren[0].getText()).to.equal('has a ');
 648
 649                     expect(wrapperChildren[1]).to.be.instanceOf(documentElement.DocumentNodeElement);
 650                     expect(wrapperChildren[1].children().length).to.equal(1);
 651                     expect(wrapperChildren[1].children()[0].getText()).to.equal('small');
 652
 653                     expect(wrapperChildren[2].getText()).to.equal(' cat');
 654                 });
 655
 656                 it('wraps multiple sibling Elements', function() {
 657                     var c = canvas.fromXML('<section>Alice<div>has</div><div>a cat</div></section>'),
 658                         section = c.doc(),
 659                         aliceText = section.children()[0],
 660                         firstDiv = section.children()[1],
 661                         lastDiv = section.children()[section.children().length -1];
 662
 663                     var returned = c.wrapElements({
 664                             element1: aliceText,
 665                             element2: lastDiv,
 666                             _with: {tag: 'header'}
 667                         });
 668
 669                     var sectionChildren = section.children(),
 670                         header = sectionChildren[0],
 671                         headerChildren = header.children();
 672
 673                     expect(sectionChildren).to.have.length(1);
 674                     expect(header.sameNode(returned)).to.equal(true, 'wrapper returned');
 675                     expect(headerChildren).to.have.length(3);
 676                     expect(headerChildren[0].sameNode(aliceText)).to.equal(true, 'first node wrapped');
 677                     expect(headerChildren[1].sameNode(firstDiv)).to.equal(true, 'second node wrapped');
 678                     expect(headerChildren[2].sameNode(lastDiv)).to.equal(true, 'third node wrapped');
 679                 });
 680                 it('wraps multiple sibling Elements - middle case', function() {
 681                     var c = canvas.fromXML('<section><div></div>div></div><div></div><div></div></section>'),
 682                         section = c.doc(),
 683                         div1 = section.children()[0],
 684                         div2 = section.children()[1],
 685                         div3 = section.children()[2],
 686                         div4 = section.children()[3];
 687
 688                     var returned = c.wrapElements({
 689                             element1: div2,
 690                             element2: div3,
 691                             _with: {tag: 'header'}
 692                         });
 693
 694                     var sectionChildren = section.children(),
 695                         header = sectionChildren[1],
 696                         headerChildren = header.children();
 697
 698                     expect(sectionChildren).to.have.length(3);
 699                     expect(headerChildren).to.have.length(2);
 700                     expect(headerChildren[0].sameNode(div2)).to.equal(true, 'first node wrapped');
 701                     expect(headerChildren[1].sameNode(div3)).to.equal(true, 'second node wrapped');
 702                 });
 703             });
 704
 705             describe('unwrapping DocumentTextElement from its parent DocumentNodeElement if it\'s its only child', function() {
 706                 it('unwraps text element from its parent and stays between its old parent siblings', function() {
 707                     var c = canvas.fromXML('<section><div>Alice</div><div>has</div><div>a cat</div></section>'),
 708                         section = c.doc(),
 709                         sectionChildren = section.children(),
 710                         divAlice = sectionChildren[0],
 711                         divHas = sectionChildren[1],
 712                         textHas = divHas.children()[0],
 713                         divCat = sectionChildren[2];
 714
 715                     var newTextContainer = textHas.unwrap(),
 716                         sectionChildren = section.children();
 717
 718                     expect(sectionChildren[0].sameNode(divAlice)).to.equal(true, 'divAlice ok');
 719                     expect(newTextContainer.sameNode(section)).to.equal(true, 'unwrap returns new text parent DocumentNodeElement');
 720                     expect(sectionChildren[1].getText()).to.equal('has');
 721                     expect(sectionChildren[2].sameNode(divCat)).to.equal(true, 'divCat ok');
 722
 723                 });
 724                 it('unwraps and join with its old parent adjacent text elements ', function() {
 725                     var c = canvas.fromXML('<section>Alice <span>has a</span> cat</section>'),
 726                     section = c.doc(),
 727                     text = section.children()[1].children()[0];
 728
 729                     var newTextContainer = text.unwrap();
 730
 731                     expect(section.children().length).to.equal(1, 'section has one child');
 732                     expect(section.children()[0].getText()).to.equal('Alice has a cat');
 733                     expect(newTextContainer.sameNode(c.doc())).to.equal(true, 'unwrap returns new text parent DocumentNodeElement');
 734                 });
 735             });
 736         });
 737
 738         describe('Lists api', function() {
 739             describe('creating lists', function() {
 740                 it('allows creation of a list from existing sibling DocumentElements', function() {
 741                     var c = canvas.fromXML('\
 742                         <section>\
 743                             Alice\
 744                             <div>has</div>\
 745                             a\
 746                             <div>cat</div>\
 747                         </section>'),
 748                         section = c.doc(),
 749                         textHas = section.children()[1],
 750                         divA = section.children()[2]
 751
 752                     c.list.create({element1: textHas, element2: divA});
 753
 754                     expect(section.children().length).to.equal(3, 'section has three child elements');
 755
 756                     var child1 = section.children()[0],
 757                         list = section.children()[1],
 758                         child3 = section.children()[2];
 759
 760                     expect(child1.getText()).to.equal('Alice');
 761                     expect(list.is('list')).to.equal(true, 'second child is a list');
 762                     expect(list.children().length).to.equal(2, 'list contains two elements');
 763                     list.children().forEach(function(child) {
 764                         expect(child.getWlxmlClass()).to.equal('item', 'list childs have wlxml class of item');
 765                     });
 766                     expect(child3.children()[0].getText()).to.equal('cat');
 767                 });
 768
 769                 it('allows creating nested list from existing sibling list items', function() {
 770                     var c = canvas.fromXML('\
 771                         <section>\
 772                             <div class="list-items">\
 773                                 <div class="item">A</div>\
 774                                 <div class="item">B</div>\
 775                                 <div class="item">C</div>\
 776                                 <div class="item">D</div>\
 777                             </div>\
 778                         </section>'),
 779                         outerList = c.doc().children()[0],
 780                         itemB = outerList.children()[1],
 781                         itemC = outerList.children()[2];
 782
 783
 784                         c.list.create({element1: itemB, element2: itemC});
 785
 786                     var outerListItems = outerList.children(),
 787                         innerList = outerListItems[1].children()[0],
 788                         innerListItems = innerList.children();
 789
 790                     expect(outerListItems.length).to.equal(3, 'outer list has three items');
 791                     expect(outerListItems[0].children()[0].getText()).to.equal('A', 'first outer item ok');
 792                     expect(outerListItems[1].getWlxmlClass()).to.equal('item', 'inner list is wrapped by item element');
 793
 794                     expect(innerList.is('list')).to.equal(true, 'inner list created');
 795                     expect(innerListItems.length).to.equal(2, 'inner list has two items');
 796                     expect(innerListItems[0].children()[0].getText()).to.equal('B', 'first inner item ok');
 797                     expect(innerListItems[1].children()[0].getText()).to.equal('C', 'second inner item ok');
 798
 799                     expect(outerListItems[2].children()[0].getText()).to.equal('D', 'last outer item ok');
 800
 801                 });
 802
 803             });
 804
 805             describe('extracting list items', function() {
 806                 it('creates two lists with extracted items in the middle if extracting from the middle of the list', function() {
 807                     var c = canvas.fromXML('\
 808                         <section>\
 809                             <div class="list.items">\
 810                                 <div class="item">0</div>\
 811                                 <div class="item">1</div>\
 812                                 <div class="item">2</div>\
 813                                 <div class="item">3</div>\
 814                             </div>\
 815                         </section>'),
 816                         list = c.doc().children()[0],
 817                         item1 = list.children()[1],
 818                         item2 = list.children()[2];
 819
 820                     c.list.extractItems({element1: item1, element2: item2});
 821
 822                     var section = c.doc(),
 823                         list1 = section.children()[0],
 824                         oldItem1 = section.children()[1],
 825                         oldItem2 = section.children()[2],
 826                         list2 = section.children()[3];
 827
 828                     expect(section.children().length).to.equal(4, 'section contains four children');
 829
 830                     expect(list1.is('list')).to.equal(true, 'first section child is a list');
 831                     expect(list1.children().length).to.equal(1, 'first list has one child');
 832                     expect(list1.children()[0].children()[0].getText()).to.equal('0', 'first item of the first list is a first item of the original list');
 833
 834                     expect(oldItem1.children()[0].getText()).to.equal('1', 'first item got extracted');
 835                     expect(oldItem1.getWlxmlClass() === undefined).to.equal(true, 'first extracted element has no wlxml class');
 836
 837                     expect(oldItem2.children()[0].getText()).to.equal('2', 'second item got extracted');
 838                     expect(oldItem2.getWlxmlClass() === undefined).to.equal(true, 'second extracted element has no wlxml class');
 839
 840                     expect(list2.is('list')).to.equal(true, 'last section child is a list');
 841                     expect(list2.children().length).to.equal(1, 'second list has one child');
 842                     expect(list2.children()[0].children()[0].getText()).to.equal('3', 'first item of the second list is a last item of the original list');
 843                 });
 844
 845                 it('puts extracted items above the list if starting item is the first one', function() {
 846                     var c = canvas.fromXML('\
 847                         <section>\
 848                             <div class="list.items">\
 849                                 <div class="item">0</div>\
 850                                 <div class="item">1</div>\
 851                                 <div class="item">2</div>\
 852                             </div>\
 853                         </section>'),
 854                         list = c.doc().children()[0],
 855                         item1 = list.children()[0],
 856                         item2 = list.children()[1],
 857                         item3 = list.children()[2];
 858
 859                     c.list.extractItems({element1: item1, element2: item2});
 860
 861                     var section = c.doc(),
 862                         oldItem1 = section.children()[0],
 863                         oldItem2 = section.children()[1],
 864                         newList = section.children()[2];
 865
 866                     expect(section.children().length).to.equal(3, 'section has three children');
 867                     expect(oldItem1.children()[0].getText()).to.equal('0', 'first item extracted');
 868                     expect(oldItem2.children()[0].getText()).to.equal('1', 'second item extracted');
 869                     expect(newList.is('list')).to.equal(true, 'list lies below extracted item');
 870                     expect(newList.children().length).to.equal(1, 'list has now one child');
 871                 });
 872
 873                 it('puts extracted items below the list if ending item is the last one', function() {
 874                     var c = canvas.fromXML('\
 875                         <section>\
 876                             <div class="list.items">\
 877                                 <div class="item">0</div>\
 878                                 <div class="item">1</div>\
 879                                 <div class="item">2</div>\
 880                             </div>\
 881                         </section>'),
 882                         list = c.doc().children()[0],
 883                         item1 = list.children()[0],
 884                         item2 = list.children()[1],
 885                         item3 = list.children()[2];
 886
 887                     c.list.extractItems({element1: item2, element2: item3});
 888
 889                     var section = c.doc(),
 890                         oldItem1 = section.children()[1],
 891                         oldItem2 = section.children()[2],
 892                         newList = section.children()[0];
 893
 894                     expect(section.children().length).to.equal(3, 'section has three children');
 895                     expect(oldItem1.children()[0].getText()).to.equal('1', 'first item extracted');
 896                     expect(oldItem2.children()[0].getText()).to.equal('2', 'second item extracted');
 897                     expect(newList.is('list')).to.equal(true, 'list lies above extracted item');
 898                     expect(newList.children().length).to.equal(1, 'list has now one child');
 899                 });
 900
 901                 it('removes list if all its items are extracted', function() {
 902                     var c = canvas.fromXML('\
 903                         <section>\
 904                             <div class="list.items">\
 905                                 <div class="item">some item</div>\
 906                                 <div class="item">some item 2</div>\
 907                             </div>\
 908                         </section>'),
 909                         list = c.doc().children()[0],
 910                         item1 = list.children()[0],
 911                         item2 = list.children()[1];
 912
 913                     c.list.extractItems({element1: item1, element2: item2});
 914
 915                     var section = c.doc(),
 916                         list1 = section.children()[0],
 917                         oldItem1 = section.children()[0],
 918                         oldItem2 = section.children()[1];
 919
 920                     expect(section.children().length).to.equal(2, 'section contains two children');
 921                     expect(oldItem1.children()[0].getText()).to.equal('some item');
 922                     expect(oldItem2.children()[0].getText()).to.equal('some item 2');
 923                 });
 924
 925                 it('creates two lists with extracted items in the middle if extracting from the middle of the list - nested case' , function() {
 926                     var c = canvas.fromXML('\
 927                         <section>\
 928                             <div class="list.items">\
 929                                 <div class="item">0</div>\
 930                                 <div class="item">\
 931                                     <div class="list.items">\
 932                                         <div class="item">1.1</div>\
 933                                         <div class="item">1.2</div>\
 934                                         <div class="item">1.3</div>\
 935                                     </div>\
 936                                 </div>\
 937                                 <div class="item">2</div>\
 938                             </div>\
 939                         </section>'),
 940                         list = c.doc().children()[0],
 941                         nestedList = list.children()[1].children()[0],
 942                         nestedListItem = nestedList.children()[1];
 943
 944                     c.list.extractItems({element1: nestedListItem, element2: nestedListItem});
 945
 946                     var section = c.doc(),
 947                         list = section.children()[0],
 948                         item1 = list.children()[0],
 949                         item2 = list.children()[1], //
 950                         item3 = list.children()[2],
 951                         item4 = list.children()[3], //
 952                         item5 = list.children()[4],
 953                         nestedList1 = item2.children()[0],
 954                         nestedList2 = item4.children()[0];
 955
 956                     expect(list.children().length).to.equal(5, 'top list has five items');
 957
 958                     expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
 959
 960                     expect(item2.getWlxmlClass()).to.equal('item', 'first nested list is still wrapped in item element');
 961                     expect(nestedList1.children().length).to.equal(1, 'first nested list is left with one child');
 962                     expect(nestedList1.children()[0].children()[0].getText()).to.equal('1.1', 'first nested list item left alone');
 963
 964                     expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
 965
 966                     expect(item4.getWlxmlClass()).to.equal('item', 'second nested list is still wrapped in item element');
 967                     expect(nestedList2.children().length).to.equal(1, 'second nested list is left with one child');
 968                     expect(nestedList2.children()[0].children()[0].getText()).to.equal('1.3', 'second nested list item left alone');
 969
 970                     expect(item5.children()[0].getText()).to.equal('2', 'last item ok');
 971                 });
 972
 973                 it('puts extracted items below the list if ending item is the last one - nested case' , function() {
 974                     var c = canvas.fromXML('\
 975                         <section>\
 976                             <div class="list.items">\
 977                                 <div class="item">0</div>\
 978                                 <div class="item">\
 979                                     <div class="list.items">\
 980                                         <div class="item">1.1</div>\
 981                                         <div class="item">1.2</div>\
 982                                         <div class="item">1.3</div>\
 983                                     </div>\
 984                                 </div>\
 985                                 <div class="item">2</div>\
 986                             </div>\
 987                         </section>'),
 988                         list = c.doc().children()[0],
 989                         nestedList = list.children()[1].children()[0],
 990                         nestedListItem1 = nestedList.children()[1],
 991                         nestedListItem2 = nestedList.children()[2];
 992
 993                     c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});
 994
 995                     var section = c.doc(),
 996                         list = section.children()[0],
 997                         item1 = list.children()[0],
 998                         item2 = list.children()[1],
 999                         item3 = list.children()[2],
1000                         item4 = list.children()[3],
1001                         item5 = list.children()[4];
1002                     nestedList = item2.children()[0];
1003
1004                     expect(list.children().length).to.equal(5, 'top list has five items');
1005                     expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
1006                     expect(item2.getWlxmlClass()).to.equal('item', 'nested list is still wrapped in item element');
1007                     expect(nestedList.children().length).to.equal(1, 'nested list is left with one child');
1008                     expect(nestedList.children()[0].children()[0].getText()).to.equal('1.1', 'nested list item left alone');
1009                     expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
1010                     expect(item4.children()[0].getText()).to.equal('1.3', 'fourth item ok');
1011                     expect(item5.children()[0].getText()).to.equal('2', 'fifth item ok');
1012                 });
1013
1014                 it('puts extracted items above the list if starting item is the first one - nested case' , function() {
1015                     var c = canvas.fromXML('\
1016                         <section>\
1017                             <div class="list.items">\
1018                                 <div class="item">0</div>\
1019                                 <div class="item">\
1020                                     <div class="list.items">\
1021                                         <div class="item">1.1</div>\
1022                                         <div class="item">1.2</div>\
1023                                         <div class="item">1.3</div>\
1024                                     </div>\
1025                                 </div>\
1026                                 <div class="item">2</div>\
1027                             </div>\
1028                         </section>'),
1029                         list = c.doc().children()[0],
1030                         nestedList = list.children()[1].children()[0],
1031                         nestedListItem1 = nestedList.children()[0],
1032                         nestedListItem2 = nestedList.children()[1];
1033
1034                     c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});
1035
1036                     var section = c.doc(),
1037                         list = section.children()[0],
1038                         item1 = list.children()[0],
1039                         item2 = list.children()[1],
1040                         item3 = list.children()[2],
1041                         item4 = list.children()[3],
1042                         item5 = list.children()[4];
1043                     nestedList = item4.children()[0];
1044
1045                     expect(list.children().length).to.equal(5, 'top list has five items');
1046                     expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
1047                     expect(item2.children()[0].getText()).to.equal('1.1', 'second item ok');
1048                     expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
1049
1050                     expect(item4.getWlxmlClass()).to.equal('item', 'nested list is still wrapped in item element');
1051                     expect(nestedList.children().length).to.equal(1, 'nested list is left with one child');
1052                     expect(nestedList.children()[0].children()[0].getText()).to.equal('1.3', 'nested list item left alone');
1053                     expect(item5.children()[0].getText()).to.equal('2', 'fifth item ok');
1054                 });
1055
1056                 it('removes list if all its items are extracted - nested case', function() {
1057                     var c = canvas.fromXML('\
1058                         <section>\
1059                             <div class="list.items">\
1060                                 <div class="item">0</div>\
1061                                 <div class="item">\
1062                                     <div class="list.items">\
1063                                         <div class="item">1.1</div>\
1064                                         <div class="item">1.2</div>\
1065                                     </div>\
1066                                 </div>\
1067                                 <div class="item">2</div>\
1068                             </div>\
1069                         </section>'),
1070                         list = c.doc().children()[0],
1071                         nestedList = list.children()[1].children()[0],
1072                         nestedListItem1 = nestedList.children()[0],
1073                         nestedListItem2 = nestedList.children()[1];
1074
1075                     c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});
1076
1077                     var section = c.doc(),
1078                         list = section.children()[0],
1079                         item1 = list.children()[0],
1080                         item2 = list.children()[1],
1081                         item3 = list.children()[2],
1082                         item4 = list.children()[3];
1083
1084                     expect(list.children().length).to.equal(4, 'top list has four items');
1085                     expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
1086                     expect(item2.children()[0].getText()).to.equal('1.1', 'second item ok');
1087                     expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
1088                     expect(item4.children()[0].getText()).to.equal('2', 'fourth item ok');
1089                 });
1090
1091                 it('extracts items out of outer most list when merge flag is set to false', function() {
1092                     var c = canvas.fromXML('\
1093                         <section>\
1094                             <div class="list.items">\
1095                                 <div class="item">0</div>\
1096                                 <div class="item">\
1097                                     <div class="list.items">\
1098                                         <div class="item">1.1</div>\
1099                                         <div class="item">1.2</div>\
1100                                     </div>\
1101                                 </div>\
1102                                 <div class="item">2</div>\
1103                             </div>\
1104                         </section>'),
1105                         section = c.doc(),
1106                         list = section.children()[0],
1107                         nestedList = list.children()[1].children()[0],
1108                         nestedListItem = nestedList.children()[0];
1109
1110                     var test = c.list.extractItems({element1: nestedListItem, element2: nestedListItem, merge: false});
1111
1112                     expect(test).to.equal(true, 'extraction status ok');
1113
1114                     var sectionChildren = section.children(),
1115                         extractedItem = sectionChildren[1];
1116
1117                     expect(sectionChildren.length).to.equal(3, 'section has three children');
1118                     expect(sectionChildren[0].is('list')).to.equal(true, 'first child is a list');
1119
1120                     expect(extractedItem.getWlxmlTag()).to.equal('div', 'extracted item is a wlxml div');
1121                     expect(extractedItem.getWlxmlClass()).to.equal(undefined, 'extracted item has no wlxml class');
1122                     expect(extractedItem.children()[0].getText()).to.equal('1.1', 'extracted item ok');
1123                     expect(sectionChildren[2].is('list')).to.equal(true, 'second child is a list');
1124                 });
1125             });
1126         });
1127
1128     });
1129
1130     describe('Cursor', function() {
1131
1132         var getSelection;
1133
1134         var findTextNode = function(inside, text) {
1135             var nodes = inside.find(':not(iframe)').addBack().contents().filter(function() {
1136                 return this.nodeType === Node.TEXT_NODE && this.data === text;
1137             });
1138             if(nodes.length)
1139                 return nodes[0];
1140             return null;
1141         }
1142
1143         beforeEach(function() {
1144             getSelection = sinon.stub(window, 'getSelection');
1145         });
1146
1147         afterEach(function() {
1148             getSelection.restore();
1149         });
1150
1151         it('returns position when browser selection collapsed', function() {
1152             var c = canvas.fromXML('<section>Alice has a cat</section>'),
1153                 dom = c.doc().dom(),
1154                 text = findTextNode(dom, 'Alice has a cat');
1155
1156             expect(text.nodeType).to.equal(Node.TEXT_NODE, 'correct node selected');
1157             expect($(text).text()).to.equal('Alice has a cat');
1158
1159             getSelection.returns({
1160                 anchorNode: text,
1161                 focusNode: text,
1162                 anchorOffset: 5,
1163                 focusOffset: 5,
1164                 isCollapsed: true
1165             });
1166             var cursor = c.getCursor(),
1167                 position = cursor.getPosition();
1168
1169             expect(cursor.isSelecting()).to.equal(false, 'cursor is not selecting anything');
1170             expect(position.element.getText()).to.equal('Alice has a cat');
1171             expect(position.offset).to.equal(5);
1172             expect(position.offsetAtEnd).to.equal(false, 'offset is not at end');
1173
1174             getSelection.returns({
1175                 anchorNode: text,
1176                 focusNode: text,
1177                 anchorOffset: 15,
1178                 focusOffset: 15,
1179                 isCollapsed: true
1180             });
1181
1182             expect(cursor.getPosition().offsetAtEnd).to.equal(true, 'offset at end');
1183         });
1184
1185         it('returns boundries of selection when browser selection not collapsed', function() {
1186             var c = canvas.fromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
1187                 dom = c.doc().dom(),
1188                 text = {
1189                     alice: findTextNode(dom, 'Alice '),
1190                     has: findTextNode(dom, 'has'),
1191                     cat: findTextNode(dom, ' cat')
1192                 },
1193                 cursor = c.getCursor(),
1194                 aliceElement = c.getDocumentElement(text.alice),
1195                 catElement = c.getDocumentElement(text.cat);
1196
1197
1198                 [
1199                     {focus: text.alice, focusOffset: 1, anchor: text.cat,   anchorOffset: 2, selectionAnchor: catElement},
1200                     {focus: text.cat,   focusOffset: 2, anchor: text.alice, anchorOffset: 1, selectionAnchor: aliceElement}
1201                 ].forEach(function(s, idx) {
1202                     getSelection.returns({isColapsed: false, anchorNode: s.anchor, anchorOffset: s.anchorOffset, focusNode: s.focus, focusOffset: s.focusOffset});
1203
1204                     var selectionStart = cursor.getSelectionStart(),
1205                         selectionEnd = cursor.getSelectionEnd(),
1206                         selectionAnchor = cursor.getSelectionAnchor();
1207
1208                     expect(cursor.isSelecting()).to.equal(true, 'cursor is selecting');
1209                     expect(selectionStart.element.sameNode(aliceElement)).to.equal(true, '"Alice" is the start of the selection ' + idx);
1210                     expect(selectionStart.offset).to.equal(1, '"Alice" offset ok' + idx);
1211                     expect(selectionEnd.element.sameNode(catElement)).to.equal(true, '"Cat" is the start of the selection ' + idx);
1212                     expect(selectionEnd.offset).to.equal(2, '"Cat" offset ok' + idx);
1213                     expect(selectionAnchor.element.sameNode(s.selectionAnchor)).to.equal(true, 'anchor ok');
1214                     expect(selectionAnchor.offset).to.equal(s.anchorOffset, 'anchor offset ok');
1215                 });
1216         });
1217
1218         it('recognizes when browser selection boundries lies in sibling DocumentTextElements', function() {
1219             var c = canvas.fromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
1220                 dom = c.doc().dom(),
1221                 text = {
1222                     alice: findTextNode(dom, 'Alice '),
1223                     has: findTextNode(dom, 'has'),
1224                     a: findTextNode(dom, ' a '),
1225                     big: findTextNode(dom, 'big'),
1226                     cat: findTextNode(dom, ' cat'),
1227                 },
1228                 cursor = c.getCursor();
1229
1230             expect($(text.alice).text()).to.equal('Alice ');
1231             expect($(text.has).text()).to.equal('has');
1232             expect($(text.a).text()).to.equal(' a ');
1233             expect($(text.big).text()).to.equal('big');
1234             expect($(text.cat).text()).to.equal(' cat');
1235
1236             getSelection.returns({anchorNode: text.alice, focusNode: text.a});
1237             expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "a" are children');
1238
1239             getSelection.returns({anchorNode: text.alice, focusNode: text.cat});
1240             expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "cat" are children');
1241
1242             getSelection.returns({anchorNode: text.alice, focusNode: text.has});
1243             expect(cursor.isSelectingSiblings()).to.equal(false, '"Alice" and "has" are not children');
1244
1245             getSelection.returns({anchorNode: text.has, focusNode: text.big});
1246             expect(cursor.isSelectingSiblings()).to.equal(false, '"has" and "big" are not children');
1247
1248         })
1249
1250         describe('zero width space handling', function() {
1251             it('position range includes ZWS at the boundries of text in case when native selection api doesn\'t', function() {
1252                 var c = canvas.fromXML("<section>Alice</section>"),
1253                     dom = c.doc().dom(),
1254                     textNode = findTextNode(dom, 'Alice'),
1255                     cursor = c.getCursor();
1256
1257                 textNode.data = utils.unicode.ZWS + 'Alice';
1258                 getSelection.returns({anchorNode: textNode, anchorOffset: 1, focusNode: textNode, focusOffset: 1});
1259                 expect(cursor.getPosition().offset).to.equal(0);
1260                 expect(cursor.getPosition().offsetAtBeginning).to.equal(true, 'offset at beginning');
1261
1262                 textNode.data = 'Alice' + utils.unicode.ZWS;
1263                 getSelection.returns({anchorNode: textNode, anchorOffset: 5, focusNode: textNode, focusOffset: 5});
1264                 expect(cursor.getPosition().offset).to.equal(6);
1265                 expect(cursor.getPosition().offsetAtEnd).to.equal(true, 'offset at end');
1266             });
1267         });
1268     });
1269
1270     describe('Serializing document to WLXML', function() {
1271         it('keeps document intact when no changes have been made', function() {
1272             var xmlIn = '<section>Alice<div>has</div>a <span class="uri" meta-uri="http://cat.com">cat</span>!</section>',
1273                 c = canvas.fromXML(xmlIn),
1274                 xmlOut = c.toXML();
1275
1276             var parser = new DOMParser(),
1277                 input = parser.parseFromString(xmlIn, "application/xml").childNodes[0],
1278                 output = parser.parseFromString(xmlOut, "application/xml").childNodes[0];
1279
1280             expect(input.isEqualNode(output)).to.be.true;
1281         });
1282
1283         it('keeps arbitrary node attributes intact', function() {
1284             var xmlIn = '<section a="1" xmlns:dcterms="http://purl.org/dc/terms/"></section>',
1285                 $xmlOut = $(canvas.fromXML(xmlIn).toXML());
1286
1287             expect($xmlOut.attr('a')).to.equal('1');
1288             expect($xmlOut.attr('xmlns:dcterms')).to.equal('http://purl.org/dc/terms/');
1289         });
1290
1291         it('doesn\' serialize meta attribute if its empty', function() {
1292             var c;
1293
1294             c = canvas.fromXML('<section class="uri" meta-uri="some.uri"></section>');
1295             c.doc().setWlxmlMetaAttr('uri', '');
1296             expect($(c.toXML()).attr('meta-uri')).to.equal(undefined, 'overriding attribute with zero length string');
1297
1298             c = canvas.fromXML('<section class="uri"></section>');
1299             c.doc().setWlxmlMetaAttr('uri', '');
1300             expect($(c.toXML()).attr('meta-uri')).to.equal(undefined, 'setting attribute to zero length string');
1301         });
1302
1303         describe('output xml', function() {
1304             it('keeps entities intact', function() {
1305                 var xmlIn = '<section>&lt; &gt;</section>',
1306                     c = canvas.fromXML(xmlIn),
1307                     xmlOut = c.toXML();
1308                 expect(xmlOut).to.equal(xmlIn);
1309             });
1310             it('keeps entities intact when they form html/xml', function() {
1311                 var xmlIn = '<section>&lt;abc&gt;</section>',
1312                     c = canvas.fromXML(xmlIn),
1313                     xmlOut = c.toXML();
1314                 expect(xmlOut).to.equal(xmlIn);
1315             });
1316         });
1317
1318         describe('formatting output xml', function() {
1319             /*it('keeps white spaces at the edges of input xml', function() {
1320                 var xmlIn = '  <section></section>  ',
1321                 c = canvas.fromXML(xmlIn),
1322                 xmlOut = c.toXML();
1323
1324                 expect(xmlOut.substr(4)).to.equal('   <', 'start');
1325                 expect(xmlOut.substr(-2)).to.equal('>  ', 'end');
1326             });*/
1327             it('keeps white space between XML nodes', function() {
1328                 var xmlIn = '<section>\n\n\n<div></div>\n\n\n<div></div>\n\n\n</section>',
1329                 c = canvas.fromXML(xmlIn),
1330                 xmlOut = c.toXML();
1331
1332                 var partsIn = xmlIn.split('\n\n\n'),
1333                     partsOut = xmlOut.split('\n\n\n');
1334
1335                 expect(partsIn).to.deep.equal(partsOut);
1336             });
1337
1338             it('keeps white space between XML nodes - inline case', function() {
1339                 var xmlIn = '<section>\n\n\n<span></span>\n\n\n<span></span>\n\n\n</section>',
1340                 c = canvas.fromXML(xmlIn),
1341                 xmlOut = c.toXML();
1342
1343                 var partsIn = xmlIn.split('\n\n\n'),
1344                     partsOut = xmlOut.split('\n\n\n');
1345
1346                 expect(partsIn).to.deep.equal(partsOut);
1347             });
1348
1349             it('keeps white space at the beginning of text', function() {
1350                 var xmlIn = '<section>    abc<div>some div</div>    abc</section>',
1351                     c = canvas.fromXML(xmlIn),
1352                     xmlOut = c.toXML();
1353
1354                 expect(xmlOut).to.equal(xmlIn);
1355             });
1356
1357             it('nests new children block elements', function() {
1358                 var c = canvas.fromXML('<section></section>');
1359
1360                 c.doc().append({tag: 'header'});
1361
1362                 var xmlOut = c.toXML();
1363                 expect(xmlOut.split('\n  ')[0]).to.equal('<section>', 'nesting start ok');
1364                 expect(xmlOut.split('\n').slice(-1)[0]).to.equal('</section>', 'nesting end ok');
1365
1366             });
1367
1368             it('doesn\'t nest new children inline elements', function() {
1369                 var c = canvas.fromXML('<section></section>');
1370
1371                 c.doc().append({tag: 'span'});
1372
1373                 var xmlOut = c.toXML();
1374                 expect(xmlOut).to.equal('<section><span></span></section>');
1375             });
1376
1377             it('keeps original white space at the end of text', function() {
1378
1379                 var xmlIn = '<header>    Some text ended with white space \
1380                 \
1381                 <span class="uri">Some text</span> some text\
1382             \
1383             </header>',
1384                     c = canvas.fromXML(xmlIn);
1385
1386             var xmlOut = c.toXML();
1387             console.log(xmlOut);
1388             expect(xmlOut).to.equal(xmlIn);
1389             });
1390
1391             it('keeps white space around text node', function() {
1392                 var xmlIn = '<section>\
1393                 <header>header1</header>\
1394                 Some text surrounded by white space\
1395                 <header>header2</header>\
1396             </section>',
1397                     c = canvas.fromXML(xmlIn);
1398
1399                 var xmlOut = c.toXML();
1400                 expect(xmlOut).to.equal(xmlIn);
1401             });
1402
1403             it('keeps white space around text node - last node case', function() {
1404                 var xmlIn = '<section>\
1405                 <header>header</header>\
1406                     \
1407                 Some text surrounded by white space\
1408                     \
1409             </section>',
1410                     c = canvas.fromXML(xmlIn);
1411
1412                 var xmlOut = c.toXML();
1413                 expect(xmlOut).to.equal(xmlIn);
1414             });
1415
1416             it('keeps white space after detaching text element', function() {
1417                 var xmlIn = '<section><header>header</header>\n\
1418                     \n\
1419                 text1\n\
1420                     \n\
1421             </section>',
1422                     expectedXmlOut = '<section><header>header</header>\n\
1423                     \n\
1424                 \n\
1425                     \n\
1426             </section>',
1427                     c = canvas.fromXML(xmlIn),
1428                     children = c.doc().children(),
1429                     text = children[children.length-1];
1430
1431                 expect(text.getText()).to.equal('text1');
1432
1433                 text.detach();
1434
1435                 var xmlOut = c.toXML();
1436                 expect(xmlOut).to.equal(expectedXmlOut);
1437             });
1438
1439         })
1440     })
1441 });
1442
1443
1444 });