0.1.11

.travis.yml

@@ -1,4 +1,6 @@
 language: node_js
+node_js:
+  - "iojs"
 notifications:
   email:
     on_success: change

lib/index.js

@@ -1,56 +1,63 @@
-var _ = require('lodash');
 var co = require('co');
-var cheerio = require('cheerio');
 var fs = require('mz/fs');
 var inlineStyle = require('./inline-style');
 var inlineImg = require('./inline-img');
-var inlineLinkLess = require('./inline-link-less');
+var inlineLess = require('./inline-less');
+var R = require('ramda');
+var Ru = require('@panosoft/ramda-utils');
 
-var inline = co.wrap(function * (html, options) {
-	options = _.defaults(options || {}, {
+/**
+ * Embed referenced local assets within and HTML file.
+ *
+ * @param {String} html
+ *         Filename or html string.
+ * @param {Object} options
+ *
+ * @return {Promise}
+ */
+var inlineHtml = co.wrap(function * (html, options) {
+	options = Ru.defaults({
 		filename: null,
 		less: {},
 		verbose: false
-	});
+	}, options || {});
 	var filename;
 	try {
 		filename = html;
 		html = yield fs.readFile(filename, 'utf8');
 	}
 	catch (error) {
-		if (error.code === 'ENOENT') {
-			filename = options.filename;
-		}
-		else {
-			throw error;
-		}
+		if (error.code === 'ENOENT') filename = options.filename;
+		else throw error;
 	}
+
+	// Embed assets
 	var files = [filename];
+	try {
+		var lessResult = yield inlineLess(html, filename, options.less);
+		html = lessResult.html;
+		files = R.concat(files, lessResult.files);
 
-	// Inline links
-	var lessResult = yield inlineLinkLess(html, filename, options.less);
-	html = lessResult.html;
-	files.push(lessResult.files);
+		var styleResult = inlineStyle(html, filename);
+		html = styleResult.html;
+		files = R.concat(files, styleResult.files);
 
-	// TODO inline links: css
-
-	// TODO inline scripts
-	// browserify js? => scriptify
-
-	// Inline paths -> datauris
-	var styleResult = inlineStyle(html, filename); // Inline styles
-	html = styleResult.html;
-	files.push(styleResult.files);
-
-	var imgResult = inlineImg(html, filename); // Inline images
-	html = imgResult.html;
-	files.push(imgResult.files);
+		var imgResult = inlineImg(html, filename);
+		html = imgResult.html;
+		files = R.concat(files, imgResult.files);
+	}
+	catch (error) {
+		if (!error.filename) error.filename = filename;
+		error.files = R.uniq(R.concat(files, error.files || []));
+		throw error;
+	}
 
+	files = R.uniq(files);
 	var result = {
-		html: html,
-		files: _.unique(_.flatten(files, true))
+		html,
+		files
 	};
 	return (options.verbose ? result : result.html);
 });
 
-module.exports = inline;
+module.exports = inlineHtml;

lib/inline-css-url.js

@@ -1,9 +1,10 @@
-var _ = require('lodash');
 var datauri = require('datauri');
 var isLocalPath = require('is-local-path');
+var isTemplateExpression = require('./is-template-expression');
 var path = require('path');
 var postcss = require('postcss');
 var postcssUrl = require('postcss-url');
+var R = require('ramda');
 var url = require('url');
 
 /**
@@ -15,8 +16,10 @@ var url = require('url');
  */
 var clean = function (path) {
 	path = url.parse(path);
-	path = _.pick(path, ['protocol', 'host', 'pathname']);
-	return url.format(path);
+	path = R.pick(['protocol', 'host', 'pathname'], path);
+	path = url.format(path);
+	path = decodeURI(path);
+	return path;
 };
 /**
  * Convert local url data type paths to datauris.
@@ -25,26 +28,34 @@ var clean = function (path) {
  * @param filename
  * @returns {{css: (css|any), files: Array}}
  */
-var inline = function (css, filename) {
+var inlineUrl = function (css, filename) {
 	var files = [];
 	var basePath = path.dirname(filename);
 	var result = postcss()
 		.use(postcssUrl({
 			url: function (urlPath) {
-				if (isLocalPath(urlPath)) {
-					urlPath = clean(urlPath);
-					urlPath = path.resolve(basePath, urlPath);
-					files.push(urlPath);
-					urlPath = datauri(urlPath);
+				if (isLocalPath(urlPath) && !isTemplateExpression(urlPath)) {
+					try {
+						urlPath = clean(urlPath);
+						urlPath = path.resolve(basePath, urlPath);
+						files = R.append(urlPath, files);
+						urlPath = datauri(urlPath);
+					}
+					catch (error) {
+						error.filename = filename;
+						error.files = R.uniq(files);
+						throw error;
+					}
 				}
 				return urlPath;
 			}
 		}))
 		.process(css);
+	files = R.uniq(files);
 	return {
 		css: result.css,
-		files: files
+		files
 	};
 };
 
-module.exports = inline;
+module.exports = inlineUrl;

lib/inline-img.js

@@ -1,25 +1,36 @@
 var cheerio = require('cheerio');
 var datauri = require('datauri');
 var isLocalPath = require('is-local-path');
+var isTemplateExpression = require('./is-template-expression');
 var path = require('path');
+var R = require('ramda');
 
 var inline = function (html, filename) {
 	var files = [];
 	var basedir = path.dirname(filename);
 	var $ = cheerio.load(html, {decodeEntities: false});
-	var images = $('img').filter(function (index, element) {
-		return isLocalPath($(element).attr('src'));
-	});
-	images.each(function (index, element) {
-		var src = $(element).attr('src');
-		var filename = path.resolve(basedir, src);
-		files.push(filename);
-		src = datauri(filename);
-		$(element).attr('src', src);
+	var $images = $('img').filter((index, element) => {
+		var path = $(element).attr('src');
+		return isLocalPath(path) && !isTemplateExpression(path);
 	});
+	try {
+		$images.each((index, element) => {
+			var source = $(element).attr('src');
+			var filename = path.resolve(basedir, source);
+			files = R.append(filename, files);
+			var uri = datauri(filename);
+			$(element).attr('src', uri);
+		});
+	}
+	catch (error) {
+		error.filename = filename;
+		error.files = R.uniq(files);
+		throw error;
+	}
+	files = R.uniq(files);
 	return {
 		html: $.xml(),
-		files: files
+		files
 	};
 };
 

lib/inline-less.js

@@ -0,0 +1,67 @@
+var co = require('co');
+var cheerio = require('cheerio');
+var fs = require('mz/fs');
+var isLocalPath = require('is-local-path');
+var less = require('less');
+var path = require('path');
+var R = require('ramda');
+var Ru = require('@panosoft/ramda-utils');
+
+var render = co.wrap(function * (filename, options) {
+	options = R.merge(options || {}, { filename });
+	var contents = yield fs.readFile(filename, 'utf8');
+	return yield less.render(contents, options);
+});
+/**
+ * @param {String} html
+ * 	HTML source to inline
+ * @param {String} filename
+ * 	Filename to apply to the HTML source being inlined
+ * @param {Object} options
+ * 	LESS compiler options
+ */
+var inlineLess = co.wrap(function * (html, filename, options) {
+	options = Ru.defaults({
+		relativeUrls: true
+	}, options || {});
+	var basedir = path.dirname(filename);
+
+	// get links
+	var $ = cheerio.load(html, {decodeEntities: false});
+	var $links = $('link[rel="stylesheet/less"]')
+		.filter((index, element) => isLocalPath($(element).attr('href')));
+
+	// render LESS stylesheets
+	var files = [];
+	var outputs = [];
+	try {
+		$links.each((index, element) => {
+			var href = $(element).attr('href');
+			var filename = path.resolve(basedir, href);
+			files = R.append(filename, files);
+			outputs = R.append(render(filename, options), outputs);
+		});
+		outputs = yield outputs;
+	}
+	catch (error) {
+		if (!error.filename) error.filename = filename;
+		error.files = R.uniq(files);
+		throw error;
+	}
+
+	// include imported filenames in files array
+	files = R.concat(files, R.flatten(R.map(output => output.imports, outputs)));
+	files = R.uniq(files);
+
+	// replace links
+	$links.each((index, element) => {
+		var style = $('<style>').html(outputs[index].css);
+		$(element).replaceWith(style);
+	});
+
+	return {
+		html: $.xml(),
+		files
+	};
+});
+module.exports = inlineLess;

lib/inline-link-less.js

@@ -1,64 +0,0 @@
-var _ = require('lodash');
-var co = require('co');
-var cheerio = require('cheerio');
-var fs = require('mz/fs');
-var isLocalPath = require('is-local-path');
-var less = require('less');
-var path = require('path');
-var url = require('url');
-
-var render = co.wrap(function * (filename, options) {
-	options = _.assign(options || {}, {
-		filename: filename
-	});
-	var contents = yield fs.readFile(filename, 'utf8');
-	return yield less.render(contents, options);
-});
-/**
- * @params html
- * 	HTML to inline
- * @params options
- * 	LESS compiler options
- */
-var inline = co.wrap(function * (html, filename, options) {
-	var files = [];
-	var basedir = path.dirname(filename);
-	options = _.defaults(options || {}, {
-		relativeUrls: true
-	});
-
-	// TODO Import less links
-	// get links
-	var $ = cheerio.load(html, {decodeEntities: false});
-	var links = $('link[rel="stylesheet/less"]')
-		.filter(function (index, element) {
-			return isLocalPath($(element).attr('href'));
-		});
-
-	// render stylesheets
-	var outputs = [];
-	links.each(function (index, element) {
-		var href = $(element).attr('href');
-		var filename = path.resolve(basedir, href);
-		files.push(filename);
-		outputs.push(render(filename, options));
-	});
-	outputs = yield outputs;
-
-	// replace links
-	links.each(function (index, element) {
-		var style = $('<style>').html(outputs[index].css);
-		$(element).replaceWith(style);
-	});
-
-	// create list of imported files from all outputs, unique listing
-	files.push(_.map(outputs, function (output) {
-		return output.imports;
-	}));
-
-	return {
-		html: $.xml(),
-		files: files
-	};
-});
-module.exports = inline;

lib/inline-style.js

@@ -1,5 +1,6 @@
 var cheerio = require('cheerio');
 var inlineUrl = require('./inline-css-url');
+var R = require('ramda');
 var string = require('string');
 
 var prefix = 'element {';
@@ -11,34 +12,43 @@ var unwrap = function (value) {
 	var regexp = new RegExp('^' + prefix + '\\s*(.*)\\s*' + suffix + '$');
 	return value.replace(regexp, '$1');
 };
-var inline = function (html, filename) {
+var inlineStyle = function (html, filename) {
 	var files = [];
 	var $ = cheerio.load(html, {decodeEntities: false});
-	// style elements
-	var styles = $('style');
-	styles.each(function (index, element) {
-		var css = $(element).html();
-		var result = inlineUrl(css, filename);
-		files.push(result.files);
-		$(element).html(result.css);
-	});
 
-	// style attributes
-	var attributes = $('*').filter('[style]');
-	attributes.each(function (index, element) {
-		var css = $(element).attr('style');
-		css = wrap(css);
-		var result = inlineUrl(css, filename);
-		files.push(result.files);
-		css = string(result.css).collapseWhitespace().toString();
-		css = unwrap(css);
-		$(element).attr('style', css);
-	});
+	try {
+		// style elements
+		var $styles = $('style');
+		$styles.each((index, element) => {
+			var css = $(element).html();
+			var result = inlineUrl(css, filename);
+			files = R.concat(files, result.files);
+			$(element).html(result.css);
+		});
 
+		// style attributes
+		var $attributes = $('*').filter('[style]');
+		$attributes.each((index, element) => {
+			var css = $(element).attr('style');
+			css = wrap(css);
+			var result = inlineUrl(css, filename);
+			files = R.concat(files, result.files);
+			css = string(result.css).collapseWhitespace().toString();
+			css = unwrap(css);
+			$(element).attr('style', css);
+		});
+	}
+	catch (error) {
+		if (!error.filename) error.filename = filename;
+		error.files = R.uniq(R.concat(files, error.files || []));
+		throw error;
+	}
+
+	files = R.uniq(files);
 	return {
 		html: $.xml(),
-		files: files
+		files
 	};
 };
 
-module.exports = inline;
+module.exports = inlineStyle;

lib/is-template-expression.js

@@ -0,0 +1,14 @@
+/**
+ * Tests whether a path is a mustache template expression.
+ *
+ * Note: would be best if this was file extension specific
+ * (i.e. *.hbs => test for `{{ }}` )
+ *
+ * @param {String} path
+ * @return {Boolean}
+ */
+var isTemplateExpression = function (path) {
+	return /^{{.*}}$/.test(path);
+};
+
+module.exports = isTemplateExpression;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "inline-html",
-  "version": "0.1.8",
+  "version": "0.1.11",
   "description": "Inline local assets referenced in an HTML document.",
   "repository": "panosoft/inline-html",
   "main": "lib/index.js",
@@ -10,15 +10,16 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
+    "@panosoft/ramda-utils": "^0.1.12",
     "cheerio": "^0.19.0",
     "co": "^4.6.0",
     "datauri": "^0.7.1",
     "is-local-path": "^0.1.0",
     "less": "^2.5.1",
-    "lodash": "^3.10.0",
     "mz": "^2.0.0",
     "postcss": "^5.0.0",
-    "postcss-url": "^4.0.0",
+    "postcss-url": "^5.0.0",
+    "ramda": "^0.17.1",
     "string": "^3.3.0"
   },
   "devDependencies": {

test/fixtures/errors/lessImport/index.html

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <link rel="stylesheet/less" href="main.less" />
+</head>
+<body></body>
+</html>

test/fixtures/errors/lessImport/main.less

@@ -0,0 +1 @@
+@import (less) 'missing.css';

test/fixtures/errors/lessSyntax/index.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <link rel="stylesheet/less" href="main.less" />
+</head>
+<body>
+
+</body>
+</html>

test/fixtures/errors/lessSyntax/main.less

@@ -0,0 +1 @@
+div {

test/fixtures/errors/lessUrl/index.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <link rel="stylesheet/less" href="main.less" />
+</head>
+<body>
+
+</body>
+</html>

test/fixtures/errors/lessUrl/main.less

@@ -0,0 +1,3 @@
+div {
+  background-image: url('missing.png');
+}

test/fixtures/file space.txt

@@ -0,0 +1 @@
+Test.

test/index.js

@@ -1,9 +1,10 @@
-var inline = require('../lib');
+var co = require('co');
+var datauri = require('datauri');
 var expect = require('chai')
 	.use(require('chai-as-promised'))
 	.expect;
-var datauri = require('datauri');
 var fs = require('fs');
+var inline = require('../lib');
 var path = require('path');
 
 describe('inlineHtml', function () {
@@ -152,6 +153,14 @@ describe('inlineHtml', function () {
 		var html = `<img src="http://test.com/file.txt?query=string#hash"/>`;
 		return expect(inline(html)).to.eventually.equal(html);
 	});
+	it('ignore css url template expression paths', function () {
+		var html = `<style> div { background-image: url({{path}}); }</style>`;
+		return expect(inline(html)).to.eventually.equal(html);
+	});
+	it('ignore img src template expression paths', function () {
+		var html = `<img src="{{path}}"/>`;
+		return expect(inline(html)).to.eventually.equal(html);
+	});
 	it('ignore query strings and hashes on local paths', function () {
 		var filename = path.resolve(__dirname, 'fixtures/file.txt');
 		var url = `${filename}?query=string#hash`;
@@ -159,5 +168,152 @@ describe('inlineHtml', function () {
 		var html = (source) => `<style> div { background-image: url('${source}'); }</style>`;
 		return expect(inline(html(url))).to.eventually.equal(html(uri));
 	});
+	it('handle assets with a space in their filename', function () {
+		var filename = path.resolve(__dirname, 'fixtures/file space.txt');
+		var uri = datauri(filename);
+		var html = (source) => `<style> div { background-image: url('${source}'); }</style>`;
+		return expect(inline(html(filename))).to.eventually.equal(html(uri));
+	});
 
+	// Error handling
+	// inline-img
+	it('throw error when html image source invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'index.html');
+			var source = 'missing.png';
+			var html = `<img src="${source}" >`;
+			var resolvedSource = path.resolve(path.dirname(filename), source);
+			try {
+				yield inline(html, {filename});
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(filename);
+				expect(error).to.have.property('files').that.contains(resolvedSource);
+			}
+		});
+	});
+	// inline-style
+	it('throw error when html style attribute syntax invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'index.html');
+			var html = `<div style="background url()"></div>`;
+			try {
+				yield inline(html, {filename});
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(filename);
+				expect(error).to.have.property('files').that.contains(filename);
+			}
+		});
+	});
+	it('throw error when html style attribute url invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'index.html');
+			var url = 'missing.png';
+			var resolvedUrl = path.resolve(path.dirname(filename), url);
+			var html = `<div style="background-image: url('${url}')"></div>`;
+			try {
+				yield inline(html, {filename});
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(filename);
+				expect(error).to.have.property('files').that.contains(resolvedUrl);
+			}
+		});
+	});
+	it('throw error when html style syntax invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'index.html');
+			var html = `<style>div {</style>`;
+			try {
+				yield inline(html, {filename});
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(filename);
+				expect(error).to.have.property('files').that.contains(filename);
+			}
+		});
+	});
+	it('throw error when html style url invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'index.html');
+			var url = 'missing.png';
+			var resolvedUrl = path.resolve(path.dirname(filename), url);
+			var html = `<style>div { background-image: url('${url}'); }</style>`;
+			try {
+				yield inline(html, {filename});
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(filename);
+				expect(error).to.have.property('files').that.contains(resolvedUrl);
+			}
+		});
+	});
+	// inline-link-less
+	it('throw error when link href invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'index.html');
+			var href = 'missing.less';
+			var resolvedHref = path.resolve(path.dirname(filename), href);
+			var html = `<link rel="stylesheet/less" href="${href}">`;
+			try {
+				yield inline(html, {filename});
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(filename);
+				expect(error).to.have.property('files').that.contains(resolvedHref);
+			}
+		});
+	});
+	it('throw error when less import invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'fixtures/errors/lessImport/index.html');
+			var lessFilename = path.resolve(path.dirname(filename), 'main.less');
+			try {
+				yield inline(filename);
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(lessFilename);
+				expect(error).to.have.property('files').that.contains(lessFilename);
+			}
+		});
+	});
+	it('throw error when less syntax invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'fixtures/errors/lessSyntax/index.html');
+			var lessFilename = path.resolve(path.dirname(filename), 'main.less');
+			try {
+				yield inline(filename);
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				expect(error).to.have.property('filename').that.equals(lessFilename);
+				expect(error).to.have.property('files').that.contains(lessFilename);
+			}
+		});
+	});
+	it('throw error when less url invalid', () => {
+		return co(function * () {
+			var filename = path.resolve(__dirname, 'fixtures/errors/lessUrl/index.html');
+			var lessFilename = path.resolve(path.dirname(filename), 'main.less');
+			var badUrl = path.resolve(path.dirname(filename), 'missing.png');
+			try {
+				yield inline(filename);
+				throw new Error('No error thrown');
+			}
+			catch (error) {
+				// expect error.filename to be html file, not less file, since images
+				// aren't inlined until after the compiled less has been inlined into the html.
+				expect(error).to.have.property('filename').that.equals(filename);
+				expect(error).to.have.property('files').that.contains(badUrl);
+			}
+		});
+	});
 });