smartxml: Getting rid of nodeMoved event in favor of `move` flag on nodeDetached...

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

diff --git a/src/wlxml/wlxml.js b/src/wlxml/wlxml.js
index 98d6a10..0505116 100644 (file)
--- a/src/wlxml/wlxml.js
+++ b/src/wlxml/wlxml.js
@@ -2,18 +2,33 @@ define([
     'libs/jquery',
     'libs/underscore',
     'smartxml/smartxml',
     'libs/jquery',
     'libs/underscore',
     'smartxml/smartxml',

-    'smartxml/transformations'
-], function($, _, smartxml, transformations) {
+    '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 WLXMLDocumentNodeMethods =  {
+    isInside: function(query) {
+        var parent = this.getParent(query);
+        return !!parent;
+    },
+    getParent: function(query) {
+        /* globals Node */
+        var me = this.nodeType === Node.ELEMENT_NODE ? [this] : [],
+            toret;
+        me.concat(this.parents()).some(function(node) {
+            if(node.is(query)) {
+                toret = node;
+                return true;
+            }
+        });
+        return toret;
+    },
+};

 
 var AttributesList = function() {};
 AttributesList.prototype = Object.create({});
 
 var AttributesList = function() {};
 AttributesList.prototype = Object.create({});


@@ -21,25 +36,31 @@ AttributesList.prototype.keys = function() {
     return _.keys(this);
 };
 
     return _.keys(this);
 };
 

+var getClassLists = function(klassName) {
+    var toret = [],
+        classParts = [''].concat(klassName.split('.')),
+        classCurrent;
+
+    classParts.forEach(function(part) {
+        classCurrent = classCurrent ? classCurrent + '.' + part : part;
+        toret.push(classCurrent);
+    });
+    return toret;
+};
+

 var installObject = function(instance, klass) {
 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 methods = {},
+        transformations = {};
+
+    getClassLists(klass).forEach(function(klassName) {
+        _.extend(methods, instance.document.classMethods[klassName] || {});
+        _.extend(methods, instance.document.classTransformations[klassName] || {});
+    });
+    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);


@@ -47,19 +68,25 @@ var WLXMLElementNode = function(nativeNode, document) {
 };
 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
 
 };
 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
 

-$.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
+$.extend(WLXMLElementNode.prototype, WLXMLDocumentNodeMethods, smartxml.ElementNode.prototype, {

     getClass: function() {
         return this.getAttr('class') || '';
     },
     getClass: function() {
         return this.getAttr('class') || '';
     },

+    getClassHierarchy: function() {
+        return getClassLists(this.getClass());
+    },

     setClass: function(klass) {
     setClass: function(klass) {

-        var methods, object;

         if(klass !== this.klass) {
             installObject(this, 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;
+    is: function(query) {
+        if(typeof query === 'string') {
+            query = {klass: query};
+        }
+        return (_.isUndefined(query.klass) || this.getClass().substr(0, query.klass.length) === query.klass) &&
+               (_.isUndefined(query.tagName) || this.getTagName() === query.tagName);

     },
     getMetaAttributes: function() {
         var toret = new AttributesList(),
     },
     getMetaAttributes: function() {
         var toret = new AttributesList(),


@@ -71,27 +98,32 @@ $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
             classDesc = this.document.options.wlxmlClasses[classCurrent];
             if(classDesc) {
                 _.keys(classDesc.attrs).forEach(function(attrName) {
             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]);
+                    toret[attrName] = _.extend({value: this.getAttr(attrName)}, classDesc.attrs[attrName]);

                 }.bind(this));
             }
         }.bind(this));
         return toret;
     },
     setMetaAttribute: function(key, value) {
                 }.bind(this));
             }
         }.bind(this));
         return toret;
     },
     setMetaAttribute: function(key, value) {

-        this.setAttr('meta-'+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),


@@ -101,7 +133,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;


@@ -131,59 +163,56 @@ $.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;
-    }
-}));
+// 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);
 
 
 
 var WLXMLDocumentNode = function() {
     smartxml.DocumentNode.apply(this, arguments);

-}
+};

 WLXMLDocumentNode.prototype = Object.create(smartxml.DocumentNode.prototype);
 
 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);
-    };
+var WLXMLTextNode = function() {
+    smartxml.TextNode.apply(this, arguments);
+};
+WLXMLTextNode.prototype = Object.create(smartxml.TextNode.prototype);
+$.extend(WLXMLTextNode.prototype, WLXMLDocumentNodeMethods);

 
 

