wip: refactoring method/transformation registration out of wlxml.js to smartxml ...
[fnpeditor.git] / src / wlxml / wlxml.test.js
index 86fe462..480ca1c 100644 (file)
@@ -5,6 +5,7 @@ define([
     
 'use strict';
 
+/* jshint expr:true */
 /* global it, describe */
 
 var expect = chai.expect;
@@ -13,8 +14,8 @@ var nodeFromXML = function(xml) {
     return wlxml.WLXMLElementNodeFromXML(xml);
 };
 
-var getDocumentFromXML = function(xml) {
-    return wlxml.WLXMLDocumentFromXML(xml);
+var getDocumentFromXML = function(xml, options) {
+    return wlxml.WLXMLDocumentFromXML(xml, options || {});
 };
 
 
@@ -26,17 +27,81 @@ describe('WLXMLDocument', function() {
             expect(node.getClass()).to.equal('class.subclass');
         });
 
-        it('returns its attributes as dict', function() {
-            var node = nodeFromXML('<span meta-attr1="val1" meta-attr2="val2"></span>');
-            expect(node.getMetaAttributes()).to.eql([{name: 'attr1', value: 'val1'}, {name: 'attr2', value: 'val2'}]);
-        });
-
         it('returns attributes other than class and meta-* as other attributes', function() {
             var node = nodeFromXML('<span class="uri" meta-attr="val" attr1="val1" attr2="val2"></span>');
             expect(node.getOtherAttributes()).to.eql({attr1: 'val1', attr2: 'val2'});
         });
     });
 
+    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('<section></section>', {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(
+                        '<span class="test" meta-attr1="val1" meta-attr2="2014-01-01"></span>',
+                        {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('<span class="test"></span>', {wlxmlClasses: testClasses}).root,
+                    attrs = node.getMetaAttributes();
+                    expect(attrs.attr1.value).to.be.undefined;
+            });
+        });
+    });
+
     describe('White space handling', function() {
         it('ignores white space surrounding block elements', function() {
             var node = nodeFromXML('<section> <div></div> </section>'),
@@ -72,6 +137,9 @@ describe('WLXMLDocument', function() {
     });
 
     describe('formatting output xml', function() {
+
+        /*jshint multistr: true */
+
         it('keeps white space between XML nodes', function() {
             var xmlIn = '<section>\n\n\n<div></div>\n\n\n<div></div>\n\n\n</section>',
             doc = getDocumentFromXML(xmlIn),
@@ -90,8 +158,6 @@ describe('WLXMLDocument', function() {
 
             var partsIn = xmlIn.split('\n\n\n'),
                 partsOut = xmlOut.split('\n\n\n');
-            console.log(xmlIn);
-            console.log(xmlOut);
             expect(partsIn).to.deep.equal(partsOut);
         });
 
@@ -185,6 +251,104 @@ describe('WLXMLDocument', function() {
 
     });
 
+    describe('Extension', function() {
+        var doc, extension, elementNode, textNode, testClassNode;
+
+        beforeEach(function() {
+            doc = getDocumentFromXML('<section>Alice<div class="test_class"></div></section>');
+            elementNode = doc.root;
+            textNode = doc.root.contents()[0];
+            extension = {};
+            
+            console.log('A');
+            expect(function() {
+                elementNode.transform('testTransformation');
+            }).to.throw(Error);
+            console.log('B');
+            expect(function() {
+                textNode.transform('testTransformation');
+            }).to.throw(Error);
+            console.log('C');
+            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');
+        });
+
+        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 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.transform('testTransformation').sameNode(testClassNode)).to.equal(true, '1');
+            expect(testClassNode.object.transform('testTransformation2').sameNode(testClassNode)).to.equal(true, '1');
+        });
+
+
+    });
+
 });
 
 });
\ No newline at end of file