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     'smartxml/fragments'
   9 ], function($, _, Backbone, events, transformations, coreTransformations, fragments) {
  10
  11 'use strict';
  12 /* globals Node */
  13
  14
  15 var privateKey = '_smartxml';
  16
  17 var DocumentNode = function(nativeNode, document) {
  18     if(!document) {
  19         throw new Error('undefined document for a node');
  20     }
  21     this.document = document;
  22     this.object = {};
  23     this._setNativeNode(nativeNode);
  24
  25 };
  26
  27 $.extend(DocumentNode.prototype, {
  28
  29     getProperty: function(propName) {
  30         var toret = this.object[propName];
  31         if(toret && _.isFunction(toret)) {
  32             toret = toret.call(this);
  33         }
  34         return toret;
  35     },
  36
  37     transform: function(Transformation, args) {
  38         var transformation = new Transformation(this.document, this, args);
  39         return this.document.transform(transformation);
  40     },
  41
  42     _setNativeNode: function(nativeNode) {
  43         this.nativeNode = nativeNode;
  44         this._$ = $(nativeNode);
  45     },
  46
  47     clone: function() {
  48         var clone = this._$.clone(true, true),
  49             node = this;
  50         clone.find('*').addBack().each(function() {
  51             var el = this,
  52                 clonedData = $(this).data();
  53             $(el).removeData(privateKey);
  54             _.pairs(clonedData).forEach(function(pair) {
  55                 var key = pair[0],
  56                     value = pair[1];
  57                 if(_.isFunction(value.clone)) {
  58                     clonedData[key] = value.clone(node.document.createDocumentNode(el));
  59                 }
  60             });
  61         });
  62         return this.document.createDocumentNode(clone[0]);
  63     },
  64
  65     getPath: function(ancestor) {
  66         if(!(this.document.containsNode(this))) {
  67             return null;
  68         }
  69
  70         var nodePath = [this].concat(this.parents()),
  71             toret, idx;
  72         ancestor = ancestor || this.document.root;
  73
  74         nodePath.some(function(node, i) {
  75             if(node.sameNode(ancestor)) {
  76                 idx = i;
  77                 return true;
  78             }
  79         });
  80
  81         if(idx !== undefined) {
  82             nodePath = nodePath.slice(0, idx);
  83         }
  84         toret = nodePath.map(function(node) {return node.getIndex(); });
  85         toret.reverse();
  86         return toret;
  87     },
  88
  89     isRoot: function() {
  90         return this.document.root.sameNode(this);
  91     },
  92
  93     isInDocument: function() {
  94         return this.document.containsNode(this);
  95     },
  96
  97     isSiblingOf: function(node) {
  98         return node && this.parent().sameNode(node.parent());
  99     },
 100
 101     sameNode: function(otherNode) {
 102         return !!(otherNode) && this.nativeNode === otherNode.nativeNode;
 103     },
 104
 105     parent: function() {
 106         var parentNode = this.nativeNode.parentNode;
 107         if(parentNode && parentNode.nodeType === Node.ELEMENT_NODE) {
 108             return this.document.createDocumentNode(parentNode);
 109         }
 110         return null;
 111     },
 112
 113     parents: function() {
 114         var parent = this.parent(),
 115             parents = parent ? parent.parents() : [];
 116         if(parent) {
 117             parents.unshift(parent);
 118         }
 119         return parents;
 120     },
 121
 122     prev: function() {
 123         var myIdx = this.getIndex();
 124         return myIdx > 0 ? this.parent().contents()[myIdx-1] : null;
 125     },
 126
 127     next: function() {
 128         if(this.isRoot()) {
 129             return null;
 130         }
 131         var myIdx = this.getIndex(),
 132             parentContents = this.parent().contents();
 133         return myIdx < parentContents.length - 1 ? parentContents[myIdx+1] : null;
 134     },
 135
 136     isSurroundedByTextNodes: function() {
 137         return this.isPrecededByTextNode() && this.isFollowedByTextNode();
 138     },
 139
 140     isPrecededByTextNode: function() {
 141         var prev = this.prev();
 142         return prev && prev.nodeType === Node.TEXT_NODE;
 143     },
 144
 145     isFollowedByTextNode: function() {
 146         var next = this.next();
 147         return next && next.nodeType === Node.TEXT_NODE;
 148     },
 149
 150     triggerChangeEvent: function(type, metaData, origParent, nodeWasContained) {
 151         var node = (metaData && metaData.node) ? metaData.node : this,
 152             event = new events.ChangeEvent(type, $.extend({node: node}, metaData || {}));
 153         if(type === 'nodeDetached' || this.document.containsNode(event.meta.node)) {
 154             this.document.trigger('change', event);
 155         }
 156         if(type === 'nodeAdded' && !this.document.containsNode(this) && nodeWasContained) {
 157              event = new events.ChangeEvent('nodeDetached', {node: node, parent: origParent});
 158              this.document.trigger('change', event);
 159         }
 160     },
 161
 162     getNodeInsertion: function(node) {
 163         return this.document.getNodeInsertion(node);
 164     },
 165
 166     getIndex: function() {
 167         var parent;
 168
 169         if(this.isRoot()) {
 170             return 0;
 171         }
 172
 173         parent = this.parent();
 174         return parent ? parent.indexOf(this) : undefined;
 175     },
 176
 177     getNearestElementNode: function() {
 178         return this.nodeType === Node.ELEMENT_NODE ? this : this.parent();
 179     }
 180 });
 181
 182
 183 var ElementNode = function(nativeNode, document) {
 184     DocumentNode.call(this, nativeNode, document);
 185     $(nativeNode).data(privateKey, {node: this});
 186 };
 187 ElementNode.prototype = Object.create(DocumentNode.prototype);
 188
 189 $.extend(ElementNode.prototype, {
 190     nodeType: Node.ELEMENT_NODE,
 191
 192     setData: function(arg1, arg2) {
 193         if(arguments.length === 2) {
 194             if(_.isUndefined(arg2)) {
 195                 this._$.removeData(arg1);
 196             } else {
 197                 this._$.data(arg1, arg2);
 198             }
 199         } else {
 200             this._$.removeData(_.keys(this._$.data()));
 201             this._$.data(arg1);
 202         }
 203     },
 204
 205     getData: function(key) {
 206         if(key) {
 207             return this._$.data(key);
 208         }
 209         var toret = _.clone(this._$.data());
 210         delete toret[privateKey];
 211         return toret;
 212     },
 213
 214     getTagName: function() {
 215         return this.nativeNode.tagName.toLowerCase();
 216     },
 217
 218     contents: function(selector) {
 219         var toret = [],
 220             document = this.document;
 221         if(selector) {
 222             this._$.children(selector).each(function() {
 223                 toret.push(document.createDocumentNode(this));
 224             });
 225         } else {
 226             this._$.contents().each(function() {
 227                 toret.push(document.createDocumentNode(this));
 228             });
 229         }
 230         return toret;
 231     },
 232
 233     indexOf: function(node) {
 234         return this._$.contents().index(node._$);
 235     },
 236
 237     getAttr: function(name) {
 238         return this._$.attr(name);
 239     },
 240
 241     getAttrs: function() {
 242         var toret = [];
 243         for(var i = 0; i < this.nativeNode.attributes.length; i++) {
 244             toret.push(this.nativeNode.attributes[i]);
 245         }
 246         return toret;
 247     },
 248
 249     containsNode: function(node) {
 250         return node && (node.nativeNode === this.nativeNode || node._$.parents().index(this._$) !== -1);
 251     },
 252
 253     getLastTextNode: function() {
 254         var contents = this.contents(),
 255             toret;
 256
 257         contents.reverse().some(function(node) {
 258             if(node.nodeType === Node.TEXT_NODE) {
 259                 toret = node;
 260                 return true;
 261             }
 262             toret = node.getLastTextNode();
 263             return !!toret;
 264         });
 265
 266         return toret;
 267     },
 268
 269     toXML: function() {
 270         var wrapper = $('<div>');
 271         wrapper.append(this._getXMLDOMToDump());
 272         return wrapper.html();
 273     },
 274
 275     _getXMLDOMToDump: function() {
 276         return this._$;
 277     }
 278 });
 279
 280
 281 var TextNode = function(nativeNode, document) {
 282     DocumentNode.call(this, nativeNode, document);
 283 };
 284 TextNode.prototype = Object.create(DocumentNode.prototype);
 285
 286 $.extend(TextNode.prototype, {
 287     nodeType: Node.TEXT_NODE,
 288
 289     getText: function() {
 290         return this.nativeNode.data;
 291     },
 292
 293
 294     containsNode: function() {
 295         return false;
 296     },
 297
 298     triggerTextChangeEvent: function() {
 299         var event = new events.ChangeEvent('nodeTextChange', {node: this});
 300         this.document.trigger('change', event);
 301     }
 302 });
 303
 304
 305 var parseXML = function(xml) {
 306     var toret = $($.trim(xml));
 307     if(toret.length !== 1) {
 308         throw new Error('Unable to parse XML: ' + xml);
 309     }
 310     return toret[0];
 311
 312 };
 313
 314 var registerTransformation = function(desc, name, target) {
 315     var Transformation = transformations.createContextTransformation(desc, name);
 316     target[name] = function() {
 317         var instance = this,
 318             args = Array.prototype.slice.call(arguments, 0);
 319         return instance.transform(Transformation, args);
 320     };
 321 };
 322
 323 var registerMethod = function(methodName, method, target) {
 324     if(target[methodName]) {
 325         throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
 326             .replace('{target}', target)
 327             .replace('{methodName}', methodName)
 328         );
 329     }
 330     target[methodName] = method;
 331 };
 332
 333
 334 var Document = function(xml, extensions) {
 335     this.undoStack = [];
 336     this.redoStack = [];
 337     this._currentTransaction = null;
 338     this._transformationLevel = 0;
 339
 340     this._nodeMethods = {};
 341     this._textNodeMethods = {};
 342     this._elementNodeMethods = {};
 343     this._nodeTransformations = {};
 344     this._textNodeTransformations = {};
 345     this._elementNodeTransformations = {};
 346
 347     this.registerExtension(coreTransformations);
 348
 349     (extensions || []).forEach(function(extension) {
 350         this.registerExtension(extension);
 351     }.bind(this));
 352     this.loadXML(xml);
 353 };
 354
 355 $.extend(Document.prototype, Backbone.Events, fragments, {
 356     ElementNodeFactory: ElementNode,
 357     TextNodeFactory: TextNode,
 358
 359     createDocumentNode: function(from) {
 360         var cached;
 361
 362         if(from instanceof Node) {
 363             cached = ($(from).data(privateKey) || {}).node;
 364             if(cached instanceof DocumentNode) {
 365                 return cached;
 366             }
 367         } else {
 368             if(typeof from === 'string') {
 369                 from = parseXML(from);
 370                 this.normalizeXML(from);
 371             } else {
 372                 if(from.text !== undefined) {
 373                     /* globals document */
 374                     from = document.createTextNode(from.text);
 375                 } else {
 376                     if(!from.tagName) {
 377                         throw new Error('tagName missing');
 378                     }
 379                     var node = $('<' + from.tagName + '>');
 380
 381                     _.keys(from.attrs || {}).forEach(function(key) {
 382                         node.attr(key, from.attrs[key]);
 383                     });
 384
 385                     from = node[0];
 386                 }
 387             }
 388         }
 389         var Factory, typeMethods, typeTransformations;
 390         if(from.nodeType === Node.TEXT_NODE) {
 391             Factory = this.TextNodeFactory;
 392             typeMethods = this._textNodeMethods;
 393             typeTransformations = this._textNodeTransformations;
 394         } else if(from.nodeType === Node.ELEMENT_NODE) {
 395             Factory = this.ElementNodeFactory;
 396             typeMethods = this._elementNodeMethods;
 397             typeTransformations = this._elementNodeTransformations;
 398         }
 399         var toret = new Factory(from, this);
 400         _.extend(toret, this._nodeMethods);
 401         _.extend(toret, typeMethods);
 402
 403         _.extend(toret, this._nodeTransformations);
 404         _.extend(toret, typeTransformations);
 405
 406         toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations);
 407         _.keys(toret.__super__).forEach(function(key) {
 408             toret.__super__[key] = _.bind(toret.__super__[key], toret);
 409         });
 410
 411         return toret;
 412     },
 413
 414     loadXML: function(xml, options) {
 415         options = options || {};
 416         this._defineDocumentProperties($(parseXML(xml)));
 417         this.normalizeXML(this.dom);
 418         if(!options.silent) {
 419             this.trigger('contentSet');
 420         }
 421     },
 422
 423     normalizeXML: function(nativeNode) {
 424         void(nativeNode); // noop
 425     },
 426
 427     toXML: function() {
 428         return this.root.toXML();
 429     },
 430
 431     containsNode: function(node) {
 432         return this.root && this.root.containsNode(node);
 433     },
 434
 435     getSiblingParents: function(params) {
 436         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
 437             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
 438             noSiblingParents = null;
 439
 440         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
 441             return noSiblingParents;
 442         }
 443
 444         var stop = Math.min(parents1.length, parents2.length),
 445             i;
 446         for(i = 0; i < stop; i++) {
 447             if(parents1[i].sameNode(parents2[i])) {
 448                 continue;
 449             }
 450             break;
 451         }
 452         if(i === stop) {
 453             i--;
 454         }
 455         return {node1: parents1[i], node2: parents2[i]};
 456     },
 457
 458     trigger: function() {
 459         Backbone.Events.trigger.apply(this, arguments);
 460     },
 461
 462     getNodeInsertion: function(node) {
 463         var insertion = {};
 464         if(node instanceof DocumentNode) {
 465             insertion.ofNode = node;
 466             insertion.insertsNew = !this.containsNode(node);
 467         } else {
 468           insertion.ofNode = this.createDocumentNode(node);
 469           insertion.insertsNew = true;
 470         }
 471         return insertion;
 472     },
 473
 474     registerMethod: function(methodName, method, dstName) {
 475         var doc = this;
 476         var destination = {
 477             document: doc,
 478             documentNode: doc._nodeMethods,
 479             textNode: doc._textNodeMethods,
 480             elementNode: doc._elementNodeMethods
 481         }[dstName];
 482         registerMethod(methodName, method, destination);
 483     },
 484
 485     registerTransformation: function(desc, name, dstName) {
 486         var doc = this;
 487         var destination = {
 488             document: doc,
 489             documentNode: doc._nodeTransformations,
 490             textNode: doc._textNodeTransformations,
 491             elementNode: doc._elementNodeTransformations
 492         }[dstName];
 493         registerTransformation(desc, name, destination);
 494     },
 495
 496     registerExtension: function(extension) {
 497         var doc = this;
 498
 499         ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) {
 500             var dstExtension = extension[dstName];
 501             if(dstExtension) {
 502                 if(dstExtension.methods) {
 503                     _.pairs(dstExtension.methods).forEach(function(pair) {
 504                         var methodName = pair[0],
 505                             method = pair[1];
 506
 507                         doc.registerMethod(methodName, method, dstName);
 508
 509                     });
 510                 }
 511
 512                 if(dstExtension.transformations) {
 513                     _.pairs(dstExtension.transformations).forEach(function(pair) {
 514                         var name = pair[0],
 515                             desc = pair[1];
 516                         doc.registerTransformation(desc, name, dstName);
 517                     });
 518                 }
 519             }
 520         });
 521     },
 522
 523     ifChanged: function(context, action, documentChangedHandler, documentUnchangedHandler) {
 524         var hasChanged = false,
 525             changeMonitor = function() {
 526                 hasChanged = true;
 527             };
 528
 529         this.on('change', changeMonitor);
 530         action.call(context);
 531         this.off('change', changeMonitor);
 532
 533         if(hasChanged) {
 534             if(documentChangedHandler) {
 535                 documentChangedHandler.call(context);
 536             }
 537         } else {
 538             if(documentUnchangedHandler) {
 539                 documentUnchangedHandler.call(context);
 540             }
 541         }
 542     },
 543
 544     transform: function(Transformation, args) {
 545         var toret, transformation;
 546
 547         if(!this._currentTransaction) {
 548             return this.transaction(function() {
 549                 return this.transform(Transformation, args);
 550             }, {context: this});
 551         }
 552
 553         if(typeof Transformation === 'function') {
 554             transformation = new Transformation(this, this, args);
 555         } else {
 556             transformation = Transformation;
 557         }
 558         if(transformation) {
 559             this._transformationLevel++;
 560
 561             this.ifChanged(
 562                 this,
 563                 function() {
 564                     toret = transformation.run({beUndoable:this._transformationLevel === 1});
 565                 },
 566                 function() {
 567                     if(this._transformationLevel === 1 && !this._undoInProgress) {
 568                         this._currentTransaction.pushTransformation(transformation);
 569                         this.redoStack = [];
 570                     }
 571                 }
 572             );
 573
 574             this._transformationLevel--;
 575             return toret;
 576         } else {
 577             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
 578         }
 579     },
 580     undo: function() {
 581         var transaction = this.undoStack.pop(),
 582             doc = this,
 583             transformations, stopAt;
 584
 585         if(transaction) {
 586             this._undoInProgress = true;
 587
 588             // We will modify this array in a minute so make sure we work on a copy.
 589             transformations = transaction.transformations.slice(0);
 590
 591             if(transformations.length > 1) {
 592                 // In case of real transactions we don't want to run undo on all of transformations if we don't have to.
 593                 transformations.some(function(t, idx) {
 594                     if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
 595                         stopAt = idx;
 596                         return true; //break
 597                     }
 598                 });
 599                 if(stopAt !== undefined) {
 600                     // We will get away with undoing only this transformations as the one at stopAt reverses the whole document.
 601                     transformations = transformations.slice(0, stopAt+1);
 602                 }
 603             }
 604
 605             transformations.reverse();
 606             transformations.forEach(function(t) {
 607                 t.undo();
 608             });
 609
 610             this._undoInProgress = false;
 611             this.redoStack.push(transaction);
 612             this.trigger('operationEnd');
 613         }
 614     },
 615     redo: function() {
 616         var transaction = this.redoStack.pop();
 617         if(transaction) {
 618             this._transformationLevel++;
 619             transaction.transformations.forEach(function(t) {
 620                 t.run({beUndoable: true});
 621             });
 622             this._transformationLevel--;
 623             this.undoStack.push(transaction);
 624             this.trigger('operationEnd');
 625
 626         }
 627     },
 628
 629     startTransaction: function(metadata) {
 630         if(this._currentTransaction) {
 631             throw new Error('Nested transactions not supported!');
 632         }
 633         this._rollbackBackup = this.root.clone();
 634         this._currentTransaction = new Transaction([], metadata);
 635     },
 636
 637     endTransaction: function() {
 638         if(!this._currentTransaction) {
 639             throw new Error('End of transaction requested, but there is no transaction in progress!');
 640         }
 641         if(this._currentTransaction.hasTransformations()) {
 642             this.undoStack.push(this._currentTransaction);
 643             this.trigger('operationEnd');
 644         }
 645         this._currentTransaction = null;
 646     },
 647
 648     rollbackTransaction: function() {
 649         if(!this._currentTransaction) {
 650             throw new Error('Transaction rollback requested, but there is no transaction in progress!');
 651         }
 652         this.replaceRoot(this._rollbackBackup);
 653         this._rollbackBackup = null;
 654         this._currentTransaction = null;
 655         this._transformationLevel = 0;
 656     },
 657
 658     transaction: function(callback, params) {
 659         var toret;
 660         params = params || {};
 661         this.startTransaction(params.metadata);
 662         try {
 663             toret = callback.call(params.context || this);
 664         } catch(e) {
 665             if(params.error) {
 666                 params.error(e);
 667             }
 668             this.rollbackTransaction();
 669             return;
 670         }
 671         this.endTransaction();
 672         if(params.success) {
 673             params.success(toret);
 674         }
 675         return toret;
 676     },
 677
 678     getNodeByPath: function(path) {
 679         var toret = this.root;
 680         path.some(function(idx) {
 681             toret = toret.contents()[idx];
 682             if(!toret) {
 683                 return true;
 684             }
 685         });
 686         return toret;
 687     },
 688
 689     _defineDocumentProperties: function($document) {
 690         var doc = this;
 691         Object.defineProperty(doc, 'root', {get: function() {
 692             if(!$document) {
 693                 return null;
 694             }
 695             return doc.createDocumentNode($document[0]);
 696         }, configurable: true});
 697         Object.defineProperty(doc, 'dom', {get: function() {
 698             if(!$document) {
 699                 return null;
 700             }
 701             return $document[0];
 702         }, configurable: true});
 703     },
 704
 705     createFragment: function(Type, params) {
 706         if(!Type.prototype instanceof fragments.Fragment) {
 707             throw new Error('Can\'t create a fragment: `Type` is not a valid Fragment');
 708         }
 709         return new Type(this, params);
 710     }
 711 });
 712
 713 var Transaction = function(transformations, metadata) {
 714     this.transformations = transformations || [];
 715     this.metadata = metadata;
 716 };
 717 $.extend(Transaction.prototype, {
 718     pushTransformation: function(transformation) {
 719         this.transformations.push(transformation);
 720     },
 721     hasTransformations: function() {
 722         return this.transformations.length > 0;
 723     }
 724 });
 725
 726
 727 return {
 728     documentFromXML: function(xml) {
 729         var doc = new Document(xml);
 730         return doc;
 731     },
 732
 733     elementNodeFromXML: function(xml) {
 734         return this.documentFromXML(xml).root;
 735     },
 736
 737     Document: Document,
 738     DocumentNode: DocumentNode,
 739     ElementNode: ElementNode,
 740     TextNode: TextNode
 741 };
 742
 743 });