editor: first approach to supplementing comments with user and date metadata

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

diff --git a/src/wlxml/wlxml.js b/src/wlxml/wlxml.js
index 0f6fa20..fe0636d 100644 (file)
--- a/src/wlxml/wlxml.js
+++ b/src/wlxml/wlxml.js
@@ -1,50 +1,87 @@
 define([
 define([

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

     
 'use strict';
 
     
 'use strict';
 

-// utils
+/* globals Node */

 
 

-var isMetaAttribute = function(attrName) {
-    return attrName.substr(0, 5) === 'meta-';
+
+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(attrName)}, classDesc.attrs[attrName]);
+                }.bind(this));

             }
             }

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

         return toret;
     },
         return toret;
     },

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

     getOtherAttributes: function() {
     getOtherAttributes: function() {

-        var toret = {};
+        var toret = {},
+            node = this;

         this.getAttrs().forEach(function(attr) {
         this.getAttrs().forEach(function(attr) {

-            if(attr.name !== 'class' && !isMetaAttribute(attr.name)) {
-                toret[attr.name] = attr.value;
+            if(attr.name !== 'class' && !node.isMetaAttribute(attr.name)) {
+                toret[attr.name] = {value: attr.value};

             }
         });
         return toret;
     },
             }
         });
         return toret;
     },

+    isMetaAttribute: function(attrName) {
+        return attrName !== 'class' &&_.contains(_.keys(this.getMetaAttributes()), attrName);
+    },

 
     _getXMLDOMToDump: function() {
 
     _getXMLDOMToDump: function() {

-        var DOM = this._$.clone(true, true);
+        var DOM = this._$.clone(true, true),
+            doc = this.document;

 
         DOM.find('*').addBack().each(function() {
             var el = $(this),
 
         DOM.find('*').addBack().each(function() {
             var el = $(this),


@@ -54,7 +91,7 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
                 data = el.data();
 
 
                 data = el.data();
 
 

-            var txt;
+            var txt, documentNode, metaNode;

 
             if(data[formatter_prefix+ 'orig_before']) {
                 txt = idx > 0 && contents[idx-1].nodeType === Node.TEXT_NODE ? contents[idx-1] : null;
 
             if(data[formatter_prefix+ 'orig_before']) {
                 txt = idx > 0 && contents[idx-1].nodeType === Node.TEXT_NODE ? contents[idx-1] : null;


@@ -84,29 +121,79 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
                     el.append(data[formatter_prefix+ 'orig_end']);
                 }
             }
                     el.append(data[formatter_prefix+ 'orig_end']);
                 }
             }

+
+
+            if(this.nodeType === Node.ELEMENT_NODE) {
+                documentNode = doc.createDocumentNode(this);
+                metaNode = $('<metadata>');
+                documentNode.getMetadata().forEach(function(row) {
+                    metaNode.append('<dc:'+ row.key + '>' + row.value + '</dc:' + row.key + '>');
+                });
+                if(metaNode.children().length) {
+                    $(this).prepend(metaNode);
+                }
+            }
+

         });
 
         });
 

+        
+

         return DOM;
     }
 });
 
         return DOM;
     }
 });
 

+// 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) {
-    smartxml.Document.call(this, xml);
+var WLXMLDocument = function(xml, options) {
+    this.classMethods = {};
+    this.classTransformations = {};
+    smartxml.Document.call(this, xml, [metadataExtension]);
+    this.options = options;

 };
 
 var formatter_prefix = '_wlxml_formatter_';
 
 };
 
 var formatter_prefix = '_wlxml_formatter_';
 

+

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

-

     loadXML: function(xml) {
     loadXML: function(xml) {

-        smartxml.Document.prototype.loadXML.call(this, xml);
-        $(this.dom).find(':not(iframe)').addBack().contents()
+        smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});
+        this.trigger('contentSet');
+    },
+
+    normalizeXML: function(nativeNode) {
+        var doc = this,
+            prefixLength = 'dc:'.length;
+
+        $(nativeNode).find('metadata').each(function() {
+            var metadataNode = $(this),
+                owner = doc.createDocumentNode(metadataNode.parent()[0]),
+                metadata = owner.getMetadata();
+                
+            metadataNode.children().each(function() {
+                metadata.add({key: (this.tagName).toLowerCase().substr(prefixLength), value: $(this).text()}, {undoable: false});
+            });
+            metadataNode.remove();
+        });
+        nativeNode.normalize();
+
+        $(nativeNode).find(':not(iframe)').addBack().contents()

             .filter(function() {return this.nodeType === Node.TEXT_NODE;})
             .each(function() {
                 var el = $(this),
             .filter(function() {return this.nodeType === Node.TEXT_NODE;})
             .each(function() {
                 var el = $(this),


@@ -185,18 +272,63 @@ $.extend(WLXMLDocument.prototype, {
                         }
                     //}
                 }
                         }
                     //}
                 }

-
+                /* globals document */

                 el.replaceWith(document.createTextNode(text.transformed));
             });
                 el.replaceWith(document.createTextNode(text.transformed));
             });

-        this.trigger('contentSet');
+        
+
+    },
+
+    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);
+        };
+    },
+
+    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);
+            });
+        });
+

     }
 
 });
 
     }
 
 });
 

+var wlxmlClasses = {
+    'link': {
+        attrs: {href: {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) {