refactoring

[fnpeditor.git] / modules / documentCanvas / canvas / canvas.test3.js

diff --git a/modules/documentCanvas/canvas/canvas.test3.js b/modules/documentCanvas/canvas/canvas.test3.js
index ff7c5c4..08e6e0f 100644 (file)
--- a/modules/documentCanvas/canvas/canvas.test3.js
+++ b/modules/documentCanvas/canvas/canvas.test3.js
@@ -1,8 +1,9 @@
 define([
 'libs/chai',
 define([
 'libs/chai',

+'libs/sinon',

 'modules/documentCanvas/canvas/canvas',
 'modules/documentCanvas/canvas/documentElement'
 'modules/documentCanvas/canvas/canvas',
 'modules/documentCanvas/canvas/documentElement'

-], function(chai, canvas, documentElement) {
+], function(chai, sinon, canvas, documentElement) {

     
 'use strict';
 
     
 'use strict';
 


@@ -67,7 +68,14 @@ describe('Canvas', function() {
 
         it('gives access to its document root node', function() {
             var c = canvas.fromXML('<section></section>');
 
         it('gives access to its document root node', function() {
             var c = canvas.fromXML('<section></section>');

-            expect(c.doc().wlxmlTag).to.equal('section');
+            expect(c.doc().getWlxmlTag()).to.equal('section');
+        });
+
+        describe('root element', function() {
+            it('has no parent', function() {
+                var c = canvas.fromXML('<section></section>');
+                expect(c.doc().parent()).to.be.null;
+            });

         });
 
         describe('DocumentTextElement', function() {
         });
 
         describe('DocumentTextElement', function() {


@@ -107,6 +115,27 @@ describe('Canvas', function() {
                 expect(section.getWlxmlClass()).to.be.undefined;
             });
         });
                 expect(section.getWlxmlClass()).to.be.undefined;
             });
         });

+
+        it('returns DocumentNodeElement instance from HTMLElement', function() {
+            var c = canvas.fromXML('<section></section>'),
+                htmlElement = c.doc().dom().get(0),
+                element = c.getDocumentElement(htmlElement);
+            expect(element).to.be.instanceOf(documentElement.DocumentNodeElement);
+            expect(element.sameNode(c.doc()));
+        });
+        
+        it('returns DocumentTextElement instance from Text Node', function() {
+            var c = canvas.fromXML('<section>Alice</section>'),
+                aliceElement = c.doc().children()[0],
+                textNode = aliceElement.dom()[0],
+                element = c.getDocumentElement(textNode);
+
+            expect(textNode.nodeType).to.equal(Node.TEXT_NODE, 'text node selected');
+            expect($(textNode).text()).to.equal('Alice');
+
+            expect(element).to.be.instanceOf(documentElement.DocumentTextElement);
+            expect(element.sameNode(c.doc().children()[0]));
+        });

     });
 
 
     });
 
 


@@ -307,14 +336,42 @@ describe('Canvas', function() {
                     var header1 = section.children()[0];
                     var header2 = section.children()[1];
 
                     var header1 = section.children()[0];
                     var header2 = section.children()[1];
 

-                    expect(header1.wlxmlTag).to.equal('header', 'first section child represents wlxml header');
+                    expect(header1.getWlxmlTag()).to.equal('header', 'first section child represents wlxml header');

                     expect(header1.children().length).to.equal(1, 'first header has one text child');
                     expect(header1.children()[0].getText()).to.equal('Some ', 'first header has correct content');
                     expect(header1.children().length).to.equal(1, 'first header has one text child');
                     expect(header1.children()[0].getText()).to.equal('Some ', 'first header has correct content');

-                    expect(header2.wlxmlTag).to.equal('header', 'second section child represents wlxml header');
+                    expect(header2.getWlxmlTag()).to.equal('header', 'second section child represents wlxml header');

                     expect(header2.children().length).to.equal(1, 'second header has one text child');
                     expect(header2.children()[0].getText()).to.equal('header', 'second header has correct content');
                 });
 
                     expect(header2.children().length).to.equal(1, 'second header has one text child');
                     expect(header2.children()[0].getText()).to.equal('header', 'second header has correct content');
                 });
 

