Implemented template modules

Author: Matt Karl

deploy/assets/js/preview.js

@@ -4,102 +4,96 @@
 	"version" : "1.2.0",
 	"rename" : {
 		"gitignore" : ".gitignore",
-		"bowerrc" : ".bowerrc",
-		"springroll": ".springroll"
+		"bowerrc" : ".bowerrc"
 	},
 	"modules": {
 		"springroll.Core": {
 			"name": "SpringRoll Core",
+			"main": "components/springroll/core.min.js",
+			"mainDebug": "components/springroll/core.js",
 			"required": true,
 			"bower": {
 				"springroll": "*"
 			},
-			"libraries": [
-				"components/preloadjs/lib/preload.min.js",
-				"components/springroll/core.min.js"
-			],
-			"librariesDebug": [
-				"components/preloadjs/lib/preload.combined.js",
-				"components/springroll/core.js"
-			]
+			"libraries": "components/preloadjs/lib/preload.min.js",
+			"librariesDebug": "components/preloadjs/lib/preload.combined.js"
 		},
 		"springroll.CreateJSDisplay": {
 			"name": "CreateJS Display Module",
+			"main": "components/springroll/dist/modules/display-createjs.min.js",
+			"mainDebug": "components/springroll/dist/modules/display-createjs.js",
 			"bower": {
 				"easeljs": "https://github.com/SpringRoll/EaselJS.git",
 				"tweenjs": "https://github.com/SpringRoll/TweenJS.git"
 			},
 			"libraries": [
 				"components/tweenjs/lib/tweenjs.min.js",
 				"components/easeljs/lib/easeljs.min.js",
-				"components/easeljs/lib/movieclip.min.js",
-				"components/springroll/dist/modules/display-createjs.min.js"
+				"components/easeljs/lib/movieclip.min.js"
 			],
 			"librariesDebug": [
 				"components/tweenjs/lib/tweenjs.combined.js",
 				"components/easeljs/lib/easeljs.combined.js",
-				"components/easeljs/lib/movieclip.combined.js",
-				"components/springroll/dist/modules/display-createjs.js"
+				"components/easeljs/lib/movieclip.combined.js"
 			],
 			"depends": "springroll.Core"
 		},
 		"springroll.PixiDisplay": {
 			"name": "Pixi.js Display Module",
+			"main": "components/springroll/dist/modules/display-pixi.min.js",
+			"mainDebug": "components/springroll/dist/modules/display-pixi.js",
 			"bower": {
 				"pixi.js":"https://github.com/SpringRoll/pixi.js.git"
 			},
-			"libraries": [
-				"components/pixi.js/bin/pixi.js",
-				"components/springroll/dist/modules/display-pixi.min.js"
-			],
-			"librariesDebug": [
-				"components/pixi.js/bin/pixi.dev.js",
-				"components/springroll/dist/modules/display-pixi.js"
-			],
+			"libraries": "components/pixi.js/bin/pixi.js",
+			"librariesDebug": "components/pixi.js/bin/pixi.dev.js",
 			"depends": "springroll.Core"
 		},
 		"springroll.NativeDisplay": {
 			"name": "Native Display Module",
-			"libraries": "components/springroll/dist/modules/display-native.min.js",
-			"librariesDebug": "components/springroll/dist/modules/display-native.js",
+			"main": "components/springroll/dist/modules/display-native.min.js",
+			"mainDebug": "components/springroll/dist/modules/display-native.js",
 			"depends": "springroll.Core"
 		},
 		"springroll.Sound": {
 			"name": "Sound Module",
 			"bower": {
 				"soundjs": "https://github.com/SpringRoll/SoundJS.git"
 			},
+			"main":"components/springroll/dist/modules/sound.min.js",
+			"mainDebug":"components/springroll/dist/modules/sound.js",
 			"libraries": [
 				"components/soundjs/lib/soundjs.min.js",
-				"components/soundjs/lib/flashaudioplugin.min.js",
-				"components/springroll/dist/modules/sound.min.js"
+				"components/soundjs/lib/flashaudioplugin.min.js"
 			],
 			"librariesDebug": [
 				"components/soundjs/lib/soundjs.min.js",
-				"components/soundjs/lib/flashaudioplugin.combined.js",
-				"components/springroll/dist/modules/sound.js"
+				"components/soundjs/lib/flashaudioplugin.combined.js"
 			],
+			"librariesCopy": {
+				"components/soundjs/lib/FlashAudioPlugin.swf": "deploy/assets/swfs/"
+			},
 			"depends": "springroll.Core"
 		},
 		"springroll.Interface": {
 			"name": "Interface Module",
-			"libraries": "components/springroll/dist/modules/interface.min.js",
-			"librariesDebug": "components/springroll/dist/modules/interface.js",
+			"main": "components/springroll/dist/modules/interface.min.js",
+			"mainDebug": "components/springroll/dist/modules/interface.js",
 			"depends": [
 				"springroll.Core",
 				"springroll.CreateJSDisplay|springroll.PixiDisplay"
 			] 
 		},
 		"springroll.Captions": {
 			"name": "Captions Module",
-			"libraries": "components/springroll/dist/modules/captions.min.js",
-			"librariesDebug": "components/springroll/dist/modules/captions.js",
+			"main": "components/springroll/dist/modules/captions.min.js",
+			"mainDebug": "components/springroll/dist/modules/captions.js",
 			"depends": "springroll.Core"
 		},
 		"springroll.Game": {
 			"name": "Game Module",
-			"libraries": "components/springroll/dist/modules/game.min.js",
-			"librariesDebug": "components/springroll/dist/modules/game.js",
+			"main": "components/springroll/dist/modules/game.min.js",
+			"mainDebug": "components/springroll/dist/modules/game.js",
 			"depends": [
 				"springroll.Sound", 
 				"springroll.Core",
@@ -108,20 +102,20 @@
 		},
 		"springroll.Tasks": {
 			"name": "Tasks Module",
-			"libraries": "components/springroll/dist/modules/tasks.min.js",
-			"librariesDebug": "components/springroll/dist/modules/tasks.js",
+			"main": "components/springroll/dist/modules/tasks.min.js",
+			"mainDebug": "components/springroll/dist/modules/tasks.js",
 			"depends": "springroll.Core"
 		},
 		"springroll.Translate": {
 			"name": "Translate Module",
-			"libraries": "components/springroll/dist/modules/translate.min.js",
-			"librariesDebug": "components/springroll/dist/modules/translate.js",
+			"main": "components/springroll/dist/modules/translate.min.js",
+			"mainDebug": "components/springroll/dist/modules/translate.js",
 			"depends": "springroll.Core"
 		},
 		"springroll.Worker": {
 			"name": "Worker Module",
-			"libraries": "components/springroll/dist/modules/worker.min.js",
-			"librariesDebug": "components/springroll/dist/modules/worker.js"
+			"main": "components/springroll/dist/modules/worker.min.js",
+			"mainDebug": "components/springroll/dist/modules/worker.js"
 		}
 	}
 }

