src/wlxml/wlxml.js

   1 define([
   2     'libs/jquery',
   3     'libs/underscore',
   4     'smartxml/smartxml',
   5     'smartxml/transformations',
   6     'wlxml/extensions/metadata/metadata',
   7     'wlxml/extensions/comments/comments'
   8 ], function($, _, smartxml, transformations, metadataExtension, commentExtension) {
   9
  10 'use strict';
  11
  12 /* globals Node */
  13
  14
  15 var WLXMLDocumentNodeMethods =  {
  16     isInside: function(query) {
  17         var parent = this.getParent(query);
  18         return !!parent;
  19     },
  20     getParent: function(query) {
  21         /* globals Node */
  22         var me = this.nodeType === Node.ELEMENT_NODE ? [this] : [],
  23             toret;
  24         me.concat(this.parents()).some(function(node) {
  25             if(node.is(query)) {
  26                 toret = node;
  27             }
  28             return !!toret || (!node.sameNode(this) && node.isContextRoot());
  29         }.bind(this));
  30
  31         return toret;
  32     },
  33     isContextRoot: function() {
  34         var me = this.nodeType === Node.ELEMENT_NODE ? [this] : [],
  35             toret = false;
  36         me.concat(this.parents()).some(function(node) {
  37             if(_.isFunction(node.object.isContextRoot) && node.object.isContextRoot(this)) {
  38                 toret = true;
  39                 return true;
  40             }
  41         }.bind(this));
  42         return toret;
  43     }
  44 };
  45
  46 var getClassLists = function(klassName) {
  47     var toret = [],
  48         classParts = [''].concat(klassName.split('.')),
  49         classCurrent;
  50
  51     classParts.forEach(function(part) {
  52         classCurrent = classCurrent ? classCurrent + '.' + part : part;
  53         toret.push(classCurrent);
  54     });
  55     return toret;
  56 };
  57
  58 var installObject = function(instance, klass) {
  59     var methods = {},
  60         transformations = {};
  61
  62     getClassLists(klass).forEach(function(klassName) {
  63         _.extend(methods, instance.document.classMethods[klassName] || {});
  64         _.extend(methods, instance.document.classTransformations[klassName] || {});
  65     });
  66     instance.object = Object.create(_.extend({}, methods, transformations));
  67     _.keys(methods).concat(_.keys(transformations)).forEach(function(key) {
  68         if(_.isFunction(instance.object[key])) {
  69             instance.object[key] = _.bind(instance.object[key], instance);
  70         }
  71     });
  72 };
  73
  74 var WLXMLElementNode = function(nativeNode, document) {
  75     smartxml.ElementNode.call(this, nativeNode, document);
  76     installObject(this, this.getClass());
  77 };
  78 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
  79
  80 $.extend(WLXMLElementNode.prototype, WLXMLDocumentNodeMethods, smartxml.ElementNode.prototype, {
  81     getClass: function() {
  82         return this.getAttr('class') || '';
  83     },
  84     getClassHierarchy: function() {
  85         return getClassLists(this.getClass());
  86     },
  87     setClass: function(klass) {
  88         if(klass !== this.klass) {
  89             installObject(this, klass);
  90             return this.setAttr('class', klass);
  91         }
  92     },
  93     is: function(query) {
  94         if(typeof query === 'string') {
  95             query = {klass: query};
  96         }
  97         return (_.isUndefined(query.klass) || this.getClass().substr(0, query.klass.length) === query.klass) &&
  98                (_.isUndefined(query.tagName) || this.getTagName() === query.tagName);
  99     },
 100     hasChild: function(query) {
 101         return this.contents().some(function(child) {
 102             return child.is(query);
 103         }.bind(this));
 104     },
 105
 106     _getXMLDOMToDump: function() {
 107         var DOM = this._$.clone(true, true),
 108             doc = this.document;
 109
 110         DOM.find('*').addBack().each(function() {
 111             var el = $(this),
 112                 parent = el.parent(),
 113                 contents = parent.contents(),
 114                 idx = contents.index(el),
 115                 data = el.data();
 116
 117
 118             var txt, documentNode, metaNode;
 119
 120             if(data[formatter_prefix+ 'orig_before']) {
 121                 txt = idx > 0 && contents[idx-1].nodeType === Node.TEXT_NODE ? contents[idx-1] : null;
 122                 if(txt && txt.data === data[formatter_prefix + 'orig_before_transformed']) {
 123                     txt.data = data[formatter_prefix+ 'orig_before_original'];
 124                 } else {
 125                     el.before(data[formatter_prefix+ 'orig_before']);
 126                 }
 127             }
 128             if(data[formatter_prefix+ 'orig_after']) {
 129                 txt = idx < contents.length-1 && contents[idx+1].nodeType === Node.TEXT_NODE ? contents[idx+1] : null;
 130                 if(txt && txt.data === data[formatter_prefix + 'orig_after_transformed']) {
 131                     txt.data = data[formatter_prefix+ 'orig_after_original'];
 132                 } else {
 133                     el.after(data[formatter_prefix+ 'orig_after']);
 134                 }
 135             }
 136             if(data[formatter_prefix+ 'orig_begin']) {
 137                 el.prepend(data[formatter_prefix+ 'orig_begin']);
 138             }
 139             if(data[formatter_prefix+ 'orig_end']) {
 140                 contents = el.contents();
 141                 txt = (contents.length && contents[contents.length-1].nodeType === Node.TEXT_NODE) ? contents[contents.length-1] : null;
 142                 if(txt && txt.data === data[formatter_prefix + 'orig_end_transformed']) {
 143                     txt.data = data[formatter_prefix+ 'orig_end_original'];
 144                 } else {
 145                     el.append(data[formatter_prefix+ 'orig_end']);
 146                 }
 147             }
 148
 149
 150             if(this.nodeType === Node.ELEMENT_NODE) {
 151                 documentNode = doc.createDocumentNode(this);
 152                 metaNode = $('<metadata>');
 153                 documentNode.getMetadata().forEach(function(row) {
 154                     metaNode.append('<dc:'+ row.key + '>' + row.value + '</dc:' + row.key + '>');
 155                 });
 156                 if(metaNode.children().length) {
 157                     $(this).prepend(metaNode);
 158                 }
 159             }
 160         });
 161
 162         return DOM;
 163     }
 164 });
 165
 166
 167 var WLXMLDocumentNode = function() {
 168     smartxml.DocumentNode.apply(this, arguments);
 169 };
 170 WLXMLDocumentNode.prototype = Object.create(smartxml.DocumentNode.prototype);
 171
 172
 173 var WLXMLTextNode = function() {
 174     smartxml.TextNode.apply(this, arguments);
 175 };
 176 WLXMLTextNode.prototype = Object.create(smartxml.TextNode.prototype);
 177 $.extend(WLXMLTextNode.prototype, WLXMLDocumentNodeMethods, {
 178     is: function() { return false; }
 179 });
 180
 181 var WLXMLDocument = function(xml, options) {
 182     this.classMethods = {};
 183     this.classTransformations = {};
 184     smartxml.Document.call(this, xml, [metadataExtension, commentExtension]);
 185     this.options = options;
 186 };
 187
 188 var formatter_prefix = '_wlxml_formatter_';
 189
 190
 191 WLXMLDocument.prototype = Object.create(smartxml.Document.prototype);
 192 $.extend(WLXMLDocument.prototype, {
 193     ElementNodeFactory: WLXMLElementNode,
 194     TextNodeFactory: WLXMLTextNode,
 195     loadXML: function(xml) {
 196         smartxml.Document.prototype.loadXML.call(this, xml, {silent: true});
 197         this.trigger('contentSet');
 198     },
 199
 200     normalizeXML: function(nativeNode) {
 201         var doc = this,
 202             prefixLength = 'dc:'.length;
 203
 204         $(nativeNode).find('metadata').each(function() {
 205             var metadataNode = $(this),
 206                 owner = doc.createDocumentNode(metadataNode.parent()[0]),
 207                 metadata = owner.getMetadata();
 208
 209             metadataNode.children().each(function() {
 210                 metadata.add({key: (this.tagName).toLowerCase().substr(prefixLength), value: $(this).text()}, {undoable: false});
 211             });
 212             metadataNode.remove();
 213         });
 214         nativeNode.normalize();
 215
 216         $(nativeNode).find(':not(iframe)').addBack().contents()
 217             .filter(function() {return this.nodeType === Node.TEXT_NODE;})
 218             .each(function() {
 219                 var el = $(this),
 220                     text = {original: el.text(), trimmed: $.trim(el.text())},
 221                     elParent = el.parent(),
 222                     hasSpanParent = elParent.prop('tagName') === 'SPAN',
 223                     hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
 224                     hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN';
 225
 226
 227                 var addInfo = function(toAdd, where, transformed, original) {
 228                     var parentContents = elParent.contents(),
 229                         idx = parentContents.index(el[0]),
 230                         prev = idx > 0 ? parentContents[idx-1] : null,
 231                         next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
 232                         target, key;
 233
 234                     if(where === 'above') {
 235                         target = prev ? $(prev) : elParent;
 236                         key = prev ? 'orig_after' : 'orig_begin';
 237                     } else if(where === 'below') {
 238                         target = next ? $(next) : elParent;
 239                         key = next ? 'orig_before' : 'orig_end';
 240                     } else { throw new Error();}
 241
 242                     target.data(formatter_prefix + key, toAdd);
 243                     if(transformed !== undefined) {
 244                         target.data(formatter_prefix + key + '_transformed', transformed);
 245                     }
 246                     if(original !== undefined) {
 247                         target.data(formatter_prefix + key + '_original', original);
 248                     }
 249                 };
 250
 251                 text.transformed = text.trimmed;
 252
 253                 if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
 254                     var startSpace = /\s/g.test(text.original.substr(0,1)),
 255                         endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
 256                     text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '');
 257                     text.transformed += text.trimmed;
 258                     text.transformed += (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
 259                 } else {
 260                     if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1) {
 261                         text.transformed = ' ';
 262                     }
 263                 }
 264
 265                 if(!text.transformed) {
 266                     addInfo(text.original, 'below');
 267                     el.remove();
 268                     return true; // continue
 269                 }
 270
 271                 if(text.transformed !== text.original) {
 272                     // if(!text.trimmed) {
 273                     //     addInfo(text.original, 'below');
 274                     // } else {
 275                         var startingMatch = text.original.match(/^\s+/g),
 276                             endingMatch = text.original.match(/\s+$/g),
 277                             startingWhiteSpace = startingMatch ? startingMatch[0] : null,
 278                             endingWhiteSpace = endingMatch ? endingMatch[0] : null;
 279
 280                         if(endingWhiteSpace) {
 281                             if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ') {
 282                                 endingWhiteSpace = endingWhiteSpace.substr(1);
 283                             }
 284                             addInfo(endingWhiteSpace, 'below', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
 285                         }
 286
 287                         if(startingWhiteSpace && text.trimmed) {
 288                             if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ') {
 289                                 startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
 290                             }
 291                             addInfo(startingWhiteSpace, 'above', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
 292                         }
 293                     //}
 294                 }
 295                 /* globals document */
 296                 el.replaceWith(document.createTextNode(text.transformed));
 297             });
 298
 299
 300     },
 301
 302     registerClassTransformation: function(Transformation, className) {
 303         var thisClassTransformations = (this.classTransformations[className] = this.classTransformations[className] || {});
 304         thisClassTransformations[Transformation.prototype.name] = function() {
 305             var nodeInstance = this;
 306             var args = Array.prototype.slice.call(arguments, 0);
 307             return nodeInstance.transform(Transformation, args);
 308         };
 309     },
 310
 311     registerClassMethod: function(methodName, method, className) {
 312         var thisClassMethods = (this.classMethods[className] = this.classMethods[className] || {});
 313         thisClassMethods[methodName] = method;
 314     },
 315
 316     registerExtension: function(extension) {
 317         smartxml.Document.prototype.registerExtension.call(this, extension);
 318         var doc = this;
 319
 320         _.pairs(extension.wlxmlClass).forEach(function(pair) {
 321             var className = pair[0],
 322                 classExtension = pair[1];
 323
 324             _.pairs(classExtension.methods || {}).forEach(function(pair) {
 325                 var name = pair[0],
 326                     method = pair[1];
 327                 doc.registerClassMethod(name, method, className);
 328             });
 329
 330             _.pairs(classExtension.transformations || {}).forEach(function(pair) {
 331                 var name = pair[0],
 332                     desc = pair[1];
 333                 doc.registerClassTransformation(transformations.createContextTransformation(desc, name), className);
 334             });
 335         });
 336
 337     }
 338
 339 });
 340
 341 return {
 342     WLXMLDocumentFromXML: function(xml, options, Factory) {
 343         Factory = Factory || WLXMLDocument;
 344         return new Factory(xml, options);
 345     },
 346     WLXMLElementNodeFromXML: function(xml) {
 347         return this.WLXMLDocumentFromXML(xml).root;
 348     },
 349
 350     WLXMLDocument: WLXMLDocument,
 351     getClassHierarchy: getClassLists
 352 };
 353
 354 });