+                it('leaves empty copy of DocumentNodeElement if splitting at the very beginning', function() {
+                        var c = canvas.fromXML('<section><header>Some header</header></section>'),
+                        section = c.doc(),
+                        text = section.children()[0].children()[0];
+
+                        text.split({offset: 0});
+                        
+                        var header1 = section.children()[0];
+                        var header2 = section.children()[1];
+
+                        expect(header1.children().length).to.equal(0);
+                        expect(header2.children()[0].getText()).to.equal('Some header');
+                });
+
+                it('leaves empty copy of DocumentNodeElement if splitting at the very end', function() {
+                        var c = canvas.fromXML('<section><header>Some header</header></section>'),
+                        section = c.doc(),
+                        text = section.children()[0].children()[0];
+
+                        text.split({offset: 11});
+                        
+                        var header1 = section.children()[0];
+                        var header2 = section.children()[1];
+
+                        expect(header1.children()[0].getText()).to.equal('Some header');
+                        expect(header2.children().length).to.equal(0);
+                });
+

                 it('keeps DocumentTextElement\'s parent\'s children elements intact', function() {
                     var c = canvas.fromXML('\
                             <section>\
                 it('keeps DocumentTextElement\'s parent\'s children elements intact', function() {
                     var c = canvas.fromXML('\
                             <section>\


@@ -330,19 +387,19 @@ describe('Canvas', function() {
                     
                     var sectionChildren = section.children();
                     expect(sectionChildren.length).to.equal(2, 'Section has two children');
                     
                     var sectionChildren = section.children();
                     expect(sectionChildren.length).to.equal(2, 'Section has two children');

-                    expect(sectionChildren[0].wlxmlTag).to.equal('header', 'First section element is a wlxml header');
-                    expect(sectionChildren[1].wlxmlTag).to.equal('header', 'Second section element is a wlxml header');
+                    expect(sectionChildren[0].getWlxmlTag()).to.equal('header', 'First section element is a wlxml header');
+                    expect(sectionChildren[1].getWlxmlTag()).to.equal('header', 'Second section element is a wlxml header');

 
                     var firstHeaderChildren = sectionChildren[0].children();
                     expect(firstHeaderChildren.length).to.equal(3, 'First header has three children');
                     expect(firstHeaderChildren[0].getText()).to.equal('A ', 'First header starts with a text');
 
                     var firstHeaderChildren = sectionChildren[0].children();
                     expect(firstHeaderChildren.length).to.equal(3, 'First header has three children');
                     expect(firstHeaderChildren[0].getText()).to.equal('A ', 'First header starts with a text');

-                    expect(firstHeaderChildren[1].wlxmlTag).to.equal('span', 'First header has span in the middle');
+                    expect(firstHeaderChildren[1].getWlxmlTag()).to.equal('span', 'First header has span in the middle');

                     expect(firstHeaderChildren[2].getText()).to.equal(' a', 'First header ends with text');
 
                     var secondHeaderChildren = sectionChildren[1].children();
                     expect(secondHeaderChildren.length).to.equal(3, 'Second header has three children');
                     expect(secondHeaderChildren[0].getText()).to.equal('nd ', 'Second header starts with text');
                     expect(firstHeaderChildren[2].getText()).to.equal(' a', 'First header ends with text');
 
                     var secondHeaderChildren = sectionChildren[1].children();
                     expect(secondHeaderChildren.length).to.equal(3, 'Second header has three children');
                     expect(secondHeaderChildren[0].getText()).to.equal('nd ', 'Second header starts with text');

-                    expect(secondHeaderChildren[1].wlxmlTag).to.equal('span', 'Second header has span in the middle');
+                    expect(secondHeaderChildren[1].getWlxmlTag()).to.equal('span', 'Second header has span in the middle');

                     expect(secondHeaderChildren[2].getText()).to.equal(' header', 'Second header ends with text');
                 });
             });
                     expect(secondHeaderChildren[2].getText()).to.equal(' header', 'Second header ends with text');
                 });
             });


