X-Git-Url: https://git.mdrn.pl/fnpeditor.git/blobdiff_plain/0f79f3ef275dc3e8400b4b517373795a463818dd..74635b9e0dd3069953072eab9de946b77d1b313e:/src/smartxml/smartxml.test.js?ds=sidebyside diff --git a/src/smartxml/smartxml.test.js b/src/smartxml/smartxml.test.js index 8d0ca4b..a994f05 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, @@ -134,40 +169,16 @@ describe('smartxml', function() { it('can change tag name', function() { var node = elementNodeFromXML('
'); - node.setTag('span'); + node = node.setTag('span'); expect(node.getTagName()).to.equal('span'); }); - it('emits nodeTagChange event', function() { - var node = elementNodeFromXML('
'), - 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('
'), - 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('
'); node.setData('key', 'value'); - node.setTag('header'); + node = node.setTag('header'); expect(node.getTagName()).to.equal('header'); expect(node.getData()).to.eql({key: 'value'}); @@ -179,12 +190,13 @@ describe('smartxml', function() { expect(doc.root.getTagName()).to.equal('span'); }); - it('keeps contents', function() { + it('keeps node contents', function() { var node = elementNodeFromXML('
'); - 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() { @@ -208,6 +220,19 @@ describe('smartxml', function() { }); }); + describe('Searching for the last child text node', function() { + [ + '
xxx
last
', + '
last
', + '
xxx
last
' + ].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); + }); + }); }); }); @@ -300,10 +325,65 @@ 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() { + describe('detaching nodes', function() { + it('can detach document root node', function() { + var doc = getDocumentFromXML('
'); + + 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('
'), @@ -377,12 +457,95 @@ describe('smartxml', function() { 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('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 root element node with another element node', function() { var node = elementNodeFromXML('
'), wrapper = elementNodeFromXML(''); 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('
'), + 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('
'), + 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() { @@ -501,6 +664,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('
aaabbb
'); + + 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('
Alice
has a cat
'); + 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('
Alice
has a cat
!!!
'); + 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('
aaa!xxx!bbb
'); + 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() { @@ -619,6 +952,7 @@ describe('smartxml', function() { expect(spy.callCount).to.equal(1); expect(event.type).to.equal('nodeMoved'); expect(event.meta.node.sameNode(appended)).to.be.true; + expect(node.document.root.sameNode(event.meta.parent)).to.equal(true, 'previous parent attached to event meta'); }); it('emits nodeAdded event when prepending new node', function() { @@ -734,6 +1068,18 @@ describe('smartxml', function() { expect(event.type).to.equal('nodeDetached'); expect(event.meta.node.sameNode(a)); }); + + it('doesn\'t emit nodeDetached event for already out of document node moved to out of document node' + insertionMethod, function() { + var doc = getDocumentFromXML('
'), + spy = sinon.spy(); + + doc.on('change', spy); + + var newNode = doc.createDocumentNode({tagName: 'b'}); + newNode.append({tagName:'c'}); + + expect(spy.callCount).to.equal(0); + }); }); @@ -756,7 +1102,9 @@ describe('smartxml', function() { c = b.contents()[0]; var parents = c.parents(); - expect(parents).to.eql([b,a]); + // @@ + expect(parents[0].sameNode(b)).to.be.true; + expect(parents[1].sameNode(a)).to.be.true; }); }); @@ -784,6 +1132,16 @@ describe('smartxml', 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('
'), + 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'); + }); }); }); @@ -814,61 +1172,551 @@ describe('smartxml', function() { }); }); - describe('Undo/redo', function() { + describe('Extension API', function() { + var doc, extension, elementNode, textNode; - it('does work', function() { - var doc = getDocumentFromXML('
Alice
'), - span = doc.root.contents()[0]; + beforeEach(function() { + doc = getDocumentFromXML('
Alice
'); + 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; + }); - span.transform('smartxml.detach'); + it('allows adding method to a document', function() { + extension = {document: {methods: { + testMethod: function() { return this; } + }}}; + doc.registerExtension(extension); + expect(doc.testMethod()).to.equal(doc, 'context is set to a document instance'); + }); - doc.undo(); + it('allows adding transformation to a document', function() { + extension = {document: {transformations: { + testTransformation: function() { return this; }, + testTransformation2: {impl: function() { return this;}} + }}}; - 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.registerExtension(extension); + expect(doc.testTransformation()).to.equal(doc, 'context is set to a document instance'); + expect(doc.testTransformation2()).to.equal(doc, 'context is set to a document instance'); + }); + + it('allows adding method to a DocumentNode instance', function() { + extension = { + documentNode: { + methods: { + testMethod: function() { return this; } + } + }, + textNode: { + methods: { + textTestMethod: function() { return this; } + } + }, + elementNode: { + methods: { + elementTestMethod: function() { return this; } + } + } + }; + + doc.registerExtension(extension); + + /* refresh */ + elementNode = doc.root; + textNode = doc.root.contents()[0]; + + expect(elementNode.testMethod().sameNode(elementNode)).to.equal(true, 'context is set to a node instance'); + expect(textNode.testMethod().sameNode(textNode)).to.equal(true, 'context is set to a node instance'); + + expect(elementNode.elementTestMethod().sameNode(elementNode)).to.be.true; + expect(elementNode.textTestMethod).to.be.undefined; + + expect(textNode.textTestMethod().sameNode(textNode)).to.be.true; + expect(textNode.elementTestMethod).to.be.undefined; + }); + + it('allows adding transformation to a DocumentNode', function() { + extension = { + documentNode: { + transformations: { + testTransformation: function() { return this; }, + testTransformation2: {impl: function() { return this;}} + } + }, + textNode: { + transformations: { + textTestTransformation: function() { return this; } + } + }, + elementNode: { + transformations: { + elementTestTransformation: function() { return this; } + } + } + }; + + doc.registerExtension(extension); + + /* refresh */ + elementNode = doc.root; + textNode = doc.root.contents()[0]; + + expect(elementNode.testTransformation().sameNode(elementNode)).to.equal(true, '1'); + expect(elementNode.testTransformation2().sameNode(elementNode)).to.equal(true, '2'); + expect(textNode.testTransformation().sameNode(textNode)).to.equal(true, '3'); + expect(textNode.testTransformation2().sameNode(textNode)).to.equal(true, '4'); + + expect(elementNode.elementTestTransformation().sameNode(elementNode)).to.be.true; + expect(elementNode.textTestTransformation).to.be.undefined; + + expect(textNode.textTestTransformation().sameNode(textNode)).to.be.true; + expect(textNode.elementTestTransfomation).to.be.undefined; + }); + + it('allows text/element node methods and transformations to access node and transormations on document node', function() { + + var doc = getDocumentFromXML('
text
'); + + doc.registerExtension({ + documentNode: { + methods: { + test: function() { + return 'super'; + } + }, + transformations: { + testT: function() { + return 'super_trans'; + } + } + }, + elementNode: { + methods: { + test: function() { + return 'element_sub_' + this.__super__.test(); + } + }, + transformations: { + testT: function() { + return 'element_trans_sub_' + this.__super__.testT(); + } + } + }, + textNode: { + methods: { + test: function() { + return 'text_sub_' + this.__super__.test(); + } + }, + transformations: { + testT: function() { + return 'text_trans_sub_' + this.__super__.testT(); + } + } + } + }); + + var textNode = doc.root.contents()[0]; + + expect(doc.root.test()).to.equal('element_sub_super'); + expect(textNode.test()).to.equal('text_sub_super'); + expect(doc.root.testT()).to.equal('element_trans_sub_super_trans'); + expect(textNode.testT()).to.equal('text_trans_sub_super_trans'); + }); + }); + + describe('Undo/redo', function() { + + it('smoke tests', function() { + var doc = getDocumentFromXML('
Alice
'), + textNode = doc.root.contents()[0]; + + expect(doc.undoStack).to.have.length(0); + + textNode.wrapWith({tagName: 'span', start:1, end:2}); + expect(doc.undoStack).to.have.length(1, '1'); + expect(doc.toXML()).to.equal('
Alice
'); + + doc.undo(); + expect(doc.undoStack).to.have.length(0, '2'); + expect(doc.toXML()).to.equal('
Alice
'); doc.redo(); - expect(doc.root.contents()).to.have.length(0); + expect(doc.undoStack).to.have.length(1, '3'); + expect(doc.toXML()).to.equal('
Alice
'); 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'); + expect(doc.undoStack).to.have.length(0, '4'); + expect(doc.toXML()).to.equal('
Alice
'); + doc.undo(); + expect(doc.undoStack).to.have.length(0, '5'); + expect(doc.toXML()).to.equal('
Alice
'); }); - it('does work - merged text nodes case', function() { - var doc = getDocumentFromXML('
Alice has a cat.
'), - span = doc.root.contents()[1]; - span.transform('smartxml.detach'); + it('smoke tests 2', function() { + var doc = getDocumentFromXML('
Alice
'), + textNode = doc.root.contents()[0], + path = textNode.getPath(); + + textNode.setText('Alice '); + textNode.setText('Alice h'); + textNode.setText('Alice ha'); + textNode.setText('Alice has'); + + expect(textNode.getText()).to.equal('Alice has'); + + doc.undo(); + expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '1'); + + doc.undo(); + expect(doc.root.contents()[0].getText()).to.equal('Alice h', '2'); + + doc.redo(); + expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '3'); + doc.redo(); + expect(doc.root.contents()[0].getText()).to.equal('Alice has', '4'); doc.undo(); + doc.undo(); + textNode = doc.getNodeByPath(path); + textNode.setText('Cat'); + doc.undo(); + textNode = doc.getNodeByPath(path); + expect(textNode.getText()).to.equal('Alice h'); + }); + + + 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'); + }); - expect(doc.root.contents().length).to.equal(3); - //console.log(doc.toXML()); - expect(doc.root.contents()[1].contents()[0].getText()).to.equal('has'); + 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('dbg - don not store nodes in tranformation state!', function() { - var doc = getDocumentFromXML('
'), - a = doc.root.contents()[0], - b = doc.root.contents()[1]; - a.transform('smartxml.detach'); - b.transform('smartxml.detach'); + it('smoke tests nested transformations', function() { + var doc = getDocumentFromXML('
'); + + 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'); + + expect(doc.root.getAttr('innerAttr')).to.equal('test2'); + expect(doc.root.getAttr('outerAttr')).to.equal('test2'); + doc.undo(); + + expect(doc.root.getAttr('innerAttr')).to.equal('test1'); + expect(doc.root.getAttr('outerAttr')).to.equal('test1'); + 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'); + + expect(doc.root.getAttr('innerAttr')).to.equal(undefined); + expect(doc.root.getAttr('outerAttr')).to.equal(undefined); doc.redo(); + + expect(doc.root.getAttr('innerAttr')).to.equal('test1'); + expect(doc.root.getAttr('outerAttr')).to.equal('test1'); + doc.redo(); - expect(doc.root.contents().length).to.equal(0); + expect(doc.root.getAttr('innerAttr')).to.equal('test2'); + expect(doc.root.getAttr('outerAttr')).to.equal('test2'); + + }); + + it('ignores transformation if document didn\'t emit change event', function() { + var doc = getDocumentFromXML('
'); + + 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('
'); + + 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'); + }); + + it('can have associated metadata', function() { + var doc = getDocumentFromXML('
'), + 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(''); + + 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(''), + 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('
'); + + 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('
'), + 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; + + }); }); });