wlxml: getParent/isInside takes context roots into account
[fnpeditor.git] / src / wlxml / wlxml.test.js
index 7eb8efb..93b6df9 100644 (file)
@@ -1,8 +1,7 @@
 define([
-    'libs/jquery',
     'libs/chai',
     './wlxml.js'
-], function($, chai, wlxml) {
+], function(chai, wlxml) {
     
 'use strict';
 
@@ -28,83 +27,9 @@ describe('WLXMLDocument', function() {
             expect(node.getClass()).to.equal('class.subclass');
         });
 
-        it('returns unregistered attributes', function() {
-            var testClasses = {
-                    'testClass': {
-                        attrs: {'attr1': {type: 'string'}}
-                    }
-                },
-                doc = getDocumentFromXML('<span class="testClass" attr="val" attr1="val1"></span>', {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('<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" attr1="val1" 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;
-            });
+        it('returns its class hierarchy', function() {
+            var node = nodeFromXML('<div class="a.b.c"></div>');
+            expect(node.getClassHierarchy()).to.eql(['', 'a', 'a.b', 'a.b.c']);
         });
     });
 
@@ -260,17 +185,10 @@ describe('WLXMLDocument', function() {
     });
 
     describe('Extension', function() {
-        var doc, extension, elementNode, textNode, testClassNode;
+        var doc, extension, testClassNode;
 
         beforeEach(function() {
-            doc = getDocumentFromXML('<section>Alice<div class="test_class"></div></section>');
-            elementNode = doc.root;
-            textNode = doc.root.contents()[0];
-            testClassNode = doc.root.contents('.test_class');
-            extension = {};
-            
-            expect(testClassNode.object).to.be.undefined;
-
+            doc = getDocumentFromXML('<section>Alice<div class="test_class"></div><div class="test_class.a"></div></section>');
         });
 
         it('allows adding method to an ElementNode of specific class', function() {
@@ -282,6 +200,15 @@ describe('WLXMLDocument', function() {
             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; },
@@ -292,40 +219,56 @@ describe('WLXMLDocument', function() {
             expect(testClassNode.object.testTransformation().sameNode(testClassNode)).to.equal(true, '1');
             expect(testClassNode.object.testTransformation2().sameNode(testClassNode)).to.equal(true, '1');
         });
-    });
 
-    describe.only('Metadata API', function() {
-        it('allows to set metadata on an element node', function() {
-            var doc = getDocumentFromXML('<section></section>');
-            expect(doc.root.getMetadata()).to.deep.equal([]);
-            doc.root.addMetadataRow({key: 'key', value: 'value'});
-            expect(doc.root.getMetadata()).to.deep.equal([{key: 'key', value: 'value'}]);
+        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');
+        });
+    });
 
-        it('reads node\'s metadata from its metadata child node', function() {
-            var doc = getDocumentFromXML('<section><metadata><dc:key>value</dc:key></metadata></section>');
-            expect(doc.root.getMetadata()).to.deep.equal([{key: 'key', value: 'value'}]);
+    describe('Context roots', function() {
+        var doc = getDocumentFromXML('<section><div class="a"><div class="b"><div class="c"></div></div></div></section>');
+        doc.registerExtension({wlxmlClass: {a: {methods: {
+            isContextRoot: function(node) {
+                return node.getClass() === 'b';
+            }
+        }}}});
+
+        var divA = doc.root.contents()[0],
+            divB = divA.contents()[0],
+            divC = divB.contents()[0];
+
+        it('allows extensions declaring a node as a context root', function() {
+            expect(divC.isContextRoot()).to.equal(false, 'c is not a context root');
+            expect(divB.isContextRoot()).to.equal(true, 'b is a context root');
+            expect(divA.isContextRoot()).to.equal(false, 'a is not a context root');
         });
 
-        it('serializes node\'s metadata to its metadata child node', function() {
-            var doc = getDocumentFromXML('<section></section>');
+        it('closes context for parent context quering methods', function() {
+            expect(divC.isInside('b')).to.equal(true, 'c inside b');
+            expect(divC.isInside('a')).to.equal(false, 'c not inside a');
+            expect(divC.isInside({tagName: 'section'})).to.equal(false, 'c not inside section');
 
-            doc.root.addMetadataRow({key: 'key', value: 'value'});
+            expect(divB.isInside('a')).to.equal(true, 'b inside a');
+            expect(divB.isInside({tagName: 'section'})).to.equal(true, 'b inside section');
 
-            var metadataNodes = $(doc.toXML()).children('metadata'),
-                keyNodes = metadataNodes.children();
-            
-            expect(metadataNodes).to.have.length(1);
-            expect(keyNodes).to.have.length(1);
-            expect(keyNodes[0].tagName.toLowerCase()).to.equal('dc:key');
-            expect($(keyNodes[0]).text()).to.equal('value');
-        });
-        it('doesnt show metadata node on nodes contents', function() {
-            var doc = getDocumentFromXML('<section><metadata><dc:key>value</dc:key></metadata></section>');
-            expect(doc.root.contents()).to.have.length(0);
+            expect(divA.isInside({tagName: 'section'})).to.equal(true, 'a inside section');
         });
     });
-
 });
 
 });
\ No newline at end of file