wlxml: methods for testing for existence and fetching ancestors with a specific class

[fnpeditor.git] / src / smartxml / smartxml.test.js

diff --git a/src/smartxml/smartxml.test.js b/src/smartxml/smartxml.test.js
index cbef963..e4e2724 100644 (file)
--- a/src/smartxml/smartxml.test.js
+++ b/src/smartxml/smartxml.test.js
@@ -169,40 +169,16 @@ describe('smartxml', function() {
 
             it('can change tag name', function() {
                 var node = elementNodeFromXML('<div></div>');
 
             it('can change tag name', function() {
                 var node = elementNodeFromXML('<div></div>');

-                node.setTag('span');
+                node = node.setTag('span');

                 expect(node.getTagName()).to.equal('span');
             });
 
                 expect(node.getTagName()).to.equal('span');
             });
 

-            it('emits nodeTagChange event', function() {
-                var node = elementNodeFromXML('<div></div>'),
-                    spy = sinon.spy();
-
-                node.document.on('change', spy);
-                node.setTag('span');
-                var event = spy.args[0][0];
-
-                expect(event.type).to.equal('nodeTagChange');
-                expect(event.meta.node.sameNode(node)).to.be.true;
-                expect(event.meta.oldTagName).to.equal('div');
-            });
-

             describe('Implementation specific expectations', function() {
             describe('Implementation specific expectations', function() {

-                // DOM specifies ElementNode tag as a read-only property, so
-                // changing it in a seamless way is a little bit tricky. For this reason
-                // the folowing expectations are required, despite the fact that they actually are
-                // motivated by implemetation details.
-
-                it('keeps node in the document', function() {
-                    var doc = getDocumentFromXML('<div><header></header></div>'),
-                        header = doc.root.contents()[0];
-                    header.setTag('span');
-                    expect(header.parent().sameNode(doc.root)).to.be.true;
-                });

                 it('keeps custom data', function() {
                     var node = elementNodeFromXML('<div></div>');
 
                     node.setData('key', 'value');
                 it('keeps custom data', function() {
                     var node = elementNodeFromXML('<div></div>');
 
                     node.setData('key', 'value');

-                    node.setTag('header');
+                    node = node.setTag('header');

                     
                     expect(node.getTagName()).to.equal('header');
                     expect(node.getData()).to.eql({key: 'value'});
                     
                     expect(node.getTagName()).to.equal('header');
                     expect(node.getData()).to.eql({key: 'value'});


@@ -214,12 +190,13 @@ describe('smartxml', function() {
                     expect(doc.root.getTagName()).to.equal('span');
                 });
 
                     expect(doc.root.getTagName()).to.equal('span');
                 });
 

-                it('keeps contents', function() {
+                it('keeps node contents', function() {

                     var node = elementNodeFromXML('<div><div></div></div>');
                     var node = elementNodeFromXML('<div><div></div></div>');

-                    node.setTag('header');
+                    node = node.setTag('header');

                     expect(node.contents()).to.have.length(1);
                 });
             });
                     expect(node.contents()).to.have.length(1);
                 });
             });

+        });

 
         describe('Setting node attributes', function() {
             it('can set node attribute', function() {
 
         describe('Setting node attributes', function() {
             it('can set node attribute', function() {


@@ -242,8 +219,6 @@ describe('smartxml', function() {
                 expect(event.meta.oldVal).to.equal('value1');
             });
         });
                 expect(event.meta.oldVal).to.equal('value1');
             });
         });

-
-        });

     });
 
     describe('Basic TextNode properties', function() {
     });
 
     describe('Basic TextNode properties', function() {


@@ -385,6 +360,15 @@ describe('smartxml', function() {
 
     describe('Manipulations', function() {
 
 
     describe('Manipulations', function() {
 

+        describe('detaching nodes', function() {
+            it('can detach document root node', function() {
+                var doc = getDocumentFromXML('<div></div>');
+
+                doc.root.detach();
+                expect(doc.root).to.equal(null);
+            });
+        });
+

         describe('replacing node with another one', function() {
             it('replaces node with another one', function() {
                 var doc = getDocumentFromXML('<div><a></a></div>'),
         describe('replacing node with another one', function() {
             it('replaces node with another one', function() {
                 var doc = getDocumentFromXML('<div><a></a></div>'),


@@ -520,12 +504,33 @@ describe('smartxml', function() {
             });
         });
 
             });
         });
 

-        it('wraps element node with another element node', function() {
+        it('wraps root element node with another element node', function() {

             var node = elementNodeFromXML('<div></div>'),
                 wrapper = elementNodeFromXML('<wrapper></wrapper>');
 
             node.wrapWith(wrapper);
             expect(node.parent().sameNode(wrapper)).to.be.true;
             var node = elementNodeFromXML('<div></div>'),
                 wrapper = elementNodeFromXML('<wrapper></wrapper>');
 
             node.wrapWith(wrapper);
             expect(node.parent().sameNode(wrapper)).to.be.true;

+            expect(node.document.root.sameNode(wrapper)).to.be.true;
+        });
+
+        it('wraps element node with another element node', function() {
+            var doc = getDocumentFromXML('<section><div></div></section>'),
+                div = doc.root.contents()[0];
+
+            var wrapper = div.wrapWith({tagName: 'wrapper'});
+            expect(wrapper.sameNode(doc.root.contents()[0])).to.equal(true, '1');
+            expect(div.parent().sameNode(wrapper)).to.equal(true, '2');
+            expect(wrapper.contents()[0].sameNode(div)).to.equal(true, '3');
+        });
+
+        it('wraps element outside of document tree', function() {
+            var doc = getDocumentFromXML('<section><div></div></section>'),
+                node = doc.createDocumentNode({tagName: 'node'});
+
+            node.wrapWith({tagName: 'wrapper'});
+            expect(node.parent().getTagName()).to.equal('wrapper');
+            expect(node.parent().contents()[0].sameNode(node)).to.be.true;
+            expect(doc.root.getTagName()).to.equal('section');

         });
 
         it('unwraps element node contents', function() {
         });
 
         it('unwraps element node contents', function() {


@@ -932,6 +937,7 @@ describe('smartxml', function() {
             expect(spy.callCount).to.equal(1);
             expect(event.type).to.equal('nodeMoved');
             expect(event.meta.node.sameNode(appended)).to.be.true;
             expect(spy.callCount).to.equal(1);
             expect(event.type).to.equal('nodeMoved');
             expect(event.meta.node.sameNode(appended)).to.be.true;

+            expect(node.document.root.sameNode(event.meta.parent)).to.equal(true, 'previous parent attached to event meta');

         });
         
         it('emits nodeAdded event when prepending new node', function() {
         });
         
         it('emits nodeAdded event when prepending new node', function() {


@@ -1111,6 +1117,16 @@ describe('smartxml', function() {
                 expect(siblingParents.node1.sameNode(aliceText)).to.equal(true, 'aliceText');
                 expect(siblingParents.node2.sameNode(span)).to.equal(true, 'span');
             });
                 expect(siblingParents.node1.sameNode(aliceText)).to.equal(true, 'aliceText');
                 expect(siblingParents.node2.sameNode(span)).to.equal(true, 'span');
             });

+
+            it('returns node itself for two same nodes', function() {
+                var doc = getDocumentFromXML('<section><div></div></section>'),
+                    div = doc.root.contents()[0];
+
+                var siblingParents = doc.getSiblingParents({node1: div, node2: div});
+                expect(!!siblingParents.node1 && !!siblingParents.node2).to.equal(true, 'nodes defined');
+                expect(siblingParents.node1.sameNode(div)).to.be.equal(true, 'node1');
+                expect(siblingParents.node2.sameNode(div)).to.be.equal(true, 'node2');
+            });

         });
     });
 
         });
     });
 


@@ -1591,6 +1607,78 @@ describe('smartxml', function() {
                 expect(doc.root.getAttr('smart')).to.equal('1');
                 expect(doc.root.getAttr('unaware')).to.equal('1');
             });
                 expect(doc.root.getAttr('smart')).to.equal('1');
                 expect(doc.root.getAttr('unaware')).to.equal('1');
             });

+
+            it('can have associated metadata', function() {
+                var doc = getDocumentFromXML('<div></div>'),
+                    metadata = Object.create({});
+
+                doc.registerExtension({document: {transformations: {
+                    test: function() {
+                        this.trigger('change');
+                    }
+                }}});
+
+                doc.startTransaction(metadata);
+                doc.test();
+                doc.endTransaction();
+
+                var transaction = doc.undoStack[0];
+                expect(transaction.metadata).to.equal(metadata);
+            });
+
+            it('can be rolled back', function() {
+                var doc = getDocumentFromXML('<root></root>');
+
+                doc.startTransaction();
+                doc.root.append({tagName: 'div'});
+                doc.rollbackTransaction();
+
+                expect(doc.undoStack.length).to.equal(0, 'nothing to undo');
+                expect(doc.root.contents().length).to.equal(0);
+            });
+
+            it('rollbacks and calls error handleor if error gets thrown', function() {
+                var doc = getDocumentFromXML('<root></root>'),
+                    err = new Error(),
+                    spy = sinon.spy();
+                
+                doc.transaction(function() {
+                    doc.root.append({tagName: 'div'});
+                    throw err;
+                }, {error: spy});
+
+                expect(spy.args[0][0]).to.equal(err);
+                expect(doc.root.contents().length).to.equal(0);
+                expect(doc.undoStack.length).to.equal(0);
+            });
+        });
+
+        describe('Regression tests', function() {
+            it('redos correctly after running its own undo followed by unaware transformation undo', function() {
+                var doc = getDocumentFromXML('<section t="0"></section>');
+                
+                doc.registerExtension({elementNode: {transformations: {
+                    unaware: function() {
+                        this.triggerChangeEvent();
+                    },
+                    test: {
+                        impl: function() {
+                            this._$.attr('t', 1);
+                            this.triggerChangeEvent();
+                        },
+                        undo: function() {
+                            this._$.attr('t', 0);
+                        }
+                    }
+                }}});
+                doc.root.unaware();
+                doc.root.test();
+                doc.undo();
+                doc.undo();
+                doc.redo();
+                doc.redo();
+                expect(doc.root.getAttr('t')).to.equal('1');
+            });

         });
     });
 
         });
     });