deploy/assets/templates/default/springroll

@@ -94,10 +94,21 @@ <h1>Create New Project</h1>
 					</div>
 				</div>
 				<div class="form-group">
+					<label for="output" class="col-sm-2 col-xs-4 control-label">Modules</label>
+					<div class="col-sm-10 col-xs-8"><div id="modules"></div></div>
+					<script type="text/html" id="moduleTemplate">
+						<div class="checkbox">
+							<label>
+								<input type="checkbox" class="module" checked="checked">
+								<span class="name"></span>
+							</label>
+						</div>
+					</script>
+				</div>
+				<!-- <div class="form-group">
 					<label for="output" class="col-sm-2 col-xs-4 control-label">Renderer</label>
 					<div class="col-sm-10 col-xs-8">
 						
-						<!-- Including core module first -->
 						<input type="checkbox" class="hidden module" checked disabled value="components/springroll/dist/core">
 
 						<div class="btn-group" data-toggle="buttons">
@@ -149,7 +160,7 @@ <h1>Create New Project</h1>
 							<label><input type="checkbox" class="module" value="components/springroll/dist/modules/worker" checked="checked"> Worker Module</label>
 						</div>
 					</div>
-				</div>
+				</div> -->
 			</div>
 			<div class="modal-footer">
 				<button type="button" class="btn btn-default" id="closeButton">Close</button>

deploy/assets/templates/default/springroll-template.json