@@ -375,26 +432,42 @@ describe('Canvas', function() {
                     expect(returned.getWlxmlClass()).to.equal('some.class');
                 });
                 
                     expect(returned.getWlxmlClass()).to.equal('some.class');
                 });
                 

-                it('wraps part of DocumentTextElement', function() {
-                    var c = canvas.fromXML('<section>Alice has a cat</section>'),
-                        text = c.doc().children()[0];
-                    
-                    var returned = text.wrapWithNodeElement({tag: 'header', klass: 'some.class', start: 5, end: 12}),
-                        children = c.doc().children();
-
-                    expect(children.length).to.equal(3);
-                    
-                    expect(children[0]).to.be.instanceOf(documentElement.DocumentTextElement);
-                    expect(children[0].getText()).to.equal('Alice');
+                describe('wrapping part of DocumentTextElement', function() {
+                    [{start: 5, end: 12}, {start: 12, end: 5}].forEach(function(offsets) {
+                        it('wraps in the middle ' + offsets.start + '/' + offsets.end, function() {
+                            var c = canvas.fromXML('<section>Alice has a cat</section>'),
+                                text = c.doc().children()[0];
+                            
+                            var returned = text.wrapWithNodeElement({tag: 'header', klass: 'some.class', start: offsets.start, end: offsets.end}),
+                                children = c.doc().children();
+
+                            expect(children.length).to.equal(3);
+                            
+                            expect(children[0]).to.be.instanceOf(documentElement.DocumentTextElement);
+                            expect(children[0].getText()).to.equal('Alice');
+
+                            expect(children[1].sameNode(returned)).to.be.true;
+                            expect(returned.getWlxmlTag()).to.equal('header');
+                            expect(returned.getWlxmlClass()).to.equal('some.class');
+                            expect(children[1].children().length).to.equal(1);
+                            expect(children[1].children()[0].getText()).to.equal(' has a ');
+
+                            expect(children[2]).to.be.instanceOf(documentElement.DocumentTextElement);
+                            expect(children[2].getText()).to.equal('cat');
+                        });
+                    });

 
 

-                    expect(children[1].sameNode(returned)).to.be.true;
-                    expect(returned.getWlxmlTag()).to.equal('header');
-                    expect(returned.getWlxmlClass()).to.equal('some.class');
-                    expect(children[1].children().length).to.equal(1);
-                    expect(children[1].children()[0].getText()).to.equal(' has a ');
+                    it('wraps whole text inside DocumentTextElement if offsets span entire content', function() {
+                         var c = canvas.fromXML('<section>Alice has a cat</section>'),
+                             text = c.doc().children()[0];
+                         
+                         var returned = text.wrapWithNodeElement({tag: 'header', klass: 'some.class', start: 0, end: 15}),
+                             children = c.doc().children();

 
 

-                    expect(children[2]).to.be.instanceOf(documentElement.DocumentTextElement);
-                    expect(children[2].getText()).to.equal('cat');
+                         expect(children.length).to.equal(1);
+                         expect(children[0]).to.be.instanceOf(documentElement.DocumentNodeElement);
+                         expect(children[0].children()[0].getText()).to.equal('Alice has a cat');
+                    });

                 });
 
                 it('wraps text spanning multiple sibling DocumentTextNodes', function() {
                 });
 
                 it('wraps text spanning multiple sibling DocumentTextNodes', function() {


@@ -426,31 +499,86 @@ describe('Canvas', function() {
                     expect(wrapperChildren[2].getText()).to.equal(' cat');
                 });
             });
                     expect(wrapperChildren[2].getText()).to.equal(' cat');
                 });
             });

