Merge pull request #127 from jrit/cheerio-node-12

XML support
Automattic · May 21, 2015 · e0ac5d6 · e0ac5d6
2 parents 73296c2 + d3dfb48
commit e0ac5d6
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 10 deletions.
diff --git a/History.md b/History.md
@@ -1,3 +1,8 @@
+1.2.0 / 2015-05-21
+==================
+
+* Add `xmlMode` option
+
 1.1.2 / 2015-05-08
 ==================
 

diff --git a/README.md b/README.md
@@ -52,6 +52,7 @@ All juice methods take an options object that can contain any of these propertie
  * `applyAttributesTableElements` - whether to create attributes for styles in `juice.styleToAttribute` on elements set in `juice.tableElements`. Defaults to `false`.
  * `webResources` - An options object that will be passed to [web-resource-inliner](https://www.npmjs.com/package/web-resource-inliner) for juice functions that will get remote resources (`juiceResources` and `juiceFile`). Defaults to `{}`.
  * `inlinePseudoElements` - Whether to insert pseudo elements (`::before` and `::after`) as `<span>` into the DOM. *Note*: Inserting pseudo elements will modify the DOM and may conflict with CSS selectors elsewhere on the page (e.g., `:last-child`).
+ * `xmlMode` - whether to output XML/XHTML with all tags closed. Note that the input *must* also be valid XML/XHTML or you will get undesirable results. Defaults to `false`.
 
 ### Methods
 

diff --git a/lib/juice.js b/lib/juice.js
@@ -6,8 +6,13 @@
  */
 
 var juice = function (html,options) {
-  var $ = utils.cheerio(html);
-  return juiceDocument($,options).html();
+  var $ = utils.cheerio(html, { xmlMode: options && options.xmlMode});
+  doc = juiceDocument($,options)
+
+  if (options && options.xmlMode)
+    return doc.xml();
+  else
+    return doc.html();
 };
 
 module.exports = juice;
@@ -295,9 +300,13 @@ function juiceResources(html, options, callback) {
       return callback(err);
     }
 
-    var $ = utils.cheerio(html);
+    var $ = utils.cheerio(html, { xmlMode: options && options.xmlMode});
     juiceDocument($, options);
-    callback(null, $.html());
+
+    if (options.xmlMode)
+      callback(null, $.xml());
+    else
+      callback(null, $.html());
   };
 
   options.webResources.relativeTo = options.webResources.relativeTo || options.url; //legacy support
@@ -334,9 +343,13 @@ function juiceFile(filePath, options, callback) {
 }
 
 function inlineContent(html, css, options) {
-    var $ = utils.cheerio(html);
+    var $ = utils.cheerio(html, { xmlMode: options && options.xmlMode});
     inlineDocument($, css, options);
-    return $.html();
+
+    if (options && options.xmlMode)
+      return $.xml();
+    else
+      return $.html();
 }
 
 function getStylesData($, options) {
@@ -372,4 +385,3 @@ function extractCssFromDocument($, options) {
   var css = results.join("\n");
   return css;
 }
-
diff --git a/lib/utils.js b/lib/utils.js
@@ -136,8 +136,9 @@ exports.getMediaQueryText = function ( css )
  * api public
  */
 
-exports.cheerio = function (html) {
-  return cheerio.load(html,{decodeEntities: false});
+exports.cheerio = function (html, options) {
+  options = exports.extend({decodeEntities: false}, options || {});
+  return cheerio.load(html,options);
 };
 
 exports.inlineExternal = function (html, inlineOptions, callback){

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "juice",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Inlines css into html source",
   "bin": "./bin/juice",
   "main": "./lib/juice",

diff --git a/test/cases/juice-content/xml.css b/test/cases/juice-content/xml.css
diff --git a/test/cases/juice-content/xml.html b/test/cases/juice-content/xml.html
@@ -0,0 +1,9 @@
+<html>
+<head>
+    <meta name="name" content="value" />
+</head>
+<body>
+    hello<br />
+    <img src="" />
+</body>
+</html>
diff --git a/test/cases/juice-content/xml.json b/test/cases/juice-content/xml.json
@@ -0,0 +1,4 @@
+{
+    "url": "./",
+    "xmlMode": true
+}
diff --git a/test/cases/juice-content/xml.out b/test/cases/juice-content/xml.out
@@ -0,0 +1,9 @@
+<html>
+<head>
+    <meta name="name" content="value"/>
+</head>
+<body>
+    hello<br/>
+    <img src=""/>
+</body>
+</html>
diff --git a/test/cases/not-xhtml.css b/test/cases/not-xhtml.css
@@ -0,0 +1 @@
+
diff --git a/test/cases/not-xhtml.html b/test/cases/not-xhtml.html
@@ -0,0 +1 @@
+<br>
diff --git a/test/cases/not-xhtml.out b/test/cases/not-xhtml.out
@@ -0,0 +1 @@
+<br>