sproutcore 0.9.0

data/generators/model/model_generator.rb

@@ -0,0 +1,55 @@
+require 'sproutcore/generator_helper'
+
+class ModelGenerator < RubiGen::Base
+  
+  include SproutCore::GeneratorHelper
+  
+  default_options :author => nil
+  
+  attr_reader :name, :client_location
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    assign_names!(@name)
+  end
+
+  def manifest
+    record do |m|
+      fp = client_file_path('models','js')
+      build_client_directories(m, fp)
+      m.template 'model.js', fp
+
+      fp = client_file_path('fixtures','js')
+      build_client_directories(m, fp)
+      m.template 'fixture.js', fp
+      
+      fp = client_file_path('tests/models', 'rhtml')
+      build_client_directories(m, fp)
+      m.template 'test.rhtml', fp
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a SproutCore model objects
+
+USAGE: #{$0} #{spec.name} client_name/model_name [ClassName]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.on("-l", '--loc="Location"', String, "Location of build. If not passed, search clients and frameworks dirs", "Default: none") { |options[:loc]| }
+    end
+    
+    def extract_options
+      @client_location = options[:loc]
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/model/templates/fixture.js

@@ -0,0 +1,11 @@
+// ==========================================================================
+// <%= client_class_name %> Fixtures
+// ==========================================================================
+
+require('core') ;
+
+<%= client_namespace %>.FIXTURES = <%= client_namespace %>.FIXTURES.concat([
+
+  // TODO: Add your data fixtures here.
+
+]);

data/generators/model/templates/model.js

@@ -0,0 +1,20 @@
+// ==========================================================================
+// <%= client_class_name %>
+// ==========================================================================
+
+require('core');
+
+/** @class
+  
+  (Document your class here)
+
+  @extends <%= base_class_name 'SC.Record' %>
+  @author    AuthorName  
+  @version 0.1
+*/  
+<%= client_class_name %> = <%= base_class_name 'SC.Record' %>.extend(
+/** @scope <%= client_class_name %>.prototype */ {
+  
+  // TODO: Add your own code here.
+  
+}) ;

data/generators/model/templates/test.rhtml

@@ -0,0 +1,21 @@
+<%% # ========================================================================
+   # <%= client_class_name %> Unit Test
+   # ========================================================================
+%>
+<%% content_for('final') do %>
+
+<script>
+
+Test.context("<%= client_class_name %>",{
+
+  "TODO: Add your own tests here": function() {
+    true.shouldEqual(true) ;
+  }
+
+}) ;
+
+appMain = main; main = null ; // Cancel main() so app does not start
+
+</script>
+
+<%% end %>

data/generators/test/USAGE

@@ -0,0 +1,16 @@
+test - Create a new unit test in your SproutCore client.
+
+USAGE:
+
+  ./script/generate test client_name/test_name [CLASS]
+  
+DISCUSSION:
+
+This generator will create a new SproutCore unit test in your client.  You should pass as the first parameter your client directory name/the test you want to create.  For example:
+
+./script/generate test todos/task
+
+defines a new test called called "Task" in the file clients/todos/tests/task.rhtml.
+
+The default test simply returns true.  Add your own tests to do something useful.
+

data/generators/test/templates/test.rhtml

@@ -0,0 +1,21 @@
+<%% # ========================================================================
+   # <%= file_name.gsub('_', ' ').titleize %> Unit Test
+   # ========================================================================
+%>
+<%% content_for('final') do %>
+
+<script>
+
+Test.context("<%= file_name.gsub('_', ' ').titleize %>",{
+
+  "TODO: Add your own tests here": function() {
+    true.shouldEqual(true) ;
+  }
+
+}) ;
+
+appMain = main; main = null ; // Cancel main() so app does not start
+
+</script>
+
+<%% end %>

data/generators/test/test_generator.rb

