editor: minor usability tweak

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

diff --git a/src/smartxml/smartxml.test.js b/src/smartxml/smartxml.test.js
index 57f11cc..a994f05 100644 (file)
--- a/src/smartxml/smartxml.test.js
+++ b/src/smartxml/smartxml.test.js
@@ -86,6 +86,31 @@ describe('smartxml', function() {
             });
         });
 
             });
         });
 

+        it('can be cloned with its contents and its contents data', function() {
+            var doc = getDocumentFromXML('<root><div></div></root>'),
+                root = doc.root,
+                div = root.contents()[0];
+
+            var ClonableObject = function(arg) {
+                this.arg = arg;
+            };
+            ClonableObject.prototype.clone = function() {
+                return new ClonableObject(this.arg);
+            };
+
+            div.setData('key', 'value');
+            div.setData('clonableObject', new ClonableObject('test'));
+
+            var rootClone = root.clone(),
+                divClone = rootClone.contents()[0],
+                stringClone = divClone.getData('key'),
+                objClone = divClone.getData('clonableObject');
+
+            expect(stringClone).to.equal('value');
+            expect(objClone.arg).to.equal('test', 'clonable object got copied');
+            expect(objClone !== div.getData('clonableObject')).to.be.equal(true, 'copy of the clonable object is a new object');
+        });
+

         it('knows its path in the document tree', function() {
             var doc = getDocumentFromXML('<root><a><b><c></c>text</b></a></root>'),
                 root = doc.root,
         it('knows its path in the document tree', function() {
             var doc = getDocumentFromXML('<root><a><b><c></c>text</b></a></root>'),
                 root = doc.root,


@@ -144,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'});


@@ -189,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() {


@@ -218,6 +220,19 @@ describe('smartxml', function() {
             });
         });
 
             });
         });
 

+        describe('Searching for the last child text node', function() {
+            [
+                '<div>xxx<div></div>last</div>',
+                '<div><div>last</div></div>',
+                '<div>xxx<div>last</div><div></div></div>'
+            ].forEach(function(xml, i) {
+                var example = 'example ' + i;
+                it('returns last child text node ' + example + ')', function() {
+                    var doc = getDocumentFromXML(xml),
+                        lastTextNode = doc.root.getLastTextNode();
+                    expect(lastTextNode.getText()).to.equal('last', example);
+                });
+            });

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


@@ -360,6 +375,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>'),


@@ -433,12 +457,95 @@ describe('smartxml', function() {
             expect(node1.contents()[1].sameNode(node2)).to.be.true;
         });
 
             expect(node1.contents()[1].sameNode(node2)).to.be.true;
         });
 