@@ -82,7 +82,8 @@
 		"new": [
 			"components/node-webkit-app/src/utils/Browser.js",
 			"src/springroll/Module.js",
-			"src/springroll/new/Module.js",
+			"src/springroll/new/JSONUtils.js",
+			"src/springroll/new/TemplateModule.js",
 			"src/springroll/new/Template.js",
 			"src/springroll/new/TemplateManager.js",
 			"src/springroll/new/Installer.js",

deploy/new.html

@@ -43,9 +43,9 @@
 	*  @static
 	*  @param {funtion} func The module to create
 	*/
-	Module.create = function(func)
+	Module.create = function(classRef)
 	{
-		$(function(){ window.module = new func(); });
+		$(function(){ window.appModule = new classRef(); });
 	};
 
 	// Reference to the prototype

project.json

@@ -144,7 +144,14 @@
 	*/
 	var onFocus = function()
 	{
-		this.window.module.focus();
+		if (this.window.appModule)
+		{
+			this.window.appModule.focus();
+		}
+		else
+		{
+			console.error("Unable to find appModule on window");
+		}
 	};
 
 	/**

src/springroll/Module.js

@@ -9,7 +9,8 @@
 		var glob = require("glob");
 	}
 
-	var TemplateManager = springroll.new.TemplateManager;
+	// Import classes
+	var JSONUtils = include('springroll.new.JSONUtils');
 
 	/**
 	*  Script to install the new springroll project
@@ -37,10 +38,19 @@
 	*/
 	Installer.FILE = 'springroll.json';
 
+	/**
+	*  The meta project file
+	*  @property {String} META_FILE
+	*  @readOnly
+	*  @static
+	*  @default  ".springroll"
+	*/
+	Installer.META_FILE = '.springroll';
+
 	/**
 	*  The main execution point for creating a new project
 	*  @method run
-	*  @param {array} templates The path to the template to use
+	*  @param {springroll.new.Template} template The path to the template to use
 	*  @param {object} options The collection of options
 	*  @param {int} options.width The width of the new game
 	*  @param {int} options.height The height of the new game
@@ -55,57 +65,18 @@
 	*  @param {object} options.bower The addition bower files to add
 	*  @param {function} complete The function to call when done
 	*/
-	p.run = function(templates, options, complete)
+	p.run = function(template, options, complete)
 	{
 		this.options = options;
 		var dest = options.destination;
 
-		if (DEBUG)
-		{
-			console.log("Copy " + template + " to " + dest);
-		}
+		// Copy the template files
+		template.copyTo(dest);
 
-		// loop through the templates from back to front,
-		// that is from parent (general) to child (specific)
-		var template, file, j, i;
-		for (i = templates.length - 1; i >= 0; i--)
-		{
-			template = templates[i];
-
-			// Copy the files from the template to the destination
-			fs.copySync(template.path, dest);
-
-			// Add subsitution options for the version and name	
-			options.templateVersion = template.version;
-			options.templateName = template.name;
-			options.templateId = template.id;
-
-			// Rename any local files that should actually
-			// be hidden
-			if (template.rename)
-			{
-				for(file in template.rename)
-				{
-					fs.renameSync(
-						path.join(dest, file), 
-						path.join(dest, template.rename[file])
-					);
-				}
-			}
-
-			// Any files to remove, this can be if we're overriding
-			// another template, we can delete things in the parent
-			if (template.remove)
-			{
-				for (j = 0; j < template.remove.length; i++)
-				{
-					fs.unlinkSync(path.join(dest, template.remove[i]));
-				}
-			}
-
-			// Remove the template file
-			fs.unlinkSync(path.join(dest, TemplateManager.FILE));
-		}
+		// Add subsitution options for the version and name	
+		options.templateVersion = template.version;
+		options.templateName = template.name;
+		options.templateId = template.id;
 
 		if (Object.keys(options.bower).length > 0)
 		{
@@ -117,6 +88,11 @@
 
 		// Update the build file with libraries and modules
 		var build = this.readJSON(Installer.FILE);
+
+		// Save the template we're using
+		this.writeJSON(Installer.META_FILE, {
+			"template": template.toJSON()
+		});
 
 		// Replace tokens with the list of depdendencies
 		insertAt(
@@ -198,8 +174,12 @@
 	*/
 	p.readJSON = function(file)
 	{
-		var filePath = path.join(this.options.destination, file);
-		return JSON.parse(fs.readFileSync(filePath));
+		return JSONUtils.read(
+			path.join(
+				this.options.destination, 
+				file
+			)
+		);  
 	};
 
 	/**
@@ -210,8 +190,13 @@
 	*/
 	p.writeJSON = function(file, obj)
 	{
-		var filePath = path.join(this.options.destination, file);
-		fs.writeFileSync(filePath, JSON.stringify(obj, null, "\t"));
+		JSONUtils.write(
+			path.join(
+				this.options.destination,
+				file
+			), 
+			obj
+		);
 	};
 
 	/**