editor: cleanup

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

diff --git a/src/smartxml/smartxml.test.js b/src/smartxml/smartxml.test.js
index 64e633f..0883ba7 100644 (file)
--- a/src/smartxml/smartxml.test.js
+++ b/src/smartxml/smartxml.test.js
@@ -1,8 +1,9 @@
 define([
     'libs/chai',
     'libs/sinon',
 define([
     'libs/chai',
     'libs/sinon',

+    'libs/underscore',

     './smartxml.js'
     './smartxml.js'

-], function(chai, sinon, smartxml) {
+], function(chai, sinon, _, smartxml) {

     
 'use strict';
 /*jshint expr:true */
     
 'use strict';
 /*jshint expr:true */


@@ -59,6 +60,15 @@ describe('smartxml', function() {
             expect(emptyTextNode.getText()).to.equal('', 'empty ok');
             expect(nonEmptyTextNode.getText()).to.equal('alice', 'non empty ok');
         });
             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() {
     });
 
     describe('DocumentNode', function() {


@@ -76,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,


@@ -300,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() {
     });
 
     describe('Manipulations', function() {


@@ -734,6 +815,18 @@ describe('smartxml', function() {
                 expect(event.type).to.equal('nodeDetached');
                 expect(event.meta.node.sameNode(a));
             });
                 expect(event.type).to.equal('nodeDetached');
                 expect(event.meta.node.sameNode(a));
             });

+
+            it('doesn\'t emit nodeDetached event for already out of document node moved to out of document node' + insertionMethod, function() {
+                var doc = getDocumentFromXML('<div><a></a></div>'),
+                    spy = sinon.spy();
+
+                doc.on('change', spy);
+
+                var newNode = doc.createDocumentNode({tagName: 'b'});
+                newNode.append({tagName:'c'});
+
+                expect(spy.callCount).to.equal(0);
+            });

         });
 
 
         });
 
 


@@ -756,7 +849,9 @@ describe('smartxml', function() {
                     c = b.contents()[0];
 
                 var parents = c.parents();
                     c = b.contents()[0];
 
                 var parents = c.parents();

-                expect(parents).to.eql([b,a]);
+                // @@
+                expect(parents[0].sameNode(b)).to.be.true;
+                expect(parents[1].sameNode(a)).to.be.true;

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


@@ -814,28 +909,436 @@ describe('smartxml', function() {
         });
     });
 
         });
     });
 

