expect(emptyTextNode.getText()).to.equal('', 'empty ok');
expect(nonEmptyTextNode.getText()).to.equal('alice', 'non empty ok');
});
+
+ it('creates nodes from xml strings', function() {
+ var doc = getDocumentFromXML('<div></div>'),
+ node = doc.createDocumentNode('<a>Alice<b></b></a>');
+ expect(node.getTagName()).to.equal('a');
+ expect(node.contents().length).to.equal(2);
+ expect(node.contents()[0].getText()).to.equal('Alice');
+ expect(node.contents()[1].getTagName()).to.equal('b');
+ });
+
+ describe('Retrieving node by path', function() {
+ it('passes smoke tests', function() {
+ var doc = getDocumentFromXML('<root><a><b>c</b></a>');
+ expect(doc.getNodeByPath([0]).sameNode(doc.root.contents()[0])).to.be.true;
+ expect(doc.getNodeByPath([0,0]).sameNode(doc.root.contents()[0].contents()[0])).to.be.true;
+ });
+ it('treats empty path as a root path', function() {
+ var doc = getDocumentFromXML('<root></root>');
+ expect(doc.getNodeByPath([]).sameNode(doc.root)).to.be.true;
+ });
+ it('returns undefined for non existing paths', function() {
+ var doc = getDocumentFromXML('<root><a></a></root>');
+ expect(doc.getNodeByPath([1])).to.be.undefined;
+ expect(doc.getNodeByPath([0,1])).to.be.undefined;
+ expect(doc.getNodeByPath([10,1])).to.be.undefined;
+ });
+ });
});
describe('DocumentNode', function() {
});
});
+ it('can be cloned with its contents and its contents data', function() {
+ var doc = getDocumentFromXML('<root><div>text</div></root>'),
+ root = doc.root,
+ div = root.contents()[0],
+ text = div.contents()[0];
+
+ var ClonableObject = function(arg) {
+ this.arg = arg;
+ };
+ ClonableObject.prototype.clone = function() {
+ return new ClonableObject(this.arg);
+ };
+
+ div.setData('key', 'value');
+ div.setData('clonableObject', new ClonableObject('test'));
+ text.setData('key', 'value');
+
+ var rootClone = root.clone(),
+ divClone = rootClone.contents()[0],
+ textClone = divClone.contents()[0],
+ stringClone = divClone.getData('key'),
+ objClone = divClone.getData('clonableObject');
+
+ expect(stringClone).to.equal('value');
+ expect(objClone.arg).to.equal('test', 'clonable object got copied');
+ expect(objClone !== div.getData('clonableObject')).to.be.equal(true, 'copy of the clonable object is a new object');
+
+ expect(textClone.getData('key')).to.be.equal(undefined, 'cloning text node data is not supported yet');
+ });
+
it('knows its path in the document tree', function() {
var doc = getDocumentFromXML('<root><a><b><c></c>text</b></a></root>'),
root = doc.root,
node.setData({key1: 'value1', key2: 'value2'});
expect(node.getData()).to.eql({key1: 'value1', key2: 'value2'});
});
+
+ it('can remove specific data', function() {
+ node.setData('key', 'value');
+ node.setData('key', undefined);
+ expect(node.getData('key')).to.be.undefined;
+ });
});
describe('Changing node tag', function() {
it('can change tag name', function() {
var node = elementNodeFromXML('<div></div>');
- node.setTag('span');
+ node = node.setTag('span');
expect(node.getTagName()).to.equal('span');
});
- it('emits nodeTagChange event', function() {
- var node = elementNodeFromXML('<div></div>'),
- spy = sinon.spy();
-
- node.document.on('change', spy);
- node.setTag('span');
- var event = spy.args[0][0];
-
- expect(event.type).to.equal('nodeTagChange');
- expect(event.meta.node.sameNode(node)).to.be.true;
- expect(event.meta.oldTagName).to.equal('div');
- });
-
describe('Implementation specific expectations', function() {
- // DOM specifies ElementNode tag as a read-only property, so
- // changing it in a seamless way is a little bit tricky. For this reason
- // the folowing expectations are required, despite the fact that they actually are
- // motivated by implemetation details.
-
- it('keeps node in the document', function() {
- var doc = getDocumentFromXML('<div><header></header></div>'),
- header = doc.root.contents()[0];
- header.setTag('span');
- expect(header.parent().sameNode(doc.root)).to.be.true;
- });
it('keeps custom data', function() {
var node = elementNodeFromXML('<div></div>');
node.setData('key', 'value');
- node.setTag('header');
+ node = node.setTag('header');
expect(node.getTagName()).to.equal('header');
expect(node.getData()).to.eql({key: 'value'});
expect(doc.root.getTagName()).to.equal('span');
});
- it('keeps contents', function() {
+ it('keeps node contents', function() {
var node = elementNodeFromXML('<div><div></div></div>');
- node.setTag('header');
+ node = node.setTag('header');
expect(node.contents()).to.have.length(1);
});
});
+ });
describe('Setting node attributes', function() {
it('can set node attribute', function() {
});
});
+ describe('Searching for the last child text node', function() {
+ [
+ '<div>xxx<div></div>last</div>',
+ '<div><div>last</div></div>',
+ '<div>xxx<div>last</div><div></div></div>'
+ ].forEach(function(xml, i) {
+ var example = 'example ' + i;
+ it('returns last child text node ' + example + ')', function() {
+ var doc = getDocumentFromXML(xml),
+ lastTextNode = doc.root.getLastTextNode();
+ expect(lastTextNode.getText()).to.equal('last', example);
+ });
+ });
+ });
+
+ describe('Putting nodes around', function() {
+ it('will not allow to put node before or after root node', function() {
+ var doc = getDocumentFromXML('<root></root>'),
+ spy = sinon.spy(),
+ root = doc.root,
+ result;
+
+ doc.on('change', spy);
+
+ result = doc.root.before({tagName: 'test'});
+
+ expect(spy.callCount).to.equal(0);
+ expect(result).to.undefined;
+
+ result = doc.root.after({tagName: 'test'});
+
+ expect(spy.callCount).to.equal(0);
+ expect(result).to.undefined;
+
+ expect(doc.root.sameNode(root));
+ });
});
});
describe('Manipulations', function() {
+ describe('detaching nodes', function() {
+ it('can detach document root node', function() {
+ var doc = getDocumentFromXML('<div></div>');
+
+ doc.root.detach();
+ expect(doc.root).to.equal(null);
+ });
+ });
+
describe('replacing node with another one', function() {
it('replaces node with another one', function() {
var doc = getDocumentFromXML('<div><a></a></div>'),
expect(rootContents[0].getText()).to.equal('Alice a cat');
});
+ it('merges adjacent text nodes resulting from moving an element node in between', function() {
+ var doc = getDocumentFromXML('<div><a></a>Alice <span>has</span>a cat</div>'),
+ span = doc.root.contents()[2],
+ a = doc.root.contents()[0];
+
+ a.append(span);
+
+ var rootContents = doc.root.contents();
+ expect(rootContents).to.have.length(2, 'one child left');
+ expect(rootContents[1].getText()).to.equal('Alice a cat');
+ });
+
it('inserts node at index', function() {
var doc = getDocumentFromXML('<div><a></a><b></b><c></c></div>'),
b = doc.root.contents()[1];
expect(node1.contents()[1].sameNode(node2)).to.be.true;
});
- it('wraps element node with another element node', function() {
+ describe('adding text nodes', function() {
+ it('merges text nodes on append', function() {
+ var doc = getDocumentFromXML('<root>text1</root>'),
+ returned;
+ returned = doc.root.append({text: 'text2'});
+ expect(doc.root.contents().length).to.equal(1);
+ expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+ expect(doc.root.contents()[0].getText()).to.equal('text1text2');
+ });
+
+ it('merges text nodes on prepend', function() {
+ var doc = getDocumentFromXML('<root>text1</root>'),
+ returned;
+ returned = doc.root.prepend({text: 'text2'});
+ expect(doc.root.contents().length).to.equal(1);
+ expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+ expect(doc.root.contents()[0].getText()).to.equal('text2text1');
+ });
+
+ it('merges text nodes on before text node', function() {
+ var doc = getDocumentFromXML('<root>text1</root>'),
+ textNode = doc.root.contents()[0],
+ returned;
+ returned = textNode.before({text: 'text2'});
+ expect(doc.root.contents().length).to.equal(1);
+ expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+ expect(doc.root.contents()[0].getText()).to.equal('text2text1');
+ });
+
+ it('merges text nodes on after text node', function() {
+ var doc = getDocumentFromXML('<root>text1</root>'),
+ textNode = doc.root.contents()[0],
+ returned;
+ returned = textNode.after({text: 'text2'});
+ expect(doc.root.contents().length).to.equal(1);
+ expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+ expect(doc.root.contents()[0].getText()).to.equal('text1text2');
+ });
+
+ it('merges text nodes on before element node', function() {
+ var doc = getDocumentFromXML('<root>text1<div></div></root>'),
+ textNode = doc.root.contents()[0],
+ div = doc.root.contents()[1],
+ returned;
+ returned = div.before({text: 'text2'});
+ expect(doc.root.contents().length).to.equal(2);
+ expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+ expect(textNode.getText()).to.equal('text1text2');
+ });
+
+ it('merges text nodes on after element node', function() {
+ var doc = getDocumentFromXML('<root><div></div>text1</root>'),
+ textNode = doc.root.contents()[1],
+ div = doc.root.contents()[0],
+ returned;
+ returned = div.after({text: 'text2'});
+ expect(doc.root.contents().length).to.equal(2);
+ expect(returned.sameNode(doc.root.contents()[1])).to.equal(true, 'modified node returned');
+ expect(textNode.getText()).to.equal('text2text1');
+ });
+ });
+
+ it('wraps root element node with another element node', function() {
var node = elementNodeFromXML('<div></div>'),
wrapper = elementNodeFromXML('<wrapper></wrapper>');
node.wrapWith(wrapper);
expect(node.parent().sameNode(wrapper)).to.be.true;
+ expect(node.document.root.sameNode(wrapper)).to.be.true;
+ });
+
+ it('wraps element node with another element node', function() {
+ var doc = getDocumentFromXML('<section><div></div></section>'),
+ div = doc.root.contents()[0];
+
+ var wrapper = div.wrapWith({tagName: 'wrapper'});
+ expect(wrapper.sameNode(doc.root.contents()[0])).to.equal(true, '1');
+ expect(div.parent().sameNode(wrapper)).to.equal(true, '2');
+ expect(wrapper.contents()[0].sameNode(div)).to.equal(true, '3');
+ });
+
+ it('wraps element outside of document tree', function() {
+ var doc = getDocumentFromXML('<section><div></div></section>'),
+ node = doc.createDocumentNode({tagName: 'node'});
+
+ node.wrapWith({tagName: 'wrapper'});
+ expect(node.parent().getTagName()).to.equal('wrapper');
+ expect(node.parent().contents()[0].sameNode(node)).to.be.true;
+ expect(doc.root.getTagName()).to.equal('section');
});
it('unwraps element node contents', function() {
expect(node.contents()[2].getText()).to.equal(' a cat!');
});
+ it('removes parent-describing sibling nodes of unwrapped node', function() {
+ var doc = getDocumentFromXML('<root><div><a></a><x></x><a></a></div></root>');
+
+ doc.registerExtension({documentNode: {methods: {
+ object: {
+ describesParent: function() {
+ return this.getTagName() === 'x';
+ }
+ }
+ }}});
+
+ var div = doc.root.contents()[0],
+ x = div.contents()[1];
+
+ div.unwrapContent();
+ expect(doc.root.contents().length).to.equal(2);
+ expect(x.isInDocument()).to.be.false;
+ });
+
it('unwrap single element node from its parent', function() {
var doc = getDocumentFromXML('<div><a><b></b></a></div>'),
div = doc.root,
expect(wrapperContents[1].contents().length).to.equal(1);
expect(wrapperContents[1].contents()[0].getText()).to.equal('small');
});
+
+ it('keeps parent-describing nodes in place', function() {
+ var doc = getDocumentFromXML('<root>Alice <x></x> probably <y></y> has a cat</root>');
+
+ doc.registerExtension({documentNode: {methods: {
+ object: {
+ describesParent: function() {
+ /* globals Node */
+ return this.nodeType === Node.ELEMENT_NODE && this.getTagName() === 'x';
+ }
+ }
+ }}});
+
+ var root = doc.root,
+ x = root.contents()[1],
+ y = root.contents()[3];
+
+ root.wrapText({
+ _with: {tagName: 'span', attrs: {'attr1': 'value1'}},
+ offsetStart: 1,
+ offsetEnd: 4,
+ textNodeIdx: [0,4]
+ });
+
+ expect(x.parent().sameNode(root)).to.be.true;
+ expect(y.parent().getTagName()).to.equal('span');
+ });
});
describe('Wrapping Nodes', function() {
expect(headerChildren[0].sameNode(div2)).to.equal(true, 'first node wrapped');
expect(headerChildren[1].sameNode(div3)).to.equal(true, 'second node wrapped');
});
+
+ it('keeps parent-describing nodes in place', function() {
+ var section = elementNodeFromXML('<section>Alice<x></x><div>a cat</div></section>');
+
+ section.document.registerExtension({documentNode: {methods: {
+ object: {
+ describesParent: function() {
+ return this.nodeType === Node.ELEMENT_NODE && this.getTagName() === 'x';
+ }
+ }
+ }}});
+
+ var aliceText = section.contents()[0],
+ x = section.contents()[1],
+ lastDiv = section.contents()[2];
+
+ section.document.wrapNodes({
+ node1: aliceText,
+ node2: lastDiv,
+ _with: {tagName: 'header'}
+ });
+
+ expect(x.parent().sameNode(section)).to.be.true;
+ expect(aliceText.parent().getTagName()).to.equal('header');
+ expect(lastDiv.parent().getTagName()).to.equal('header');
+ });
});
});
+ var getTextNodes = function(text, doc) {
+ /* globals Node */
+ var toret = [];
+ var search = function(node) {
+ node.contents().forEach(function(node) {
+ if(node.nodeType === Node.TEXT_NODE) {
+ if(node.getText() === text) {
+ toret.push(node);
+ }
+ } else {
+ search(node);
+ }
+ });
+ };
+ search(doc.root);
+ return toret;
+ };
+
+ var getTextNode = function(text, doc) {
+ var nodes = getTextNodes(text, doc),
+ error;
+ if(nodes.length === 0) {
+ error = 'Text not found';
+ } else if(nodes.length > 1) {
+ error = 'Text not unique';
+ } else if(nodes[0].getText() !== text) {
+ error = 'I was trying to cheat your test :(';
+ }
+ if(error) {
+ throw new Error(error);
+ }
+ return nodes[0];
+ };
+
+ describe('Removing arbitrary text', function() {
+ it('removes within single text element', function() {
+ var doc = getDocumentFromXML('<div>Alice</div>'),
+ text = getTextNode('Alice', doc);
+ doc.deleteText({
+ from: {
+ node: text,
+ offset: 1
+ },
+ to: {
+ node: text,
+ offset: 4
+ }
+ });
+ expect(doc.root.contents().length).to.equal(1);
+ expect(doc.root.contents()[0].getText()).to.equal('Ae');
+ });
+ it('removes across elements - 1', function() {
+ var doc = getDocumentFromXML('<div><a>aaa</a><b>bbb</b></div>');
+
+ doc.deleteText({
+ from: {
+ node: getTextNode('aaa', doc),
+ offset: 2
+ },
+ to: {
+ node: getTextNode('bbb', doc),
+ offset: 2
+ }
+ });
+
+ var contents = doc.root.contents();
+ expect(contents.length).to.equal(2);
+ expect(contents[0].contents()[0].getText()).to.equal('aa');
+ expect(contents[1].contents()[0].getText()).to.equal('b');
+ });
+ it('removes across elements - 2', function() {
+ var doc = getDocumentFromXML('<a><b><c>ccc</c></b>xxx</a>');
+ doc.deleteText({
+ from: {
+ node: getTextNode('ccc', doc),
+ offset: 2
+ },
+ to: {
+ node: getTextNode('xxx', doc),
+ offset: 2
+ }
+ });
+
+ var contents = doc.root.contents();
+ expect(contents.length).to.equal(2);
+ expect(contents[0].getTagName()).to.equal('b');
+ expect(contents[1].getText()).to.equal('x');
+
+ var bContents = contents[0].contents();
+ expect(bContents.length).to.equal(1);
+ expect(bContents[0].getTagName()).to.equal('c');
+ expect(bContents[0].contents().length).to.equal(1);
+ expect(bContents[0].contents()[0].getText()).to.equal('cc');
+ });
+ it('remove across elements - 3 (merged text nodes)', function() {
+ var doc = getDocumentFromXML('<div>Alice <span>has</span> a cat</div>');
+ doc.deleteText({
+ from: {
+ node: getTextNode('Alice ', doc),
+ offset: 1
+ },
+ to: {
+ node: getTextNode(' a cat', doc),
+ offset: 3
+ }
+ });
+ var contents = doc.root.contents();
+ expect(contents.length).to.equal(1);
+ expect(contents[0].getText()).to.equal('Acat');
+ });
+ it('remove across elements - 4', function() {
+ var doc = getDocumentFromXML('<div>Alice <div>has <span>a</span> cat</div></div>');
+ doc.deleteText({
+ from: {
+ node: getTextNode('Alice ', doc),
+ offset: 1
+ },
+ to: {
+ node: getTextNode(' cat', doc),
+ offset: 1
+ }
+ });
+ var contents = doc.root.contents();
+ expect(contents.length).to.equal(2);
+ expect(contents[0].getText()).to.equal('A');
+ expect(contents[1].getTagName()).to.equal('div');
+ expect(contents[1].contents().length).to.equal(1);
+ expect(contents[1].contents()[0].getText()).to.equal('cat');
+ });
+ it('removes across elements - 5 (whole document)', function() {
+ var doc = getDocumentFromXML('<div>Alice <div>has <span>a</span> cat</div>!!!</div>');
+ doc.deleteText({
+ from: {
+ node: getTextNode('Alice ', doc),
+ offset: 0
+ },
+ to: {
+ node: getTextNode('!!!', doc),
+ offset: 3
+ }
+ });
+
+ expect(doc.root.getTagName()).to.equal('div');
+ expect(doc.root.contents().length).to.equal(1);
+ expect(doc.root.contents()[0].getText()).to.equal('');
+ });
+ it('removes nodes in between', function() {
+ var doc = getDocumentFromXML('<div><a>aaa<x>!</x></a>xxx<x></x><b><x>!</x>bbb</b></div>');
+ doc.deleteText({
+ from: {
+ node: getTextNode('aaa', doc),
+ offset: 2
+ },
+ to: {
+ node: getTextNode('bbb', doc),
+ offset: 2
+ }
+ });
+
+ var contents = doc.root.contents();
+ expect(contents.length).to.equal(2, 'two nodes survived');
+ expect(contents[0].getTagName()).to.equal('a');
+ expect(contents[1].getTagName()).to.equal('b');
+ expect(contents[0].contents().length).to.equal(1);
+ expect(contents[0].contents()[0].getText()).to.equal('aa');
+ expect(contents[1].contents().length).to.equal(1);
+ expect(contents[1].contents()[0].getText()).to.equal('b');
+ });
+ it('removes across elements - 6', function() {
+ var doc = getDocumentFromXML('<root><div>aaa<span>bbb</span>ccc</div><div>ddd</div></root>');
+ doc.deleteText({
+ from: {
+ node: getTextNode('aaa', doc),
+ offset: 1
+ },
+ to: {
+ node: getTextNode('ddd', doc),
+ offset: 1
+ }
+ }, {
+ error: function(e) {throw e;}
+ });
+
+ var contents = doc.root.contents();
+ expect(contents.length).to.equal(2);
+ expect(contents[0].contents().length).to.equal(1);
+ expect(contents[0].contents()[0].getText()).to.equal('a');
+ expect(contents[1].contents().length).to.equal(1);
+ expect(contents[1].contents()[0].getText()).to.equal('dd');
+ });
+ });
+
describe('Splitting text', function() {
it('splits TextNode\'s parent into two ElementNodes', function() {
expect(event.meta.node.sameNode(appended)).to.be.true;
});
- it('emits nodeMoved when appending aready existing node', function() {
+ it('emits nodeDetached/nodeAdded events with `move` flag when appending aready existing node', function() {
var node = elementNodeFromXML('<div><a></a><b></b></div>'),
a = node.contents()[0],
b = node.contents()[1],
node.document.on('change', spy);
var appended = a.append(b),
- event = spy.args[0][0];
+ detachedEvent = spy.args[0][0],
+ addedEvent = spy.args[1][0];
+
+ expect(spy.callCount).to.equal(2);
+ expect(detachedEvent.type).to.equal('nodeDetached');
+ expect(detachedEvent.meta.node.sameNode(appended)).to.be.true;
+ expect(detachedEvent.meta.move).to.equal(true, 'move flag set to true for nodeDetachedEvent');
+ expect(addedEvent.type).to.equal('nodeAdded');
+ expect(addedEvent.meta.node.sameNode(appended)).to.be.true;
+ expect(addedEvent.meta.move).to.equal(true, 'move flag set to true for nodeAddedEvent');
- expect(spy.callCount).to.equal(1);
- expect(event.type).to.equal('nodeMoved');
- expect(event.meta.node.sameNode(appended)).to.be.true;
});
it('emits nodeAdded event when prepending new node', function() {
expect(event.meta.node.sameNode(prepended)).to.be.true;
});
- it('emits nodeMoved when prepending aready existing node', function() {
+ it('emits nodeDetached/nodeAdded events with `move` flag when prepending aready existing node', function() {
var node = elementNodeFromXML('<div><a></a><b></b></div>'),
a = node.contents()[0],
b = node.contents()[1],
spy = sinon.spy();
node.document.on('change', spy);
-
+
var prepended = a.prepend(b),
- event = spy.args[0][0];
- expect(spy.callCount).to.equal(1);
- expect(event.type).to.equal('nodeMoved');
- expect(event.meta.node.sameNode(prepended)).to.be.true;
+ detachedEvent = spy.args[0][0],
+ addedEvent = spy.args[1][0];
+
+ expect(spy.callCount).to.equal(2);
+ expect(detachedEvent.type).to.equal('nodeDetached');
+ expect(detachedEvent.meta.node.sameNode(prepended)).to.be.true;
+ expect(detachedEvent.meta.move).to.equal(true, 'move flag set to true for nodeDetachedEvent');
+ expect(addedEvent.type).to.equal('nodeAdded');
+ expect(addedEvent.meta.node.sameNode(prepended)).to.be.true;
+ expect(addedEvent.meta.move).to.equal(true, 'move flag set to true for nodeAddedEvent');
});
it('emits nodeAdded event when inserting node after another', function() {
expect(event.meta.node.sameNode(inserted)).to.be.true;
});
- it('emits nodeMoved when inserting aready existing node after another', function() {
+ it('emits nodeDetached/nodeAdded events with `move` flag when inserting aready existing node after another', function() {
var node = elementNodeFromXML('<div><a></a><b></b></div>'),
a = node.contents()[0],
b = node.contents()[1],
spy = sinon.spy();
node.document.on('change', spy);
var inserted = b.after(a),
- event = spy.args[0][0];
+ detachedEvent = spy.args[0][0],
+ addedEvent = spy.args[1][0];
- expect(spy.callCount).to.equal(1);
- expect(event.type).to.equal('nodeMoved');
- expect(event.meta.node.sameNode(inserted)).to.be.true;
+ expect(spy.callCount).to.equal(2);
+ expect(detachedEvent.type).to.equal('nodeDetached');
+ expect(detachedEvent.meta.node.sameNode(inserted)).to.be.true;
+ expect(detachedEvent.meta.move).to.equal(true, 'move flag set to true for nodeDetachedEvent');
+ expect(addedEvent.type).to.equal('nodeAdded');
+ expect(addedEvent.meta.node.sameNode(inserted)).to.be.true;
+ expect(addedEvent.meta.move).to.equal(true, 'move flag set to true for nodeAddedEvent');
});
it('emits nodeAdded event when inserting node before another', function() {
expect(event.meta.node.sameNode(inserted)).to.be.true;
});
- it('emits nodeAdded when inserting aready existing node before another', function() {
+ it('emits nodeDetached/nodeAdded events with `move` flag when inserting aready existing node before another', function() {
var node = elementNodeFromXML('<div><a></a><b></b></div>'),
a = node.contents()[0],
b = node.contents()[1],
spy = sinon.spy();
node.document.on('change', spy);
var inserted = a.before(b),
- event = spy.args[0][0];
+ detachedEvent = spy.args[0][0],
+ addedEvent = spy.args[1][0];
- expect(spy.callCount).to.equal(1);
- expect(event.type).to.equal('nodeMoved');
- expect(event.meta.node.sameNode(inserted)).to.be.true;
+ expect(spy.callCount).to.equal(2);
+ expect(detachedEvent.type).to.equal('nodeDetached');
+ expect(detachedEvent.meta.node.sameNode(inserted)).to.be.true;
+ expect(detachedEvent.meta.move).to.equal(true, 'move flag set to true for nodeDetachedEvent');
+ expect(addedEvent.type).to.equal('nodeAdded');
+ expect(addedEvent.meta.node.sameNode(inserted)).to.be.true;
+ expect(addedEvent.meta.move).to.equal(true, 'move flag set to true for nodeAddedEvent');
});
it('emits nodeDetached and nodeAdded when replacing root node with another', function() {
expect(siblingParents.node1.sameNode(aliceText)).to.equal(true, 'aliceText');
expect(siblingParents.node2.sameNode(span)).to.equal(true, 'span');
});
+
+ it('returns node itself for two same nodes', function() {
+ var doc = getDocumentFromXML('<section><div></div></section>'),
+ div = doc.root.contents()[0];
+
+ var siblingParents = doc.getSiblingParents({node1: div, node2: div});
+ expect(!!siblingParents.node1 && !!siblingParents.node2).to.equal(true, 'nodes defined');
+ expect(siblingParents.node1.sameNode(div)).to.be.equal(true, 'node1');
+ expect(siblingParents.node2.sameNode(div)).to.be.equal(true, 'node2');
+ });
});
});
beforeEach(function() {
doc = getDocumentFromXML('<section>Alice<div class="test_class"></div></section>');
- elementNode = doc.root;
- textNode = doc.root.contents()[0];
- extension = {};
-
- expect(elementNode.testTransformation).to.be.undefined;
- expect(textNode.testTransformation).to.be.undefined;
- expect(doc.testTransformation).to.be.undefined;
-
- expect(doc.testMethod).to.be.undefined;
- expect(elementNode.testMethod).to.be.undefined;
- expect(textNode.testMethod).to.be.undefined;
- expect(elementNode.elementTestMethod).to.be.undefined;
- expect(textNode.textTestMethod).to.be.undefined;
});
it('allows adding method to a document', function() {
doc.registerExtension(extension);
- /* refresh */
elementNode = doc.root;
textNode = doc.root.contents()[0];
doc.registerExtension(extension);
- /* refresh */
elementNode = doc.root;
textNode = doc.root.contents()[0];
var sampleMethod = function(val) {
this._$.attr('x', val);
+ this.triggerChangeEvent();
};
var transformations = {
doc.registerExtension({elementNode: {transformations: {
nested: function(v) {
this._$.attr('innerAttr', v);
+ this.triggerChangeEvent();
},
outer: function(v) {
this.nested(v);
this._$.attr('outerAttr', v);
+ this.triggerChangeEvent();
}
}}});
expect(doc.root.getAttr('outerAttr')).to.equal('test2');
});
+
+ it('ignores transformation if document didn\'t emit change event', function() {
+ var doc = getDocumentFromXML('<div></div>');
+
+ doc.registerExtension({elementNode: {transformations: {
+ test: function() {
+ // empty
+ }
+ }}});
+
+ doc.root.test();
+ expect(doc.undoStack.length).to.equal(0);
+
+ });
+
+ describe('Transactions', function() {
+ it('allows to undo/redo series of transformations at once', function() {
+ var doc = getDocumentFromXML('<div></div>');
+
+ doc.registerExtension({
+ elementNode: {transformations: {
+ test: function(v) {
+ this.setAttr('test', v);
+ }
+ }}
+ });
+
+ doc.startTransaction();
+ doc.root.test('1');
+ doc.root.test('2');
+ doc.root.test('3');
+ doc.endTransaction();
+
+ doc.undo();
+ expect(doc.root.getAttr('test'), '1');
+ doc.redo();
+ expect(doc.root.getAttr('test'), '3');
+ doc.undo();
+ expect(doc.root.getAttr('test'), '1');
+ doc.redo();
+ expect(doc.root.getAttr('test'), '3');
+ });
+
+ it('ignores empty transactions', function() {
+ var doc = getDocumentFromXML('<div></div>');
+ doc.startTransaction();
+ doc.endTransaction();
+ expect(doc.undoStack).to.have.length(0, 'empty transaction doesn\'t get pushed into undo stack');
+ });
+
+ it('doesn\'t break on optimizations', function() {
+ // This is a smoke test checking if optimizations made to transaction undoing
+ // doesnt't break anything.
+ var doc = getDocumentFromXML('<div smart="1" unaware="1"></div>');
+
+ doc.registerExtension({
+ elementNode: {transformations: {
+ unaware: function(v) {
+ this.setAttr('unware', v);
+ this.triggerChangeEvent();
+ },
+ smart: {
+ impl: function(t, v) {
+ t.oldVal = this.getAttr('smart');
+ this.setAttr('smart', v);
+ this.triggerChangeEvent();
+ },
+ undo: function(t) {
+ this.setAttr('smart', t.oldVal);
+ this.triggerChangeEvent();
+ }
+ }
+ }}
+ });
+
+ doc.startTransaction();
+ doc.root.smart('2');
+ doc.root.unaware('2');
+ doc.root.smart('3');
+ doc.root.unaware('3');
+ doc.endTransaction();
+
+ doc.undo();
+
+ expect(doc.root.getAttr('smart')).to.equal('1');
+ expect(doc.root.getAttr('unaware')).to.equal('1');
+ });
+
+ it('can have associated metadata', function() {
+ var doc = getDocumentFromXML('<div></div>'),
+ metadata = Object.create({});
+
+ doc.registerExtension({document: {transformations: {
+ test: function() {
+ this.trigger('change');
+ }
+ }}});
+
+ doc.startTransaction(metadata);
+ doc.test();
+ doc.endTransaction();
+
+ var transaction = doc.undoStack[0];
+ expect(transaction.metadata).to.equal(metadata);
+ });
+
+ it('can be rolled back', function() {
+ var doc = getDocumentFromXML('<root></root>');
+
+ doc.startTransaction();
+ doc.root.append({tagName: 'div'});
+ doc.rollbackTransaction();
+
+ expect(doc.undoStack.length).to.equal(0, 'nothing to undo');
+ expect(doc.root.contents().length).to.equal(0);
+ });
+
+ it('rollbacks and calls error handleor if error gets thrown', function() {
+ var doc = getDocumentFromXML('<root></root>'),
+ err = new Error(),
+ spy = sinon.spy();
+
+ doc.transaction(function() {
+ doc.root.append({tagName: 'div'});
+ throw err;
+ }, {error: spy});
+
+ expect(spy.args[0][0]).to.equal(err);
+ expect(doc.root.contents().length).to.equal(0);
+ expect(doc.undoStack.length).to.equal(0);
+ });
+ });
+
+ describe('Regression tests', function() {
+ it('redos correctly after running its own undo followed by unaware transformation undo', function() {
+ var doc = getDocumentFromXML('<section t="0"></section>');
+
+ doc.registerExtension({elementNode: {transformations: {
+ unaware: function() {
+ this.triggerChangeEvent();
+ },
+ test: {
+ impl: function() {
+ this._$.attr('t', 1);
+ this.triggerChangeEvent();
+ },
+ undo: function() {
+ this._$.attr('t', 0);
+ }
+ }
+ }}});
+ doc.root.unaware();
+ doc.root.test();
+ doc.undo();
+ doc.undo();
+ doc.redo();
+ doc.redo();
+ expect(doc.root.getAttr('t')).to.equal('1');
+ });
+ it('can perform undo of an operation performed after automatic transaction rollback', function() {
+ var doc = getDocumentFromXML('<section></section>'),
+ extension = {document: {transformations: {
+ throwingTransformation: function() { throw new Error(); }
+ }}};
+
+ doc.registerExtension(extension);
+
+ doc.throwingTransformation();
+
+ doc.transaction(function() {
+ doc.root.setAttr('x', '2');
+ });
+
+ expect(doc.undoStack.length).to.equal(1);
+ expect(doc.root.getAttr('x')).to.equal('2');
+
+ doc.undo();
+
+ expect(doc.undoStack.length).to.equal(0);
+ expect(doc.root.getAttr('x')).to.be.undefined;
+
+ });
+ });
});
});
fnp / fnpeditor.git / blobdiff