editor: fix - block removing root node via insert/delete
[fnpeditor.git] / src / smartxml / smartxml.test.js
index 5d2bbb7..cbef963 100644 (file)
@@ -60,6 +60,15 @@ describe('smartxml', function() {
             expect(emptyTextNode.getText()).to.equal('', 'empty ok');
             expect(nonEmptyTextNode.getText()).to.equal('alice', 'non empty ok');
         });
+
+        it('creates nodes from xml strings', function() {
+            var doc = getDocumentFromXML('<div></div>'),
+                node = doc.createDocumentNode('<a>Alice<b></b></a>');
+            expect(node.getTagName()).to.equal('a');
+            expect(node.contents().length).to.equal(2);
+            expect(node.contents()[0].getText()).to.equal('Alice');
+            expect(node.contents()[1].getTagName()).to.equal('b');
+        });
     });
 
     describe('DocumentNode', function() {
@@ -77,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,
@@ -301,6 +335,52 @@ describe('smartxml', function() {
             });
         });
 
+        describe('Dividing text node into two with element node', function() {
+                it('can divide text node with element node, splitting text node into two', function() {
+                    var doc = getDocumentFromXML('<div>Alice has a cat</div>'),
+                        text = doc.root.contents()[0];
+
+                    var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 5}),
+                        contents = doc.root.contents(),
+                        lhsText = contents[0],
+                        rhsText = contents[2];
+
+                    expect(lhsText.getText()).to.equal('Alice');
+                    expect(returned.sameNode(contents[1]));
+                    expect(rhsText.getText()).to.equal(' has a cat');
+                });
+
+                it('treats dividing at the very end as appending after it', function() {
+                    var doc = getDocumentFromXML('<div>Alice has a cat</div>'),
+                        text = doc.root.contents()[0];
+
+
+                    var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 15}),
+                        contents = doc.root.contents(),
+                        textNode = contents[0],
+                        elementNode = contents[1];
+
+                    expect(contents.length).to.equal(2);
+                    expect(textNode.getText()).to.equal('Alice has a cat');
+                    expect(returned.sameNode(elementNode)).to.be.true;
+                    expect(elementNode.getTagName()).to.equal('aside');
+                });
+
+                it('treats dividing at the very beginning as prepending before it', function() {
+                    var doc = getDocumentFromXML('<div>Alice has a cat</div>'),
+                        text = doc.root.contents()[0];
+
+                    var returned = text.divideWithElementNode({tagName: 'aside'}, {offset: 0}),
+                        contents = doc.root.contents(),
+                        textNode = contents[1],
+                        elementNode = contents[0];
+
+                    expect(contents.length).to.equal(2);
+                    expect(textNode.getText()).to.equal('Alice has a cat');
+                    expect(returned.sameNode(elementNode)).to.be.true;
+                    expect(elementNode.getTagName()).to.equal('aside');
+                });
+        });
     });
 
     describe('Manipulations', function() {
@@ -378,6 +458,68 @@ describe('smartxml', function() {
             expect(node1.contents()[1].sameNode(node2)).to.be.true;
         });
 
+        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 element node with another element node', function() {
             var node = elementNodeFromXML('<div></div>'),
                 wrapper = elementNodeFromXML('<wrapper></wrapper>');
@@ -502,6 +644,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() {
@@ -1059,6 +1371,7 @@ describe('smartxml', function() {
         
         var sampleMethod = function(val) {
             this._$.attr('x', val);
+            this.triggerChangeEvent();
         };
 
         var transformations = {
@@ -1155,10 +1468,12 @@ describe('smartxml', function() {
             doc.registerExtension({elementNode: {transformations: {
                 nested: function(v) {
                     this._$.attr('innerAttr', v);
+                    this.triggerChangeEvent();
                 },
                 outer: function(v) {
                     this.nested(v);
                     this._$.attr('outerAttr', v);
+                    this.triggerChangeEvent();
                 }
             }}});
 
@@ -1189,6 +1504,94 @@ describe('smartxml', function() {
             expect(doc.root.getAttr('outerAttr')).to.equal('test2');
 
         });
+
+        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>');
+
+                doc.registerExtension({
+                    elementNode: {transformations: {
+                        test: function(v) {
+                            this.setAttr('test', v);
+                        }
+                    }}
+                });
+
+                doc.startTransaction();
+                doc.root.test('1');
+                doc.root.test('2');
+                doc.root.test('3');
+                doc.endTransaction();
+
+                doc.undo();
+                expect(doc.root.getAttr('test'), '1');
+                doc.redo();
+                expect(doc.root.getAttr('test'), '3');
+                doc.undo();
+                expect(doc.root.getAttr('test'), '1');
+                doc.redo();
+                expect(doc.root.getAttr('test'), '3');
+            });
+
+            it('ignores empty transactions', function() {
+                var doc = getDocumentFromXML('<div></div>');
+                doc.startTransaction();
+                doc.endTransaction();
+                expect(doc.undoStack).to.have.length(0, 'empty transaction doesn\'t get pushed into undo stack');
+            });
+
+            it('doesn\'t break on optimizations', function() {
+                // This is a smoke test checking if optimizations made to transaction undoing
+                // doesnt't break anything.
+                var doc = getDocumentFromXML('<div smart="1" unaware="1"></div>');
+
+                doc.registerExtension({
+                    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);
+                                this.triggerChangeEvent();
+                            },
+                            undo: function(t) {
+                                this.setAttr('smart', t.oldVal);
+                                this.triggerChangeEvent();
+                            }
+                        }
+                    }}
+                });
+
+                doc.startTransaction();
+                doc.root.smart('2');
+                doc.root.unaware('2');
+                doc.root.smart('3');
+                doc.root.unaware('3');
+                doc.endTransaction();
+
+                doc.undo();
+
+                expect(doc.root.getAttr('smart')).to.equal('1');
+                expect(doc.root.getAttr('unaware')).to.equal('1');
+            });
+        });
     });
 
 });