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     nativeNode.__smartxmlTextNodeInstance = this;
 284 };
 285 TextNode.prototype = Object.create(DocumentNode.prototype);
 286
 287 $.extend(TextNode.prototype, {
 288     nodeType: Node.TEXT_NODE,
 289
 290     getText: function() {
 291         return this.nativeNode.data;
 292     },
 293
 294
 295     containsNode: function() {
 296         return false;
 297     },
 298
 299     triggerTextChangeEvent: function() {
 300         var event = new events.ChangeEvent('nodeTextChange', {node: this});
 301         this.document.trigger('change', event);
 302     }
 303 });
 304
 305
 306 var parseXML = function(xml) {
 307     var toret = $($.trim(xml));
 308     if(toret.length !== 1) {
 309         throw new Error('Unable to parse XML: ' + xml);
 310     }
 311     return toret[0];
 312
 313 };
 314
 315 var registerTransformation = function(desc, name, target) {
 316     var Transformation = transformations.createContextTransformation(desc, name);
 317     target[name] = function() {
 318         var instance = this,
 319             args = Array.prototype.slice.call(arguments, 0);
 320         return instance.transform(Transformation, args);
 321     };
 322 };
 323
 324 var registerMethod = function(methodName, method, target) {
 325     if(target[methodName]) {
 326         throw new Error('Cannot extend {target} with method name {methodName}. Name already exists.'
 327             .replace('{target}', target)
 328             .replace('{methodName}', methodName)
 329         );
 330     }
 331     target[methodName] = method;
 332 };
 333
 334
 335 var Document = function(xml, extensions) {
 336     this.undoStack = [];
 337     this.redoStack = [];
 338     this._currentTransaction = null;
 339     this._transformationLevel = 0;
 340
 341     this._nodeMethods = {};
 342     this._textNodeMethods = {};
 343     this._elementNodeMethods = {};
 344     this._nodeTransformations = {};
 345     this._textNodeTransformations = {};
 346     this._elementNodeTransformations = {};
 347
 348     this.registerExtension(coreTransformations);
 349
 350     (extensions || []).forEach(function(extension) {
 351         this.registerExtension(extension);
 352     }.bind(this));
 353     this.loadXML(xml);
 354 };
 355
 356 $.extend(Document.prototype, Backbone.Events, fragments, {
 357     ElementNodeFactory: ElementNode,
 358     TextNodeFactory: TextNode,
 359
 360     createDocumentNode: function(from) {
 361         var cached;
 362
 363         if(from instanceof Node) {
 364             /* globals Text */
 365             cached = from instanceof Text ? from.__smartxmlTextNodeInstance : ($(from).data(privateKey) || {}).node;
 366             if(cached instanceof DocumentNode) {
 367                 return cached;
 368             }
 369         } else {
 370             if(typeof from === 'string') {
 371                 from = parseXML(from);
 372                 this.normalizeXML(from);
 373             } else {
 374                 if(from.text !== undefined) {
 375                     /* globals document */
 376                     from = document.createTextNode(from.text);
 377                 } else {
 378                     if(!from.tagName) {
 379                         throw new Error('tagName missing');
 380                     }
 381                     var node = $('<' + from.tagName + '>');
 382
 383                     _.keys(from.attrs || {}).forEach(function(key) {
 384                         node.attr(key, from.attrs[key]);
 385                     });
 386
 387                     from = node[0];
 388                 }
 389             }
 390         }
 391         var Factory, typeMethods, typeTransformations;
 392         if(from.nodeType === Node.TEXT_NODE) {
 393             Factory = this.TextNodeFactory;
 394             typeMethods = this._textNodeMethods;
 395             typeTransformations = this._textNodeTransformations;
 396         } else if(from.nodeType === Node.ELEMENT_NODE) {
 397             Factory = this.ElementNodeFactory;
 398             typeMethods = this._elementNodeMethods;
 399             typeTransformations = this._elementNodeTransformations;
 400         }
 401         var toret = new Factory(from, this);
 402         _.extend(toret, this._nodeMethods);
 403         _.extend(toret, typeMethods);
 404
 405         _.extend(toret, this._nodeTransformations);
 406         _.extend(toret, typeTransformations);
 407
 408         toret.__super__ = _.extend({}, this._nodeMethods, this._nodeTransformations);
 409         _.keys(toret.__super__).forEach(function(key) {
 410             toret.__super__[key] = _.bind(toret.__super__[key], toret);
 411         });
 412
 413         return toret;
 414     },
 415
 416     loadXML: function(xml, options) {
 417         options = options || {};
 418         this._defineDocumentProperties($(parseXML(xml)));
 419         this.normalizeXML(this.dom);
 420         if(!options.silent) {
 421             this.trigger('contentSet');
 422         }
 423     },
 424
 425     normalizeXML: function(nativeNode) {
 426         void(nativeNode); // noop
 427     },
 428
 429     toXML: function() {
 430         return this.root.toXML();
 431     },
 432
 433     containsNode: function(node) {
 434         return this.root && this.root.containsNode(node);
 435     },
 436
 437     getSiblingParents: function(params) {
 438         var parents1 = [params.node1].concat(params.node1.parents()).reverse(),
 439             parents2 = [params.node2].concat(params.node2.parents()).reverse(),
 440             noSiblingParents = null;
 441
 442         if(parents1.length === 0 || parents2.length === 0 || !(parents1[0].sameNode(parents2[0]))) {
 443             return noSiblingParents;
 444         }
 445
 446         var stop = Math.min(parents1.length, parents2.length),
 447             i;
 448         for(i = 0; i < stop; i++) {
 449             if(parents1[i].sameNode(parents2[i])) {
 450                 continue;
 451             }
 452             break;
 453         }
 454         if(i === stop) {
 455             i--;
 456         }
 457         return {node1: parents1[i], node2: parents2[i]};
 458     },
 459
 460     trigger: function() {
 461         Backbone.Events.trigger.apply(this, arguments);
 462     },
 463
 464     getNodeInsertion: function(node) {
 465         var insertion = {};
 466         if(node instanceof DocumentNode) {
 467             insertion.ofNode = node;
 468             insertion.insertsNew = !this.containsNode(node);
 469         } else {
 470           insertion.ofNode = this.createDocumentNode(node);
 471           insertion.insertsNew = true;
 472         }
 473         return insertion;
 474     },
 475
 476     registerMethod: function(methodName, method, dstName) {
 477         var doc = this;
 478         var destination = {
 479             document: doc,
 480             documentNode: doc._nodeMethods,
 481             textNode: doc._textNodeMethods,
 482             elementNode: doc._elementNodeMethods
 483         }[dstName];
 484         registerMethod(methodName, method, destination);
 485     },
 486
 487     registerTransformation: function(desc, name, dstName) {
 488         var doc = this;
 489         var destination = {
 490             document: doc,
 491             documentNode: doc._nodeTransformations,
 492             textNode: doc._textNodeTransformations,
 493             elementNode: doc._elementNodeTransformations
 494         }[dstName];
 495         registerTransformation(desc, name, destination);
 496     },
 497
 498     registerExtension: function(extension) {
 499         var doc = this;
 500
 501         ['document', 'documentNode', 'elementNode', 'textNode'].forEach(function(dstName) {
 502             var dstExtension = extension[dstName];
 503             if(dstExtension) {
 504                 if(dstExtension.methods) {
 505                     _.pairs(dstExtension.methods).forEach(function(pair) {
 506                         var methodName = pair[0],
 507                             method = pair[1];
 508
 509                         doc.registerMethod(methodName, method, dstName);
 510
 511                     });
 512                 }
 513
 514                 if(dstExtension.transformations) {
 515                     _.pairs(dstExtension.transformations).forEach(function(pair) {
 516                         var name = pair[0],
 517                             desc = pair[1];
 518                         doc.registerTransformation(desc, name, dstName);
 519                     });
 520                 }
 521             }
 522         });
 523     },
 524
 525     ifChanged: function(context, action, documentChangedHandler, documentUnchangedHandler) {
 526         var hasChanged = false,
 527             changeMonitor = function() {
 528                 hasChanged = true;
 529             };
 530
 531         this.on('change', changeMonitor);
 532         action.call(context);
 533         this.off('change', changeMonitor);
 534
 535         if(hasChanged) {
 536             if(documentChangedHandler) {
 537                 documentChangedHandler.call(context);
 538             }
 539         } else {
 540             if(documentUnchangedHandler) {
 541                 documentUnchangedHandler.call(context);
 542             }
 543         }
 544     },
 545
 546     transform: function(Transformation, args) {
 547         var toret, transformation;
 548
 549         if(!this._currentTransaction) {
 550             return this.transaction(function() {
 551                 return this.transform(Transformation, args);
 552             }, {context: this});
 553         }
 554
 555         if(typeof Transformation === 'function') {
 556             transformation = new Transformation(this, this, args);
 557         } else {
 558             transformation = Transformation;
 559         }
 560         if(transformation) {
 561             this._transformationLevel++;
 562
 563             this.ifChanged(
 564                 this,
 565                 function() {
 566                     toret = transformation.run({beUndoable:this._transformationLevel === 1});
 567                 },
 568                 function() {
 569                     if(this._transformationLevel === 1 && !this._undoInProgress) {
 570                         this._currentTransaction.pushTransformation(transformation);
 571                         this.redoStack = [];
 572                     }
 573                 }
 574             );
 575
 576             this._transformationLevel--;
 577             return toret;
 578         } else {
 579             throw new Error('Transformation ' + transformation + ' doesn\'t exist!');
 580         }
 581     },
 582     undo: function() {
 583         var transaction = this.undoStack.pop(),
 584             doc = this,
 585             transformations, stopAt;
 586
 587         if(transaction) {
 588             this._undoInProgress = true;
 589
 590             // We will modify this array in a minute so make sure we work on a copy.
 591             transformations = transaction.transformations.slice(0);
 592
 593             if(transformations.length > 1) {
 594                 // In case of real transactions we don't want to run undo on all of transformations if we don't have to.
 595                 transformations.some(function(t, idx) {
 596                     if(!t.undo && t.getChangeRoot().sameNode(doc.root)) {
 597                         stopAt = idx;
 598                         return true; //break
 599                     }
 600                 });
 601                 if(stopAt !== undefined) {
 602                     // We will get away with undoing only this transformations as the one at stopAt reverses the whole document.
 603                     transformations = transformations.slice(0, stopAt+1);
 604                 }
 605             }
 606
 607             transformations.reverse();
 608             transformations.forEach(function(t) {
 609                 t.undo();
 610             });
 611
 612             this._undoInProgress = false;
 613             this.redoStack.push(transaction);
 614             this.trigger('operationEnd');
 615         }
 616     },
 617     redo: function() {
 618         var transaction = this.redoStack.pop();
 619         if(transaction) {
 620             this._transformationLevel++;
 621             transaction.transformations.forEach(function(t) {
 622                 t.run({beUndoable: true});
 623             });
 624             this._transformationLevel--;
 625             this.undoStack.push(transaction);
 626             this.trigger('operationEnd');
 627
 628         }
 629     },
 630
 631     startTransaction: function(metadata) {
 632         if(this._currentTransaction) {
 633             throw new Error('Nested transactions not supported!');
 634         }
 635         this._rollbackBackup = this.root.clone();
 636         this._currentTransaction = new Transaction([], metadata);
 637     },
 638
 639     endTransaction: function() {
 640         if(!this._currentTransaction) {
 641             throw new Error('End of transaction requested, but there is no transaction in progress!');
 642         }
 643         if(this._currentTransaction.hasTransformations()) {
 644             this.undoStack.push(this._currentTransaction);
 645             this.trigger('operationEnd');
 646         }
 647         this._currentTransaction = null;
 648     },
 649
 650     rollbackTransaction: function() {
 651         if(!this._currentTransaction) {
 652             throw new Error('Transaction rollback requested, but there is no transaction in progress!');
 653         }
 654         this.replaceRoot(this._rollbackBackup);
 655         this._rollbackBackup = null;
 656         this._currentTransaction = null;
 657         this._transformationLevel = 0;
 658     },
 659
 660     transaction: function(callback, params) {
 661         var toret;
 662         params = params || {};
 663         this.startTransaction(params.metadata);
 664         try {
 665             toret = callback.call(params.context || this);
 666         } catch(e) {
 667             if(params.error) {
 668                 params.error(e);
 669             }
 670             this.rollbackTransaction();
 671             return;
 672         }
 673         this.endTransaction();
 674         if(params.success) {
 675             params.success(toret);
 676         }
 677         return toret;
 678     },
 679
 680     getNodeByPath: function(path) {
 681         var toret = this.root;
 682         path.some(function(idx) {
 683             toret = toret.contents()[idx];
 684             if(!toret) {
 685                 return true;
 686             }
 687         });
 688         return toret;
 689     },
 690
 691     _defineDocumentProperties: function($document) {
 692         var doc = this;
 693         Object.defineProperty(doc, 'root', {get: function() {
 694             if(!$document) {
 695                 return null;
 696             }
 697             return doc.createDocumentNode($document[0]);
 698         }, configurable: true});
 699         Object.defineProperty(doc, 'dom', {get: function() {
 700             if(!$document) {
 701                 return null;
 702             }
 703             return $document[0];
 704         }, configurable: true});
 705     },
 706
 707     createFragment: function(Type, params) {
 708         if(!Type.prototype instanceof fragments.Fragment) {
 709             throw new Error('Can\'t create a fragment: `Type` is not a valid Fragment');
 710         }
 711         return new Type(this, params);
 712     }
 713 });
 714
 715 var Transaction = function(transformations, metadata) {
 716     this.transformations = transformations || [];
 717     this.metadata = metadata;
 718 };
 719 $.extend(Transaction.prototype, {
 720     pushTransformation: function(transformation) {
 721         this.transformations.push(transformation);
 722     },
 723     hasTransformations: function() {
 724         return this.transformations.length > 0;
 725     }
 726 });
 727
 728
 729 return {
 730     documentFromXML: function(xml) {
 731         var doc = new Document(xml);
 732         return doc;
 733     },
 734
 735     elementNodeFromXML: function(xml) {
 736         return this.documentFromXML(xml).root;
 737     },
 738
 739     Document: Document,
 740     DocumentNode: DocumentNode,
 741     ElementNode: ElementNode,
 742     TextNode: TextNode
 743 };
 744
 745 });