Refactoring extension registration - abstracting away registration on objects

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

diff --git a/src/wlxml/wlxml.js b/src/wlxml/wlxml.js
index d2dbd30..98d6a10 100644 (file)
--- a/src/wlxml/wlxml.js
+++ b/src/wlxml/wlxml.js
@@ -22,9 +22,19 @@ AttributesList.prototype.keys = function() {
 };
 
 var installObject = function(instance, klass) {
-    var methods = classMethods[klass];
+    var methods = instance.document.classMethods[klass] || instance.document.classTransformations;
     if(methods) {
-        instance.object = Object.create(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);
         });
@@ -139,17 +149,49 @@ WLXMLElementNode.prototype.transformations.register(transformations.createContex
 
 
 
+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.DocumentNodeFactory = function() {
+    //     WLXMLDocumentNode.apply(this, arguments);
+    // };
+
+    // this.DocumentNodeFactory.prototype = Object.create(WLXMLDocumentNode.prototype);    
+    
+    this.ElementNodeFactory = function() {
+        WLXMLElementNode.apply(this, arguments);
+    }
+    this.ElementNodeFactory.prototype = Object.create(WLXMLElementNode.prototype);
+    this.ElementNodeFactory.prototype.transformations = new transformations.TransformationStorage();
+    this.ElementNodeFactory.prototype.registerTransformation = function(Transformation) {
+        return this.transformations.register(Transformation);
+    };
+
+    this.TextNodeFactory = function() {
+        smartxml.TextNode.apply(this, arguments);
+    }
+    this.TextNodeFactory.prototype = Object.create(smartxml.TextNode.prototype);
+    this.TextNodeFactory.prototype.transformations = new transformations.TransformationStorage();
+    this.TextNodeFactory.prototype.registerTransformation = function(Transformation) {
+        return this.transformations.register(Transformation);
+    };
+
+    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()
@@ -235,6 +277,90 @@ $.extend(WLXMLDocument.prototype, {
                 el.replaceWith(document.createTextNode(text.transformed));
             });
         this.trigger('contentSet');
+    },
+
+    registerTransformation: function(Transformation) {
+        return this.transformations.register(Transformation);
+    },
+
+    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) {
+                            target[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) {
+                            target.registerTransformation(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);
+            }); 
+        });
+
     }
 
 });
@@ -258,9 +384,12 @@ return {
     },
 
     registerExtension: function(extension) {
-        extension.documentTransformations.forEach(function(method) {
-            WLXMLDocument.prototype.transformations.register(transformations.createContextTransformation(method));
-        });
+        // @@ depracated
+        if(extension.documentTransformations) {
+            extension.documentTransformations.forEach(function(method) {
+                WLXMLDocument.prototype.transformations.register(transformations.createContextTransformation(method));
+            });
+        }
 
         _.pairs(extension.classMethods).forEach(function(pair) {
             var className = pair[0],
@@ -274,6 +403,8 @@ return {
             
         });
 
+        _.extend(WLXMLDocument.prototype, extension.documentMethods);
+
     }
 
 };