wip: refactoring method/transformation registration out of wlxml.js to smartxml ...

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

diff --git a/src/wlxml/wlxml.js b/src/wlxml/wlxml.js
index 63d2307..7c5207a 100644 (file)
--- a/src/wlxml/wlxml.js
+++ b/src/wlxml/wlxml.js
@@ -1,8 +1,9 @@
 define([
     'libs/jquery',
     'libs/underscore',
-    'smartxml/smartxml'
-], function($, _, smartxml) {
+    'smartxml/smartxml',
+    'smartxml/transformations'
+], function($, _, smartxml, transformations) {
     
 'use strict';
 
@@ -20,9 +21,29 @@ AttributesList.prototype.keys = function() {
     return _.keys(this);
 };
 
+var installObject = function(instance, klass) {
+    var methods = instance.document.classMethods[klass] || instance.document.classTransformations;
+    if(methods) {
+        instance.object = Object.create(_.extend({
+            transform: function(name, args) {
+                // TODO: refactor with DocumentElement.transform
+                var Transformation = instance.document.classTransformations[klass].get(name),
+                    transformation;
+                if(Transformation) {
+                    transformation = new Transformation(instance.document, instance, args);
+                }
+                return instance.document.transform(transformation);
+            }
+        }, methods));
+        _.keys(methods).forEach(function(key) {
+            instance.object[key] = _.bind(instance.object[key], instance);
+        });
+    }
+}
 
 var WLXMLElementNode = function(nativeNode, document) {
     smartxml.ElementNode.call(this, nativeNode, document);
+    installObject(this, this.getClass());
 };
 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
 
@@ -31,7 +52,14 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
         return this.getAttr('class') || '';
     },
     setClass: function(klass) {
-        return this.setAttr('class', klass);
+        var methods, object;
+        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() {
         var toret = new AttributesList(),
@@ -109,21 +137,37 @@ $.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, options) {
     smartxml.Document.call(this, xml);
     this.options = options;
+
+    this.classMethods = {};
+    this.classTransformations = {};
 };
 
 var formatter_prefix = '_wlxml_formatter_';
 
+
 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()
@@ -209,6 +253,97 @@ $.extend(WLXMLDocument.prototype, {
                 el.replaceWith(document.createTextNode(text.transformed));
             });
         this.trigger('contentSet');
+    },
+
+    registerClassTransformation: function(Transformation, className) {
+        var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || new transformations.TransformationStorage());
+        return thisClassTransformations.register(Transformation);
+    },
+
+    registerClassMethod: function(methodName, method, className) {
+        var thisClassMethods = (this.classMethods[className] = this.classMethods[className] || {});
+        thisClassMethods[methodName] = method;
+    },
+
+    registerExtension: function(extension) {
+        //debugger;
+        var doc = this,
+            existingPropertyNames = _.values(this);
+
+        var getTrans = function(desc, methodName) {
+            if(typeof desc === 'function') {
+                desc = {impl: desc};
+            }
+            if(!desc.impl) {
+                throw new Error('Got transformation description without implementation.')
+            }
+            desc.name = desc.name || methodName;
+            return desc;
+        };
+
+        [
+            {source: extension.document, target: doc},
+            {source: extension.documentNode, target: [doc.ElementNodeFactory.prototype, doc.TextNodeFactory.prototype]},
+
+        ].forEach(function(mapping) {
+            if(mapping.source) {
+                if(mapping.source.methods) {
+                    existingPropertyNames = _.values(mapping.target)
+                    _.pairs(mapping.source.methods).forEach(function(pair) {
+                        var methodName = pair[0],
+                            method = pair[1],
+                            targets = _.isArray(mapping.target) ? mapping.target : [mapping.target];
+                        if(_.contains(existingPropertyNames, methodName)) {
+                            throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
+                                .replace('{target}', mapping.target)
+                                .replace('{methodName}', methodName)
+                            );
+                        }
+                        targets.forEach(function(target) {
+                            if(target === doc) {
+                                target.registerMethod(methodName, method);
+                            } else {
+                                doc.registerNodeMethod(methodName, method);
+                            }
+
+                        });
+                    });
+                }
+
+                if(mapping.source.transformations) {
+                    _.pairs(mapping.source.transformations).forEach(function(pair) {
+                        var transformation = getTrans(pair[1], pair[0]),
+                            targets = _.isArray(mapping.target) ? mapping.target : [mapping.target];
+                        targets.forEach(function(target) {
+                            if(target === doc) {
+                                target.registerTransformation(transformations.createContextTransformation(transformation));    
+                            } else {
+                                doc.registerNodeTransformation(transformations.createContextTransformation(transformation));
+                            }
+
+                            
+                        });
+                    });
+                }
+            }
+        });
+
+        _.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 transformation = getTrans(pair[1], pair[0]);
+                doc.registerClassTransformation(transformations.createContextTransformation(transformation), className);
+            }); 
+        });
+
     }
 
 });
@@ -219,6 +354,7 @@ var wlxmlClasses = {
     }
 };
 
+
 return {
     WLXMLDocumentFromXML: function(xml, options) {
         options = _.extend({wlxmlClasses: wlxmlClasses}, options);