Externalized default template

Author: Matt Karl

.gitignore

@@ -6,27 +6,16 @@ docs
 *.log
 *.map
 deploy/assets/js/captions.js
-
 deploy/assets/js/main.js
-
 deploy/assets/js/remote.js
-
 deploy/tasks-test.html
-
 deploy/assets/js/tasks.js
-
 deploy/assets/js/libraries.js
-
 deploy/assets/css/tasks.css
-
 deploy/assets/css/remote.css
-
 deploy/assets/css/main.css
-
 deploy/assets/css/libraries.css
-
 deploy/assets/css/captions.css
-
 deploy/assets/css/new.css
-
 deploy/assets/js/new.js
+deploy/assets/templates/default

bower.json

@@ -11,6 +11,7 @@
 		"wavesurfer.js": "*",
 		"underscore": "~1.7.0",
 		"node-webkit-app": "*",
-		"sortable": "farhadi/html5sortable"
+		"sortable": "farhadi/html5sortable",
+		"default": "https://github.com/SpringRoll/SpringRollTemplate.git"
 	}
 }

deploy/assets/templates/default/README.md

@@ -1,3 +1,27 @@
-# _className_ (*_name_*)
+# SpringRollTemplate
 
-This project was started using [SpringRoll Studio](https://github.com/springroll/SpringRollStudio) with template _templateName_ (_templateVersion_).
+Default template for the [SpringRoll Studio](https://github.com/SpringRoll/SpringRollStudio) application.
+
+## Extending
+
+You create your own Template based on the default template. Create **springroll-template.json** within your project (example below).
+
+```js
+{
+	// The human-readible name of the template
+	"name" : "Custom Template",
+
+	// A unique bundle id for the template
+	"id" : "com.example.customtemplate",
+
+	// The version of the template
+	"version" : "1.0.0",
+
+	// Tagged releases will get auto-updated
+	// from Github if the username/repo is set
+	"github": "username/CustomTemplate",
+
+	// This is required to extend!
+	"extend": "io.springroll.default"
+}
+```

deploy/assets/templates/default/bower.json

@@ -2,9 +2,12 @@
 	"name" : "Default",
 	"id" : "io.springroll.default",
 	"version" : "1.2.0",
+	"github": "SpringRoll/SpringRollTemplate",
 	"rename" : {
 		"gitignore" : ".gitignore",
-		"bowerrc" : ".bowerrc"
+		"bowerrc" : ".bowerrc",
+		"project.md": "README.md",
+		"bower": "bower.json"
 	},
 	"required": ["springroll.Core"],
 	"modules": [
@@ -135,4 +138,4 @@
 			"default": false
 		}
 	]
-}
+}

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

@@ -1,12 +1,13 @@
 {
-	"name": "SpringRollStudio",
-	"private": true,
-	"version": "0.2.0-alpha.4",
-	"dependencies": {
-		"grunt": "~0.4.5",
-		"grunt-exec": "~0.4.6",
-		"grunt-node-webkit-builder": "~1.0.0",
-		"lodash": "~3.0.0",
-		"project-grunt": "*"
-	}
-}
+  "name": "SpringRollStudio",
+  "private": true,
+  "version": "0.2.0-alpha.4",
+  "dependencies": {
+    "grunt": "~0.4.5",
+    "grunt-contrib-copy": "^0.7.0",
+    "grunt-exec": "~0.4.6",
+    "grunt-node-webkit-builder": "~1.0.0",
+    "lodash": "~3.0.0",
+    "project-grunt": "*"
+  }
+}

package.json

@@ -166,7 +166,7 @@
 	};
 
 	// Reference to the prototype
-	var p = Captions.prototype = Object.create(Module.prototype);
+	var p = extend(Captions, Module);
 
 	/**
 	*  The default width of a new caption in ms

src/springroll/captions/Captions.js

@@ -113,7 +113,7 @@
 		this.namespace.val(localStorage.getItem('namespace') || "");
 
 		// Restrict the input
-		$('input[data-restrict]').keyup(function(e){
+		$('input:data(restrict)').keyup(function(e){
 			var input = $(this),
 				restrict = new RegExp("[^" + input.data('restrict') + "]"),
 				value = input.val(),
@@ -124,41 +124,10 @@
 				input.val(newValue);
 			}
 		});
-
-		// Hide the unsupported modules for native display
-		/*var noNative = $('.no-native input');
-		var optional = $('.optional input');*/
-
-		/*this.displays = $(".display:checkbox").change(function(){
-
-			// Get the selected displays
-			var displays = this.getDisplays();
-
-			optional.removeAttr('disabled')
-				.prop('checked', true)
-				.parent()
-					.removeClass('disabled');
-
-			// Display modules if only the native display is selected
-			if (displays.length === 1 && $("#native").prop('checked'))
-			{
-				noNative.prop('checked', false)
-					.attr('disabled', true)
-					.parent()
-						.addClass('disabled');
-			} 
-			else if (displays.length === 0)
-			{
-				optional.attr('disabled', true)
-					.prop('checked', false)
-					.parent()
-						.addClass('disabled');
-			}
-		}.bind(this));*/
 	};
 
 	// Reference to the prototype
-	var p = NewProject.prototype = Object.create(Module.prototype);
+	var p = extend(NewProject, Module);
 
 	Object.defineProperty(p, 'enabled', {
 		set : function(enabled)

src/springroll/new/NewProject.js

@@ -84,6 +84,12 @@
 		 */
 		this.extend = data.extend || null;
 
+		/**
+		 * The username/repo for github
+		 * @property {string} github
+		 */
+		this.github = data.github || null;
+
 		/**
 		 * The parent template
 		 * @property {springroll.new.Template} parent

src/springroll/new/Template.js

@@ -401,15 +401,13 @@
 			}
 		}
 
+		// First-Time run, copy the default template
+		// to the setting folder
 		if (!this.templates)
 		{
-			// Create the default template
-			var template = new Template(path.join('assets','templates','default'));
-
-			// Create the templates object
 			this.templates = {};
-			this.templates[template.id] = template;
-			this.save();
+			this.addTemplate(path.join('assets','templates','default'));
+			return;
 		}
 
 		// Load the existing templates
@@ -461,7 +459,7 @@
 	*  @param  {array} tags List of github tag objects
 	*/
 	p.getTemplateTags = function(template, tags)
-	{
+	{		
 		var message = "A new version of " + template.name + " is available, update?";
 		for (var i = 0; i < tags.length; i++)
 		{