@@ -0,0 +1,47 @@
+require 'sproutcore/generator_helper'
+
+class TestGenerator < RubiGen::Base
+  
+  include SproutCore::GeneratorHelper
+  
+  default_options :author => nil
+  
+  attr_reader :name, :client_location
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    assign_names!(@name)
+  end
+
+  def manifest
+    record do |m|
+      fp = client_file_path('tests', 'rhtml')
+      build_client_directories(m, fp)
+      m.template 'test.rhtml', fp
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Add a test to a SproutCore project
+
+USAGE: #{$0} #{spec.name} client_name/test_name
+EOS
+    end
+
+    def add_options!(opts)
+      opts.on("-l", '--loc="Location"', String, "Location of build. If not passed, search clients and frameworks dirs", "Default: none") { |options[:loc]| }
+    end
+    
+    def extract_options
+      @client_location = options[:loc]
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/view/USAGE

@@ -0,0 +1,16 @@
+sc_view - Create a new view class in your SproutCore client.
+
+USAGE:
+
+  ./script/generate view client_name/view_name [CLASS]
+  
+DISCUSSION:
+
+This generator will create a new SproutCore view class in your client.  You should pass as the first parameter your client directory name/the view you want to create.  For example:
+
+./script/generate view todos/task
+
+defines a new class called Todos.TaskView in the file clients/todos/views/task.js.
+
+This generator creates view that inherit from SC.View but you can override this by passing the name of the view class you want as the second argument.
+

data/generators/view/templates/test.rhtml

@@ -0,0 +1,21 @@
+<%% # ========================================================================
+   # <%= view_class_name %> Unit Test
+   # ========================================================================
+%>
+<%% content_for('final') do %>
+
+<script>
+
+Test.context("<%= view_class_name %>",{
+
+  "TODO: Add your own tests here": function() {
+    true.shouldEqual(true) ;
+  }
+
+}) ;
+
+appMain = main; main = null ; // Cancel main() so app does not start
+
+</script>
+
+<%% end %>

data/generators/view/templates/view.js

@@ -0,0 +1,20 @@
+// ==========================================================================
+// <%= view_class_name %>
+// ==========================================================================
+
+require('core');
+
+/** @class
+
+  (Document Your View Here)
+
+  @extends <%= base_class_name 'SC.View' %>
+  @author    AuthorName  
+  @version 0.1
+*/
+<%= view_class_name %> = <%= base_class_name 'SC.View' %>.extend(
+/** @scope <%= view_class_name %>.prototype */ {
+  
+  // TODO: Add your own code here.
+  
+}) ;

data/generators/view/view_generator.rb

@@ -0,0 +1,51 @@
+require 'sproutcore/generator_helper'
+
+class ViewGenerator < RubiGen::Base
+  
+  include SproutCore::GeneratorHelper
+  
+  default_options :author => nil
+  
+  attr_reader :name, :client_location
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    assign_names!(@name)
+  end
+
+  def manifest
+    record do |m|
+      fp = client_file_path('views','js','view')
+      build_client_directories(m, fp)
+      m.template 'view.js', fp
+      
+      fp = client_file_path('tests/views', 'rhtml')
+      build_client_directories(m, fp)
+      m.template 'test.rhtml', fp
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a SproutCore model objects
+
+USAGE: #{$0} #{spec.name} client_name/model_name [ClassName]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.on("-l", '--loc="Location"', String, "Location of build. If not passed, search clients and frameworks dirs", "Default: none") { |options[:loc]| }
+    end
+    
+    def extract_options
+      @client_location = options[:loc]
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/jsdoc/README.txt

