src/wlxml/wlxml.js

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