src/smartxml/smartxml.js

   1 define([
   2     'libs/jquery',
   3     'libs/underscore',
   4     'libs/backbone',
   5     'smartxml/events',
   6     'smartxml/transformations',
   7     'smartxml/core'
   8 ], function($, _, Backbone, events, transformations, coreTransformations) {
   9
  10 'use strict';
  11 /* globals Node */
  12
  13
  14 var DocumentNode = function(nativeNode, document) {
  15     if(!document) {
  16         throw new Error('undefined document for a node');
  17     }
  18     this.document = document;
  19     this._setNativeNode(nativeNode);
  20
  21 };
  22
  23 $.extend(DocumentNode.prototype, {
  24
  25     transform: function(Transformation, args) {
  26         var transformation = new Transformation(this.document, this, args);
  27         return this.document.transform(transformation);
  28     },
  29
  30     _setNativeNode: function(nativeNode) {
  31         this.nativeNode = nativeNode;
  32         this._$ = $(nativeNode);
  33     },
  34
  35     clone: function() {
  36         var clone = this._$.clone(true, true);
  37         return this.document.createDocumentNode(clone[0]);
  38     },
  39
  40     getPath: function(ancestor) {
  41         if(!(this.document.containsNode(this))) {
  42             return null;
  43         }
  44
  45         var nodePath = [this].concat(this.parents()),
  46             toret, idx;
  47         ancestor = ancestor || this.document.root;
  48
  49         nodePath.some(function(node, i) {
  50             if(node.sameNode(ancestor)) {
  51                 idx = i;
  52                 return true;
  53             }
  54         });
  55
  56         if(idx !== 'undefined') {
  57             nodePath = nodePath.slice(0, idx);
  58         }
  59         toret = nodePath.map(function(node) {return node.getIndex(); });
  60         toret.reverse();
  61         return toret;
  62     },
  63
  64     isRoot: function() {
  65         return this.document.root.sameNode(this);
  66     },
  67
  68     sameNode: function(otherNode) {
  69         return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
  70     },
  71
  72     parent: function() {
  73         var parentNode = this.nativeNode.parentNode;
  74         if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
  75             return this.document.createDocumentNode(parentNode);
  76         }
  77         return null;
  78     },
  79
  80     parents: function() {
  81         var parent = this.parent(),
  82             parents = parent ? parent.parents() : [];
  83         if(parent) {
  84             parents.unshift(parent);
  85         }
  86         return parents;
  87     },
  88
  89     prev: function() {
  90         var myIdx = this.getIndex();
  91         return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
  92     },
  93
  94     next: function() {
  95         if(this.isRoot()) {
  96             return null;
  97         }
  98         var myIdx = this.getIndex(),
  99             parentContents = this.parent().contents();
 100         return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
 101     },
 102
 103     isSurroundedByTextElements: function() {
 104         var prev = this.prev(),
 105             next = this.next();
 106         return prev && (prev.nodeType === Node.TEXT_NODE) && next && (next.nodeType === Node.TEXT_NODE);
 107     },
 108
 109     triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
 110         var node = (metaData && metaData.node) ? metaData.node : this,
 111             event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {}));
 112         if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
 113             this.document.trigger('change', event);
 114         }
 115         if((type === 'nodeAdded' || type === 'nodeMoved') && !this.document.containsNode(this) && nodeWasContained) {
 116              event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
 117              this.document.trigger('change', event);
 118         }
 119     },
 120
 121     getNodeInsertion: function(node) {
 122         return this.document.getNodeInsertion(node);
 123     },
 124
 125     getIndex: function() {
 126         if(this.isRoot()) {
 127             return 0;
 128         }
 129         return this.parent().indexOf(this);
 130     }
 131 });
 132
 133
 134 var ElementNode = function(nativeNode, document) {
 135     DocumentNode.call(this, nativeNode, document);
 136 };
 137 ElementNode.prototype = Object.create(DocumentNode.prototype);
 138
 139 $.extend(ElementNode.prototype, {
 140     nodeType: Node.ELEMENT_NODE,
 141
 142     setData: function(key, value) {
 143         if(value !== undefined) {
 144             this._$.data(key, value);
 145         } else {
 146             this._$.removeData(_.keys(this._$.data()));
 147             this._$.data(key);
 148         }
 149     },
 150
 151     getData: function(key) {
 152         if(key) {
 153             return this._$.data(key);
 154         }
 155         return this._$.data();
 156     },
 157
 158     getTagName: function() {
 159         return this.nativeNode.tagName.toLowerCase();
 160     },
 161
 162     contents: function(selector) {
 163         var toret = [],
 164             document = this.document;
 165         if(selector) {
 166             this._$.children(selector).each(function() {
 167                 toret.push(document.createDocumentNode(this));
 168             });
 169         } else {
 170             this._$.contents().each(function() {
 171                 toret.push(document.createDocumentNode(this));
 172             });
 173         }
 174         return toret;
 175     },
 176
 177     indexOf: function(node) {
 178         return this._$.contents().index(node._$);
 179     },
 180
 181     getAttr: function(name) {
 182         return this._$.attr(name);
 183     },
 184
 185     getAttrs: function() {
 186         var toret = [];
 187         for(var i = 0; i < this.nativeNode.attributes.length; i++) {
 188             toret.push(this.nativeNode.attributes[i]);
 189         }
 190         return toret;
 191     },
 192
 193     toXML: function() {
 194         var wrapper = $('<div>');
 195         wrapper.append(this._getXMLDOMToDump());
 196         return wrapper.html();
 197     },
 198
 199     _getXMLDOMToDump: function() {
 200         return this._$;
 201     }
 202 });
 203
 204
 205 var TextNode = function(nativeNode, document) {
 206     DocumentNode.call(this, nativeNode, document);
 207 };
 208 TextNode.prototype = Object.create(DocumentNode.prototype);
 209
 210 $.extend(TextNode.prototype, {
 211     nodeType: Node.TEXT_NODE,
 212
 213     getText: function() {
 214         return this.nativeNode.data;
 215     },
 216
 217     triggerTextChangeEvent: function() {
 218         var event = new events.ChangeEvent('nodeTextChange', {node: this});
 219         this.document.trigger('change', event);
 220     }
 221 });
 222
 223
 224 var parseXML = function(xml) {
 225     return $($.trim(xml))[0];
 226 };
 227
 228 var registerTransformation = function(desc, name, target) {
 229     var Transformation = transformations.createContextTransformation(desc, name);
 230     target[name] = function() {
 231         var instance = this,
 232             args = Array.prototype.slice.call(arguments, 0);
 233         return instance.transform(Transformation, args);
 234     };
 235 };
 236
 237 var registerMethod = function(methodName, method, target) {
 238     if(target[methodName]) {
 239         throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
 240             .replace('{target}', target)
 241             .replace('{methodName}', methodName)
 242         );
 243     }
 244     target[methodName] = method;
 245 };
 246
 247
 248 var Document = function(xml) {
 249     this.loadXML(xml);
 250     this.undoStack = [];
 251     this.redoStack = [];
 252     this._transformationLevel = 0;
 253
 254     this._nodeMethods = {};
 255     this._textNodeMethods = {};
 256     this._elementNodeMethods = {};
 257     this._nodeTransformations = {};
 258     this._textNodeTransformations = {};
 259     this._elementNodeTransformations = {};
 260
 261     this.registerExtension(coreTransformations);
 262 };
 263
 264 $.extend(Document.prototype, Backbone.Events, {
 265     ElementNodeFactory: ElementNode,
 266     TextNodeFactory: TextNode,
 267
 268     createDocumentNode: function(from) {
 269         if(!(from instanceof Node)) {
 270             if(from.text !== undefined) {
 271                 /* globals document */
 272                 from = document.createTextNode(from.text);
 273             } else {
 274                 var node = $('<' + from.tagName + '>');
 275
 276                 _.keys(from.attrs || {}).forEach(function(key) {
 277                     node.attr(key, from.attrs[key]);
 278                 });
 279
 280                 from = node[0];
 281             }
 282         }
 283         var Factory, typeMethods, typeTransformations;
 284         if(from.nodeType === Node.TEXT_NODE) {
 285             Factory = this.TextNodeFactory;
 286             typeMethods = this._textNodeMethods;
 287             typeTransformations = this._textNodeTransformations;
 288         } else if(from.nodeType === Node.ELEMENT_NODE) {
 289             Factory = this.ElementNodeFactory;
 290             typeMethods = this._elementNodeMethods;
 291             typeTransformations = this._elementNodeTransformations;
 292         }
 293         var toret = new Factory(from, this);
 294         _.extend(toret, this._nodeMethods);
 295         _.extend(toret, typeMethods);
 296
 297         _.extend(toret, this._nodeTransformations);
 298         _.extend(toret, typeTransformations);
 299
 300         toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations);
 301         _.keys(toret.__super__).forEach(function(key) {
 302             toret.__super__[key] = _.bind(toret.__super__[key], toret);
 303         });
 304
 305         return toret;
 306     },
 307
 308     loadXML: function(xml, options) {
 309         options = options || {};
 310         this._defineDocumentProperties($(parseXML(xml)));
 311         if(!options.silent) {
 312             this.trigger('contentSet');
 313         }
 314     },
 315
 316     toXML: function() {
 317         return this.root.toXML();
 318     },
 319
 320     containsNode: function(node) {
 321         return this.root && (node.nativeNode === this.root.nativeNode || node._$.parents().index(this.root._$) !== -1);
 322     },
 323
 324     getSiblingParents: function(params) {
 325         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
 326             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
 327             noSiblingParents = null;
 328
 329         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
 330             return noSiblingParents;
 331         }
 332
 333         var i;
 334         for(i = 0; i < Math.min(parents1.length, parents2.length); i++) {
 335             if(parents1[i].sameNode(parents2[i])) {
 336                 continue;
 337             }
 338             break;
 339         }
 340         return {node1: parents1[i], node2: parents2[i]};
 341     },
 342
 343     trigger: function() {
 344         Backbone.Events.trigger.apply(this, arguments);
 345     },
 346
 347     getNodeInsertion: function(node) {
 348         var insertion = {};
 349         if(node instanceof DocumentNode) {
 350             insertion.ofNode = node;
 351             insertion.insertsNew = !this.containsNode(node);
 352         } else {
 353           insertion.ofNode = this.createDocumentNode(node);
 354           insertion.insertsNew = true;
 355         }
 356         return insertion;
 357     },
 358
 359     registerMethod: function(methodName, method, dstName) {
 360         var doc = this;
 361         var destination = {
 362             document: doc,
 363             documentNode: doc._nodeMethods,
 364             textNode: doc._textNodeMethods,
 365             elementNode: doc._elementNodeMethods
 366         }[dstName];
 367         registerMethod(methodName, method, destination);
 368     },
 369
 370     registerTransformation: function(desc, name, dstName) {
 371         var doc = this;
 372         var destination = {
 373             document: doc,
 374             documentNode: doc._nodeTransformations,
 375             textNode: doc._textNodeTransformations,
 376             elementNode: doc._elementNodeTransformations
 377         }[dstName];
 378         registerTransformation(desc, name, destination);
 379     },
 380
 381     registerExtension: function(extension) {
 382         var doc = this;
 383
 384         ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) {
 385             var dstExtension = extension[dstName];
 386             if(dstExtension) {
 387                 if(dstExtension.methods) {
 388                     _.pairs(dstExtension.methods).forEach(function(pair) {
 389                         var methodName = pair[0],
 390                             method = pair[1];
 391
 392                         doc.registerMethod(methodName, method, dstName);
 393
 394                     });
 395                 }
 396
 397                 if(dstExtension.transformations) {
 398                     _.pairs(dstExtension.transformations).forEach(function(pair) {
 399                         var name = pair[0],
 400                             desc = pair[1];
 401                         doc.registerTransformation(desc, name, dstName);
 402                     });
 403                 }
 404             }
 405         });
 406     },
 407
 408     transform: function(Transformation, args) {
 409         var toret, transformation;
 410
 411         if(typeof Transformation === 'function') {
 412             transformation = new Transformation(this, this, args);
 413         } else {
 414             transformation = Transformation;
 415         }
 416         if(transformation) {
 417             this._transformationLevel++;
 418             toret = transformation.run({beUndoable:this._transformationLevel === 1});
 419             if(this._transformationLevel === 1 && !this._undoInProgress) {
 420                 this.undoStack.push(transformation);
 421             }
 422             this._transformationLevel--;
 423             if(!this._undoInProgress) {
 424                 this.redoStack = [];
 425             }
 426             return toret;
 427         } else {
 428             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
 429         }
 430     },
 431     undo: function() {
 432         var transformation = this.undoStack.pop();
 433         if(transformation) {
 434             this._undoInProgress = true;
 435             transformation.undo();
 436             this._undoInProgress = false;
 437             this.redoStack.push(transformation);
 438         }
 439     },
 440     redo: function() {
 441         var transformation = this.redoStack.pop();
 442         if(transformation) {
 443             this._transformationLevel++;
 444             transformation.run({beUndoable: true});
 445             this._transformationLevel--;
 446             this.undoStack.push(transformation);
 447
 448         }
 449     },
 450
 451     getNodeByPath: function(path) {
 452         var toret = this.root;
 453         path.forEach(function(idx) {
 454             toret = toret.contents()[idx];
 455         });
 456         return toret;
 457     },
 458
 459     _defineDocumentProperties: function($document) {
 460         var doc = this;
 461         Object.defineProperty(doc, 'root', {get: function() {
 462             return doc.createDocumentNode($document[0]);
 463         }, configurable: true});
 464         Object.defineProperty(doc, 'dom', {get: function() {
 465             return $document[0];
 466         }, configurable: true});
 467     }
 468 });
 469
 470
 471 return {
 472     documentFromXML: function(xml) {
 473         var doc = new Document(xml);
 474         return doc;
 475     },
 476
 477     elementNodeFromXML: function(xml) {
 478         return this.documentFromXML(xml).root;
 479     },
 480
 481     Document: Document,
 482     DocumentNode: DocumentNode,
 483     ElementNode: ElementNode,
 484     TextNode: TextNode
 485 };
 486
 487 });