wlxml: getParent/isInside takes context roots into account
[fnpeditor.git] / src / wlxml / wlxml.test.js
index 89f571c..93b6df9 100644 (file)
@@ -6,7 +6,7 @@ define([
 'use strict';
 
 /* jshint expr:true */
-/* global it, describe */
+/* global it, describe, beforeEach */
 
 var expect = chai.expect;
 
@@ -27,82 +27,15 @@ describe('WLXMLDocument', function() {
             expect(node.getClass()).to.equal('class.subclass');
         });
 
-        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;
-            });
+        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']);
         });
     });
 
     describe('White space handling', function() {
+        /* globals Node */
+
         it('ignores white space surrounding block elements', function() {
             var node = nodeFromXML('<section> <div></div> </section>'),
                 contents = node.contents();
@@ -252,102 +185,90 @@ 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];
-            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;
-
-            // spr+ a expect dotyczacy object api?
+            doc = getDocumentFromXML('<section>Alice<div class="test_class"></div><div class="test_class.a"></div></section>');
         });
 
-        it('allows adding method to a document', function() {
-            extension = {document: {methods: {
+        it('allows adding method to an ElementNode of specific class', function() {
+            extension = {wlxmlClass: {test_class: {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');
+            testClassNode = doc.root.contents()[1];
+            expect(testClassNode.object.testMethod().sameNode(testClassNode)).to.equal(true, '1');
         });
 
-        it('allows adding method to a DocumentNode instance', function() {
-            extension = {documentNode: {methods: {
-                testMethod: function() { return this; }    
-            }}};
-
+        it('allows adding non-function properties to an ElementNode of specific class', function() {
+            extension = {wlxmlClass: {test_class: {methods: {
+                testProp: 123
+            }}}};
             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');
+            testClassNode = doc.root.contents()[1];
+            expect(testClassNode.object.testProp).to.equal(123);
         });
 
-        it('allows adding transformation to a DocumentNode', function() {
-            extension = {documentNode: {transformations: {
+        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;}}
-            }}};
-            
+                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');
+            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');
         });
 
-        it('allows adding method to an ElementNode of specific class', function() {
+        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()[1];
-            expect(testClassNode.object.testMethod().sameNode(testClassNode)).to.equal(true, '1');
+            testClassNode = doc.root.contents()[2];
+            expect(testClassNode.object.testMethod().sameNode(testClassNode)).to.equal(true);
         });
-
-        it('allows adding transformation to an ElementNode of specific class', function() {
+        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()[1];
-            expect(testClassNode.object.transform('testTransformation').sameNode(testClassNode)).to.equal(true, '1');
-            expect(testClassNode.object.transform('testTransformation2').sameNode(testClassNode)).to.equal(true, '1');
+            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');
         });
+    });
 
+    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('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');
+
+            expect(divB.isInside('a')).to.equal(true, 'b inside a');
+            expect(divB.isInside({tagName: 'section'})).to.equal(true, 'b inside section');
 
+            expect(divA.isInside({tagName: 'section'})).to.equal(true, 'a inside section');
+        });
+    });
 });
 
 });
\ No newline at end of file