+
+            describe('unwrapping', function() {
+                it('unwraps DocumentTextElement from its parent DocumentNodeElement if it\'s its only child', function() {
+                    var c = canvas.fromXML('<section>Alice <span>has a</span> cat</section>'),
+                    section = c.doc(),
+                    text = section.children()[1].children()[0];
+
+                    text.unwrap();
+
+                    expect(section.children().length).to.equal(1, 'section has one child');
+                    expect(section.children()[0].getText()).to.equal('Alice has a cat');
+                })
+            });

         });
 
         describe('Lists api', function() {
         });
 
         describe('Lists api', function() {

-            it('allows creation of a list from existing sibling DocumentElements', function() {
-                var c = canvas.fromXML('\
-                    <section>\
-                        Alice\
-                        <div>has</div>\
-                        a\
-                        <div>cat</div>\
-                    </section>'),
-                    section = c.doc(),
-                    textAlice = section.children()[0],
-                    divCat = section.children()[3]
+            describe('creating lists', function() {
+                it('allows creation of a list from existing sibling DocumentElements', function() {
+                    var c = canvas.fromXML('\
+                        <section>\
+                            Alice\
+                            <div>has</div>\
+                            a\
+                            <div>cat</div>\
+                        </section>'),
+                        section = c.doc(),
+                        textHas = section.children()[1],
+                        divA = section.children()[2]
+                    
+                    c.list.create({element1: textHas, element2: divA});
+
+                    expect(section.children().length).to.equal(3, 'section has three child elements');
+
+                    var child1 = section.children()[0],
+                        list = section.children()[1],
+                        child3 = section.children()[2];
+
+                    expect(child1.getText()).to.equal('Alice');
+                    expect(list.is('list')).to.equal(true, 'second child is a list');
+                    expect(list.children().length).to.equal(2, 'list contains two elements');
+                    list.children().forEach(function(child) {
+                        expect(child.getWlxmlClass()).to.equal('item', 'list childs have wlxml class of item');
+                    });
+                    expect(child3.children()[0].getText()).to.equal('cat');
+                });

                 
                 

-                c.list.create({element1: textAlice, element2: divCat});
+                it('allows creating nested list from existing sibling list items', function() {
+                    var c = canvas.fromXML('\
+                        <section>\
+                            <div class="list-items">\
+                                <div class="item">A</div>\
+                                <div class="item">B</div>\
+                                <div class="item">C</div>\
+                                <div class="item">D</div>\
+                            </div>\
+                        </section>'),
+                        outerList = c.doc().children()[0],
+                        itemB = outerList.children()[1],
+                        itemC = outerList.children()[2];
+
+
+                        c.list.create({element1: itemB, element2: itemC});
+
+                    var outerListItems = outerList.children(),
+                        innerList = outerListItems[1].children()[0],
+                        innerListItems = innerList.children();
+
+                    expect(outerListItems.length).to.equal(3, 'outer list has three items');
+                    expect(outerListItems[0].children()[0].getText()).to.equal('A', 'first outer item ok');
+                    expect(outerListItems[1].getWlxmlClass()).to.equal('item', 'inner list is wrapped by item element');
+
+                    expect(innerList.is('list')).to.equal(true, 'inner list created');
+                    expect(innerListItems.length).to.equal(2, 'inner list has two items');
+                    expect(innerListItems[0].children()[0].getText()).to.equal('B', 'first inner item ok');
+                    expect(innerListItems[1].children()[0].getText()).to.equal('C', 'second inner item ok');

 
 

-                expect(section.children().length).to.equal(1, 'section has one child element');
+                    expect(outerListItems[2].children()[0].getText()).to.equal('D', 'last outer item ok');

 
 

-                var list = section.children()[0];
-                expect(list.is('list')).to.equal(true, 'section\'s only child is a list');
-                expect(list.children().length).to.equal(4, 'list contains four elements');
-                list.children().forEach(function(child) {
-                    expect(child.getWlxmlClass()).to.equal('item', 'list childs have wlxml class of item');

                 });
                 });

+

             });
 
             describe('extracting list items', function() {
             });
 
             describe('extracting list items', function() {


@@ -592,7 +720,7 @@ describe('Canvas', function() {
                         nestedList = list.children()[1].children()[0],
                         nestedListItem = nestedList.children()[1];
 
                         nestedList = list.children()[1].children()[0],
                         nestedListItem = nestedList.children()[1];
 

-                    c.list.extractItems({element1: nestedListItem, element2: nestedListItem, merge: true});
+                    c.list.extractItems({element1: nestedListItem, element2: nestedListItem});

 
                     var section = c.doc(),
                         list = section.children()[0],
 
                     var section = c.doc(),
                         list = section.children()[0],


@@ -641,7 +769,7 @@ describe('Canvas', function() {
                         nestedListItem1 = nestedList.children()[1],
                         nestedListItem2 = nestedList.children()[2];
 
                         nestedListItem1 = nestedList.children()[1],
                         nestedListItem2 = nestedList.children()[2];
 

-                    c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2, merge: true});
+                    c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});

 
                     var section = c.doc(),
                         list = section.children()[0],
 
                     var section = c.doc(),
                         list = section.children()[0],


@@ -682,7 +810,7 @@ describe('Canvas', function() {
                         nestedListItem1 = nestedList.children()[0],
                         nestedListItem2 = nestedList.children()[1];
 
                         nestedListItem1 = nestedList.children()[0],
                         nestedListItem2 = nestedList.children()[1];
 

-                    c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2, merge: true});
+                    c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});

 
                     var section = c.doc(),
                         list = section.children()[0],
 
                     var section = c.doc(),
                         list = section.children()[0],


@@ -723,7 +851,7 @@ describe('Canvas', function() {
                         nestedListItem1 = nestedList.children()[0],
                         nestedListItem2 = nestedList.children()[1];
 
                         nestedListItem1 = nestedList.children()[0],
                         nestedListItem2 = nestedList.children()[1];
 

-                    c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2, merge: true});
+                    c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});

 
                     var section = c.doc(),
                         list = section.children()[0],
 
                     var section = c.doc(),
                         list = section.children()[0],


@@ -738,9 +866,144 @@ describe('Canvas', function() {
                     expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
                     expect(item4.children()[0].getText()).to.equal('2', 'fourth item ok');
                 });
                     expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
                     expect(item4.children()[0].getText()).to.equal('2', 'fourth item ok');
                 });

