describe('Canvas', function() {
+
+ describe('Internal HTML representation of a sample document', function() {
+ it('works', function() {
+ var c = canvas.fromXML('\
+ <section>\
+ This is some text without its own wrapping tag.\
+ <div class="p.subclass">\
+ This is a paragraph.\
+ </div>\
+ <div>\
+ This is text in a div <span>with some inline text</span>.\
+ </div>\
+ This is some text without its own wrapping tag.\
+ </section>\
+ ');
+ var expected = '<div wlxml-tag="section">'
+ + 'This is some text without its own wrapping tag.'
+ + '<div wlxml-tag="div" wlxml-class="p-subclass">This is a paragraph.</div>'
+ + '<div wlxml-tag="div">This is text in a div <div wlxml-tag="span">with some inline text</div>.</div>'
+ + 'This is some text without its own wrapping tag.'
+ + '</div>';
+ expect(c.doc().dom()[0].isEqualNode($(expected)[0])).to.be.true;
+ });
+ });
+
+ describe('Internal HTML representation of a DocumentNodeElement', function() {
+ it('is always a div tag', function() {
+ ['section', 'header', 'span', 'aside', 'figure'].forEach(function(tagName) {
+ var dom = canvas.fromXML('<' + tagName + '></' + tagName + '>').doc().dom();
+ expect(dom.prop('tagName')).to.equal('DIV', tagName + ' is represented as div');
+ });
+ });
+ it('has wlxml tag put into wlxml-tag attribute', function() {
+ var dom = canvas.fromXML('<section></section>').doc().dom();
+ expect(dom.attr('wlxml-tag')).to.equal('section');
+ });
+ it('has wlxml class put into wlxml-class, dots replaced with dashes', function() {
+ var dom = canvas.fromXML('<section class="some.class"></section>').doc().dom();
+ expect(dom.attr('wlxml-class')).to.equal('some-class');
+ });
+ });
+
+ describe('Internal HTML representation of a DocumentTextElement', function() {
+ it('is just a TextNode', function() {
+ var dom = canvas.fromXML('<section>Alice</section>').doc().children()[0].dom();
+ expect(dom[0].nodeType === Node.TEXT_NODE);
+ });
+ });
+
describe('basic properties', function() {
it('renders empty document when canvas created from empty XML', function() {
var c = canvas.fromXML('');
expect(c.doc().wlxmlTag).to.equal('section');
});
- describe('DocumentElement', function() {
+ describe('DocumentTextElement', function() {
+ it('can have its content set', function() {
+ var c = canvas.fromXML('<section>Alice</section>'),
+ root = c.doc(),
+ text = root.children()[0];
+
+ text.setText('a cat');
+ expect(root.children()[0].getText()).to.equal('a cat');
+ });
+ });
+
+ describe('DocumentNodeElement', function() {
it('knows index of its child', function() {
var c = canvas.fromXML('<section><div></div><header></header><span></span></section>'),
root = c.doc(),
expect(root.childIndex(child)).to.equal(1);
});
- describe('DocumentTextElement can have its content set', function() {
- var c = canvas.fromXML('<section>Alice</section>'),
- root = c.doc(),
- text = root.children()[0];
-
- text.setText('a cat');
- expect(root.children()[0].getText()).to.equal('a cat');
+ it('knows WLXML tag it renders', function(){
+ var c = canvas.fromXML('<section></section>'),
+ section = c.doc();
+ expect(section.getWlxmlTag()).to.equal('section', 'initial tag is section');
+ section.setWlxmlTag('header');
+ expect(section.getWlxmlTag()).to.equal('header', 'tag is changed to header');
});
+
+ it('knows WLXML class of a WLXML tag it renders', function(){
+ var c = canvas.fromXML('<section class="some.class"></section>'),
+ section = c.doc();
+ expect(section.getWlxmlClass()).to.equal('some.class');
+ section.setWlxmlClass('some.other.class');
+ expect(section.getWlxmlClass()).to.equal('some.other.class');
+ section.setWlxmlClass(null);
+ 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>'),
+ textNode = c.doc().children(0)[0].dom().get(0),
+ element = c.getDocumentElement(textNode);
+ expect(element).to.be.instanceOf(documentElement.DocumentTextElement);
+ expect(element.sameNode(c.doc().children()[0]));
});
});
+
+
describe('document representation api', function() {
describe('document root element', function() {
var c = canvas.fromXML('<section></section>');
var c = canvas.fromXML('<section> </section>');
expect(c.doc().children().length).to.equal(1);
expect(c.doc().children()[0]).to.be.instanceOf(documentElement.DocumentTextElement);
+ expect(c.doc().children()[0].getText()).to.equal(' ');
});
it('ignores white space surrounding block elements', function() {
var c = canvas.fromXML('<section> <div></div> </section>');
expect(returned.sameNode(parent)).to.be.true;
expect(returned.sameNode(parent2)).to.be.true;
+ expect(returned.getWlxmlTag()).to.equal('header');
+ expect(returned.getWlxmlClass()).to.equal('some.class');
});
it('wraps DocumentTextElement', function() {
var c = canvas.fromXML('<section>Alice</section>'),
expect(returned.sameNode(parent)).to.be.true;
expect(returned.sameNode(parent2)).to.be.true;
+ expect(returned.getWlxmlTag()).to.equal('header');
+ 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(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() {
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><div>Alice has a cat</div></section>'),
+ section = c.doc(),
+ text = section.children()[0].children()[0];
+
+ text.unwrap();
+
+ expect(section.children().length).to.equal(1);
+ expect(section.children()[0].getText()).to.equal('Alice has a cat');
+ })
+ });
});
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(outerListItems[2].children()[0].getText()).to.equal('D', 'last outer item ok');
+
+ });
+
+ });
- expect(section.children().length).to.equal(1, 'section has one child element');
+ describe('extracting list items', function() {
+ it('creates two lists with extracted items in the middle if extracting from the middle of the list', function() {
+ var c = canvas.fromXML('\
+ <section>\
+ <div class="list.items">\
+ <div class="item">0</div>\
+ <div class="item">1</div>\
+ <div class="item">2</div>\
+ <div class="item">3</div>\
+ </div>\
+ </section>'),
+ list = c.doc().children()[0],
+ item1 = list.children()[1],
+ item2 = list.children()[2];
+
+ c.list.extractItems({element1: item1, element2: item2});
+
+ var section = c.doc(),
+ list1 = section.children()[0],
+ oldItem1 = section.children()[1],
+ oldItem2 = section.children()[2],
+ list2 = section.children()[3];
+
+ expect(section.children().length).to.equal(4, 'section contains four children');
+
+ expect(list1.is('list')).to.equal(true, 'first section child is a list');
+ expect(list1.children().length).to.equal(1, 'first list has one child');
+ expect(list1.children()[0].children()[0].getText()).to.equal('0', 'first item of the first list is a first item of the original list');
+
+ expect(oldItem1.children()[0].getText()).to.equal('1', 'first item got extracted');
+ expect(oldItem1.getWlxmlClass() === undefined).to.equal(true, 'first extracted element has no wlxml class');
+
+ expect(oldItem2.children()[0].getText()).to.equal('2', 'second item got extracted');
+ expect(oldItem2.getWlxmlClass() === undefined).to.equal(true, 'second extracted element has no wlxml class');
+
+ expect(list2.is('list')).to.equal(true, 'last section child is a list');
+ expect(list2.children().length).to.equal(1, 'second list has one child');
+ expect(list2.children()[0].children()[0].getText()).to.equal('3', 'first item of the second list is a last item of the original list');
+ });
+
+ it('puts extracted items above the list if starting item is the first one', function() {
+ var c = canvas.fromXML('\
+ <section>\
+ <div class="list.items">\
+ <div class="item">0</div>\
+ <div class="item">1</div>\
+ <div class="item">2</div>\
+ </div>\
+ </section>'),
+ list = c.doc().children()[0],
+ item1 = list.children()[0],
+ item2 = list.children()[1],
+ item3 = list.children()[2];
+
+ c.list.extractItems({element1: item1, element2: item2});
+
+ var section = c.doc(),
+ oldItem1 = section.children()[0],
+ oldItem2 = section.children()[1],
+ newList = section.children()[2];
+
+ expect(section.children().length).to.equal(3, 'section has three children');
+ expect(oldItem1.children()[0].getText()).to.equal('0', 'first item extracted');
+ expect(oldItem2.children()[0].getText()).to.equal('1', 'second item extracted');
+ expect(newList.is('list')).to.equal(true, 'list lies below extracted item');
+ expect(newList.children().length).to.equal(1, 'list has now one child');
+ });
- 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');
+ it('puts extracted items below the list if ending item is the last one', function() {
+ var c = canvas.fromXML('\
+ <section>\
+ <div class="list.items">\
+ <div class="item">0</div>\
+ <div class="item">1</div>\
+ <div class="item">2</div>\
+ </div>\
+ </section>'),
+ list = c.doc().children()[0],
+ item1 = list.children()[0],
+ item2 = list.children()[1],
+ item3 = list.children()[2];
+
+ c.list.extractItems({element1: item2, element2: item3});
+
+ var section = c.doc(),
+ oldItem1 = section.children()[1],
+ oldItem2 = section.children()[2],
+ newList = section.children()[0];
+
+ expect(section.children().length).to.equal(3, 'section has three children');
+ expect(oldItem1.children()[0].getText()).to.equal('1', 'first item extracted');
+ expect(oldItem2.children()[0].getText()).to.equal('2', 'second item extracted');
+ expect(newList.is('list')).to.equal(true, 'list lies above extracted item');
+ expect(newList.children().length).to.equal(1, 'list has now one child');
+ });
+
+ it('removes list if all its items are extracted', function() {
+ var c = canvas.fromXML('\
+ <section>\
+ <div class="list.items">\
+ <div class="item">some item</div>\
+ <div class="item">some item 2</div>\
+ </div>\
+ </section>'),
+ list = c.doc().children()[0],
+ item1 = list.children()[0],
+ item2 = list.children()[1];
+
+ c.list.extractItems({element1: item1, element2: item2});
+
+ var section = c.doc(),
+ list1 = section.children()[0],
+ oldItem1 = section.children()[0],
+ oldItem2 = section.children()[1];
+
+ expect(section.children().length).to.equal(2, 'section contains two children');
+ expect(oldItem1.children()[0].getText()).to.equal('some item');
+ expect(oldItem2.children()[0].getText()).to.equal('some item 2');
+ });
+
+ it('creates two lists with extracted items in the middle if extracting from the middle of the list - nested case' , 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 class="item">1.3</div>\
+ </div>\
+ </div>\
+ <div class="item">2</div>\
+ </div>\
+ </section>'),
+ list = c.doc().children()[0],
+ nestedList = list.children()[1].children()[0],
+ nestedListItem = nestedList.children()[1];
+
+ c.list.extractItems({element1: nestedListItem, element2: nestedListItem});
+
+ var section = c.doc(),
+ list = section.children()[0],
+ item1 = list.children()[0],
+ item2 = list.children()[1], //
+ item3 = list.children()[2],
+ item4 = list.children()[3], //
+ item5 = list.children()[4],
+ nestedList1 = item2.children()[0],
+ nestedList2 = item4.children()[0];
+
+ expect(list.children().length).to.equal(5, 'top list has five items');
+
+ expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
+
+ expect(item2.getWlxmlClass()).to.equal('item', 'first nested list is still wrapped in item element');
+ expect(nestedList1.children().length).to.equal(1, 'first nested list is left with one child');
+ expect(nestedList1.children()[0].children()[0].getText()).to.equal('1.1', 'first nested list item left alone');
+
+ expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
+
+ expect(item4.getWlxmlClass()).to.equal('item', 'second nested list is still wrapped in item element');
+ expect(nestedList2.children().length).to.equal(1, 'second nested list is left with one child');
+ expect(nestedList2.children()[0].children()[0].getText()).to.equal('1.3', 'second nested list item left alone');
+
+ expect(item5.children()[0].getText()).to.equal('2', 'last item ok');
+ });
+
+ it('puts extracted items below the list if ending item is the last one - nested case' , 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 class="item">1.3</div>\
+ </div>\
+ </div>\
+ <div class="item">2</div>\
+ </div>\
+ </section>'),
+ list = c.doc().children()[0],
+ nestedList = list.children()[1].children()[0],
+ nestedListItem1 = nestedList.children()[1],
+ nestedListItem2 = nestedList.children()[2];
+
+ c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});
+
+ var section = c.doc(),
+ list = section.children()[0],
+ item1 = list.children()[0],
+ item2 = list.children()[1],
+ item3 = list.children()[2],
+ item4 = list.children()[3],
+ item5 = list.children()[4];
+ nestedList = item2.children()[0];
+
+ expect(list.children().length).to.equal(5, 'top list has five items');
+ expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
+ expect(item2.getWlxmlClass()).to.equal('item', 'nested list is still wrapped in item element');
+ expect(nestedList.children().length).to.equal(1, 'nested list is left with one child');
+ expect(nestedList.children()[0].children()[0].getText()).to.equal('1.1', 'nested list item left alone');
+ expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
+ expect(item4.children()[0].getText()).to.equal('1.3', 'fourth item ok');
+ expect(item5.children()[0].getText()).to.equal('2', 'fifth item ok');
+ });
+
+ it('puts extracted items above the list if starting item is the first one - nested case' , 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 class="item">1.3</div>\
+ </div>\
+ </div>\
+ <div class="item">2</div>\
+ </div>\
+ </section>'),
+ list = c.doc().children()[0],
+ nestedList = list.children()[1].children()[0],
+ nestedListItem1 = nestedList.children()[0],
+ nestedListItem2 = nestedList.children()[1];
+
+ c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});
+
+ var section = c.doc(),
+ list = section.children()[0],
+ item1 = list.children()[0],
+ item2 = list.children()[1],
+ item3 = list.children()[2],
+ item4 = list.children()[3],
+ item5 = list.children()[4];
+ nestedList = item4.children()[0];
+
+ expect(list.children().length).to.equal(5, 'top list has five items');
+ expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
+ expect(item2.children()[0].getText()).to.equal('1.1', 'second item ok');
+ expect(item3.children()[0].getText()).to.equal('1.2', 'third item ok');
+
+ expect(item4.getWlxmlClass()).to.equal('item', 'nested list is still wrapped in item element');
+ expect(nestedList.children().length).to.equal(1, 'nested list is left with one child');
+ expect(nestedList.children()[0].children()[0].getText()).to.equal('1.3', 'nested list item left alone');
+ expect(item5.children()[0].getText()).to.equal('2', 'fifth item ok');
+ });
+
+ it('removes list if all its items are extracted - nested case', 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>'),
+ list = c.doc().children()[0],
+ nestedList = list.children()[1].children()[0],
+ nestedListItem1 = nestedList.children()[0],
+ nestedListItem2 = nestedList.children()[1];
+
+ c.list.extractItems({element1: nestedListItem1, element2: nestedListItem2});
+
+ var section = c.doc(),
+ list = section.children()[0],
+ item1 = list.children()[0],
+ item2 = list.children()[1],
+ item3 = list.children()[2],
+ item4 = list.children()[3];
+
+ expect(list.children().length).to.equal(4, 'top list has four items');
+ expect(item1.children()[0].getText()).to.equal('0', 'first item ok');
+ expect(item2.children()[0].getText()).to.equal('1.1', 'second 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');
+ });
});
});
fnp / fnpeditor.git / blobdiff