X-Git-Url: https://git.mdrn.pl/fnpeditor.git/blobdiff_plain/0487914c40881829a526a7a09b6d545f08aa28e7..15376df0aa6df3484cd942b4be2207b94172c502:/src/wlxml/wlxml.test.js diff --git a/src/wlxml/wlxml.test.js b/src/wlxml/wlxml.test.js index 95c230f..af0e23b 100644 --- a/src/wlxml/wlxml.test.js +++ b/src/wlxml/wlxml.test.js @@ -5,13 +5,325 @@ define([ 'use strict'; +/* jshint expr:true */ +/* global it, describe, beforeEach */ + var expect = chai.expect; +var nodeFromXML = function(xml) { + return wlxml.WLXMLElementNodeFromXML(xml); +}; + +var getDocumentFromXML = function(xml, options) { + return wlxml.WLXMLDocumentFromXML(xml, options || {}); +}; + + +describe('WLXMLDocument', function() { + + describe('Basic wlxml element node properties', function() { + it('returns its class', function() { + var node = nodeFromXML('
'); + expect(node.getClass()).to.equal('class.subclass'); + }); + + it('returns its class hierarchy', function() { + var node = nodeFromXML('
'); + expect(node.getClassHierarchy()).to.eql(['', 'a', 'a.b', 'a.b.c']); + }); + + it('returns unregistered attributes', function() { + var testClasses = { + 'testClass': { + attrs: {'attr1': {type: 'string'}} + } + }, + doc = getDocumentFromXML('', {wlxmlClasses: testClasses}); + expect(doc.root.getOtherAttributes()).to.eql({attr: {value:'val'}}); + }); + }); + + describe('WLXML node meta attributes', function() { + + it('inherits keys from super classes', function() { + var testClasses = { + '': { + attrs: {'common': {type: 'string'}} + }, + 'a': { + attrs: {'a_attr': {type: 'string'}} + }, + 'a.b': { + attrs: {'a_b_attr': {type: 'string'}} + }, + 'a.b.c': { + attrs: {'a_b_c_attr': {type: 'string'}} + } + }, + doc = getDocumentFromXML('
', {wlxmlClasses: testClasses}), + section = doc.root; + + expect(section.getMetaAttributes().keys()).to.eql(['common']); + + section.setClass('a'); + expect(section.getMetaAttributes().keys().sort()).to.eql(['common', 'a_attr'].sort()); + + section.setClass('a.b'); + expect(section.getMetaAttributes().keys().sort()).to.eql(['common', 'a_attr', 'a_b_attr'].sort()); + + section.setClass('a.b.c'); + expect(section.getMetaAttributes().keys().sort()).to.eql(['common', 'a_attr', 'a_b_attr', 'a_b_c_attr'].sort()); + }); + + describe('api', function() { + it('returns meta attributes as a dict', function() { + var testClasses = { + 'test': { + attrs: { + attr1: {type: 'string'}, + attr2: {type: 'date'} + } + } + }, + node = getDocumentFromXML( + '', + {wlxmlClasses: testClasses} + ).root, + attrs = node.getMetaAttributes(); + + expect(attrs.keys().sort()).to.eql(['attr1', 'attr2'].sort()); + expect(attrs.attr1.value).to.equal('val1'); + expect(attrs.attr1.type).to.equal('string'); + expect(attrs.attr2.value).to.equal('2014-01-01'); + expect(attrs.attr2.type).to.equal('date'); + }); + it('returns undefined value if attribute is missing', function() { + var testClasses = { + 'test': { + attrs: { + attr1: {type: 'string'}, + } + } + }, + node = getDocumentFromXML('', {wlxmlClasses: testClasses}).root, + attrs = node.getMetaAttributes(); + expect(attrs.attr1.value).to.be.undefined; + }); + }); + }); + + describe('White space handling', function() { + /* globals Node */ + + it('ignores white space surrounding block elements', function() { + var node = nodeFromXML('
'), + contents = node.contents(); + expect(contents).to.have.length(1); + expect(contents[0].nodeType).to.equal(Node.ELEMENT_NODE); + }); + it('ignores white space between block elements', function() { + var node = nodeFromXML('
'), + contents = node.contents(); + expect(contents).to.have.length(2); + [0,1].forEach(function(idx) { + expect(contents[idx].nodeType).to.equal(Node.ELEMENT_NODE); + }); + }); + it('trims white space from the beginning and the end of the block elements', function() { + var node = nodeFromXML('
Alice has a cat
'); + expect(node.contents()[0].getText()).to.equal('Alice '); + expect(node.contents()[2].getText()).to.equal(' a cat'); + }); + it('normalizes string of white characters to one space at the inline element boundries', function() { + var node = nodeFromXML(' Alice has a cat '); + expect(node.contents()[0].getText()).to.equal(' Alice has a cat '); + }); + it('normalizes string of white characters to one space before inline element', function() { + var node = nodeFromXML('
Alice has a cat
'); + expect(node.contents()[0].getText()).to.equal('Alice has '); + }); + it('normalizes string of white characters to one space after inline element', function() { + var node = nodeFromXML('
Alice has a cat
'); + expect(node.contents()[2].getText()).to.equal(' cat'); + }); + }); + + describe('formatting output xml', function() { + + /*jshint multistr: true */ + + it('keeps white space between XML nodes', function() { + var xmlIn = '
\n\n\n
\n\n\n
\n\n\n
', + doc = getDocumentFromXML(xmlIn), + xmlOut = doc.toXML(); + + var partsIn = xmlIn.split('\n\n\n'), + partsOut = xmlOut.split('\n\n\n'); + + expect(partsIn).to.deep.equal(partsOut); + }); + + it('keeps white space between XML nodes - inline case', function() { + var xmlIn = '
\n\n\n\n\n\n\n\n\n
', + doc = getDocumentFromXML(xmlIn), + xmlOut = doc.toXML(); + + var partsIn = xmlIn.split('\n\n\n'), + partsOut = xmlOut.split('\n\n\n'); + expect(partsIn).to.deep.equal(partsOut); + }); + + it('keeps white space at the beginning of text', function() { + var xmlIn = '
abc
some div
abc
', + doc = getDocumentFromXML(xmlIn), + xmlOut = doc.toXML(); + + expect(xmlOut).to.equal(xmlIn); + }); + + // it('nests new children block elements', function() { + // var doc = getDocumentFromXML('
'); + + // doc.root.append({tag: 'header'}); + + // var xmlOut = doc.toXML(); + // expect(xmlOut.split('\n ')[0]).to.equal('
', 'nesting start ok'); + // expect(xmlOut.split('\n').slice(-1)[0]).to.equal('
', 'nesting end ok'); + + // }); + + // it('doesn\'t nest new children inline elements', function() { + // var doc = getDocumentFromXML('
'); + + // doc.root.append({tag: 'span'}); + + // var xmlOut = doc.toXML(); + // expect(xmlOut).to.equal('
'); + // }); + + it('keeps original white space at the end of text', function() { + + var xmlIn = '
Some text ended with white space \ + \ + Some text some text\ + \ +
', + doc = getDocumentFromXML(xmlIn), + xmlOut = doc.toXML(); + + expect(xmlOut).to.equal(xmlIn); + }); + + it('keeps white space around text node', function() { + var xmlIn = '
\ +
header1
\ + Some text surrounded by white space\ +
header2
\ +
', + doc = getDocumentFromXML(xmlIn), + xmlOut = doc.toXML(); + expect(xmlOut).to.equal(xmlIn); + }); + + it('keeps white space around text node - last node case', function() { + var xmlIn = '
\ +
header
\ + \ + Some text surrounded by white space\ + \ +
', + doc = getDocumentFromXML(xmlIn), + xmlOut = doc.toXML(); + + expect(xmlOut).to.equal(xmlIn); + }); + + it('keeps white space after detaching text element', function() { + var xmlIn = '
header
\n\ + \n\ + text1\n\ + \n\ +
', + expectedXmlOut = '
header
\n\ + \n\ + \n\ + \n\ +
', + doc = getDocumentFromXML(xmlIn), + contents = doc.root.contents(), + text = contents[contents.length-1]; + + expect(text.getText()).to.equal('text1'); + + text.detach(); + + var xmlOut = doc.toXML(); + expect(xmlOut).to.equal(expectedXmlOut); + }); + + }); + + describe('Extension', function() { + var doc, extension, elementNode, textNode, testClassNode; + + beforeEach(function() { + doc = getDocumentFromXML('
Alice
'); + elementNode = doc.root; + textNode = doc.root.contents()[0]; + testClassNode = doc.root.contents('.test_class'); + extension = {}; + + expect(testClassNode.object).to.be.undefined; + + }); + + it('allows adding method to an ElementNode of specific class', function() { + extension = {wlxmlClass: {test_class: {methods: { + testMethod: function() { return this; } + }}}}; + doc.registerExtension(extension); + testClassNode = doc.root.contents()[1]; + expect(testClassNode.object.testMethod().sameNode(testClassNode)).to.equal(true, '1'); + }); + + it('allows adding non-function properties to an ElementNode of specific class', function() { + extension = {wlxmlClass: {test_class: {methods: { + testProp: 123 + }}}}; + doc.registerExtension(extension); + testClassNode = doc.root.contents()[1]; + expect(testClassNode.object.testProp).to.equal(123); + }); + + it('allows adding transformation to an ElementNode of specific class', function() { + extension = {wlxmlClass: {test_class: {transformations: { + testTransformation: function() { return this; }, + testTransformation2: {impl: function() { return this; }} + }}}}; + doc.registerExtension(extension); + testClassNode = doc.root.contents()[1]; + expect(testClassNode.object.testTransformation().sameNode(testClassNode)).to.equal(true, '1'); + expect(testClassNode.object.testTransformation2().sameNode(testClassNode)).to.equal(true, '1'); + }); -describe('how it works', function() { - it('does something', function() { - var doc = wlxml.WLXMLDocumentFromXML('
'); - expect(doc.root.getClass()).to.equal('class.subclass'); + it('added methods are inherited by nodes with subclasses', function() { + extension = {wlxmlClass: {test_class: {methods: { + testMethod: function() { return this; } + }}}}; + doc.registerExtension(extension); + testClassNode = doc.root.contents()[2]; + expect(testClassNode.object.testMethod().sameNode(testClassNode)).to.equal(true); + }); + it('added transformations are inherited by nodes with subclasses', function() { + extension = {wlxmlClass: {test_class: {transformations: { + testTransformation: function() { return this; }, + testTransformation2: {impl: function() { return this; }} + }}}}; + doc.registerExtension(extension); + testClassNode = doc.root.contents()[2]; + expect(testClassNode.object.testTransformation().sameNode(testClassNode)).to.equal(true, '1'); + expect(testClassNode.object.testTransformation2().sameNode(testClassNode)).to.equal(true, '2'); + }); }); });