+    describe('Extension API', function() {
+        var doc, extension, elementNode, textNode;
+
+        beforeEach(function() {
+            doc = getDocumentFromXML('<section>Alice<div class="test_class"></div></section>');
+            elementNode = doc.root;
+            textNode = doc.root.contents()[0];
+            extension = {};
+            
+            expect(elementNode.testTransformation).to.be.undefined;
+            expect(textNode.testTransformation).to.be.undefined;
+            expect(doc.testTransformation).to.be.undefined;
+            
+            expect(doc.testMethod).to.be.undefined;
+            expect(elementNode.testMethod).to.be.undefined;
+            expect(textNode.testMethod).to.be.undefined;
+            expect(elementNode.elementTestMethod).to.be.undefined;
+            expect(textNode.textTestMethod).to.be.undefined;
+        });
+
+        it('allows adding method to a document', function() {
+            extension = {document: {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.testTransformation()).to.equal(doc, 'context is set to a document instance');
+            expect(doc.testTransformation2()).to.equal(doc, 'context is set to a document instance');
+        });
+
+        it('allows adding method to a DocumentNode instance', function() {
+            extension = {
+                documentNode: {
+                    methods: {
+                        testMethod: function() { return this; }
+                    }
+                },
+                textNode: {
+                    methods: {
+                        textTestMethod: function() { return this; }
+                    }
+                },
+                elementNode: {
+                    methods: {
+                        elementTestMethod: function() { return this; }
+                    }
+                }
+            };
+
+            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');
+
+            expect(elementNode.elementTestMethod().sameNode(elementNode)).to.be.true;
+            expect(elementNode.textTestMethod).to.be.undefined;
+        
+            expect(textNode.textTestMethod().sameNode(textNode)).to.be.true;
+            expect(textNode.elementTestMethod).to.be.undefined;
+        });
+
+        it('allows adding transformation to a DocumentNode', function() {
+            extension = {
+                documentNode: {
+                    transformations: {
+                        testTransformation: function() { return this; },
+                        testTransformation2: {impl: function() { return this;}}
+                    }
+                },
+                textNode: {
+                    transformations: {
+                        textTestTransformation: function() { return this; }
+                    }
+                },
+                elementNode: {
+                    transformations: {
+                        elementTestTransformation: function() { return this; }
+                    }
+                }
+            };
+            
+            doc.registerExtension(extension);
+
+            /* refresh */
+            elementNode = doc.root;
+            textNode = doc.root.contents()[0];
+            
+            expect(elementNode.testTransformation().sameNode(elementNode)).to.equal(true, '1');
+            expect(elementNode.testTransformation2().sameNode(elementNode)).to.equal(true, '2');
+            expect(textNode.testTransformation().sameNode(textNode)).to.equal(true, '3');
+            expect(textNode.testTransformation2().sameNode(textNode)).to.equal(true, '4');
+
+            expect(elementNode.elementTestTransformation().sameNode(elementNode)).to.be.true;
+            expect(elementNode.textTestTransformation).to.be.undefined;
+        
+            expect(textNode.textTestTransformation().sameNode(textNode)).to.be.true;
+            expect(textNode.elementTestTransfomation).to.be.undefined;
+        });
+
+        it('allows text/element node methods and transformations to access node and transormations on document node', function() {
+
+            var doc = getDocumentFromXML('<div>text</div>');
+
+            doc.registerExtension({
+                documentNode: {
+                    methods: {
+                        test: function() {
+                            return 'super';
+                        }
+                    },
+                    transformations: {
+                        testT: function() {
+                            return 'super_trans';
+                        }
+                    }
+                },
+                elementNode: {
+                    methods: {
+                        test: function() {
+                            return 'element_sub_' + this.__super__.test();
+                        }
+                    },
+                    transformations: {
+                        testT: function() {
+                            return 'element_trans_sub_' + this.__super__.testT();
+                        }
+                    }
+                },
+                textNode: {
+                    methods: {
+                        test: function() {
+                            return 'text_sub_' + this.__super__.test();
+                        }
+                    },
+                    transformations: {
+                        testT: function() {
+                            return 'text_trans_sub_' + this.__super__.testT();
+                        }
+                    }
+                }
+            });
+
+            var textNode = doc.root.contents()[0];
+
+            expect(doc.root.test()).to.equal('element_sub_super');
+            expect(textNode.test()).to.equal('text_sub_super');
+            expect(doc.root.testT()).to.equal('element_trans_sub_super_trans');
+            expect(textNode.testT()).to.equal('text_trans_sub_super_trans');
+        });
+    });
+

     describe('Undo/redo', function() {
     describe('Undo/redo', function() {

-        it('does work', function() {
-            var doc = getDocumentFromXML('<section><span>Alice</span></section>'),
-                span = doc.root.contents()[0];

 
 

-            doc.transform('detach3', {node: span});
+        it('smoke tests', function() {
+            var doc = getDocumentFromXML('<div>Alice</div>'),
+                textNode = doc.root.contents()[0];
+
+            expect(doc.undoStack).to.have.length(0);
+            
+            textNode.wrapWith({tagName: 'span', start:1, end:2});
+            expect(doc.undoStack).to.have.length(1, '1');
+            expect(doc.toXML()).to.equal('<div>A<span>l</span>ice</div>');
+
+            doc.undo();
+            expect(doc.undoStack).to.have.length(0, '2');
+            expect(doc.toXML()).to.equal('<div>Alice</div>');
+
+            doc.redo();
+            expect(doc.undoStack).to.have.length(1, '3');
+            expect(doc.toXML()).to.equal('<div>A<span>l</span>ice</div>');
+
+            doc.undo();
+            expect(doc.undoStack).to.have.length(0, '4');
+            expect(doc.toXML()).to.equal('<div>Alice</div>');
+
+            doc.undo();
+            expect(doc.undoStack).to.have.length(0, '5');
+            expect(doc.toXML()).to.equal('<div>Alice</div>');
+        });
+
+        it('smoke tests 2', function() {
+            var doc = getDocumentFromXML('<div>Alice</div>'),
+                textNode = doc.root.contents()[0],
+                path = textNode.getPath();
+
+            textNode.setText('Alice ');
+            textNode.setText('Alice h');
+            textNode.setText('Alice ha');
+            textNode.setText('Alice has');

 
 

+            expect(textNode.getText()).to.equal('Alice has');

 
             doc.undo();
 
             doc.undo();

+            expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '1');

 
 

-            expect(doc.root.contents()).to.have.length(1);
-            expect(doc.root.contents()[0].getTagName()).to.equal('span');
-            expect(doc.root.contents()[0].contents()[0].getText()).to.equal('Alice');
+            doc.undo();
+            expect(doc.root.contents()[0].getText()).to.equal('Alice h', '2');
+
+            doc.redo();
+            expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '3');

 
             doc.redo();
 
             doc.redo();

-            expect(doc.root.contents()).to.have.length(0);
+            expect(doc.root.contents()[0].getText()).to.equal('Alice has', '4');

 
             doc.undo();
 
             doc.undo();

-            expect(doc.root.contents()).to.have.length(1);
-            expect(doc.root.contents()[0].getTagName()).to.equal('span');
-            expect(doc.root.contents()[0].contents()[0].getText()).to.equal('Alice');
+            doc.undo();
+            textNode = doc.getNodeByPath(path);
+            textNode.setText('Cat');
+            doc.undo();
+            textNode = doc.getNodeByPath(path);
+            expect(textNode.getText()).to.equal('Alice h');
+        });
+
+        
+        var sampleMethod = function(val) {
+            this._$.attr('x', val);
+        };
+
+        var transformations = {
+            'unaware': sampleMethod,
+            'returning change root': {
+                impl: sampleMethod,
+                getChangeRoot: function() {
+                    return this.context;
+                }
+            },
+            'implementing undo operation': {
+                impl: function(t, val) {
+                    t.oldVal = this.getAttr('x');
+                    sampleMethod.call(this, val);
+                },
+                undo: function(t) {
+                    this.setAttr('x', t.oldVal);
+                }
+            }
+        };
+
+        _.pairs(transformations).forEach(function(pair) {
+            var name = pair[0],
+                transformaton = pair[1];
+
+            describe(name + ' transformation: ', function() {
+                var doc, node, nodePath;
+
+                beforeEach(function() {
+                    doc = getDocumentFromXML('<div><test x="old"></test></div>');
+
+                    doc.registerExtension({elementNode: {transformations: {
+                        test: transformaton
+                    }}});
+
+                    node = doc.root.contents()[0];
+                    nodePath = node.getPath();
+                });
+
+                it('transforms as expected', function() {
+                    node.test('new');
+                    expect(node.getAttr('x')).to.equal('new');
+                });
+
+                it('can be undone', function() {
+                    node.test('new');
+                    doc.undo();
+                    node = doc.getNodeByPath(nodePath);
+                    expect(node.getAttr('x')).to.equal('old');
+                });
+
+                it('can be undone and then redone', function() {
+                    node.test('new');
+                    doc.undo();
+                    doc.redo();
+                    node = doc.getNodeByPath(nodePath);
+                    expect(node.getAttr('x')).to.equal('new');
+                });
+
+                it('handles a sample scenario', function() {
+                    doc.root.contents()[0].test('1');
+                    doc.root.contents()[0].test('2');
+                    doc.root.contents()[0].test('3');
+                    doc.root.contents()[0].test('4');
+                    doc.root.contents()[0].test('5');
+
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'after initial transformations');
+                    doc.undo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 1.1');
+                    doc.undo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('3', 'undo 1.2');
+                    doc.redo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'redo 1.1');
+                    doc.redo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('5', 'redo 1.2');
+                    doc.undo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undo 2.1');
+                    doc.root.contents()[0].test('10');
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'additional transformation');
+                    expect(doc.redoStack.length).to.equal(0, 'transformation cleared redo stack');
+                    doc.redo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'empty redoStack so redo was noop');
+                    doc.undo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('4', 'undoing additional transformation');
+                    doc.redo();
+                    expect(doc.root.contents()[0].getAttr('x')).to.equal('10', 'redoing additional transformation');
+                });
+            });
+        });
+
+        it('smoke tests nested transformations', function() {
+            var doc = getDocumentFromXML('<div></div>');
+
+            doc.registerExtension({elementNode: {transformations: {
+                nested: function(v) {
+                    this._$.attr('innerAttr', v);
+                },
+                outer: function(v) {
+                    this.nested(v);
+                    this._$.attr('outerAttr', v);
+                }
+            }}});

 
 

+            doc.root.outer('test1');
+            doc.root.outer('test2');
+
+            expect(doc.root.getAttr('innerAttr')).to.equal('test2');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test2');
+
+            doc.undo();
+
+            expect(doc.root.getAttr('innerAttr')).to.equal('test1');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test1');
+
+            doc.undo();
+
+            expect(doc.root.getAttr('innerAttr')).to.equal(undefined);
+            expect(doc.root.getAttr('outerAttr')).to.equal(undefined);
+
+            doc.redo();
+
+            expect(doc.root.getAttr('innerAttr')).to.equal('test1');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test1');
+
+            doc.redo();
+
+            expect(doc.root.getAttr('innerAttr')).to.equal('test2');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test2');
+
+        });
+
+        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);
+                        },
+                        smart: {
+                            impl: function(t, v) {
+                                t.oldVal = this.getAttr('smart');
+                                this.setAttr('smart', v);
+                            },
+                            undo: function(t) {
+                                this.setAttr('smart', t.oldVal);
+                            }
+                        }
+                    }}
+                });
+
+                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');
+            });

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