Linting, minor test description fix
[fnpeditor.git] / src / smartxml / smartxml.test.js
index 991f1af..5d2bbb7 100644 (file)
@@ -1,8 +1,9 @@
 define([
     'libs/chai',
     'libs/sinon',
+    'libs/underscore',
     './smartxml.js'
-], function(chai, sinon, smartxml) {
+], function(chai, sinon, _, smartxml) {
     
 'use strict';
 /*jshint expr:true */
@@ -735,15 +736,14 @@ describe('smartxml', function() {
                 expect(event.meta.node.sameNode(a));
             });
 
-            it('doesn\'t emit nodeDetached event for already out of document moved to out of document node: ' + insertionMethod, function() {
+            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>'),
-                    a = doc.root.contents()[0],
                     spy = sinon.spy();
 
                 doc.on('change', spy);
 
                 var newNode = doc.createDocumentNode({tagName: 'b'});
-                    var newNodeInner = newNode.append({tagName:'c'});
+                newNode.append({tagName:'c'});
 
                 expect(spy.callCount).to.equal(0);
             });
@@ -830,7 +830,7 @@ describe('smartxml', function() {
     });
 
     describe('Extension API', function() {
-        var doc, extension, elementNode, textNode, testClassNode;
+        var doc, extension, elementNode, textNode;
 
         beforeEach(function() {
             doc = getDocumentFromXML('<section>Alice<div class="test_class"></div></section>');
@@ -939,7 +939,7 @@ describe('smartxml', function() {
             expect(elementNode.textTestTransformation).to.be.undefined;
         
             expect(textNode.textTestTransformation().sameNode(textNode)).to.be.true;
-            expect(textNode.elementTestTransfomation).to.be.undefined; 
+            expect(textNode.elementTestTransfomation).to.be.undefined;
         });
 
         it('allows text/element node methods and transformations to access node and transormations on document node', function() {
@@ -998,8 +998,7 @@ describe('smartxml', function() {
 
         it('smoke tests', function() {
             var doc = getDocumentFromXML('<div>Alice</div>'),
-                textNode = doc.root.contents()[0],
-                result;
+                textNode = doc.root.contents()[0];
 
             expect(doc.undoStack).to.have.length(0);
             
@@ -1011,7 +1010,6 @@ describe('smartxml', function() {
             expect(doc.undoStack).to.have.length(0, '2');
             expect(doc.toXML()).to.equal('<div>Alice</div>');
 
-            debugger;
             doc.redo();
             expect(doc.undoStack).to.have.length(1, '3');
             expect(doc.toXML()).to.equal('<div>A<span>l</span>ice</div>');
@@ -1028,10 +1026,8 @@ describe('smartxml', function() {
         it('smoke tests 2', function() {
             var doc = getDocumentFromXML('<div>Alice</div>'),
                 textNode = doc.root.contents()[0],
-                path = textNode.getPath(),
-                result;
+                path = textNode.getPath();
 
-            debugger;
             textNode.setText('Alice ');
             textNode.setText('Alice h');
             textNode.setText('Alice ha');
@@ -1060,60 +1056,139 @@ describe('smartxml', function() {
             expect(textNode.getText()).to.equal('Alice h');
         });
 
-        // it('does work', function() {
-        //     var doc = getDocumentFromXML('<section><span>Alice</span></section>'),
-        //         span = doc.root.contents()[0];
+        
+        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');
+                });
 
-        //     span.transform('smartxml.detach');
+                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');
+                });
+            });
+        });
 
-        //     doc.undo();
+        it('smoke tests nested transformations', function() {
+            var doc = getDocumentFromXML('<div></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.registerExtension({elementNode: {transformations: {
+                nested: function(v) {
+                    this._$.attr('innerAttr', v);
+                },
+                outer: function(v) {
+                    this.nested(v);
+                    this._$.attr('outerAttr', v);
+                }
+            }}});
 
-        //     doc.redo();
-        //     expect(doc.root.contents()).to.have.length(0);
+            doc.root.outer('test1');
+            doc.root.outer('test2');
 
-        //     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');
+            expect(doc.root.getAttr('innerAttr')).to.equal('test2');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test2');
 
-        // });
-        // it('does work - merged text nodes case', function() {
-        //     var doc = getDocumentFromXML('<section>Alice <span>has</span> a cat.</section>'),
-        //         span = doc.root.contents()[1];
+            doc.undo();
 
-        //     span.transform('smartxml.detach');
+            expect(doc.root.getAttr('innerAttr')).to.equal('test1');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test1');
 
+            doc.undo();
 
-        //     doc.undo();
+            expect(doc.root.getAttr('innerAttr')).to.equal(undefined);
+            expect(doc.root.getAttr('outerAttr')).to.equal(undefined);
 
-        //     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();
 
-        // });
-        // 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];
+            expect(doc.root.getAttr('innerAttr')).to.equal('test1');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test1');
 
-        //     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');
+            doc.redo();
 
-        //     doc.redo();
-        //     doc.redo();
-        //     expect(doc.root.contents().length).to.equal(0);
+            expect(doc.root.getAttr('innerAttr')).to.equal('test2');
+            expect(doc.root.getAttr('outerAttr')).to.equal('test2');
 
-        // });
+        });
     });
 
 });