define([
'libs/chai',
+'libs/sinon',
'modules/documentCanvas/canvas/canvas',
'modules/documentCanvas/canvas/documentElement'
-], function(chai, canvas, documentElement) {
+], function(chai, sinon, canvas, documentElement) {
'use strict';
</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 wlxml-text>This is some text without its own wrapping tag.</div>'
+ + '<div wlxml-tag="div" wlxml-class="p-subclass">'
+ + '<div wlxml-text>This is a paragraph.</div>'
+ + '</div>'
+ + '<div wlxml-tag="div">'
+ + '<div wlxml-text>This is text in a div </div>'
+ + '<div wlxml-tag="span">'
+ + '<div wlxml-text>with some inline text</div>'
+ + '</div>'
+ + '<div wlxml-text>.</div>'
+ + '</div>'
+ + '<div wlxml-text>This is some text without its own wrapping tag.</div>'
+ '</div>';
expect(c.doc().dom()[0].isEqualNode($(expected)[0])).to.be.true;
});
});
describe('Internal HTML representation of a DocumentTextElement', function() {
- it('is just a TextNode', function() {
+ it('is text node wrapped in a div with wlxml-text attribute set', function() {
var dom = canvas.fromXML('<section>Alice</section>').doc().children()[0].dom();
- expect(dom[0].nodeType === Node.TEXT_NODE);
+ expect(dom.prop('tagName')).to.equal('DIV');
+ expect(dom.attr('wlxml-text')).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');
});
});
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() {
});
it('knows WLXML class of a WLXML tag it renders', function(){
- var c = canvas.fromXML('<section class="some.class"></section>'),
+ var c = canvas.fromXML('<section class="some.class.A"></section>'),
section = c.doc();
- expect(section.getWlxmlClass()).to.equal('some.class');
- section.setWlxmlClass('some.other.class');
- expect(section.getWlxmlClass()).to.equal('some.other.class');
+ expect(section.getWlxmlClass()).to.equal('some.class.A');
+ section.setWlxmlClass('some.class.B');
+ expect(section.getWlxmlClass()).to.equal('some.class.B');
section.setWlxmlClass(null);
expect(section.getWlxmlClass()).to.be.undefined;
});
+
+
+
+ describe('element has meta attributes', function() {
+ it('can change its meta attributes', function() {
+ var c = canvas.fromXML('<section><span class="uri" meta-uri="someuri"></span></section>'),
+ span = c.doc().children()[0];
+
+ expect(span.getWlxmlMetaAttr('uri')).to.equal('someuri');
+ span.setWlxmlMetaAttr('uri', 'otheruri');
+ expect(span.getWlxmlMetaAttr('uri')).to.equal('otheruri');
+ });
+
+ it('changes its meta attributes with class change', function() {
+ var c = canvas.fromXML('<section><span class="uri" meta-uri="someuri"></span></section>'),
+ span = c.doc().children()[0];
+
+ expect(span.getWlxmlMetaAttr('uri')).to.equal('someuri');
+ span.setWlxmlClass('author');
+ expect(span.getWlxmlMetaAttr('uri')).to.be.undefined;
+ });
+
+ it('keeps meta attribute value on class change if a new class has this attribute', function() {
+ var c = canvas.fromXML('<section><span class="uri" meta-uri="someuri"></span></section>'),
+ span = c.doc().children()[0];
+ span.setWlxmlClass('uri.some.subclass');
+ expect(span.getWlxmlMetaAttr('uri')).to.equal('someuri');
+ });
+ });
+ });
+
+ 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().contents()[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]));
});
});
expect(c.doc().children()[2].getText()).to.equal(' cat');
});
});
+
+ describe('getting vertically first text element', function() {
+ it('returns the first child if it\'s text element, ignores metadata', function() {
+ var c = canvas.fromXML('<section><metadata><dc:author>author</dc:author></metadata>Alice<div>has</div>a cat</section>'),
+ first = c.doc().getVerticallyFirstTextElement();
+
+ expect(first.sameNode(c.doc().children()[1])).to.be.true;
+ });
+
+ it('looks recursively inside node elements if they precede text element', function() {
+ var c = canvas.fromXML('\
+ <section>\
+ <div>\
+ <div>\
+ Alice\
+ </div>\
+ </div>\
+ Some text\
+ </section>'),
+ textAlice = c.doc().children()[0].children()[0].children()[0],
+ first = c.doc().getVerticallyFirstTextElement();
+
+ expect(textAlice).to.be.instanceOf(documentElement.DocumentTextElement);
+ expect(first.sameNode(textAlice)).to.be.true;
+ });
+ });
});
describe('manipulation api', function() {
children = c.doc().children();
expect(children.length).to.equal(1);
- expect(children[0].sameNode(appended));
+ expect(children[0].sameNode(appended)).to.be.true;
});
it('can put new TextElement at the end', function() {
children = c.doc().children();
expect(children.length).to.equal(1);
- expect(children[0].sameNode(appended));
+ expect(children[0].sameNode(appended)).to.be.true;
expect(children[0].getText()).to.equal('Alice');
});
added = div.after({tag: 'header', klass: 'some.class'}),
children = c.doc().children();
expect(children.length).to.equal(2);
- expect(children[1].sameNode(added));
+ expect(children[1].sameNode(added)).to.be.true;
});
it('can put new Nodeelement before another element', function() {
added = div.before({tag: 'header', klass: 'some.class'}),
children = c.doc().children();
expect(children.length).to.equal(2);
- expect(children[0].sameNode(added));
+ expect(children[0].sameNode(added)).to.be.true;
});
it('can put new DocumentNodeElement after DocumentTextElement', function() {
section = c.doc(),
text = section.children()[0].children()[0];
- text.split({offset: 5});
+ var returnedValue = text.split({offset: 5});
expect(section.children().length).to.equal(2, 'section has two children');
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(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(returnedValue.first.sameNode(header1)).to.equal(true, 'first node returnde');
+ expect(returnedValue.second.sameNode(header2)).to.equal(true, 'second node returned');
+ });
+
+ 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 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');
- 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(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');
});
});
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>'),
+ var c = canvas.fromXML('<section>Alice <span>has a</span> cat</section>'),
section = c.doc(),
- text = section.children()[0].children()[0];
+ text = section.children()[1].children()[0];
- text.unwrap();
+ var newTextContainer = text.unwrap();
- expect(section.children().length).to.equal(1);
+ 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');
})
});
});
});
});
+
+ 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]).contents()[0];
+
+ expect(text.nodeType).to.equal(Node.TEXT_NODE, 'correct node selected');
+ 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);
+ expect(position.offsetAtEnd).to.equal(false, 'offset is not at end');
+
+ getSelection.returns({
+ anchorNode: text,
+ focusNode: text,
+ anchorOffset: 15,
+ focusOffset: 15,
+ isCollapsed: true
+ });
+
+ expect(cursor.getPosition().offsetAtEnd).to.equal(true, 'offset at end');
+ });
+
+ 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');
+
+ })
+ });
+
+ describe('Serializing document to WLXML', function() {
+ it('keeps document intact when no changes have been made', function() {
+ var xmlIn = '<section>Alice<div>has</div>a <span class="uri" meta-uri="http://cat.com">cat</span>!</section>',
+ c = canvas.fromXML(xmlIn),
+ xmlOut = c.toXML();
+
+ var parser = new DOMParser(),
+ input = parser.parseFromString(xmlIn, "application/xml").childNodes[0],
+ output = parser.parseFromString(xmlOut, "application/xml").childNodes[0];
+
+ expect(input.isEqualNode(output)).to.be.true;
+ });
+
+ it('keeps arbitrary node attributes intact', function() {
+ var xmlIn = '<section a="1" xmlns:dcterms="http://purl.org/dc/terms/"></section>',
+ $xmlOut = $(canvas.fromXML(xmlIn).toXML());
+
+ expect($xmlOut.attr('a')).to.equal('1');
+ expect($xmlOut.attr('xmlns:dcterms')).to.equal('http://purl.org/dc/terms/');
+ });
+
+ it('doesn\' serialize meta attribute if its empty', function() {
+ var c;
+
+ c = canvas.fromXML('<section class="uri" meta-uri="some.uri"></section>');
+ c.doc().setWlxmlMetaAttr('uri', '');
+ expect($(c.toXML()).attr('meta-uri')).to.equal(undefined, 'overriding attribute with zero length string');
+
+ c = canvas.fromXML('<section class="uri"></section>');
+ c.doc().setWlxmlMetaAttr('uri', '');
+ expect($(c.toXML()).attr('meta-uri')).to.equal(undefined, 'setting attribute to zero length string');
+ });
+
+ describe('formatting output xml', function() {
+ /*it('keeps white spaces at the edges of input xml', function() {
+ var xmlIn = ' <section></section> ',
+ c = canvas.fromXML(xmlIn),
+ xmlOut = c.toXML();
+
+ expect(xmlOut.substr(4)).to.equal(' <', 'start');
+ expect(xmlOut.substr(-2)).to.equal('> ', 'end');
+ });*/
+ it('keeps white space between XML nodes', function() {
+ var xmlIn = '<section>\n\n\n<div></div>\n\n\n<div></div>\n\n\n</section>',
+ c = canvas.fromXML(xmlIn),
+ xmlOut = c.toXML();
+
+ var partsIn = xmlIn.split('\n\n\n'),
+ partsOut = xmlOut.split('\n\n\n');
+
+ expect(partsIn).to.deep.equal(partsOut);
+ });
+
+ 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();
+
+ var partsIn = xmlIn.split('\n\n\n'),
+ partsOut = xmlOut.split('\n\n\n');
+
+ expect(partsIn).to.deep.equal(partsOut);
+ });
+
+ it('nests new children block elements', function() {
+ var c = canvas.fromXML('<section></section>');
+
+ c.doc().append({tag: 'header'});
+
+ var xmlOut = c.toXML();
+ expect(xmlOut.split('\n ')[0]).to.equal('<section>', 'nesting start ok');
+ expect(xmlOut.split('\n').slice(-1)[0]).to.equal('</section>', 'nesting end ok');
+
+ });
+
+ it('doesn\'t nest new children inline elements', function() {
+ var c = canvas.fromXML('<section></section>');
+
+ c.doc().append({tag: 'span'});
+
+ var xmlOut = c.toXML();
+ expect(xmlOut).to.equal('<section><span></span></section>');
+ });
+
+ it('keeps original white space at the end of text', function() {
+
+ var xmlIn = '<header> Some text ended with white space \
+ \
+ <span class="uri">Some text</span> some text\
+ \
+ </header>',
+ c = canvas.fromXML(xmlIn);
+
+ var xmlOut = c.toXML();
+ console.log(xmlOut);
+ expect(xmlOut).to.equal(xmlIn);
+
+ });
+
+ })
+ })
});
fnp / fnpeditor.git / blobdiff