smartxml: throw exception on transformation returning invalid change root

[fnpeditor.git] / src / wlxml / wlxml.js

diff --git a/src/wlxml/wlxml.js b/src/wlxml/wlxml.js
index 51655d4..b3783af 100644 (file)
--- a/src/wlxml/wlxml.js
+++ b/src/wlxml/wlxml.js
@@ -1,9 +1,14 @@
 define([
 define([

-    'smartxml/smartxml'
-], function(smartxml) {
+    'libs/jquery',
+    'libs/underscore',
+    'smartxml/smartxml',
+    'smartxml/transformations'
+], function($, _, smartxml, transformations) {

     
 'use strict';
 
     
 'use strict';
 

+/* globals Node */
+

 // utils
 
 var isMetaAttribute = function(attrName) {
 // utils
 
 var isMetaAttribute = function(attrName) {


@@ -12,27 +17,60 @@ var isMetaAttribute = function(attrName) {
 
 //
 
 
 //
 

+var AttributesList = function() {};
+AttributesList.prototype = Object.create({});
+AttributesList.prototype.keys = function() {
+    return _.keys(this);
+};
+
+var installObject = function(instance, klass) {
+    var methods = instance.document.classMethods[klass] || {},
+        transformations = instance.document.classTransformations[klass] || {};
+
+    instance.object = Object.create(_.extend({}, methods, transformations));
+    _.keys(methods).concat(_.keys(transformations)).forEach(function(key) {
+        instance.object[key] = _.bind(instance.object[key], instance);
+    });
+};
+

 var WLXMLElementNode = function(nativeNode, document) {
     smartxml.ElementNode.call(this, nativeNode, document);
 var WLXMLElementNode = function(nativeNode, document) {
     smartxml.ElementNode.call(this, nativeNode, document);

+    installObject(this, this.getClass());

 };
 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
 
 $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
     getClass: function() {
 };
 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
 
 $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
     getClass: function() {

-        return this.getAttr('class');
+        return this.getAttr('class') || '';

     },
     setClass: function(klass) {
     },
     setClass: function(klass) {

-        return this.setAttr('class', klass);
+        if(klass !== this.klass) {
+            installObject(this, klass);
+            return this.setAttr('class', klass);
+        }
+    },
+    is: function(klass) {
+        return this.getClass().substr(0, klass.length) === klass;

     },
     getMetaAttributes: function() {
     },
     getMetaAttributes: function() {

-        var toret = [];
-        this.getAttrs().forEach(function(attr) {
-            if(isMetaAttribute(attr.name)) {
-                toret.push({name: attr.name.substr(5), value: attr.value});
+        var toret = new AttributesList(),
+            classParts = [''].concat(this.getClass().split('.')),
+            classCurrent, classDesc;
+
+        classParts.forEach(function(part) {
+            classCurrent = classCurrent ? classCurrent + '.' + part : part;
+            classDesc = this.document.options.wlxmlClasses[classCurrent];
+            if(classDesc) {
+                _.keys(classDesc.attrs).forEach(function(attrName) {
+                    toret[attrName] = _.extend({value: this.getAttr('meta-' + attrName)}, classDesc.attrs[attrName]);
+                }.bind(this));

             }
             }

-        });
+        }.bind(this));

         return toret;
     },
         return toret;
     },

+    setMetaAttribute: function(key, value) {
+        this.setAttr('meta-'+key, value);
+    },

     getOtherAttributes: function() {
         var toret = {};
         this.getAttrs().forEach(function(attr) {
     getOtherAttributes: function() {
         var toret = {};
         this.getAttrs().forEach(function(attr) {


@@ -90,106 +128,174 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
     }
 });
 
     }
 });
 

+// WLXMLElementNode.prototype.transformations.register(transformations.createContextTransformation({
+//     name: 'wlxml.setMetaAttribute',
+//     impl: function(args) {
+//         this.setMetaAttribute(args.name, args.value);
+//     },
+//     getChangeRoot: function() {
+//         return this.context;
+//     }
+// }));

 
 
 
 
 
 

+var WLXMLDocumentNode = function() {
+    smartxml.DocumentNode.apply(this, arguments);
+};
+WLXMLDocumentNode.prototype = Object.create(smartxml.DocumentNode.prototype);

 
 

-var WLXMLDocument = function(xml) {
+var WLXMLDocument = function(xml, options) {

     smartxml.Document.call(this, xml);
     smartxml.Document.call(this, xml);

+    this.options = options;

 
 

-    $(this.dom).find(':not(iframe)').addBack().contents()
-    .filter(function() {return this.nodeType === Node.TEXT_NODE;})
-    .each(function() {
-        var el = $(this),
-            text = {original: el.text(), trimmed: $.trim(el.text())},
-            elParent = el.parent(),
-            hasSpanParent = elParent.prop('tagName') === 'SPAN',
-            hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
-            hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN';
-
-
-        var addInfo = function(toAdd, where, transformed, original) {
-            var parentContents = elParent.contents(),
-                idx = parentContents.index(el[0]),
-                prev = idx > 0 ? parentContents[idx-1] : null,
-                next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
-                target, key;
-
-            if(where === 'above') {
-                target = prev ? $(prev) : elParent;
-                key = prev ? 'orig_after' : 'orig_begin';
-            } else if(where === 'below') {
-                target = next ? $(next) : elParent;
-                key = next ? 'orig_before' : 'orig_end';
-            } else { throw new Object;}
-
-            target.data(formatter_prefix + key, toAdd);
-            if(transformed !== undefined) {
-                target.data(formatter_prefix + key + '_transformed', transformed);
-            }
-            if(original !== undefined) {
-                target.data(formatter_prefix + key + '_original', original);   
-            }
-        }
+    this.classMethods = {};
+    this.classTransformations = {};
+};

 
 

-        text.transformed = text.trimmed;
-
-        if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
-            var startSpace = /\s/g.test(text.original.substr(0,1)),
-                endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
-            text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '');
-            text.transformed += text.trimmed;
-            text.transformed += (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
-        } else {
-            if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1) {
-                text.transformed = ' ';
-            }
-        }
+var formatter_prefix = '_wlxml_formatter_';

 
 

-        if(!text.transformed) {
-            addInfo(text.original, 'below');
-            el.remove();
-            return true; // continue
-        }

 
 

-        if(text.transformed !== text.original) {
-            // if(!text.trimmed) {
-            //     addInfo(text.original, 'below');
-            // } else {
-                var startingMatch = text.original.match(/^\s+/g),
-                    endingMatch = text.original.match(/\s+$/g),
-                    startingWhiteSpace = startingMatch ? startingMatch[0] : null,
-                    endingWhiteSpace = endingMatch ? endingMatch[0] : null;
-
-                if(endingWhiteSpace) {
-                    if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ')
-                        endingWhiteSpace = endingWhiteSpace.substr(1);
-                    addInfo(endingWhiteSpace, 'below', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
+WLXMLDocument.prototype = Object.create(smartxml.Document.prototype);
+$.extend(WLXMLDocument.prototype, {
+    ElementNodeFactory: WLXMLElementNode,
+    loadXML: function(xml) {
+        smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});
+        $(this.dom).find(':not(iframe)').addBack().contents()
+            .filter(function() {return this.nodeType === Node.TEXT_NODE;})
+            .each(function() {
+                var el = $(this),
+                    text = {original: el.text(), trimmed: $.trim(el.text())},
+                    elParent = el.parent(),
+                    hasSpanParent = elParent.prop('tagName') === 'SPAN',
+                    hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
+                    hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN';
+
+
+                var addInfo = function(toAdd, where, transformed, original) {
+                    var parentContents = elParent.contents(),
+                        idx = parentContents.index(el[0]),
+                        prev = idx > 0 ? parentContents[idx-1] : null,
+                        next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
+                        target, key;
+
+                    if(where === 'above') {
+                        target = prev ? $(prev) : elParent;
+                        key = prev ? 'orig_after' : 'orig_begin';
+                    } else if(where === 'below') {
+                        target = next ? $(next) : elParent;
+                        key = next ? 'orig_before' : 'orig_end';
+                    } else { throw new Error();}
+
+                    target.data(formatter_prefix + key, toAdd);
+                    if(transformed !== undefined) {
+                        target.data(formatter_prefix + key + '_transformed', transformed);
+                    }
+                    if(original !== undefined) {
+                        target.data(formatter_prefix + key + '_original', original);
+                    }
+                };
+
+                text.transformed = text.trimmed;
+
+                if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
+                    var startSpace = /\s/g.test(text.original.substr(0,1)),
+                        endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
+                    text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '');
+                    text.transformed += text.trimmed;
+                    text.transformed += (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
+                } else {
+                    if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1) {
+                        text.transformed = ' ';
+                    }
+                }
+
+                if(!text.transformed) {
+                    addInfo(text.original, 'below');
+                    el.remove();
+                    return true; // continue

                 }
 
                 }
 

-                if(startingWhiteSpace && text.trimmed) {
-                    if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ')
-                        startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
-                    addInfo(startingWhiteSpace, 'above', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
+                if(text.transformed !== text.original) {
+                    // if(!text.trimmed) {
+                    //     addInfo(text.original, 'below');
+                    // } else {
+                        var startingMatch = text.original.match(/^\s+/g),
+                            endingMatch = text.original.match(/\s+$/g),
+                            startingWhiteSpace = startingMatch ? startingMatch[0] : null,
+                            endingWhiteSpace = endingMatch ? endingMatch[0] : null;
+
+                        if(endingWhiteSpace) {
+                            if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ') {
+                                endingWhiteSpace = endingWhiteSpace.substr(1);
+                            }
+                            addInfo(endingWhiteSpace, 'below', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
+                        }
+
+                        if(startingWhiteSpace && text.trimmed) {
+                            if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ') {
+                                startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
+                            }
+                            addInfo(startingWhiteSpace, 'above', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
+                        }
+                    //}

                 }
                 }

-            //}
-        }
+                /* globals document */
+                el.replaceWith(document.createTextNode(text.transformed));
+            });
+        this.trigger('contentSet');
+    },

 
 

-        el.replaceWith(document.createTextNode(text.transformed));
-    });
-};
+    registerClassTransformation: function(Transformation, className) {
+        var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || {});
+        thisClassTransformations[Transformation.prototype.name] = function(args) {
+            var nodeInstance = this;
+            return nodeInstance.transform(Transformation, args);
+        };
+    },

 
 

-var formatter_prefix = '_wlxml_formatter_';
+    registerClassMethod: function(methodName, method, className) {
+        var thisClassMethods = (this.classMethods[className] = this.classMethods[className] || {});
+        thisClassMethods[methodName] = method;
+    },
+
+    registerExtension: function(extension) {
+        //debugger;
+        smartxml.Document.prototype.registerExtension.call(this, extension);
+        var doc = this;
+
+        _.pairs(extension.wlxmlClass).forEach(function(pair) {
+            var className = pair[0],
+                classExtension = pair[1];
+
+            _.pairs(classExtension.methods || {}).forEach(function(pair) {
+                var name = pair[0],
+                    method = pair[1];
+                doc.registerClassMethod(name, method, className);
+            });
+
+            _.pairs(classExtension.transformations || {}).forEach(function(pair) {
+                var name = pair[0],
+                    desc = pair[1];
+                doc.registerClassTransformation(transformations.createContextTransformation(desc, name), className);
+            });
+        });
+
+    }

 
 

-WLXMLDocument.prototype = Object.create(smartxml.Document.prototype);
-$.extend(WLXMLDocument.prototype, {
-    ElementNodeFactory: WLXMLElementNode,

 });
 
 });
 

+var wlxmlClasses = {
+    'uri': {
+        attrs: {uri: {type: 'string'}}
+    }
+};
+

 
 return {
 
 return {

-    WLXMLDocumentFromXML: function(xml) {
-        return new WLXMLDocument(xml);
+    WLXMLDocumentFromXML: function(xml, options) {
+        options = _.extend({wlxmlClasses: wlxmlClasses}, options);
+        return new WLXMLDocument(xml, options);

     },
 
     WLXMLElementNodeFromXML: function(xml) {
     },
 
     WLXMLElementNodeFromXML: function(xml) {