X-Git-Url: https://git.mdrn.pl/fnpeditor.git/blobdiff_plain/fadd66e0cc7a22d06a1d8f4ab08871fec8dafcdf..75d2183aafd4b2d3e94c17f6c3c8ee0d8a4738e4:/src/smartxml/smartxml.test.js?ds=inline diff --git a/src/smartxml/smartxml.test.js b/src/smartxml/smartxml.test.js index 67ada78..a15f833 100644 --- a/src/smartxml/smartxml.test.js +++ b/src/smartxml/smartxml.test.js @@ -6,7 +6,7 @@ define([ 'use strict'; /*jshint expr:true */ -/* global describe, it, beforeEach */ +/* global describe, it, beforeEach, Node, DOMParser */ var expect = chai.expect; @@ -51,6 +51,48 @@ describe('smartxml', function() { expect(doc.containsNode(a)).to.equal(true, 'contains Element Node'); expect(doc.containsNode(text)).to.equal(true, 'contains Text Node'); }); + + it('creates text nodes', function() { + var doc = getDocumentFromXML('
'), + emptyTextNode = doc.createDocumentNode({text:''}), + nonEmptyTextNode = doc.createDocumentNode({text: 'alice'}); + expect(emptyTextNode.getText()).to.equal('', 'empty ok'); + expect(nonEmptyTextNode.getText()).to.equal('alice', 'non empty ok'); + }); + }); + + describe('DocumentNode', function() { + it('can be cloned', function() { + var doc = getDocumentFromXML('
Alice
'), + text = doc.root.contents()[0], + clone, suffix; + + [doc.root, text].forEach(function(node) { + suffix = ' (' + (node.nodeType === Node.TEXT_NODE ? 'text' : 'element') + ')'; + clone = node.clone(); + expect(doc.containsNode(clone)).to.equal(false, 'clone is not contained in a document' + suffix); + expect(node.sameNode(clone)).to.equal(false, 'clone is not same node as its originator' + suffix); + expect(node.nativeNode.isEqualNode(clone.nativeNode)).to.equal(true, 'clone is identical as its originator' + suffix); + }); + }); + + it('knows its path in the document tree', function() { + var doc = getDocumentFromXML('text'), + root = doc.root, + a = root.contents()[0], + b = a.contents()[0], + text = b.contents()[1]; + + expect(root.getPath()).to.eql([], 'path of the root element is empty'); + expect(a.getPath()).to.eql([0]); + expect(b.getPath()).to.eql([0, 0]); + expect(text.getPath()).to.eql([0,0,1]); + + /* Paths relative to a given ancestor */ + expect(text.getPath(root)).to.eql([0,0,1]); + expect(text.getPath(a)).to.eql([0,1]); + expect(text.getPath(b)).to.eql([1]); + }); }); describe('Basic ElementNode properties', function() { @@ -262,6 +304,27 @@ describe('smartxml', function() { describe('Manipulations', function() { + describe('replacing node with another one', function() { + it('replaces node with another one', function() { + var doc = getDocumentFromXML('
'), + a = doc.root.contents()[0]; + + var c = a.replaceWith({tagName: 'b', attrs: {b:'1'}}); + + expect(doc.root.contents()[0].sameNode(c)); + expect(c.getTagName()).to.equal('b'); + expect(c.getAttr('b')).to.equal('1'); + }); + it('can replace document root', function() { + var doc = getDocumentFromXML('
'); + + var header = doc.root.replaceWith({tagName: 'header'}); + + expect(doc.root.sameNode(header)).to.be.true; + expect(doc.containsNode(header)).to.be.true; + }); + }); + it('merges adjacent text nodes resulting from detaching an element node in between', function() { var doc = getDocumentFromXML('
Alice hasa cat
'), span = doc.root.contents()[1]; @@ -273,6 +336,27 @@ describe('smartxml', function() { expect(rootContents[0].getText()).to.equal('Alice a cat'); }); + it('inserts node at index', function() { + var doc = getDocumentFromXML('
'), + b = doc.root.contents()[1]; + + var inserted = doc.root.insertAtIndex({tagName: 'test'}, 1); + + expect(doc.root.contents()[1].sameNode(inserted)).to.equal(true, 'inserted node returned'); + expect(b.getIndex()).to.equal(2, 'b node shifted right'); + }); + + it('appends node when inserting node at index out of range', function() { + var doc = getDocumentFromXML('
'); + + var test1 = doc.root.insertAtIndex({tagName: 'test1'}, 0), + test2 = doc.root.insertAtIndex({tagName: 'test1'}, 10); + + expect(doc.root.contents()[0].sameNode(test1)).to.equal(true, 'inserting at index 0 of empty nodes appends node'); + expect(doc.root.contents().length).to.equal(1, 'inserting at index out of range does nothing'); + expect(test2).to.equal(undefined, 'inserting at index out of range returns undefined'); + }); + it('appends element node to another element node', function() { var node1 = elementNodeFromParams({tag: 'div'}), node2 = elementNodeFromParams({tag: 'a'}), @@ -313,7 +397,7 @@ describe('smartxml', function() { expect(node.contents()[2].getText()).to.equal(' a cat!'); }); - it('unwrap single node from its parent', function() { + it('unwrap single element node from its parent', function() { var doc = getDocumentFromXML('
'), div = doc.root, a = div.contents()[0], @@ -326,6 +410,19 @@ describe('smartxml', function() { expect(div.contents()[0].sameNode(b)).to.equal(true, 'node got unwrapped'); }); + it('unwrap single text node from its parent', function() { + var doc = getDocumentFromXML('
Some text!
'), + div = doc.root, + span = div.contents()[1], + text = span.contents()[0]; + + var parent = text.unwrap(); + + expect(parent.sameNode(div)).to.equal(true, 'returns new parent'); + expect(div.contents()).to.have.length(1, 'root contains only one node'); + expect(div.contents()[0].getText()).to.equal('Some text!'); + }); + describe('Wrapping text', function() { it('wraps text spanning multiple sibling TextNodes', function() { var section = elementNodeFromXML('
Alice has a small cat
'), @@ -362,16 +459,16 @@ describe('smartxml', function() { lastDiv = section.contents()[section.contents().length -1]; var returned = section.document.wrapNodes({ - element1: aliceText, - element2: lastDiv, + node1: aliceText, + node2: lastDiv, _with: {tagName: 'header'} }); - var sectionContents = section.contents(), - header = sectionContents[0], + var sectionContentss = section.contents(), + header = sectionContentss[0], headerContents = header.contents(); - expect(sectionContents).to.have.length(1); + expect(sectionContentss).to.have.length(1); expect(header.sameNode(returned)).to.equal(true, 'wrapper returned'); expect(header.parent().sameNode(section)).to.be.true; expect(headerContents).to.have.length(3); @@ -386,16 +483,16 @@ describe('smartxml', function() { div3 = section.contents()[2]; section.document.wrapNodes({ - element1: div2, - element2: div3, + node1: div2, + node2: div3, _with: {tagName: 'header'} }); - var sectionContents = section.contents(), - header = sectionContents[1], + var sectionContentss = section.contents(), + header = sectionContentss[1], headerChildren = header.contents(); - expect(sectionContents).to.have.length(3); + expect(sectionContentss).to.have.length(3); expect(headerChildren).to.have.length(2); expect(headerChildren[0].sameNode(div2)).to.equal(true, 'first node wrapped'); expect(headerChildren[1].sameNode(div3)).to.equal(true, 'second node wrapped'); @@ -404,6 +501,85 @@ describe('smartxml', function() { }); + describe('Splitting text', function() { + + it('splits TextNode\'s parent into two ElementNodes', function() { + var doc = getDocumentFromXML('
Some header
'), + section = doc.root, + text = section.contents()[0].contents()[0]; + + var returnedValue = text.split({offset: 5}); + expect(section.contents().length).to.equal(2, 'section has two children'); + + var header1 = section.contents()[0]; + var header2 = section.contents()[1]; + + expect(header1.getTagName()).to.equal('header', 'first section child ok'); + expect(header1.contents().length).to.equal(1, 'first header has one child'); + expect(header1.contents()[0].getText()).to.equal('Some ', 'first header has correct content'); + expect(header2.getTagName()).to.equal('header', 'second section child ok'); + expect(header2.contents().length).to.equal(1, 'second header has one child'); + expect(header2.contents()[0].getText()).to.equal('header', 'second header has correct content'); + + expect(returnedValue.first.sameNode(header1)).to.equal(true, 'first node returned'); + expect(returnedValue.second.sameNode(header2)).to.equal(true, 'second node returned'); + }); + + it('leaves empty copy of ElementNode if splitting at the very beginning', function() { + var doc = getDocumentFromXML('
Some header
'), + section = doc.root, + text = section.contents()[0].contents()[0]; + + text.split({offset: 0}); + + var header1 = section.contents()[0]; + var header2 = section.contents()[1]; + + expect(header1.contents().length).to.equal(0); + expect(header2.contents()[0].getText()).to.equal('Some header'); + }); + + it('leaves empty copy of ElementNode if splitting at the very end', function() { + var doc = getDocumentFromXML('
Some header
'), + section = doc.root, + text = section.contents()[0].contents()[0]; + + text.split({offset: 11}); + + var header1 = section.contents()[0]; + var header2 = section.contents()[1]; + + expect(header1.contents()[0].getText()).to.equal('Some header'); + expect(header2.contents().length).to.equal(0); + }); + + it('keeps TextNodes\'s parent\'s children elements intact', function() { + var doc = getDocumentFromXML('
A fancy and nice header
'), + section = doc.root, + header = section.contents()[0], + textAnd = header.contents()[2]; + + textAnd.split({offset: 2}); + + var sectionContents = section.contents(); + expect(sectionContents.length).to.equal(2, 'Section has two children'); + expect(sectionContents[0].getTagName()).to.equal('header', 'First section node is a header'); + expect(sectionContents[1].getTagName()).to.equal('header', 'Second section node is a header'); + + var firstHeaderContents = sectionContents[0].contents(); + expect(firstHeaderContents.length).to.equal(3, 'First header has three children'); + expect(firstHeaderContents[0].getText()).to.equal('A ', 'First header starts with a text'); + expect(firstHeaderContents[1].getTagName()).to.equal('span', 'First header has span in the middle'); + expect(firstHeaderContents[2].getText()).to.equal(' a', 'First header ends with text'); + + var secondHeaderContents = sectionContents[1].contents(); + expect(secondHeaderContents.length).to.equal(3, 'Second header has three children'); + expect(secondHeaderContents[0].getText()).to.equal('nd ', 'Second header starts with text'); + expect(secondHeaderContents[1].getTagName()).to.equal('span', 'Second header has span in the middle'); + expect(secondHeaderContents[2].getText()).to.equal(' header', 'Second header ends with text'); + }); + }); + describe('Events', function() { it('emits nodeDetached event on node detach', function() { var node = elementNodeFromXML('
'), @@ -519,6 +695,61 @@ describe('smartxml', function() { expect(event.type).to.equal('nodeMoved'); expect(event.meta.node.sameNode(inserted)).to.be.true; }); + + it('emits nodeDetached and nodeAdded when replacing root node with another', function() { + var doc = getDocumentFromXML(''), + oldRoot = doc.root, + spy = sinon.spy(); + + doc.on('change', spy); + + doc.root.replaceWith({tagName: 'b'}); + + expect(spy.callCount).to.equal(2); + + var event1 = spy.args[0][0], + event2 = spy.args[1][0]; + + expect(event1.type).to.equal('nodeDetached'); + expect(event1.meta.node.sameNode(oldRoot)).to.equal(true, 'root node in nodeDetached event metadata'); + expect(event2.type).to.equal('nodeAdded'); + expect(event2.meta.node.sameNode(doc.root)).to.equal(true, 'new root node in nodelAdded event meta'); + }); + + + ['append', 'prepend', 'before', 'after'].forEach(function(insertionMethod) { + it('emits nodeDetached for node moved from a document tree 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'}), + newNodeInner = newNode.append({tagName:'c'}); + + newNodeInner[insertionMethod](a); + + var event = spy.args[0][0]; + expect(event.type).to.equal('nodeDetached'); + 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() { + 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'}); + + expect(spy.callCount).to.equal(0); + }); + }); + + }); describe('Traversing', function() { @@ -596,6 +827,137 @@ describe('smartxml', function() { }); }); + describe('Extension API', function() { + var doc, extension, elementNode, textNode, testClassNode; + + beforeEach(function() { + doc = getDocumentFromXML('
Alice
'); + elementNode = doc.root; + textNode = doc.root.contents()[0]; + extension = {}; + + expect(function() { + elementNode.transform('testTransformation'); + }).to.throw(Error); + expect(function() { + textNode.transform('testTransformation'); + }).to.throw(Error); + expect(function() { + doc.transform('testTransformation'); + }).to.throw(Error); + expect(doc.testMethod).to.be.undefined; + expect(elementNode.testMethod).to.be.undefined; + expect(textNode.testMethod).to.be.undefined; + }); + + 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'); + }); + + it('allows adding transformation to a document', function() { + extension = {document: {transformations: { + testTransformation: function() { return this; }, + testTransformation2: {impl: function() { return this;}} + }}}; + + doc.registerExtension(extension); + expect(doc.transform('testTransformation')).to.equal(doc, 'context is set to a document instance'); + expect(doc.transform('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; } + }}}; + + 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'); + }); + + it('allows adding transformation to a DocumentNode', function() { + extension = {documentNode: {transformations: { + testTransformation: function() { return this; }, + testTransformation2: {impl: function() { return this;}} + }}}; + + doc.registerExtension(extension); + + expect(elementNode.transform('testTransformation').sameNode(elementNode)).to.equal(true, '1'); + expect(elementNode.transform('testTransformation2').sameNode(elementNode)).to.equal(true, '2'); + expect(textNode.transform('testTransformation').sameNode(textNode)).to.equal(true, '3'); + expect(textNode.transform('testTransformation2').sameNode(textNode)).to.equal(true, '4'); + }); + }); + + // describe('Undo/redo', function() { + + // it('does work', function() { + // var doc = getDocumentFromXML('
Alice
'), + // span = doc.root.contents()[0]; + + // span.transform('smartxml.detach'); + + + // 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.redo(); + // expect(doc.root.contents()).to.have.length(0); + + // 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'); + + // }); + // it('does work - merged text nodes case', function() { + // var doc = getDocumentFromXML('
Alice has a cat.
'), + // span = doc.root.contents()[1]; + + // span.transform('smartxml.detach'); + + + // doc.undo(); + + // expect(doc.root.contents().length).to.equal(3); + // //console.log(doc.toXML()); + // expect(doc.root.contents()[1].contents()[0].getText()).to.equal('has'); + + // }); + // 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'); + // 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.redo(); + // doc.redo(); + // expect(doc.root.contents().length).to.equal(0); + + // }); + // }); + }); }); \ No newline at end of file