@@ -0,0 +1,119 @@
+=====================================================================
+
+DESCRIPTION:
+
+JsDoc Toolkit is an automatic documentation generation tool for
+JavaScript. It is written in JavaScript and is run from a command line
+(or terminal) using Mozilla Rhino JavaScript engine. Using this tool
+you can automatically turn JavaDoc-like comments in your JavaScript
+source code into published output, such as HTML or XML.
+
+For more information, to report a bug or to browse the technical
+documentation for this tool please visit the official JsDoc Toolkit
+project homepage: http://code.google.com/p/jsdoc-toolkit/
+
+This project is based on the JSDoc.pm tool, created by Michael 
+Mathews, maintained by Gabriel Reid. More information on JsDoc can
+be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/
+
+Complete documentation on JsDoc Toolkit can be found on the project
+wiki at http://code.google.com/p/jsdoc-toolkit/w/list
+
+
+=====================================================================
+
+USAGE:
+
+Running JsDoc Toolkit on your desktop requires you to have Java
+installed and the Mozilla Rhino JavaScript jar file (named "js.jar")
+available. A copy of this jar file is included with the JsDoc Toolkit
+distribution. To download Rhino yourself or to find out more go to 
+the official Rhino web page: http://www.mozilla.org/rhino/
+
+Before running the JsDoc Toolkit app you must change your current
+working directory to the jsdoc-toolkit folder. Then follow the
+examples below, or as shown on the project wiki.
+
+On a computer running Windows a valid command line to run JsDoc
+Toolkit might look like this:
+
+ > java -jar app\js.jar app\run.js -a -t=templates\htm test\data\test.js
+
+On Mac OS X or Linux the same command would look like this:
+
+ $ java -jar app/js.jar app/run.js -a -t=templates/htm test/data/test.js
+
+The above assumes your current working directory contains the app, test
+and templates subdirectories from the standard JsDoc Toolkit 
+distribution. If you have the js.jar file saved to a place in your
+system's Java CLASSPATH, it can safely be omitted from the command.
+
+To run JsDoc Toolkit from any directory, specify the path to the app
+folder like so:
+
+ > java -Djsdoc.dir=%BASE_DIR% -jar %RHINO% %RUN% %OPTS% %SRC_FILES%
+
+So assuming the JsDoc Toolkit "app" directory is in "lib\jsdoc-toolkit"
+you would specify that like so:
+
+ > java -Djsdoc.dir=lib\jsdoc-toolkit <etc>
+
+The output documentation files will be saved to a new directory named
+"js_docs_out" (by default) in the current directory, or if you specify
+a -d=somewhere_else option, to the somewhere_else directory.
+
+For help (usage notes) enter this on the command line:
+
+ > java -jar app\js.jar app\run.js -h
+
+To run the unit tests included with JsDoc Toolkit enter this on the
+command line:
+
+ > java -jar app\js.jar test\run.js
+
+To run any example in the included examples enter this on the
+command line:
+
+ $ java -jar app/js.jar examples/run.js -a  examples/data/whatever.js
+
+
+=====================================================================
+
+LICENSE:
+
+Rhino (JavaScript in Java) is open source and licensed by Mozilla
+under the MPL 1.1 or later/GPL 2.0 or later licenses, the text of which
+is available at http://www.mozilla.org/MPL/
+
+You can obtain the source code for Rhino via the Mozilla web site at
+http://www.mozilla.org/rhino/download.html
+
+The Tango base icon theme is licensed under the Creative Commons 
+Attribution Share-Alike license. The palette is in the public domain.
+For more details visit the Tango! Desktop Project page at
+http://tango.freedesktop.org/Tango_Desktop_Project
+
+JsDoc Toolkit is a larger work that uses the Rhino JavaScript engine
+without modification and without any claims whatsoever. The portions of
+code specific to JsDoc Toolkit are open source and licensed under the
+X11/MIT License.
+
+Copyright (c) 2007 Michael Mathews <micmath@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions: The above copyright notice and this
+permission notice must be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/jsdoc/app/DocFile.js

