simplify code and add support for arbitrary file formats

Author: Christian Theilemann

index.js

@@ -12,64 +12,55 @@ module.exports = function (options) {
 		throw new gutil.PluginError('gulp-ui5-preload', '`base` parameter required');
 	}
 
-	var transformedContentsArr = [];
 	var firstFile;
+	var preloadModules = {};
 
-	function transformSingleFile(file, options) {
-
-		var ui5Path = (options.namespace ? options.namespace.split('.').join('/') + '/' : '' ) + path.relative(path.resolve(options.base), file.path);
-		var contents = file.contents.toString();
-
-		if (/\.js$/.test(ui5Path)) {
-			// Javascript file
-			contents = 'function() {' + contents + '}';
-		} else if (/\.xml$/.test(ui5Path)) {
-			// XML file
-			contents = contents.replace(/"/g, '\\"')
-				.replace(/'/g, '\\\'')
-				.replace(/(\r\n|\n|\r)/gm, '')
-				.replace(/\t+/gm, ' ');
-			contents = '\'' + contents + '\'';
-		}
-		contents = '\'' + ui5Path + '\': ' + contents;
-		return contents;
-	}
-
-	function collectAndTransformFileContentsFromStream(file, enc, done) {
+	function collectFileContentsFromStream(file, enc, done) {
 		// ignore empty files
-		if (file.isNull()) {return;}
+		if (file.isNull()) {
+			return;
+		}
 		// we dont do streams (yet)
 		if (file.isStream()) {
-			return this.emit('error', new PluginError('gulp-ui5-preload', 'Streaming not supported'));
+			return this.emit('error', new PluginError('gulp-ui5-preload', 'File Content streams not yet supported'));
+		}
+		if (!firstFile && file) {
+			firstFile = file;
 		}
-		if (!firstFile && file) {firstFile = file;}
 
 		try {
-			transformedContentsArr.push(transformSingleFile(file, options));
+
+			var resolvedPath = (options.namespace ? options.namespace.split('.').join('/') + '/' : '' ) + path.relative(path.resolve(options.base), file.path);
+			preloadModules[resolvedPath] = file.contents.toString();
+
 		} catch (err) {
 			this.emit('error', new gutil.PluginError('gulp-ui5-preload', err));
 		}
 		done();
 	}
 
-	function pushCombinedFilesToStream() {
-
-		gutil.log('gulp-ui5-preload', gutil.colors.magenta('number of files combined to preload file ' + options.fileName + ': ', transformedContentsArr.length));
+	function pushCombinedFileToStream() {
 
-		if (transformedContentsArr.length === 0) {
-			return this.emit('end');
-		}
+		gutil.log('gulp-ui5-preload',
+			gutil.colors.magenta(
+				'number of files combined to preload file ' + options.fileName + ': ',
+				Object.keys(preloadModules).length)
+		);
 
-		var contents = 'jQuery.sap.registerPreloadedModules({"name" : "' + options.namespace + '.Component-preload' + '",\n"version" : "2.0",' +
-			'"modules" : {' + transformedContentsArr.join(',\n') + '}});';
+		var contents = 'jQuery.sap.registerPreloadedModules(' + JSON.stringify(
+				{
+					name: options.namespace + '.Component-preload',
+					version: '2.0',
+					modules: preloadModules
+				}, null, '\t') + ');';
 
 		var preloadFile = firstFile.clone({contents: false});
-		preloadFile.path = path.join(firstFile.base, options.fileName);
 		preloadFile.contents = new Buffer(contents);
+		preloadFile.path = path.join(firstFile.base, options.fileName);
 
 		this.push(preloadFile);
 		this.emit('end');
 	}
 
-	return through.obj(collectAndTransformFileContentsFromStream, pushCombinedFilesToStream);
+	return through.obj(collectFileContentsFromStream, pushCombinedFileToStream);
 };

package.json

@@ -2,7 +2,7 @@
   "name": "gulp-ui5-preload",
   "version": "1.0.2",
   "description": "Creates a Component-preload.js file for openui5 / sapui5 projects.",
-  "license": "MIT",
+  "license": "Apache 2.0",
   "repository": "geekflyer/gulp-ui5-preload",
   "author": {
     "name": "Christian Theilemann",

readme.md

@@ -1,6 +1,6 @@
 # gulp-ui5-preload [![Build Status](https://travis-ci.org/geekflyer/gulp-ui5-preload.svg?branch=master)](https://travis-ci.org/geekflyer/gulp-ui5-preload) [![npm version](https://badge.fury.io/js/gulp-ui5-preload.svg)](http://badge.fury.io/js/gulp-ui5-preload)
 
-Creates a Component-preload.js file for openui5 / sapui5 projects. Supports .js and .xml artifacts.
+Creates a Component-preload.js file for openui5 / sapui5 projects. Creating a prelaod file can speed up the initial load time of your webapp, by reducing the number of HTTP requests / roundtrips to load your code. The preload file can combine your `js` artifacts, `xml`,`js`, `html` and `json` views as well as `.properties` files into a single `Component-preload.js` file.
 
 ## Install
 
@@ -75,12 +75,6 @@ The namespace at the `base` path. All source files are treated as sub-namespaces
 
 File name of the combined file to emit.
 
-
-## Limitations
-
-`.json` and `.html` views are not yet supported. Please open an issue or make a pull request if you need them. Implementation should be fairly easy - just a few LoC in the function `transformSingleFile`.
-
-
 ## License
 
 Apache 2.0 © [Christian Theilemann](https://github.com/geekflyer)

test.js

@@ -6,7 +6,7 @@ var lab = exports.lab = require('lab').script();
 
 lab.test('creates a preload file full of unicorns and zebras :-)', function (done) {
 	var stream = ui5Preload({base: 'src/conf/ui', namespace: 'sap.pdms.fdn'});
-	var expectedFile = 'jQuery.sap.registerPreloadedModules({"name" : "sap.pdms.fdn.Component-preload",\n"version" : "2.0","modules" : {\'sap/pdms/fdn/app/unicorns.js\': function() {unicorns},\n\'sap/pdms/fdn/app/zebras.xml\': \'zebras\'}});';
+	var expectedFile = 'jQuery.sap.registerPreloadedModules({\n\t"name": "sap.pdms.fdn.Component-preload",\n\t"version": "2.0",\n\t"modules": {\n\t\t"sap/pdms/fdn/app/unicorns.js": "unicorns",\n\t\t\"sap/pdms/fdn/app/zebras.xml": "zebras"\n\t}\n});';
 
 	stream.write(new gutil.File({
 		base: __dirname,