-        it('wraps element node with another element node', function() {
+        describe('adding text nodes', function() {
+            it('merges text nodes on append', function() {
+                var doc = getDocumentFromXML('<root>text1</root>'),
+                    returned;
+                returned = doc.root.append({text: 'text2'});
+                expect(doc.root.contents().length).to.equal(1);
+                expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+                expect(doc.root.contents()[0].getText()).to.equal('text1text2');
+            });
+
+            it('merges text nodes on prepend', function() {
+                var doc = getDocumentFromXML('<root>text1</root>'),
+                    returned;
+                returned = doc.root.prepend({text: 'text2'});
+                expect(doc.root.contents().length).to.equal(1);
+                expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+                expect(doc.root.contents()[0].getText()).to.equal('text2text1');
+            });
+
+            it('merges text nodes on before text node', function() {
+                var doc = getDocumentFromXML('<root>text1</root>'),
+                    textNode = doc.root.contents()[0],
+                    returned;
+                returned = textNode.before({text: 'text2'});
+                expect(doc.root.contents().length).to.equal(1);
+                expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+                expect(doc.root.contents()[0].getText()).to.equal('text2text1');
+            });
+
+            it('merges text nodes on after text node', function() {
+                var doc = getDocumentFromXML('<root>text1</root>'),
+                    textNode = doc.root.contents()[0],
+                    returned;
+                returned = textNode.after({text: 'text2'});
+                expect(doc.root.contents().length).to.equal(1);
+                expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+                expect(doc.root.contents()[0].getText()).to.equal('text1text2');
+            });
+
+            it('merges text nodes on before element node', function() {
+                var doc = getDocumentFromXML('<root>text1<div></div></root>'),
+                    textNode = doc.root.contents()[0],
+                    div = doc.root.contents()[1],
+                    returned;
+                returned = div.before({text: 'text2'});
+                expect(doc.root.contents().length).to.equal(2);
+                expect(returned.sameNode(doc.root.contents()[0])).to.equal(true, 'modified node returned');
+                expect(textNode.getText()).to.equal('text1text2');
+            });
+
+            it('merges text nodes on after element node', function() {
+                var doc = getDocumentFromXML('<root><div></div>text1</root>'),
+                    textNode = doc.root.contents()[1],
+                    div = doc.root.contents()[0],
+                    returned;
+                returned = div.after({text: 'text2'});
+                expect(doc.root.contents().length).to.equal(2);
+                expect(returned.sameNode(doc.root.contents()[1])).to.equal(true, 'modified node returned');
+                expect(textNode.getText()).to.equal('text2text1');
+            });
+        });
+
+        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() {


@@ -557,6 +664,176 @@ describe('smartxml', function() {
 
     });
 
 
     });
 

+    var getTextNodes = function(text, doc) {
+        /* globals Node */
+        var toret = [];
+        var search = function(node) {
+            node.contents().forEach(function(node) {
+                if(node.nodeType === Node.TEXT_NODE) {
+                    if(node.getText() === text) {
+                        toret.push(node);
+                    }
+                } else {
+                    search(node);
+                }
+            });
+        };
+        search(doc.root);
+        return toret;
+    };
+
+    var getTextNode = function(text, doc) {
+        var nodes = getTextNodes(text, doc),
+            error;
+        if(nodes.length === 0) {
+            error = 'Text not found';
+        } else if(nodes.length > 1) {
+            error = 'Text not unique';
+        } else if(nodes[0].getText() !== text) {
+            error = 'I was trying to cheat your test :(';
+        }
+        if(error) {
+            throw new Error(error);
+        }
+        return nodes[0];
+    };
+
+    describe('Removing arbitrary text', function() {
+        it('removes within single text element', function() {
+            var doc = getDocumentFromXML('<div>Alice</div>'),
+                text = getTextNode('Alice', doc);
+            doc.deleteText({
+                from: {
+                    node: text,
+                    offset: 1
+                },
+                to: {
+                    node: text,
+                    offset: 4
+                }
+            });
+            expect(doc.root.contents().length).to.equal(1);
+            expect(doc.root.contents()[0].getText()).to.equal('Ae');
+        });
+        it('removes across elements - 1', function() {
+            var doc = getDocumentFromXML('<div><a>aaa</a><b>bbb</b></div>');
+
+            doc.deleteText({
+                from: {
+                    node: getTextNode('aaa', doc),
+                    offset: 2
+                },
+                to: {
+                    node: getTextNode('bbb', doc),
+                    offset: 2
+                }
+            });
+
+            var contents = doc.root.contents();
+            expect(contents.length).to.equal(2);
+            expect(contents[0].contents()[0].getText()).to.equal('aa');
+            expect(contents[1].contents()[0].getText()).to.equal('b');
+        });
+        it('removes across elements - 2', function() {
+            var doc = getDocumentFromXML('<a><b><c>ccc</c></b>xxx</a>');
+            doc.deleteText({
+                from: {
+                    node: getTextNode('ccc', doc),
+                    offset: 2
+                },
+                to: {
+                    node: getTextNode('xxx', doc),
+                    offset: 2
+                }
+            });
+
+            var contents = doc.root.contents();
+            expect(contents.length).to.equal(2);
+            expect(contents[0].getTagName()).to.equal('b');
+            expect(contents[1].getText()).to.equal('x');
+            
+            var bContents = contents[0].contents();
+            expect(bContents.length).to.equal(1);
+            expect(bContents[0].getTagName()).to.equal('c');
+            expect(bContents[0].contents().length).to.equal(1);
+            expect(bContents[0].contents()[0].getText()).to.equal('cc');
+        });
+        it('remove across elements - 3 (merged text nodes)', function() {
+            var doc = getDocumentFromXML('<div>Alice <span>has</span> a cat</div>');
+            doc.deleteText({
+                from: {
+                    node: getTextNode('Alice ', doc),
+                    offset: 1
+                },
+                to: {
+                    node: getTextNode(' a cat', doc),
+                    offset: 3
+                }
+            });
+            var contents = doc.root.contents();
+            expect(contents.length).to.equal(1);
+            expect(contents[0].getText()).to.equal('Acat');
+        });
+        it('remove across elements - 4', function() {
+            var doc = getDocumentFromXML('<div>Alice <div>has <span>a</span> cat</div></div>');
+            doc.deleteText({
+                from: {
+                    node: getTextNode('Alice ', doc),
+                    offset: 1
+                },
+                to: {
+                    node: getTextNode(' cat', doc),
+                    offset: 1
+                }
+            });
+            var contents = doc.root.contents();
+            expect(contents.length).to.equal(2);
+            expect(contents[0].getText()).to.equal('A');
+            expect(contents[1].getTagName()).to.equal('div');
+            expect(contents[1].contents().length).to.equal(1);
+            expect(contents[1].contents()[0].getText()).to.equal('cat');
+        });
+        it('removes across elements - 5 (whole document)', function() {
+            var doc = getDocumentFromXML('<div>Alice <div>has <span>a</span> cat</div>!!!</div>');
+            doc.deleteText({
+                from: {
+                    node: getTextNode('Alice ', doc),
+                    offset: 0
+                },
+                to: {
+                    node: getTextNode('!!!', doc),
+                    offset: 3
+                }
+            });
+
+            expect(doc.root.getTagName()).to.equal('div');
+            expect(doc.root.contents().length).to.equal(1);
+            expect(doc.root.contents()[0].getText()).to.equal('');
+        });
+        it('removes nodes in between', function() {
+            var doc = getDocumentFromXML('<div><a>aaa<x>!</x></a>xxx<x></x><b><x>!</x>bbb</b></div>');
+            doc.deleteText({
+                from: {
+                    node: getTextNode('aaa', doc),
+                    offset: 2
+                },
+                to: {
+                    node: getTextNode('bbb', doc),
+                    offset: 2
+                }
+            });
+
+            var contents = doc.root.contents();
+            expect(contents.length).to.equal(2, 'two nodes survived');
+            expect(contents[0].getTagName()).to.equal('a');
+            expect(contents[1].getTagName()).to.equal('b');
+            expect(contents[0].contents().length).to.equal(1);
+            expect(contents[0].contents()[0].getText()).to.equal('aa');
+            expect(contents[1].contents().length).to.equal(1);
+            expect(contents[1].contents()[0].getText()).to.equal('b');
+        });
+    });
+

     describe('Splitting text', function() {
     
         it('splits TextNode\'s parent into two ElementNodes', function() {
     describe('Splitting text', function() {
     
         it('splits TextNode\'s parent into two ElementNodes', function() {


@@ -675,6 +952,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() {


@@ -854,6 +1132,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');
+            });

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


@@ -1114,6 +1402,7 @@ describe('smartxml', function() {
         
         var sampleMethod = function(val) {
             this._$.attr('x', val);
         
         var sampleMethod = function(val) {
             this._$.attr('x', val);

+            this.triggerChangeEvent();

         };
 
         var transformations = {
         };
 
         var transformations = {


@@ -1210,10 +1499,12 @@ describe('smartxml', function() {
             doc.registerExtension({elementNode: {transformations: {
                 nested: function(v) {
                     this._$.attr('innerAttr', v);
             doc.registerExtension({elementNode: {transformations: {
                 nested: function(v) {
                     this._$.attr('innerAttr', v);

+                    this.triggerChangeEvent();

                 },
                 outer: function(v) {
                     this.nested(v);
                     this._$.attr('outerAttr', v);
                 },
                 outer: function(v) {
                     this.nested(v);
                     this._$.attr('outerAttr', v);

+                    this.triggerChangeEvent();

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


@@ -1245,6 +1536,20 @@ describe('smartxml', function() {
 
         });
 
 
         });
 

+        it('ignores transformation if document didn\'t emit change event', function() {
+            var doc = getDocumentFromXML('<div></div>');
+
+            doc.registerExtension({elementNode: {transformations: {
+                test: function() {
+                    // empty
+                }
+            }}});
+
+            doc.root.test();
+            expect(doc.undoStack.length).to.equal(0);
+
+        });
+

         describe('Transactions', function() {
             it('allows to undo/redo series of transformations at once', function() {
                 var doc = getDocumentFromXML('<div></div>');
         describe('Transactions', function() {
             it('allows to undo/redo series of transformations at once', function() {
                 var doc = getDocumentFromXML('<div></div>');


@@ -1289,14 +1594,17 @@ describe('smartxml', function() {
                     elementNode: {transformations: {
                         unaware: function(v) {
                             this.setAttr('unware', v);
                     elementNode: {transformations: {
                         unaware: function(v) {
                             this.setAttr('unware', v);

+                            this.triggerChangeEvent();

                         },
                         smart: {
                             impl: function(t, v) {
                                 t.oldVal = this.getAttr('smart');
                                 this.setAttr('smart', v);
                         },
                         smart: {
                             impl: function(t, v) {
                                 t.oldVal = this.getAttr('smart');
                                 this.setAttr('smart', v);

+                                this.triggerChangeEvent();

                             },
                             undo: function(t) {
                                 this.setAttr('smart', t.oldVal);
                             },
                             undo: function(t) {
                                 this.setAttr('smart', t.oldVal);

+                                this.triggerChangeEvent();

                             }
                         }
                     }}
                             }
                         }
                     }}


@@ -1314,6 +1622,101 @@ 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');
+            });
+            it('can perform undo of an operation performed after automatic transaction rollback', function() {
+                var doc = getDocumentFromXML('<section></section>'),
+                    extension = {document: {transformations: {
+                        throwingTransformation: function() { throw new Error(); }
+                    }}};
+
+                doc.registerExtension(extension);
+
+                doc.throwingTransformation();
+
+                doc.transaction(function() {
+                    doc.root.setAttr('x', '2');
+                });
+
+                expect(doc.undoStack.length).to.equal(1);
+                expect(doc.root.getAttr('x')).to.equal('2');
+
+                doc.undo();
+
+                expect(doc.undoStack.length).to.equal(0);
+                expect(doc.root.getAttr('x')).to.be.undefined;
+
+            });

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