+
+                it('extracts items out of outer most list when merge flag is set to false', function() {
+                    var c = canvas.fromXML('\
+                        <section>\
+                            <div class="list.items">\
+                                <div class="item">0</div>\
+                                <div class="item">\
+                                    <div class="list.items">\
+                                        <div class="item">1.1</div>\
+                                        <div class="item">1.2</div>\
+                                    </div>\
+                                </div>\
+                                <div class="item">2</div>\
+                            </div>\
+                        </section>'),
+                        section = c.doc(),
+                        list = section.children()[0],
+                        nestedList = list.children()[1].children()[0],
+                        nestedListItem = nestedList.children()[0];
+
+                    var test = c.list.extractItems({element1: nestedListItem, element2: nestedListItem, merge: false});
+
+                    expect(test).to.equal(true, 'extraction status ok');
+
+                    var sectionChildren = section.children(),
+                        extractedItem = sectionChildren[1];
+
+                    expect(sectionChildren.length).to.equal(3, 'section has three children');
+                    expect(sectionChildren[0].is('list')).to.equal(true, 'first child is a list');
+
+                    expect(extractedItem.getWlxmlTag()).to.equal('div', 'extracted item is a wlxml div');
+                    expect(extractedItem.getWlxmlClass()).to.equal(undefined, 'extracted item has no wlxml class');
+                    expect(extractedItem.children()[0].getText()).to.equal('1.1', 'extracted item ok');
+                    expect(sectionChildren[2].is('list')).to.equal(true, 'second child is a list');
+                });
+            });
+        });
+
+    });
+
+    describe('Cursor', function() {
+
+        var getSelection;
+
+        beforeEach(function() {
+            getSelection = sinon.stub(window, 'getSelection');
+        });
+
+        afterEach(function() {
+            getSelection.restore();
+        });
+
+        it('returns position when browser selection collapsed', function() {
+            var c = canvas.fromXML('<section>Alice has a cat</section>'),
+                dom = c.doc().dom(),
+                text = dom.contents()[0];
+
+            expect($(text).text()).to.equal('Alice has a cat');
+
+            getSelection.returns({
+                anchorNode: text,
+                focusNode: text,
+                anchorOffset: 5,
+                focusOffset: 5,
+                isCollapsed: true

             });
             });

+            var cursor = c.getCursor(),
+                position = cursor.getPosition();
+
+            expect(cursor.isSelecting()).to.equal(false, 'cursor is not selecting anything');
+            expect(position.element.getText()).to.equal('Alice has a cat');
+            expect(position.offset).to.equal(5);
+        });
+
+        it('returns boundries of selection when browser selection not collapsed', function() {
+            var c = canvas.fromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
+                dom = c.doc().dom(),
+                text = {
+                    alice: dom.contents()[0],
+                    has: $(dom.contents()[1]).contents()[0],
+                    cat: dom.contents()[4]
+                },
+                cursor = c.getCursor(),
+                aliceElement = c.getDocumentElement(text.alice),
+                catElement = c.getDocumentElement(text.cat);
+
+
+                [
+                    {focus: text.alice, focusOffset: 1, anchor: text.cat,   anchorOffset: 2, selectionAnchor: catElement},
+                    {focus: text.cat,   focusOffset: 2, anchor: text.alice, anchorOffset: 1, selectionAnchor: aliceElement}
+                ].forEach(function(s, idx) {
+                    getSelection.returns({isColapsed: false, anchorNode: s.anchor, anchorOffset: s.anchorOffset, focusNode: s.focus, focusOffset: s.focusOffset});
+
+                    var selectionStart = cursor.getSelectionStart(),
+                        selectionEnd = cursor.getSelectionEnd(),
+                        selectionAnchor = cursor.getSelectionAnchor();
+
+                    expect(cursor.isSelecting()).to.equal(true, 'cursor is selecting');
+                    expect(selectionStart.element.sameNode(aliceElement)).to.equal(true, '"Alice" is the start of the selection ' + idx);
+                    expect(selectionStart.offset).to.equal(1, '"Alice" offset ok' + idx);
+                    expect(selectionEnd.element.sameNode(catElement)).to.equal(true, '"Cat" is the start of the selection ' + idx);
+                    expect(selectionEnd.offset).to.equal(2, '"Cat" offset ok' + idx);
+                    expect(selectionAnchor.element.sameNode(s.selectionAnchor)).to.equal(true, 'anchor ok');
+                    expect(selectionAnchor.offset).to.equal(s.anchorOffset, 'anchor offset ok');
+                });

         });
 
         });
 

