[t663] - html snapshotting for export

1. Added _page to butter to expose functions 2. Added data-butter-exclude to dialog modal container 3. Added snapshotHTML/eraseSnapshot functions in Page class 4. Added test for html snapshotting
brianchirls · Apr 16, 2012 · 58b0af7 · 58b0af7
1 parent 3a6cc3e
commit 58b0af7
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 4 deletions.
diff --git a/config/default.conf b/config/default.conf
@@ -1,5 +1,6 @@
 {
   "name": "default-butter-test",
+  "snapshotHTMLOnReady": true,
   "editor": {
     "default": "../editors/default-editor.html"
   },

diff --git a/src/core/page.js b/src/core/page.js
@@ -80,10 +80,18 @@ define( [ "core/logger", "core/eventmanager" ], function( Logger, EventManager )
     };
 
     this.getHTML = function( popcornStrings ){
-      var html = document.createElement( "html" ),
-          head = document.getElementsByTagName( "head" )[ 0 ].cloneNode( true ),
-          body = document.getElementsByTagName( "body" )[ 0 ].cloneNode( true ),
-          i, toClean, toExclude, node;
+      var html, head, body, i, toClean, toExclude, node;
+
+      html = document.createElement( "html" );
+
+      if( !_snapshot ){
+        head = document.getElementsByTagName( "head" )[ 0 ].cloneNode( true );
+        body = document.getElementsByTagName( "body" )[ 0 ].cloneNode( true );
+      }
+      else{
+        head = _snapshot.head.cloneNode( true );
+        body = _snapshot.body.cloneNode( true );
+      }          
 
       toExclude = Array.prototype.slice.call( head.querySelectorAll( "*[data-butter-exclude]" ) );
       toExclude = toExclude.concat( Array.prototype.slice.call( head.querySelectorAll( "*[data-requiremodule]" ) ) );
@@ -97,6 +105,7 @@ define( [ "core/logger", "core/eventmanager" ], function( Logger, EventManager )
         node = toClean[ i ];
         node.removeAttribute( "butter-clean" );
         node.removeAttribute( "data-butter" );
+        node.removeAttribute( "data-butter-default" );
 
         // obviously, classList is preferred (https://developer.mozilla.org/en/DOM/element.classList)
         if( node.classList ){
@@ -128,5 +137,16 @@ define( [ "core/logger", "core/eventmanager" ], function( Logger, EventManager )
       return "<html>" + html.innerHTML + "</html>";
     }; //getHTML
 
+    this.snapshotHTML = function(){
+      _snapshot = {
+        head: document.getElementsByTagName( "head" )[ 0 ].cloneNode( true ),
+        body: document.getElementsByTagName( "body" )[ 0 ].cloneNode( true )
+      };
+    };
+
+    this.eraseSnapshot = function(){
+      _snapshot = null;
+    };
+
   }; // page
 });
diff --git a/src/dialog/modal.js b/src/dialog/modal.js
@@ -11,6 +11,7 @@ define( [], function(){
     if( !__container ){
       __container = document.createElement( "div" );
       __container.id = "butter-modal-container";
+      __container.setAttribute( "data-butter-exclude", true );
       document.body.appendChild( __container );
     } //if
 

diff --git a/src/main.js b/src/main.js
@@ -566,6 +566,11 @@
         //prepare the page next
         preparePage(function(){
           moduleCollection.ready(function(){
+
+            if( _config.snapshotHTMLOnReady ){
+              _page.snapshotHTML();
+            }
+
             //fire the ready event
             _em.dispatch( "ready", _this );
           });
@@ -600,6 +605,8 @@
         readConfig();
       } //if
 
+      this.page = _page;
+
     }
 
     Butter.instances = __instances;

diff --git a/test/core.js b/test/core.js
@@ -612,6 +612,30 @@
     });
   });
 
+  asyncTest( "Export HTML snapshotting", function() {
+    expect( 1 );
+    createButter( function( butter ){
+      var m1 = butter.addMedia( { url:"../external/popcorn-js/test/trailer.ogv", target:"mediaDiv" } );
+
+      butter.listen( "mediaready", function( e ) {
+        butter.page.snapshotHTML();
+
+        t1 = m1.addTrack();
+        te1 = t1.addTrackEvent({
+          popcornOptions: {
+            start: 0,
+            end: 6,
+            text: "OBVIOUS",
+            target: "stringSanity"
+          },
+          type: "footnote"
+        });
+
+        equals( butter.getHTML().match( "OBVIOUS" ).length, 1, "TrackEvent wasn't exported" );
+        start();
+      });
+    });
+  });
   module( "Debug functionality" );
   asyncTest( "Debug enables/disables logging", 4, function() {
     createButter(function( butter ) {
@@ -638,4 +662,5 @@
       butter.addMedia({ url: "../external/popcorn-js/test/trailer.ogv", target: "mediaDiv" });
     });
   });
+
 })(window, window.document );