@@ -0,0 +1,137 @@
+/**
+ * @fileOverview
+ * @name DocFile
+ * @author Michael Mathews micmath@gmail.com
+ * @url $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-1.4.0b/app/DocFile.js $
+ * @revision $Id: DocFile.js 260 2007-10-03 22:18:38Z micmath $
+ * @license <a href="http://en.wikipedia.org/wiki/MIT_License">X11/MIT License</a>
+ *          (See the accompanying README file for full details.)
+ */
+
+/**
+ * @class Represents a collection of docFiles.
+ * @constructor
+ * @author Michael Mathews <a href="mailto:micmath@gmail.com">micmath@gmail.com</a>
+ */
+function DocFileGroup() {
+	this.files = [];
+}
+
+/**
+ * @param {DocFile} docFile Add this docFile to this group.
+ */
+DocFileGroup.prototype.addDocFile = function(docFile) {
+	docFile.fileGroup = this;
+	docFile.fileGroup.circularReference = 1; // keeps dumper from getting dizzy
+	this.files.push(docFile);
+}
+
+/**
+ * Search the entire dofFileGroup for a certain symbol.
+ * @param {string} alias The full alias name of the symbol.
+ * @return {Symbol}
+ */
+DocFileGroup.prototype.getSymbol = function(alias) {
+	for (var f = 0; f < this.files.length; f++) {
+		var symbol = this.files[f].getSymbol(alias);
+		if (symbol) return symbol;
+	}
+}
+
+/**
+ * @class Represents a collection of doclets associated with a file.
+ * @constructor
+ * @author Michael Mathews <a href="mailto:micmath@gmail.com">micmath@gmail.com</a>
+ * @param {string} [path] The file path to the source file.
+ */
+function DocFile(path) {
+	this.path = path;
+	this.filename = Util.fileName(this.path);
+	this.overview = new Symbol(this.filename, [], "FILE", "/** @overview */");
+	this.symbols = [];
+	fileGroup = null;
+}
+
+/**
+ * Add a group of doclets. Finds relationships between doclets within the group
+ * @param {Symbol[]} symbols
+ * @param {object} opt Passed in from the command line.
+ */
+DocFile.prototype.addSymbols = function(symbols, opt) {
+	for (var s = 0; s < symbols.length; s++) {
+		if (symbols[s].doc.getTag("ignore").length)
+			continue;
+			
+		if (symbols[s].isPrivate && !opt.p)
+			continue;
+			
+		symbols[s].file = this;
+		symbols[s].file.circularReference = 1; // keeps dumper from getting dizzy
+		
+		var parents;
+		if ((parents = symbols[s].doc.getTag("memberof")) && parents.length) {
+			if (symbols[s].name.indexOf(parents[0]+".") == 0) {
+				symbols[s].name = symbols[s].name.replace(parents[0]+".", parents[0]+"/");
+				symbols[s].isStatic = true;
+			}
+			else if (symbols[s].name.indexOf(parents[0]+"/") != 0) {
+				symbols[s].name = parents[0]+"/"+symbols[s].name;
+			}
+
+			symbols[s].doc._dropTag("memberof");
+		}
+		
+		if (symbols[s].desc == "undocumented") {
+			if (/(^_|[.\/]_)/.test(symbols[s].name) && !opt.A) {
+				continue;
+			}
+			if (!opt.a && !opt.A) {
+				continue;
+			}
+		}
+		
+		// is this a member of another object?
+		// TODO this relationship may span files, so should move into DocFileGroup?
+		var parts = null;
+		if (
+			symbols[s].name.indexOf("/") > -1
+			&& (parts = symbols[s].name.match(/^(.+)\/([^\/]+)$/))
+		) {
+			var parentName = parts[1].replace(/\//g, ".");
+			var childName = parts[2];
+			
+			symbols[s].alias = symbols[s].name.replace(/\//g, ".");
+			symbols[s].name = childName;
+			symbols[s].memberof = parentName;
+
+			// is the parent defined?
+			var parent = this.getSymbol(parentName);
+
+			if (!parent) LOG.warn("Member '"+childName+"' documented but no documentation exists for parent object '"+parentName+"'.");
+			else {
+				if (symbols[s].is("OBJECT")) {
+					parent.properties.push(symbols[s]);
+				}
+				if (symbols[s].is("FUNCTION")) {
+					parent.methods.push(symbols[s]);
+				}
+                if (symbols[s].is("EVENT")) {
+					parent.events.push(symbols[s]);
+				}
+			}
+		}
+		
+		this.symbols.push(symbols[s]);
+	}
+}
+
+/**
+ * @param {string} alias The full alias name of the symbol.
+ * @return {Symbol}
+ */
+DocFile.prototype.getSymbol = function(alias) {
+	for (var i = 0; i < this.symbols.length; i++) {
+		if (this.symbols[i].alias == alias) return this.symbols[i];
+	}
+    return null;
+}

data/jsdoc/app/DocTag.js

@@ -0,0 +1,110 @@
+/**
+ * @fileOverview
+ * @name DocTag
+ * @author Michael Mathews micmath@gmail.com
+ * @url $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-1.4.0b/app/DocTag.js $
+ * @revision $Id: DocTag.js 334 2007-11-13 19:52:49Z micmath $
+ * @license <a href="http://en.wikipedia.org/wiki/MIT_License">X11/MIT License</a>
+ *          (See the accompanying README file for full details.)
+ */
+ 
+ /**
+  * @class Represents a tag within a doclet.
+  * @author Michael Mathews <a href="mailto:micmath@gmail.com">micmath@gmail.com</a>
+  * @constructor
+  * @param {string} src line(s) of text following the @ character
+  */
+function DocTag(src) {
+	/**
+	 * Like @title
+	 * @type string
+	 */
+	this.title = "";
+	
+	/**
+	 * Like @title {type}
+	 * @type string
+	 */
+	this.type = "";
+	
+	/**
+	 * Like @title {type}? name, though this is only recognized in tags with a title of "param" or "property."
+	 * @type string
+	 */
+	this.name = "";
+	
+	/**
+	 * Like @title {type}? name? description goes here...
+	 * @type string
+	 */
+	this.desc = "";
+	
+	if (typeof(src) != "undefined") {
+		var parts = src.match(/^(\S+)(?:\s+\{\s*([\S\s]+?)\s*\})?\s*([\S\s]*\S)?/);
+		
+		this.title = (parts[1].toLowerCase() || "");
+		this.type = (parts[2] || "");
+	
+		if (this.type) this.type = this.type.replace(/\s*(,|\|\|?)\s*/g, ", ");
+		this.desc = (parts[3] || "");
+		
+		// should be @type foo but we'll accept @type {foo} too
+		if (this.title == "type") {
+			if (this.type) this.desc = this.type;
+			
+			// should be @type foo, bar, baz but we'll accept @type foo|bar||baz too
+			if (this.desc) {
+				this.desc = this.desc.replace(/\s*(,|\|\|?)\s*/g, ", ");
+			}
+		}
+		
+		var syn;
+		if ((syn = DocTag.synonyms["="+this.title])) this.title = syn;
+		
+		if (this.desc) {
+			if (this.title == "param") { // long tags like {type} [name] desc
+				var m = this.desc.match(/^\s*(\[?)([a-zA-Z0-9.$_]+)(\]?)(?:\s+\{\s*([\S\s]+?)\s*\})?(?:\s+([\S\s]*\S))?/);
+				if (m) {
+					this.isOptional = (!!m[1] && !!m[3]); // bracketed name means optional
+					this.name = (m[2] || "");
+					this.type = (m[4] || this.type);
+					this.desc = (m[5] || "");
+				}
+			}
+			else if (this.title == "property") {
+				m = this.desc.match(/^\s*([a-zA-Z0-9.$_]+)(?:\s+([\S\s]*\S))?/);
+				if (m) {
+					this.name = (m[1] || "");
+					this.desc = (m[2] || "");
+				}
+			}
+			else if (this.title == "config") {
+				m = this.desc.match(/^\s*(\[?)([a-zA-Z0-9.$_]+)(\]?)(?:\s+([\S\s]*\S))?/);
+				if (m) {
+					this.isOptional = (!!m[1] && !!m[3]); // bracketed name means optional
+					this.name = (m[2] || "");
+					this.desc = (m[4] || "");
+				}
+			}
+		}
+	}
+}
+
+/**
+ * Used to make various JsDoc tags compatible with JsDoc Toolkit.
+ * @memberOf DocTag
+ */
+DocTag.synonyms = {
+	"=member":             "memberof",
+	"=description":        "desc",
+	"=exception":          "throws",
+	"=argument":           "param",
+	"=returns":            "return",
+	"=classdescription":   "class",
+	"=fileoverview":       "overview",
+	"=extends":            "augments"
+}
+
+DocTag.prototype.toString = function() {
+	return this.desc;
+}