Changing Zero Width Space handling strategy
[fnpeditor.git] / modules / documentCanvas / canvas / canvas.test3.js
index 3b14b19..f96e0ff 100644 (file)
@@ -2,8 +2,9 @@ define([
 'libs/chai',
 'libs/sinon',
 'modules/documentCanvas/canvas/canvas',
 'libs/chai',
 'libs/sinon',
 'modules/documentCanvas/canvas/canvas',
-'modules/documentCanvas/canvas/documentElement'
-], function(chai, sinon, canvas, documentElement) {
+'modules/documentCanvas/canvas/documentElement',
+'modules/documentCanvas/canvas/utils'
+], function(chai, sinon, canvas, documentElement, utils) {
     
 'use strict';
 
     
 'use strict';
 
@@ -12,6 +13,58 @@ var expect = chai.expect;
 
 describe('Canvas', function() {
 
 
 describe('Canvas', function() {
 
+
+
+    describe('ZWS', function() {
+        var view, section, textElement;
+        
+        beforeEach(function() {
+            var c = canvas.fromXML('<section></section>');
+
+            section = c.doc();
+            textElement = section.children()[0];
+            view = c.view()[0];
+            document.getElementsByTagName('body')[0].appendChild(view);
+        });
+
+        afterEach(function() {
+            view.parentNode.removeChild(view);
+        });
+
+        var getTextContainerNode = function(textElement) {
+            return textElement.dom().contents()[0];
+        }
+
+        it('is set automatically on all empty DocumentTextElements', function() {
+            expect(getTextContainerNode(textElement).data).to.equal(utils.unicode.ZWS);
+
+            var header = section.append({tag: 'header'}),
+                newText = header.append({text: ''}),
+                textNode = getTextContainerNode(textElement);
+            
+            expect(textNode.data).to.equal(utils.unicode.ZWS);
+        });
+
+        it('is added automatically when whole text gets deleted', function() {
+            getTextContainerNode(textElement).data = '';
+            
+            window.setTimeout(function() {
+                expect(getTextContainerNode(textElement).data).to.equal(utils.unicode.ZWS);
+            }, 0)
+            
+            var header = section.append({tag: 'header'}),
+                newText = header.append({text: 'Alice'}),
+                textNode = getTextContainerNode(newText);
+
+            expect(textNode.data).to.have.length('Alice'.length);
+            textNode.data = '';
+
+            window.setTimeout(function() {
+                expect(textNode.data).to.equal(utils.unicode.ZWS);
+            }, 0)
+        });
+    });
+
     describe('Internal HTML representation of a DocumentNodeElement', function() {
         it('is always a div tag', function() {
             ['section', 'header', 'span', 'aside', 'figure'].forEach(function(tagName) {
     describe('Internal HTML representation of a DocumentNodeElement', function() {
         it('is always a div tag', function() {
             ['section', 'header', 'span', 'aside', 'figure'].forEach(function(tagName) {
@@ -30,10 +83,10 @@ describe('Canvas', function() {
     });
 
     describe('Internal HTML representation of a DocumentTextElement', function() {
     });
 
     describe('Internal HTML representation of a DocumentTextElement', function() {
-        it('is text node wrapped in a div with wlxml-text attribute set', function() {
+        it('is text node wrapped in a div with document-text-element attribute set', function() {
             var dom = canvas.fromXML('<section>Alice</section>').doc().children()[0].dom();
             expect(dom.prop('tagName')).to.equal('DIV');
             var dom = canvas.fromXML('<section>Alice</section>').doc().children()[0].dom();
             expect(dom.prop('tagName')).to.equal('DIV');
-            expect(dom.attr('wlxml-text')).to.equal('');
+            expect(dom.attr('document-text-element')).to.equal('');
             expect(dom.contents().length).to.equal(1);
             expect(dom.contents()[0].nodeType).to.equal(Node.TEXT_NODE);
             expect($(dom.contents()[0]).text()).to.equal('Alice');
             expect(dom.contents().length).to.equal(1);
             expect(dom.contents()[0].nodeType).to.equal(Node.TEXT_NODE);
             expect($(dom.contents()[0]).text()).to.equal('Alice');
@@ -206,6 +259,39 @@ describe('Canvas', function() {
                 });
             });
 
                 });
             });
 
+            describe('accessing sibling parents of two elements', function() {
+                it('returns elements themself if they have direct common parent', function() {
+                    var c = canvas.fromXML('<section>\
+                        <div>\
+                            <div>A</div>\
+                            <div>B</div>\
+                        </div>\
+                    </section>'),
+                        section = c.doc(),
+                        wrappingDiv = c.doc().children()[0],
+                        divA = wrappingDiv.children()[0],
+                        divB = wrappingDiv.children()[1];
+
+                    var siblingParents = c.getSiblingParents({element1: divA, element2: divB});
+
+                    expect(siblingParents.element1.sameNode(divA)).to.equal(true, 'divA');
+                    expect(siblingParents.element2.sameNode(divB)).to.equal(true, 'divB');
+                });
+
+                it('returns sibling parents - example 1', function() {
+                    var c = canvas.fromXML('<section>Alice <span>has a cat</span></section>'),
+                        section = c.doc(),
+                        aliceText = section.children()[0],
+                        span = section.children()[1],
+                        spanText = span.children()[0];
+
+                    var siblingParents = c.getSiblingParents({element1: aliceText, element2: spanText});
+
+                    expect(siblingParents.element1.sameNode(aliceText)).to.equal(true, 'aliceText');
+                    expect(siblingParents.element2.sameNode(span)).to.equal(true, 'span');
+                });
+            })
+
             describe('free text handling', function() {
                     it('sees free text', function() {
                         var c = canvas.fromXML('<section>Alice <span>has</span> a cat</section>'),
             describe('free text handling', function() {
                     it('sees free text', function() {
                         var c = canvas.fromXML('<section>Alice <span>has</span> a cat</section>'),
@@ -216,12 +302,24 @@ describe('Canvas', function() {
                         expect(children[2]).to.be.instanceOf(documentElement.DocumentTextElement);
                     });
             });
                         expect(children[2]).to.be.instanceOf(documentElement.DocumentTextElement);
                     });
             });
-            
-            describe('white characters handling', function() {
-                it('says empty element node has no children', function() {
+
+            describe('empty nodes handling', function() {
+                it('says empty element node from XML source has one empty DocumentTextElement', function() {
                     var c = canvas.fromXML('<section></section>');
                     var c = canvas.fromXML('<section></section>');
-                    expect(c.doc().children().length).to.equal(0);
+                    expect(c.doc().children()).to.have.length(1);
+                    expect(c.doc().children()[0].getText()).to.equal('');
                 });
                 });
+
+                it('allows creation of an empty element node', function() {
+                    var c = canvas.fromXML('<section></section>'),
+                        section = c.doc(),
+                        header = section.append({tag: 'header'});
+                    expect(header.children()).to.have.length(0);
+                });
+            });
+            
+            describe('white characters handling', function() {
+
                 it('says element node with one space has one DocumentTextElement', function() {
                     var c = canvas.fromXML('<section> </section>');
                     expect(c.doc().children().length).to.equal(1);
                 it('says element node with one space has one DocumentTextElement', function() {
                     var c = canvas.fromXML('<section> </section>');
                     expect(c.doc().children().length).to.equal(1);
@@ -296,21 +394,40 @@ describe('Canvas', function() {
 
             describe('Basic Element inserting', function() {
                 it('can put new NodeElement at the end', function() {
 
             describe('Basic Element inserting', function() {
                 it('can put new NodeElement at the end', function() {
-                    var c = canvas.fromXML('<section></section>'),
+                    var c = canvas.fromXML('<section><div></div></section>'),
                         appended = c.doc().append({tag: 'header', klass: 'some.class'}),
                         children = c.doc().children();
 
                         appended = c.doc().append({tag: 'header', klass: 'some.class'}),
                         children = c.doc().children();
 
-                    expect(children.length).to.equal(1);
-                    expect(children[0].sameNode(appended)).to.be.true;
+                    expect(children.length).to.equal(2);
+                    expect(children[1].sameNode(appended)).to.be.true;
                 });
 
                 it('can put new TextElement at the end', function() {
                 });
 
                 it('can put new TextElement at the end', function() {
-                    var c = canvas.fromXML('<section></section>'),
+                    var c = canvas.fromXML('<section><div><div></section>'),
                         appended = c.doc().append({text: 'Alice'}),
                         children = c.doc().children();
 
                         appended = c.doc().append({text: 'Alice'}),
                         children = c.doc().children();
 
-                    expect(children.length).to.equal(1);
-                    expect(children[0].sameNode(appended)).to.be.true;
+                    expect(children.length).to.equal(2);
+                    expect(children[1].sameNode(appended)).to.be.true;
+                    expect(children[1].getText()).to.equal('Alice');
+                });
+
+                it('can put new NodeElement at the beginning', function() {
+                    var c = canvas.fromXML('<section><div></div></section>'),
+                        prepended = c.doc().prepend({tag: 'header', klass: 'some.class'}),
+                        children = c.doc().children();
+
+                    expect(children).to.have.length(2);
+                    expect(children[0].sameNode(prepended)).to.be.true;
+                });
+
+                it('can put new TextElement at the beginning', function() {
+                    var c = canvas.fromXML('<section><div></div></section>'),
+                        prepended = c.doc().prepend({text: 'Alice'}),
+                        children = c.doc().children();
+
+                    expect(children).to.have.length(2)
+                    expect(children[0].sameNode(prepended)).to.be.true;
                     expect(children[0].getText()).to.equal('Alice');
                 });
 
                     expect(children[0].getText()).to.equal('Alice');
                 });
 
@@ -405,6 +522,22 @@ describe('Canvas', function() {
                 });
             });
 
                 });
             });
 
+            describe('Removing elements', function() {
+                it('merges left and right DocumentTextElement sibling of a detached DocumentNodeElement', function() {
+                    var c = canvas.fromXML('<section>Alice<div>has</div>a cat</section>'),
+                        section = c.doc(),
+                        div = section.children()[1];
+
+                    div.detach();
+
+                    var sectionChildren = section.children(),
+                        textElement = sectionChildren[0];
+
+                    expect(sectionChildren).to.have.length(1);
+                    expect(textElement.getText()).to.equal('Alicea cat');
+                });
+            });
+
             describe('Splitting text', function() {
                 
                 it('splits DocumentTextElement\'s parent into two DocumentNodeElements of the same type', function() {
             describe('Splitting text', function() {
                 
                 it('splits DocumentTextElement\'s parent into two DocumentNodeElements of the same type', function() {
@@ -583,10 +716,76 @@ describe('Canvas', function() {
 
                     expect(wrapperChildren[2].getText()).to.equal(' cat');
                 });
 
                     expect(wrapperChildren[2].getText()).to.equal(' cat');
                 });
+
+                it('wraps multiple sibling Elements', function() {
+                    var c = canvas.fromXML('<section>Alice<div>has</div><div>a cat</div></section>'),
+                        section = c.doc(),
+                        aliceText = section.children()[0],
+                        firstDiv = section.children()[1],
+                        lastDiv = section.children()[section.children().length -1];
+
+                    var returned = c.wrapElements({
+                            element1: aliceText,
+                            element2: lastDiv,
+                            _with: {tag: 'header'}
+                        });
+
+                    var sectionChildren = section.children(),
+                        header = sectionChildren[0],
+                        headerChildren = header.children();
+
+                    expect(sectionChildren).to.have.length(1);
+                    expect(header.sameNode(returned)).to.equal(true, 'wrapper returned');
+                    expect(headerChildren).to.have.length(3);
+                    expect(headerChildren[0].sameNode(aliceText)).to.equal(true, 'first node wrapped');
+                    expect(headerChildren[1].sameNode(firstDiv)).to.equal(true, 'second node wrapped');
+                    expect(headerChildren[2].sameNode(lastDiv)).to.equal(true, 'third node wrapped');
+                });
+                it('wraps multiple sibling Elements - middle case', function() {
+                    var c = canvas.fromXML('<section><div></div>div></div><div></div><div></div></section>'),
+                        section = c.doc(),
+                        div1 = section.children()[0],
+                        div2 = section.children()[1],
+                        div3 = section.children()[2],
+                        div4 = section.children()[3];
+
+                    var returned = c.wrapElements({
+                            element1: div2,
+                            element2: div3,
+                            _with: {tag: 'header'}
+                        });
+
+                    var sectionChildren = section.children(),
+                        header = sectionChildren[1],
+                        headerChildren = header.children();
+
+                    expect(sectionChildren).to.have.length(3);
+                    expect(headerChildren).to.have.length(2);
+                    expect(headerChildren[0].sameNode(div2)).to.equal(true, 'first node wrapped');
+                    expect(headerChildren[1].sameNode(div3)).to.equal(true, 'second node wrapped');
+                });
             });
 
             });
 
-            describe('unwrapping', function() {
-                it('unwraps DocumentTextElement from its parent DocumentNodeElement if it\'s its only child', function() {
+            describe('unwrapping DocumentTextElement from its parent DocumentNodeElement if it\'s its only child', function() {
+                it('unwraps text element from its parent and stays between its old parent siblings', function() {
+                    var c = canvas.fromXML('<section><div>Alice</div><div>has</div><div>a cat</div></section>'),
+                        section = c.doc(),
+                        sectionChildren = section.children(),
+                        divAlice = sectionChildren[0],
+                        divHas = sectionChildren[1],
+                        textHas = divHas.children()[0],
+                        divCat = sectionChildren[2];
+
+                    var newTextContainer = textHas.unwrap(),
+                        sectionChildren = section.children();
+
+                    expect(sectionChildren[0].sameNode(divAlice)).to.equal(true, 'divAlice ok');
+                    expect(newTextContainer.sameNode(section)).to.equal(true, 'unwrap returns new text parent DocumentNodeElement');
+                    expect(sectionChildren[1].getText()).to.equal('has');
+                    expect(sectionChildren[2].sameNode(divCat)).to.equal(true, 'divCat ok');
+
+                });
+                it('unwraps and join with its old parent adjacent text elements ', function() {
                     var c = canvas.fromXML('<section>Alice <span>has a</span> cat</section>'),
                     section = c.doc(),
                     text = section.children()[1].children()[0];
                     var c = canvas.fromXML('<section>Alice <span>has a</span> cat</section>'),
                     section = c.doc(),
                     text = section.children()[1].children()[0];
@@ -596,7 +795,20 @@ describe('Canvas', function() {
                     expect(section.children().length).to.equal(1, 'section has one child');
                     expect(section.children()[0].getText()).to.equal('Alice has a cat');
                     expect(newTextContainer.sameNode(c.doc())).to.equal(true, 'unwrap returns new text parent DocumentNodeElement');
                     expect(section.children().length).to.equal(1, 'section has one child');
                     expect(section.children()[0].getText()).to.equal('Alice has a cat');
                     expect(newTextContainer.sameNode(c.doc())).to.equal(true, 'unwrap returns new text parent DocumentNodeElement');
-                })
+                });
+
+                it('unwraps text element from its parent - first child case', function() {
+                    var c = canvas.fromXML('<section><span class="uri">Some</span>text</section>'),
+                        section = c.doc(),
+                        span = section.children()[0];
+
+                    span.children()[0].unwrap();
+
+                    var sectionChildren = section.children();
+
+                    expect(sectionChildren).to.have.length(1);
+                    expect(sectionChildren[0].getText()).to.equal('Sometext');
+                });
             });
         });
 
             });
         });
 
@@ -1183,8 +1395,9 @@ describe('Canvas', function() {
 
             it('keeps white space between XML nodes - inline case', function() {
                 var xmlIn = '<section>\n\n\n<span></span>\n\n\n<span></span>\n\n\n</section>',
 
             it('keeps white space between XML nodes - inline case', function() {
                 var xmlIn = '<section>\n\n\n<span></span>\n\n\n<span></span>\n\n\n</section>',
-                c = canvas.fromXML(xmlIn),
-                xmlOut = c.toXML();
+                c = canvas.fromXML(xmlIn);
+                
+                var xmlOut = c.toXML();
 
                 var partsIn = xmlIn.split('\n\n\n'),
                     partsOut = xmlOut.split('\n\n\n');
 
                 var partsIn = xmlIn.split('\n\n\n'),
                     partsOut = xmlOut.split('\n\n\n');