+var WLXMLDocument = function(xml, options) {

     this.classMethods = {};
     this.classTransformations = {};
     this.classMethods = {};
     this.classTransformations = {};

+    smartxml.Document.call(this, xml, [metadataExtension]);
+    this.options = options;

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


@@ -192,9 +221,29 @@ 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,

+    TextNodeFactory: WLXMLTextNode,

     loadXML: function(xml) {
         smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});
     loadXML: function(xml) {
         smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});

-        $(this.dom).find(':not(iframe)').addBack().contents()
+        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),


@@ -273,19 +322,20 @@ $.extend(WLXMLDocument.prototype, {
                         }
                     //}
                 }
                         }
                     //}
                 }

-
+                /* globals document */

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

-        this.trigger('contentSet');
-    },
+        

 
 

-    registerTransformation: function(Transformation) {
-        return this.transformations.register(Transformation);

     },
 
     registerClassTransformation: function(Transformation, className) {
     },
 
     registerClassTransformation: function(Transformation, className) {

-        var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || new transformations.TransformationStorage());
-        return thisClassTransformations.register(Transformation);
+        var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || {});
+        thisClassTransformations[Transformation.prototype.name] = function() {
+            var nodeInstance = this;
+            var args = Array.prototype.slice.call(arguments, 0);
+            return nodeInstance.transform(Transformation, args);
+        };

     },
 
     registerClassMethod: function(methodName, method, className) {
     },
 
     registerClassMethod: function(methodName, method, className) {


@@ -295,55 +345,8 @@ $.extend(WLXMLDocument.prototype, {
 
     registerExtension: function(extension) {
         //debugger;
 
     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));
-                        });
-                    });
-                }
-            }
-        });
+        smartxml.Document.prototype.registerExtension.call(this, extension);
+        var doc = this;

 
         _.pairs(extension.wlxmlClass).forEach(function(pair) {
             var className = pair[0],
 
         _.pairs(extension.wlxmlClass).forEach(function(pair) {
             var className = pair[0],


@@ -356,9 +359,10 @@ $.extend(WLXMLDocument.prototype, {
             });
 
             _.pairs(classExtension.transformations || {}).forEach(function(pair) {
             });
 
             _.pairs(classExtension.transformations || {}).forEach(function(pair) {

-                var transformation = getTrans(pair[1], pair[0]);
-                doc.registerClassTransformation(transformations.createContextTransformation(transformation), className);
-            }); 
+                var name = pair[0],
+                    desc = pair[1];
+                doc.registerClassTransformation(transformations.createContextTransformation(desc, name), className);
+            });

         });
 
     }
         });
 
     }


@@ -366,47 +370,25 @@ $.extend(WLXMLDocument.prototype, {
 });
 
 var wlxmlClasses = {
 });
 
 var wlxmlClasses = {

-    'uri': {
-        attrs: {uri: {type: 'string'}}
+    'link': {
+        attrs: {href: {type: 'string'}}

     }
 };
 
     }
 };
 

-var classMethods = {};

 
 return {
 
 return {

-    WLXMLDocumentFromXML: function(xml, options) {
+    WLXMLDocumentFromXML: function(xml, options, Factory) {

         options = _.extend({wlxmlClasses: wlxmlClasses}, options);
         options = _.extend({wlxmlClasses: wlxmlClasses}, options);

-        return new WLXMLDocument(xml, options);
+        Factory = Factory || WLXMLDocument;
+        return new Factory(xml, options);

     },
 
     WLXMLElementNodeFromXML: function(xml) {
         return this.WLXMLDocumentFromXML(xml).root;
     },
 
     },
 
     WLXMLElementNodeFromXML: function(xml) {
         return this.WLXMLDocumentFromXML(xml).root;
     },
 

-    registerExtension: function(extension) {
-        // @@ 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],
-                methods = pair[1];
-            _.pairs(methods).forEach(function(pair) {
-                var methodName = pair[0],
-                    method = pair[1];
-                classMethods[className] = classMethods[className] || {};
-                classMethods[className][methodName] = method;
-            });
-            
-        });
-
-        _.extend(WLXMLDocument.prototype, extension.documentMethods);
-
-    }
-
+    WLXMLDocument: WLXMLDocument,
+    getClassHierarchy: getClassLists

 };
 
 });
\ No newline at end of file
 };
 
 });
\ No newline at end of file