Linting, cleanup, removing unused code

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

diff --git a/src/smartxml/smartxml.test.js b/src/smartxml/smartxml.test.js
index 8041013..bb82467 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 */


@@ -769,7 +770,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;

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


@@ -836,18 +839,15 @@ describe('smartxml', function() {
             textNode = doc.root.contents()[0];
             extension = {};
             
             textNode = doc.root.contents()[0];
             extension = {};
             

-            expect(function() {
-                elementNode.testTransformation();
-            }).to.throw(Error);
-            expect(function() {
-                textNode.testTransformation();
-            }).to.throw(Error);
-            expect(function() {
-                doc.testTransformation();
-            }).to.throw(Error);
+            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(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() {
         });
 
         it('allows adding method to a document', function() {


@@ -871,9 +871,23 @@ describe('smartxml', function() {
         });
 
         it('allows adding method to a DocumentNode instance', function() {
         });
 
         it('allows adding method to a DocumentNode instance', function() {

-            extension = {documentNode: {methods: {
-                testMethod: function() { return this; }    
-            }}};
+            extension = {
+                documentNode: {
+                    methods: {
+                        testMethod: function() { return this; }
+                    }
+                },
+                textNode: {
+                    methods: {
+                        textTestMethod: function() { return this; }
+                    }
+                },
+                elementNode: {
+                    methods: {
+                        elementTestMethod: function() { return this; }
+                    }
+                }
+            };

 
             doc.registerExtension(extension);
 
 
             doc.registerExtension(extension);
 


@@ -883,13 +897,33 @@ describe('smartxml', function() {
 
             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.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() {
         });
 
         it('allows adding transformation to a DocumentNode', function() {

-            extension = {documentNode: {transformations: {
-                testTransformation: function() { return this; },
-                testTransformation2: {impl: function() { return this;}}
-            }}};
+            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);
 
             
             doc.registerExtension(extension);
 


@@ -901,66 +935,262 @@ describe('smartxml', function() {
             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.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('smoke tests', function() {
+            var doc = getDocumentFromXML('<div>Alice</div>'),
+                textNode = doc.root.contents()[0];

 
 

-    //     it('does work', function() {
-    //         var doc = getDocumentFromXML('<section><span>Alice</span></section>'),
-    //             span = 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>');

 
 

-    //         span.transform('smartxml.detach');
+            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();
+            doc.undo();
+            expect(doc.undoStack).to.have.length(0, '4');
+            expect(doc.toXML()).to.equal('<div>Alice</div>');

 
 

-    //         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.undoStack).to.have.length(0, '5');
+            expect(doc.toXML()).to.equal('<div>Alice</div>');
+        });

 
 

-    //         doc.redo();
-    //         expect(doc.root.contents()).to.have.length(0);
+        it('smoke tests 2', function() {
+            var doc = getDocumentFromXML('<div>Alice</div>'),
+                textNode = doc.root.contents()[0],
+                path = textNode.getPath();

 
 

-    //         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');
+            textNode.setText('Alice ');
+            textNode.setText('Alice h');
+            textNode.setText('Alice ha');
+            textNode.setText('Alice has');

 
 

-    //     });
-    //     it('does work - merged text nodes case', function() {
-    //         var doc = getDocumentFromXML('<section>Alice <span>has</span> a cat.</section>'),
-    //             span = doc.root.contents()[1];
+            expect(textNode.getText()).to.equal('Alice has');

 
 

-    //         span.transform('smartxml.detach');
+            doc.undo();
+            expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '1');

 
 

+            doc.undo();
+            expect(doc.root.contents()[0].getText()).to.equal('Alice h', '2');

 
 

-    //         doc.undo();
+            doc.redo();
+            expect(doc.root.contents()[0].getText()).to.equal('Alice ha', '3');

 
 

-    //         expect(doc.root.contents().length).to.equal(3);
-    //         //console.log(doc.toXML());
-    //         expect(doc.root.contents()[1].contents()[0].getText()).to.equal('has');
+            doc.redo();
+            expect(doc.root.contents()[0].getText()).to.equal('Alice has', '4');

 
 

-    //     });
-    //     it('dbg - don not store nodes in tranformation state!', function() {
-    //         var doc = getDocumentFromXML('<section><a></a><b></b></section>'),
-    //             a = doc.root.contents()[0],
-    //             b = doc.root.contents()[1];
+            doc.undo();
+            doc.undo();
+            textNode = doc.getNodeByPath(path);
+            textNode.setText('Cat');
+            doc.undo();
+            textNode = doc.getNodeByPath(path);
+            expect(textNode.getText()).to.equal('Alice h');
+        });

 
 

-    //         a.transform('smartxml.detach');
-    //         b.transform('smartxml.detach');
-    //         doc.undo();
-    //         doc.undo();
-    //         expect(doc.root.contents().length).to.equal(2);
-    //         expect(doc.root.contents()[0].getTagName()).to.equal('a');
-    //         expect(doc.root.contents()[1].getTagName()).to.equal('b');
+        
+        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();
+                });

 
 

-    //         doc.redo();
-    //         doc.redo();
-    //         expect(doc.root.contents().length).to.equal(0);
+                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');
+
+        });
+    });

 
 });
 
 
 });