fnp / fnpeditor.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
list fixes: headers, invalid elements, easier ending
[fnpeditor.git] / src / wlxml / wlxml.js
diff --git a/src/wlxml/wlxml.js b/src/wlxml/wlxml.js
index 7c5207a..d05eb64 100644 (file)
--- a/src/wlxml/wlxml.js
+++ b/src/wlxml/wlxml.js
@@ -2,44 +2,91 @@ define([
     'libs/jquery',
     'libs/underscore',
     'smartxml/smartxml',
     'libs/jquery',
     'libs/underscore',
     'smartxml/smartxml',
-    'smartxml/transformations'
-], function($, _, smartxml, transformations) {
+    'smartxml/transformations',
+    'wlxml/extensions/metadata/metadata',
+    'wlxml/extensions/comments/comments',
+    'wlxml/extensions/edumed/edumed'
+], function($, _, smartxml, transformations, metadataExtension, commentExtension, edumedExtension) {
     
 '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 !!toret || (!node.sameNode(this) && node.isContextRoot());
+        }.bind(this));
+
+        return toret;
+    },
+    isContextRoot: function() {
+        var me = this.nodeType === Node.ELEMENT_NODE ? [this] : [],
+            toret = false;
+        if(!this.parent()) {
+            return true;
+        }
+        me.concat(this.parents()).some(function(node) {
+            if(_.isFunction(node.object.isContextRoot) && node.object.isContextRoot(this)) {
+                toret = true;
+                return true;
+            }
+        }.bind(this));
+        return toret;
+    },
+    getContextRoot: function() {
+        var contextRoot;
+        [this].concat(this.parents()).some(function(n) {
+            if(n.isContextRoot()) {
+                contextRoot = n;
+                return true;
+            }
+        });
+        return contextRoot;
+    },
+    hasSameContextRoot: function(other) {
+        return this.getContextRoot().sameNode(other.getContextRoot());
+    }
 };
 
 };
 
-//
+var getClassLists = function(klassName) {
+    var toret = [],
+        classParts = [''].concat(klassName.split('.')),
+        classCurrent;
 
 
-var AttributesList = function() {};
-AttributesList.prototype = Object.create({});
-AttributesList.prototype.keys = function() {
-    return _.keys(this);
+    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) {
+    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) {
+        if(_.isFunction(instance.object[key])) {
             instance.object[key] = _.bind(instance.object[key], instance);
             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,51 +94,45 @@ 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(),
-            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));
-            }
+    hasChild: function(query) {
+        return this.contents().some(function(child) {
+            return child.is(query);
         }.bind(this));
         }.bind(this));
-        return toret;
-    },
-    setMetaAttribute: function(key, value) {
-        this.setAttr('meta-'+key, value);
     },
     },
-    getOtherAttributes: function() {
-        var toret = {};
-        this.getAttrs().forEach(function(attr) {
-            if(attr.name !== 'class' && !isMetaAttribute(attr.name)) {
-                toret[attr.name] = attr.value;
-            }
-        });
-        return toret;
+    find: function(query) {
+        var doc = this.document;
+        return this._$.find('*')
+            .map(function() {
+                return doc.createDocumentNode(this);
+            })
+            .filter(function() {
+                return this.is(query);
+            });
     },
 
     _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 +142,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,35 +172,43 @@ $.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);
 
 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;
+var WLXMLTextNode = function() {
+    smartxml.TextNode.apply(this, arguments);
+};
+WLXMLTextNode.prototype = Object.create(smartxml.TextNode.prototype);
+$.extend(WLXMLTextNode.prototype, WLXMLDocumentNodeMethods, {
+    is: function() { return false; }
+});
 
 
+var WLXMLDocument = function(xml, options) {
     this.classMethods = {};
     this.classTransformations = {};
     this.classMethods = {};
     this.classTransformations = {};
+    smartxml.Document.call(this, xml, [metadataExtension, commentExtension, edumedExtension]);
+    this.options = options;
 };
 
 var formatter_prefix = '_wlxml_formatter_';
 };
 
 var formatter_prefix = '_wlxml_formatter_';
@@ -168,9 +217,35 @@ 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('*').each(function() {
+            if (this.childNodes.length === 0) {
+                var fakeTextNode = window.document.createTextNode("");
+                this.appendChild(fakeTextNode);
+            }
+        });
+
+        $(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),
@@ -178,7 +253,8 @@ $.extend(WLXMLDocument.prototype, {
                     elParent = el.parent(),
                     hasSpanParent = elParent.prop('tagName') === 'SPAN',
                     hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
                     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';
+                    hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN',
+                    onlyChild = el.is(':only-child');
 
 
                 var addInfo = function(toAdd, where, transformed, original) {
 
 
                 var addInfo = function(toAdd, where, transformed, original) {
@@ -219,7 +295,7 @@ $.extend(WLXMLDocument.prototype, {
                     }
                 }
 
                     }
                 }
 
-                if(!text.transformed) {
+                if(!text.transformed  && !onlyChild) {
                     addInfo(text.original, 'below');
                     el.remove();
                     return true; // continue
                     addInfo(text.original, 'below');
                     el.remove();
                     return true; // continue
@@ -249,15 +325,20 @@ $.extend(WLXMLDocument.prototype, {
                         }
                     //}
                 }
                         }
                     //}
                 }
-
+                /* globals document */
                 el.replaceWith(document.createTextNode(text.transformed));
             });
                 el.replaceWith(document.createTextNode(text.transformed));
             });
-        this.trigger('contentSet');
+        
+
     },
 
     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) {
@@ -266,67 +347,8 @@ $.extend(WLXMLDocument.prototype, {
     },
 
     registerExtension: function(extension) {
     },
 
     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));
-                            }
-
-                            
-                        });
-                    });
-                }
-            }
-        });
+        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],
@@ -339,31 +361,27 @@ $.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);
+            });
         });
 
     }
 
 });
 
         });
 
     }
 
 });
 
-var wlxmlClasses = {
-    'uri': {
-        attrs: {uri: {type: 'string'}}
-    }
-};
-
-
 return {
 return {
-    WLXMLDocumentFromXML: function(xml, options) {
-        options = _.extend({wlxmlClasses: wlxmlClasses}, options);
-        return new WLXMLDocument(xml, options);
+    WLXMLDocumentFromXML: function(xml, options, Factory) {
+        Factory = Factory || WLXMLDocument;
+        return new Factory(xml, options);
     },
     },
-
     WLXMLElementNodeFromXML: function(xml) {
         return this.WLXMLDocumentFromXML(xml).root;
     WLXMLElementNodeFromXML: function(xml) {
         return this.WLXMLDocumentFromXML(xml).root;
-    }
+    },
+
+    WLXMLDocument: WLXMLDocument,
+    getClassHierarchy: getClassLists
 };
 
 });
\ No newline at end of file
 };
 
 });
\ No newline at end of file