+        it('recognizes when browser selection boundries lies in sibling DocumentTextElements', function() {
+            var c = canvas.fromXML('<section>Alice <span>has</span> a <span>big</span> cat</section>'),
+                dom = c.doc().dom(),
+                text = {
+                    alice: dom.contents()[0],
+                    has: $(dom.contents()[1]).contents()[0],
+                    a: dom.contents()[2],
+                    big: $(dom.contents()[3]).contents()[0],
+                    cat: dom.contents()[4]
+                },
+                cursor = c.getCursor();
+
+            expect($(text.alice).text()).to.equal('Alice ');
+            expect($(text.has).text()).to.equal('has');
+            expect($(text.a).text()).to.equal(' a ');
+            expect($(text.big).text()).to.equal('big');
+            expect($(text.cat).text()).to.equal(' cat');
+
+            getSelection.returns({anchorNode: text.alice, focusNode: text.a});
+            expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "a" are children');
+
+            getSelection.returns({anchorNode: text.alice, focusNode: text.cat});
+            expect(cursor.isSelectingSiblings()).to.equal(true, '"Alice" and "cat" are children');
+
+            getSelection.returns({anchorNode: text.alice, focusNode: text.has});
+            expect(cursor.isSelectingSiblings()).to.equal(false, '"Alice" and "has" are not children');
+
+            getSelection.returns({anchorNode: text.has, focusNode: text.big});
+            expect(cursor.isSelectingSiblings()).to.equal(false, '"has" and "big" are not children');
+            
+        })

     });
 });
 
     });
 });