Merge pull request #25 from SAP/exclude-dest-file

Always exclude corresponding preload files

Gruntfile.js

@@ -29,7 +29,11 @@ module.exports = function(grunt) {
 
 		// Before generating any new files, remove any previously-created files.
 		clean: {
-			tests: ['tmp']
+			tests: [
+				'tmp',
+				'test/preload/fixtures/app-same-dest/my/app/Component-preload.js',
+				'test/preload/fixtures/library-same-dest/my/ui/lib/library-preload.json'
+			]
 		},
 
 		// Configuration to be run (and then tested).
@@ -111,6 +115,24 @@ module.exports = function(grunt) {
 				components: '**'
 			},
 
+			// The following two targets are testing that a generated preload file
+			// doesn't get included when runnign the preload again
+			// (same folder for src and dest)
+			'component_same_dest_1': {
+				options: {
+					resources: 'test/preload/fixtures/app-same-dest',
+					dest: 'test/preload/fixtures/app-same-dest'
+				},
+				components: '**'
+			},
+			'component_same_dest_2': {
+				options: {
+					resources: 'test/preload/fixtures/app-same-dest',
+					dest: 'test/preload/fixtures/app-same-dest'
+				},
+				components: '**'
+			},
+
 			'library_default_options': {
 				options: {
 					resources: 'test/preload/fixtures/library',
@@ -139,6 +161,58 @@ module.exports = function(grunt) {
 					compress: false
 				},
 				libraries: '**'
+			},
+
+			// The following two targets are testing that a generated preload file
+			// doesn't get included when runnign the preload again
+			// (same folder for src and dest)
+			'library_same_dest_1': {
+				options: {
+					resources: [
+						{
+							cwd: 'test/preload/fixtures/library-same-dest',
+							src: [
+								// Defaults
+								'**/*.js',
+								'**/*.fragment.html',
+								'**/*.fragment.json',
+								'**/*.fragment.xml',
+								'**/*.view.html',
+								'**/*.view.json',
+								'**/*.view.xml',
+								'**/*.properties',
+								// Include "library-preload.json" for this test
+								'**/library-preload.json'
+							]
+						}
+					],
+					dest: 'test/preload/fixtures/library-same-dest'
+				},
+				libraries: '**'
+			},
+			'library_same_dest_2': {
+				options: {
+					resources: [
+						{
+							cwd: 'test/preload/fixtures/library-same-dest',
+							src: [
+								// Defaults
+								'**/*.js',
+								'**/*.fragment.html',
+								'**/*.fragment.json',
+								'**/*.fragment.xml',
+								'**/*.view.html',
+								'**/*.view.json',
+								'**/*.view.xml',
+								'**/*.properties',
+								// Include "library-preload.json" for this test
+								'**/library-preload.json'
+							]
+						}
+					],
+					dest: 'test/preload/fixtures/library-same-dest'
+				},
+				libraries: '**'
 			}
 
 		},

tasks/preload.js

@@ -176,7 +176,15 @@ module.exports = function (grunt) {
 						preloadObject.name = preloadModuleName;
 					}
 
-					var preloadPatterns = preloadOption.src ? preloadOption.src : (preloadDir + '/**');
+					var preloadPatterns = preloadOption.src ? preloadOption.src : [ preloadDir + '/**' ];
+					if (typeof preloadPatterns === "string") {
+						preloadPatterns = [ preloadPatterns ];
+					}
+
+					// Always exclude the corresponding preload file (Component-preload.js / library-preload.json)
+					// Otherwise it might get included every time the build runs if src / dest are the same dir
+					preloadPatterns.push('!' + preloadDir + '/' + preloadInfo.moduleName + preloadInfo.ext);
+
 					var preloadFiles = grunt.file.match(preloadPatterns, resourceFiles);
 					if (preloadFiles.length === 0) {
 						var patternsString = (typeof preloadPatterns === 'string') ? preloadPatterns : preloadPatterns.join('", "');

test/preload/fixtures/app-same-dest/my/app/Component-preload.js

@@ -0,0 +1,9 @@
+jQuery.sap.registerPreloadedModules({
+	"version": "2.0",
+	"name": "my/app/Component-preload",
+	"modules": {
+		"my/app/Component.js": "/* © */\n\"use strict\";function myFunction(n,o){return n+o}/**\n* This is a copyright comment\n*/\n/* (c) */\n/* released under */\n/* license */\nconsole.log(\"myJS\");",
+		"my/app/view/my.view.xml": "<my>XML</my>\n",
+		"my/app/view/myHtmlPre.view.xml": "<my>XML</my>\n<!-- A comment in XML is the same as in HTML -->\n<html:pre>   </html:pre>"
+	}
+});

test/preload/fixtures/app-same-dest/my/app/Component.js

@@ -0,0 +1,22 @@
+/* © */
+'use strict';
+
+/**
+* This is a copyright comment
+*/
+
+/* (c) */
+
+/* released under */
+/* normal comment */
+/* license */
+
+
+console.log('myJS');
+
+/**
+ * This is a little comment
+ */
+function myFunction(longVariableName, longerVariableName) {
+	return longVariableName + longerVariableName;
+}

test/preload/fixtures/app-same-dest/my/app/view/my.view.xml

@@ -0,0 +1,2 @@
+<my>XML</my>
+<!-- A comment in XML is the same as in HTML -->

test/preload/fixtures/app-same-dest/my/app/view/myHtmlPre.view.xml

@@ -0,0 +1,3 @@
+<my>XML</my>
+<!-- A comment in XML is the same as in HTML -->
+<html:pre>   </html:pre>

test/preload/fixtures/library-same-dest/my/ui/lib/foo.properties

@@ -0,0 +1 @@
+FOO=BAR

test/preload/fixtures/library-same-dest/my/ui/lib/library-preload.json

@@ -0,0 +1,11 @@
+{
+	"version": "2.0",
+	"name": "my.ui.lib.library-preload",
+	"modules": {
+		"my/ui/lib/library.js": "jQuery.sap.require(\"sap.ui.core.library\"),jQuery.sap.declare(\"my.ui.lib.library\"),sap.ui.getCore().initLibrary({name:\"my.ui.lib\",version:\"0.0.0\",dependencies:[\"sap.ui.core\"]});",
+		"my/ui/lib/myJS.js": "/* © */\n\"use strict\";function myFunction(n,o){return n+o}/**\n* This is a copyright comment\n*/\n/* (c) */\n/* released under */\n/* license */\nconsole.log(\"myJS\");",
+		"my/ui/lib/my.view.xml": "<my>XML</my>\n",
+		"my/ui/lib/myHtmlPre.view.xml": "<my>XML</my>\n<!-- A comment in XML is the same as in HTML -->\n<html:pre>   </html:pre>",
+		"my/ui/lib/foo.properties": "FOO=BAR\n"
+	}
+}

test/preload/fixtures/library-same-dest/my/ui/lib/library.js

@@ -0,0 +1,8 @@
+jQuery.sap.require("sap.ui.core.library");
+jQuery.sap.declare("my.ui.lib.library");
+
+sap.ui.getCore().initLibrary({
+	name : "my.ui.lib",
+	version: "0.0.0",
+	dependencies : ["sap.ui.core"]
+});

test/preload/fixtures/library-same-dest/my/ui/lib/my.view.xml

@@ -0,0 +1,2 @@
+<my>XML</my>
+<!-- A comment in XML is the same as in HTML -->

test/preload/fixtures/library-same-dest/my/ui/lib/myHtmlPre.view.xml

@@ -0,0 +1,3 @@
+<my>XML</my>
+<!-- A comment in XML is the same as in HTML -->
+<html:pre>   </html:pre>

test/preload/fixtures/library-same-dest/my/ui/lib/myJS.js

@@ -0,0 +1,22 @@
+/* © */
+'use strict';
+
+/**
+* This is a copyright comment
+*/
+
+/* (c) */
+
+/* released under */
+/* normal comment */
+/* license */
+
+
+console.log('myJS');
+
+/**
+ * This is a little comment
+ */
+function myFunction(longVariableName, longerVariableName) {
+	return longVariableName + longerVariableName;
+}

test/preload/fixtures/library-same-dest/my/ui/lib/myJSON.json

@@ -0,0 +1,3 @@
+{
+	"my": "json"
+}

test/preload_test.js

@@ -45,6 +45,14 @@ describe('openui5_preload', function() {
 			});
 		});
 
+		it('library_same_dest', function() {
+			fileContent.equal({
+				sActualFileSource: 'test/preload/fixtures/library-same-dest/my/ui/lib/library-preload.json',
+				sExpectedFileSource: 'test/preload/expected/library_default_options/my/ui/lib/library-preload.json',
+				sMessage: 'library preload JSON should be correctly created.'
+			});
+		});
+
 	});
 
 	describe('component', function() {
@@ -73,6 +81,14 @@ describe('openui5_preload', function() {
 			});
 		});
 
+		it('component_same_dest', function() {
+			fileContent.equal({
+				sActualFileSource: 'test/preload/fixtures/app-same-dest/my/app/Component-preload.js',
+				sExpectedFileSource: 'test/preload/expected/component_default_options/my/app/Component-preload.js',
+				sMessage: 'component preload JS should be correctly created.'
+			});
+		});
+
 	});
 
 });