Merge pull request #230 from mobify/v2.0-rename-method

Renames "escapedHTMLString" to "enabledHTMLString"
mobify · Mar 4, 2014 · 3a9aa47 · 3a9aa47
2 parents fbe2ed1 + 61544ac
commit 3a9aa47
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 17 deletions.
diff --git a/build/mobify.js b/build/mobify.js
@@ -410,9 +410,10 @@ Capture.prototype.createDocumentFragments = function() {
 };
 
 /**
- * Returns an escaped HTML representation of the captured DOM
+ * Returns an HTML representation of the captured DOM with resources enabled.
+ * (escapedHTMLString remains for backwards compatibility)
  */
-Capture.prototype.escapedHTMLString = function() {
+Capture.prototype.enabledHTMLString = Capture.prototype.escapedHTMLString = function() {
     var doc = this.capturedDoc;
     var html = Capture.enable(Utils.outerHTML(doc.documentElement), this.prefix);
     var htmlWithDoctype = this.doctype + html;
@@ -423,11 +424,11 @@ Capture.prototype.escapedHTMLString = function() {
  * Rewrite the document with a new html string
  */
 Capture.prototype.render = function(htmlString) {
-    var escapedHTMLString;
+    var enabledHTMLString;
     if (!htmlString) {
-        escapedHTMLString = this.escapedHTMLString();
+        enabledHTMLString = this.enabledHTMLString();
     } else {
-        escapedHTMLString = Capture.enable(htmlString, this.prefix);
+        enabledHTMLString = Capture.enable(htmlString, this.prefix);
     }
 
     var doc = this.sourceDoc;
@@ -438,7 +439,7 @@ Capture.prototype.render = function(htmlString) {
     // Asynchronously render the new document
     setTimeout(function(){
         doc.open("text/html", "replace");
-        doc.write(escapedHTMLString);
+        doc.write(enabledHTMLString);
         doc.close();
     });
 };

diff --git a/build/mobify.min.js b/build/mobify.min.js
diff --git a/src/capture.js b/src/capture.js
@@ -409,9 +409,10 @@ Capture.prototype.createDocumentFragments = function() {
 };
 
 /**
- * Returns an escaped HTML representation of the captured DOM
+ * Returns an HTML representation of the captured DOM with resources enabled.
+ * (escapedHTMLString remains for backwards compatibility)
  */
-Capture.prototype.escapedHTMLString = function() {
+Capture.prototype.enabledHTMLString = Capture.prototype.escapedHTMLString = function() {
     var doc = this.capturedDoc;
     var html = Capture.enable(Utils.outerHTML(doc.documentElement), this.prefix);
     var htmlWithDoctype = this.doctype + html;
@@ -422,11 +423,11 @@ Capture.prototype.escapedHTMLString = function() {
  * Rewrite the document with a new html string
  */
 Capture.prototype.render = function(htmlString) {
-    var escapedHTMLString;
+    var enabledHTMLString;
     if (!htmlString) {
-        escapedHTMLString = this.escapedHTMLString();
+        enabledHTMLString = this.enabledHTMLString();
     } else {
-        escapedHTMLString = Capture.enable(htmlString, this.prefix);
+        enabledHTMLString = Capture.enable(htmlString, this.prefix);
     }
 
     var doc = this.sourceDoc;
@@ -437,7 +438,7 @@ Capture.prototype.render = function(htmlString) {
     // Asynchronously render the new document
     setTimeout(function(){
         doc.open("text/html", "replace");
-        doc.write(escapedHTMLString);
+        doc.write(enabledHTMLString);
         doc.close();
     });
 };

diff --git a/tests/capture.html b/tests/capture.html
@@ -135,7 +135,7 @@
 \n\
 \n\
 \n</body></html>";
-                    var html = capture.escapedHTMLString(capturedDoc);
+                    var html = capture.enabledHTMLString(capturedDoc);
                     equal(html, expectedHtml, "Passed!");
                     start();
                 }, doc);

diff --git a/www/_includes/nav-docsv2.md b/www/_includes/nav-docsv2.md
@@ -5,7 +5,7 @@
     - [`Capture.init()`]({{ site.baseurl }}/v2/docs/capturing/#captureinitcallback-document-prefixx-)
     - [`getCapturedDoc()`]({{ site.baseurl }}/v2/docs/capturing/#getcaptureddoc)
     - [`capturing` variable]({{ site.baseurl }}/v2/docs/capturing/#capturing-variable)
-    - [`escapedHTMLString()`]({{ site.baseurl }}/v2/docs/capturing/#escapedhtmlstring)
+    - [`enabledHTMLString()`]({{ site.baseurl }}/v2/docs/capturing/#enabledhtmlstring)
     - [`render(htmlString)`]({{ site.baseurl }}/v2/docs/capturing/#renderhtmlstring)
     - [`renderCapturedDoc()`]({{ site.baseurl }}/v2/docs/capturing/#rendercaptureddoc)
     - [`restore()`]({{ site.baseurl }}/v2/docs/capturing/#restore)

diff --git a/www/v2/docs/capturing.md b/www/v2/docs/capturing.md
@@ -93,7 +93,7 @@ Mobify.js is run again in a non-capturing context (at this time
     }
 
 
-## `escapedHTMLString()`
+## `enabledHTMLString()`
 
 Returns a string representation of the `captured document`, but with
 all resources enabled (prefix removed). Can be considered an
@@ -102,7 +102,7 @@ alternative to `capturedDoc.outerHTML`.
 **Usage/Example:**
 
     Mobify.Capture.init(function(capture){
-        var htmlString = capture.escapedHTMLString();
+        var htmlString = capture.enabledHTMLString();
     });
 
 ## `render(htmlString)`