X-Git-Url: https://git.mdrn.pl/fnpeditor.git/blobdiff_plain/274b8289ef222d2641b124b6f9c55c63b27af7bb..a132113f20073907fd2907a93c75c9d699516ee6:/src/smartxml/smartxml.test.js?ds=inline
diff --git a/src/smartxml/smartxml.test.js b/src/smartxml/smartxml.test.js
index 991f1af..cbef963 100644
--- a/src/smartxml/smartxml.test.js
+++ b/src/smartxml/smartxml.test.js
@@ -1,8 +1,9 @@
define([
'libs/chai',
'libs/sinon',
+ 'libs/underscore',
'./smartxml.js'
-], function(chai, sinon, smartxml) {
+], function(chai, sinon, _, smartxml) {
'use strict';
/*jshint expr:true */
@@ -59,6 +60,15 @@ describe('smartxml', function() {
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('
'),
+ node = doc.createDocumentNode('Alice');
+ 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('DocumentNode', function() {
@@ -76,6 +86,31 @@ describe('smartxml', function() {
});
});
+ it('can be cloned with its contents and its contents data', function() {
+ var doc = getDocumentFromXML(''),
+ root = doc.root,
+ div = root.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'));
+
+ var rootClone = root.clone(),
+ divClone = rootClone.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');
+ });
+
it('knows its path in the document tree', function() {
var doc = getDocumentFromXML('text'),
root = doc.root,
@@ -300,6 +335,52 @@ describe('smartxml', function() {
});
});
+ describe('Dividing text node into two with element node', function() {
+ it('can divide text node with element node, splitting text node into two', function() {
+ var doc = getDocumentFromXML('Alice has a cat
'),
+ text = doc.root.contents()[0];
+
+ var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 5}),
+ contents = doc.root.contents(),
+ lhsText = contents[0],
+ rhsText = contents[2];
+
+ expect(lhsText.getText()).to.equal('Alice');
+ expect(returned.sameNode(contents[1]));
+ expect(rhsText.getText()).to.equal(' has a cat');
+ });
+
+ it('treats dividing at the very end as appending after it', function() {
+ var doc = getDocumentFromXML('Alice has a cat
'),
+ text = doc.root.contents()[0];
+
+
+ var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 15}),
+ contents = doc.root.contents(),
+ textNode = contents[0],
+ elementNode = contents[1];
+
+ expect(contents.length).to.equal(2);
+ expect(textNode.getText()).to.equal('Alice has a cat');
+ expect(returned.sameNode(elementNode)).to.be.true;
+ expect(elementNode.getTagName()).to.equal('aside');
+ });
+
+ it('treats dividing at the very beginning as prepending before it', function() {
+ var doc = getDocumentFromXML('Alice has a cat
'),
+ text = doc.root.contents()[0];
+
+ var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 0}),
+ contents = doc.root.contents(),
+ textNode = contents[1],
+ elementNode = contents[0];
+
+ expect(contents.length).to.equal(2);
+ expect(textNode.getText()).to.equal('Alice has a cat');
+ expect(returned.sameNode(elementNode)).to.be.true;
+ expect(elementNode.getTagName()).to.equal('aside');
+ });
+ });
});
describe('Manipulations', function() {
@@ -377,6 +458,68 @@ describe('smartxml', function() {
expect(node1.contents()[1].sameNode(node2)).to.be.true;
});
+ describe('adding text nodes', function() {
+ it('merges text nodes on append', function() {
+ var doc = getDocumentFromXML('text1'),
+ 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('text1'),
+ 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('text1'),
+ 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('text1'),
+ 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('text1'),
+ 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('text1'),
+ 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 element node with another element node', function() {
var node = elementNodeFromXML(''),
wrapper = elementNodeFromXML('');
@@ -501,6 +644,176 @@ describe('smartxml', function() {
});
+ 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('Alice
'),
+ 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('');
+
+ 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('cccxxx');
+ 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('Alice has a cat
');
+ 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('');
+ 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('');
+ 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('');
+ 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');
+ });
+ });
+
describe('Splitting text', function() {
it('splits TextNode\'s parent into two ElementNodes', function() {
@@ -735,15 +1048,14 @@ describe('smartxml', function() {
expect(event.meta.node.sameNode(a));
});
- it('doesn\'t emit nodeDetached event for already out of document moved to out of document node: ' + insertionMethod, function() {
+ it('doesn\'t emit nodeDetached event for already out of document node moved to out of document node' + insertionMethod, function() {
var doc = getDocumentFromXML(''),
- a = doc.root.contents()[0],
spy = sinon.spy();
doc.on('change', spy);
var newNode = doc.createDocumentNode({tagName: 'b'});
- var newNodeInner = newNode.append({tagName:'c'});
+ newNode.append({tagName:'c'});
expect(spy.callCount).to.equal(0);
});
@@ -830,7 +1142,7 @@ describe('smartxml', function() {
});
describe('Extension API', function() {
- var doc, extension, elementNode, textNode, testClassNode;
+ var doc, extension, elementNode, textNode;
beforeEach(function() {
doc = getDocumentFromXML('');
@@ -939,7 +1251,7 @@ describe('smartxml', function() {
expect(elementNode.textTestTransformation).to.be.undefined;
expect(textNode.textTestTransformation().sameNode(textNode)).to.be.true;
- expect(textNode.elementTestTransfomation).to.be.undefined;
+ expect(textNode.elementTestTransfomation).to.be.undefined;
});
it('allows text/element node methods and transformations to access node and transormations on document node', function() {
@@ -998,8 +1310,7 @@ describe('smartxml', function() {
it('smoke tests', function() {
var doc = getDocumentFromXML('Alice
'),
- textNode = doc.root.contents()[0],
- result;
+ textNode = doc.root.contents()[0];
expect(doc.undoStack).to.have.length(0);
@@ -1011,7 +1322,6 @@ describe('smartxml', function() {
expect(doc.undoStack).to.have.length(0, '2');
expect(doc.toXML()).to.equal('Alice
');
- debugger;
doc.redo();
expect(doc.undoStack).to.have.length(1, '3');
expect(doc.toXML()).to.equal('Alice
');
@@ -1028,10 +1338,8 @@ describe('smartxml', function() {
it('smoke tests 2', function() {
var doc = getDocumentFromXML('Alice
'),
textNode = doc.root.contents()[0],
- path = textNode.getPath(),
- result;
+ path = textNode.getPath();
- debugger;
textNode.setText('Alice ');
textNode.setText('Alice h');
textNode.setText('Alice ha');
@@ -1060,60 +1368,230 @@ describe('smartxml', function() {
expect(textNode.getText()).to.equal('Alice h');
});
- // it('does work', function() {
- // var doc = getDocumentFromXML(''),
- // span = doc.root.contents()[0];
+
+ var sampleMethod = function(val) {
+ this._$.attr('x', val);
+ this.triggerChangeEvent();
+ };
+
+ var transformations = {
+ 'unaware': sampleMethod,
+ 'returning change root': {
+ impl: sampleMethod,
+ getChangeRoot: function() {
+ return this.context;
+ }
+ },
+ 'implementing undo operation': {
+ impl: function(t, val) {
+ t.oldVal = this.getAttr('x');
+ sampleMethod.call(this, val);
+ },
+ undo: function(t) {
+ this.setAttr('x', t.oldVal);
+ }
+ }
+ };
+
+ _.pairs(transformations).forEach(function(pair) {
+ var name = pair[0],
+ transformaton = pair[1];
+
+ describe(name + ' transformation: ', function() {
+ var doc, node, nodePath;
+
+ beforeEach(function() {
+ doc = getDocumentFromXML('
');
+
+ doc.registerExtension({elementNode: {transformations: {
+ test: transformaton
+ }}});
+
+ node = doc.root.contents()[0];
+ nodePath = node.getPath();
+ });
+
+ it('transforms as expected', function() {
+ node.test('new');
+ expect(node.getAttr('x')).to.equal('new');
+ });
+
+ it('can be undone', function() {
+ node.test('new');
+ doc.undo();
+ node = doc.getNodeByPath(nodePath);
+ expect(node.getAttr('x')).to.equal('old');
+ });
+
+ it('can be undone and then redone', function() {
+ node.test('new');
+ doc.undo();
+ doc.redo();
+ node = doc.getNodeByPath(nodePath);
+ expect(node.getAttr('x')).to.equal('new');
+ });
+
+ it('handles a sample scenario', function() {
+ doc.root.contents()[0].test('1');
+ doc.root.contents()[0].test('2');
+ doc.root.contents()[0].test('3');
+ doc.root.contents()[0].test('4');
+ doc.root.contents()[0].test('5');
+
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'after initial transformations');
+ doc.undo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 1.1');
+ doc.undo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('3', 'undo 1.2');
+ doc.redo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'redo 1.1');
+ doc.redo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'redo 1.2');
+ doc.undo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 2.1');
+ doc.root.contents()[0].test('10');
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'additional transformation');
+ expect(doc.redoStack.length).to.equal(0, 'transformation cleared redo stack');
+ doc.redo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'empty redoStack so redo was noop');
+ doc.undo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undoing additional transformation');
+ doc.redo();
+ expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'redoing additional transformation');
+ });
+ });
+ });
+
+ it('smoke tests nested transformations', function() {
+ var doc = getDocumentFromXML('');
- // span.transform('smartxml.detach');
+ 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();
+ }
+ }}});
+ doc.root.outer('test1');
+ doc.root.outer('test2');
- // doc.undo();
+ expect(doc.root.getAttr('innerAttr')).to.equal('test2');
+ expect(doc.root.getAttr('outerAttr')).to.equal('test2');
- // expect(doc.root.contents()).to.have.length(1);
- // expect(doc.root.contents()[0].getTagName()).to.equal('span');
- // expect(doc.root.contents()[0].contents()[0].getText()).to.equal('Alice');
+ doc.undo();
- // doc.redo();
- // expect(doc.root.contents()).to.have.length(0);
+ expect(doc.root.getAttr('innerAttr')).to.equal('test1');
+ expect(doc.root.getAttr('outerAttr')).to.equal('test1');
- // doc.undo();
- // expect(doc.root.contents()).to.have.length(1);
- // expect(doc.root.contents()[0].getTagName()).to.equal('span');
- // expect(doc.root.contents()[0].contents()[0].getText()).to.equal('Alice');
+ doc.undo();
- // });
- // it('does work - merged text nodes case', function() {
- // var doc = getDocumentFromXML(''),
- // span = doc.root.contents()[1];
+ expect(doc.root.getAttr('innerAttr')).to.equal(undefined);
+ expect(doc.root.getAttr('outerAttr')).to.equal(undefined);
- // span.transform('smartxml.detach');
+ doc.redo();
+ expect(doc.root.getAttr('innerAttr')).to.equal('test1');
+ expect(doc.root.getAttr('outerAttr')).to.equal('test1');
- // doc.undo();
+ doc.redo();
+
+ expect(doc.root.getAttr('innerAttr')).to.equal('test2');
+ expect(doc.root.getAttr('outerAttr')).to.equal('test2');
+
+ });
- // expect(doc.root.contents().length).to.equal(3);
- // //console.log(doc.toXML());
- // expect(doc.root.contents()[1].contents()[0].getText()).to.equal('has');
+ it('ignores transformation if document didn\'t emit change event', function() {
+ var doc = getDocumentFromXML('');
- // });
- // it('dbg - don not store nodes in tranformation state!', function() {
- // var doc = getDocumentFromXML(''),
- // a = doc.root.contents()[0],
- // b = doc.root.contents()[1];
+ doc.registerExtension({elementNode: {transformations: {
+ test: function() {
+ // empty
+ }
+ }}});
- // a.transform('smartxml.detach');
- // b.transform('smartxml.detach');
- // doc.undo();
- // doc.undo();
- // expect(doc.root.contents().length).to.equal(2);
- // expect(doc.root.contents()[0].getTagName()).to.equal('a');
- // expect(doc.root.contents()[1].getTagName()).to.equal('b');
+ doc.root.test();
+ expect(doc.undoStack.length).to.equal(0);
- // doc.redo();
- // doc.redo();
- // expect(doc.root.contents().length).to.equal(0);
+ });
- // });
+ describe('Transactions', function() {
+ it('allows to undo/redo series of transformations at once', function() {
+ var doc = getDocumentFromXML('');
+
+ 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('');
+ 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('');
+
+ 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');
+ });
+ });
});
});