javascriptmvc 3.0.0.pre15

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.markdown

@@ -0,0 +1,15 @@
+Get it
+======
+
+    sudo gem install javascriptmvc
+
+Use it
+======
+
+    jmvc-init new_project_folder
+    
+    cd new_project_folder
+    
+    jmvc-gen new_app
+    
+    jmvc-build new_app

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "javascriptmvc"
+    gem.summary = %Q{Binaries for interacting with JavascriptMVC}
+    gem.email = "tdreyno@gmail.com"
+    gem.homepage = "http://github.com/tdreyno/javascriptmvc"
+    gem.authors = ["Thomas Reynolds"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+3.0.0.pre15

data/bin/jmvc-build

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", "lib", "javascriptmvc")
+JavascriptMVC.build!(*ARGV)

data/bin/jmvc-gen

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", "lib", "javascriptmvc")
+JavascriptMVC.gen!(*ARGV)

data/bin/jmvc-get

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", "lib", "javascriptmvc")
+JavascriptMVC.get!(*ARGV)

data/bin/jmvc-init

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", "lib", "javascriptmvc")
+JavascriptMVC.init!(*ARGV)

data/bin/jmvc-update

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", "lib", "javascriptmvc")
+JavascriptMVC.update!(*ARGV)

data/lib/javascriptmvc.rb

@@ -0,0 +1,97 @@
+require 'fileutils'
+
+class JavascriptMVC
+  def self.init!(folder=nil, *options)
+    if !folder
+      $stderr.puts "Error: You must provide a path to initialize a new project"
+      return
+    end
+    
+    FileUtils.mkdir_p(folder)
+    local_jmvc  = File.join(File.dirname(__FILE__), "javascriptmvc")
+    
+    client_jmvc = File.expand_path(folder)
+    if !File.exists?(client_jmvc) || !File.directory?(client_jmvc) || !File.writable?(client_jmvc) 
+      $stderr.puts "Error: You must have permission to write to the destination folder"
+      return
+    end
+    
+    $stderr.puts "Copying library files"
+    library_folders = [
+      File.join(local_jmvc, "documentjs"),
+      File.join(local_jmvc, "funcunit"),
+      File.join(local_jmvc, "jquery"),
+      File.join(local_jmvc, "steal")
+    ]
+    FileUtils.cp_r(library_folders, client_jmvc)
+    
+    $stderr.puts "Making binary files executable"
+    FileUtils.chmod 0755, File.join(client_jmvc, "steal", "js")
+    
+    $stderr.puts "Success: Project initialized in #{folder}"
+  end
+  
+  def self.gen!(app = nil, *options)
+    js_bin = get_js_binary_file
+    
+    if !js_bin
+      return
+    end
+    
+    if !app
+      $stderr.puts "Error: You must include the path for the app you want to generate"
+      return
+    end
+    
+    $stderr.puts `#{js_bin} steal/generate/app #{app}`
+  end
+  
+  def self.get!(source = nil, *options)
+    js_bin = get_js_binary_file
+    
+    if !js_bin
+      return
+    end
+    
+    if !source
+      $stderr.puts "Error: You must include the path (or library name) of the module you want to get"
+      return
+    end
+    
+    $stderr.puts `#{js_bin} steal/getjs #{source}`
+  end
+  
+  def self.update!
+    js_bin = get_js_binary_file
+    
+    if !js_bin
+      return
+    end
+    
+    $stderr.puts "Updating library from github"
+    `#{js_bin} steal/update`
+    $stderr.puts "Update complete"
+  end
+  
+  def self.build!(*apps)
+    js_bin = get_js_binary_file
+
+    if !js_bin
+      return
+    end
+    
+    $stderr.puts "Building apps: #{apps.join(',')}"
+    $stderr.puts `#{js_bin} steal/buildjs #{apps.join(" ")}`
+  end
+  
+  def self.get_js_binary_file(prefix=nil)
+    js_bin = File.join("steal", "js")
+    js_bin = prefix + js_bin if prefix
+    
+    if !File.exists?(js_bin) || !File.executable?(js_bin)
+      $stderr.puts "Error: StealJS must exist in steal/js and be executable"
+    end
+    
+    js_bin
+  end
+end

data/lib/javascriptmvc/documentjs/add.js

@@ -0,0 +1,76 @@
+/**
+ * Used to set scope to add to classes or methods in another file.
+ * Examples:
+ * @codestart no-highlight
+ * /* @add steal.String Static *|         adds to steal.String's static methods
+ * /* @add steal.Controller Prototype *|  adds to steal.Controller's prototype methods
+ * @codeend
+ * It's important to note that add must be in its own comment block.
+ */
+DocumentJS.Pair.extend('DocumentJS.Add',
+{
+    comment_setup: DocumentJS.Function.prototype.comment_setup,
+    /**
+     * Looks for a line like @add (scope) (Static|Prototype)
+     * @param {String} line the line that had @add
+     */
+    add_add : function(line){
+        var m = line.match(/^@add\s+([\w\.]+)\s*([\w\.]+)?/i)
+        if(m){
+            var sub = m.pop()
+            this.sub_scope = sub ? sub.toLowerCase() : null;
+            this.scope_name = m.pop()
+        }
+    },
+    /**
+     * Searches for the new scope.
+     * @return {DocumentJS.Pair} The new scope where additional comments will be added
+     */
+    scope : function(){
+ 
+        var Class = DocumentJS.Class
+        
+        //find
+        var inst;
+        for(var l =0 ; l < Class.listing.length; l++){
+            if(Class.listing[l].name == this.scope_name) {
+                inst = Class.listing[l];break;
+            }
+        }
+        if(!inst){
+            var Class =  DocumentJS.Constructor
+            for(var l =0 ; l < Class.listing.length; l++){
+                if(Class.listing[l].name == this.scope_name) {
+                    inst = Class.listing[l];break;
+                }
+            }
+        }
+		if(!inst){
+            var Class =  DocumentJS.Page
+            for(var l =0 ; l < Class.listing.length; l++){
+                if(Class.listing[l].name == this.scope_name) {
+                    inst = Class.listing[l];break;
+                }
+            }
+        }
+        if(!inst) return this;
+        if(this.sub_scope){
+            var children = inst.children;
+            var child;
+            for(var i=0; i< children.length; i++){
+                if(children[i].Class.shortName.toLowerCase() == this.sub_scope.toLowerCase()) {
+                    child = children[i];break;
+                }
+            }
+            if(child) return child;
+        }
+        return inst;
+        
+    },
+    toHTML: function(){return ""},
+    linker: function(){}
+});
+
+
+
+

data/lib/javascriptmvc/documentjs/application.js

@@ -0,0 +1,285 @@
+
+/**
+ * @class DocumentJS
+ * @tag core, documentation
+ * DocumentJS provides powerful and easy to extend documentation functionality.
+ * It's smart enough to guess 
+ * at things like function names and parameters, but powerful enough to generate 
+ * <span class='highlight'>JavaScriptMVC's entire website</span>!
+ * 
+ * <br/>
+ * 
+ * <p>DocumentJS is pure JavaScript so it is easy to modify and make improvements.  First, lets show what
+ * DocumentJS can document: </p>
+ * <ul>
+ *     <li>[DocumentJS.Attribute | @attribute] -  values on an object.</li>
+ *     <li>[DocumentJS.Function | @function] - functions on an object.</li>
+ *     <li>[DocumentJS.Constructor | @constructor] - functions you call like: new Thing()</li>
+ *     <li>[DocumentJS.Class| @class] - normal JS Objects and source that uses [jQuery.Class]</li>
+ * </ul>
+ * <p>You can also specifify where your functions and attributes are being added with: </p>
+ * <ul>
+ *     <li>[DocumentJS.Prototype | @prototype] - add to the previous class or constructor's prototype functions</li>
+ *     <li>[DocumentJS.Static | @static] - add to the previous class or constructor's static functions</li>
+ *     <li>[DocumentJS.Add |@add] - add docs to a class or construtor described in another file</li>
+ * </ul>    
+ * <p>Finally, you have [DocumentJS.Directive|directives] that provide addtional info about the comment:</p>
+ * <ul>
+ *     <li>[DocumentJS.Directive.Alias|@alias] - another commonly used name for Class or Constructor</li>
+ *     <li>[DocumentJS.Directive.Author|@author] - author of class</li>
+ *     <li>[DocumentJS.Directive.CodeStart|@codestart] -> [DocumentJS.Directive.CodeEnd|@codeend] - insert highlighted code block</li>
+ *     <li>[DocumentJS.Directive.Hide|@hide] - hide in Class view</li>
+ *     <li>[DocumentJS.Directive.Inherits|@inherits] - what the Class or Constructor inherits</li>
+ *     <li>[DocumentJS.Directive.Init|@init] - constructor function</li>
+ *     <li>[DocumentJS.Directive.Param|@param] - A function's parameter</li>
+ *     <li>[DocumentJS.Directive.Plugin|@plugin] - by which plugin this object gets steald</li>
+ *     <li>[DocumentJS.Directive.Return|@return] - what a function returns</li>
+ *     <li>[DocumentJS.Directive.Tag|@tag] - tags for searching</li>
+ * </ul>
+ * <h3>Example</h3>
+ * The following documents a Person constructor.
+ * @codestart
+ * /* @constructor
+ *  * Person represents a human with a name.  Read about the 
+ *  * animal class [Animal | here].
+ *  * @init 
+ *  * You must pass in a name.
+ *  * @params {String} name A person's name
+ *  *|
+ * Person = function(name){
+ *    this.name = name
+ *    Person.count ++;
+ * }
+ * /* @Static *|
+ * steal.Object.extend(Person, {
+ *    /* Number of People *|
+ *    count: 0
+ * })
+ * /* @Prototype *|
+ * Person.prototype = {
+ *   /* Returns a formal name 
+ *    * @return {String} the name with "Mrs." added
+ *    *|
+ *   fancy_name : function(){
+ *      return "Mrs. "+this.name;
+ *   }
+ * }
+ * @codeend
+ * There are a few things to notice:
+ * <ul>
+ *     <li>The example closes comments with <i>*|</i>.  You should close them with / instead of |.</li>
+ *     <li>We create a link to another class with <i>[Animal | here]</i>.</li>
+ * </ul>
+ * 
+ * <h3>Using with a JavaScritpMVC application</h3>
+ * You just have to run the docs script in your apps scripts folder:
+ * <pre>js <i>APPNAME</i>/scripts/docs.js</pre>
+ * Open <i>APPNAME</i>/docs.html to see your documentation.
+ * <h3>Using without JavaScriptMVC</h3>
+ * Coming soon!
+ * <h3>Inspiration</h3>
+ * DocumentJS was inspired by the [http://api.jquery.com/ jQuery API Browser] by [http://remysharp.com/ Remy Sharp]
+ */
+DocumentJS.extend(DocumentJS,
+/* @Static */
+{    
+    render_to: function(file, ejs, data){
+        new DocumentJS.File(file).save( new DocumentJS.EJS({ text : readFile(ejs) }).render(data)  );
+        //MVCOptions.save(file,  this.render(ejs, data) );
+    },
+    render : function(ejs, data){
+         var v = new DocumentJS.EJS({text: readFile(ejs), name: ejs });
+        return v.render(data)
+    },
+    /**
+     * Replaces content in brackets [] with a link to source.
+     * @param {String} content Any text, usually a commment.
+     */
+    link_content : function(content){
+        return content.replace(/\[\s*([^\|\]\s]*)\s*\|?\s*([^\]]*)\s*\]/g, function(match, first, n){
+            //need to get last
+            //need to remove trailing whitespace
+            var url = DocumentJS.objects[first];
+            if(url){
+                if(!n){
+                    n = first.replace(/\.prototype|\.static/,"")
+                }
+                return "<a href='"+url+"'>"+n+"</a>"
+            }else if(typeof first == 'string' && first.match(/^https?|www\.|#/)){
+                return "<a href='"+first+"'>"+(n || first)+"</a>"
+            }
+            return  match;
+        })
+    },
+    /**
+     * Will replace with a link to a class or function if appropriate.
+     * @param {Object} content
+     */
+    link : function(content){
+        var url = DocumentJS.objects[content];
+        return url ? "<a href='#&who="+content+"'>"+content+"</a>" : content;
+    },
+    /**
+     * A map of the full name of all the objects the application creates and the url to 
+     * the documentation for them.
+     */
+    objects : {}
+});
+
+/**
+ * @constructor
+ * @hide
+ * Creates documentation for an application
+ * @init
+ * Generates documentation from the passed in files.
+ * @param {Array} total An array of path names or objects with a path and text.
+ * @param {Object} app_name The application name.
+ */
+DocumentJS.Application = function(total, app_name){
+    
+    this.name = app_name;
+    this.total = total;
+    this.files = [];
+    
+    //create each Script, which will create each class/constructor, etc
+    for(var s=0; s < total.length; s++){
+		this.files.push( new DocumentJS.Script(total[s]) ) 
+	}
+	//sort class and constructors so they are easy to find
+	this.all_sorted = DocumentJS.Class.listing.concat( DocumentJS.Constructor.listing ).sort( DocumentJS.Pair.sort_by_name )
+}
+
+
+DocumentJS.Application.prototype = 
+/* @prototype */
+{
+    /**
+     * Creates the documentation files.
+     * @param {String} path where to put the docs
+     */
+    generate : function(path, convert){
+        /* Make the needed directory structure for documentation */
+        //new steal.File('docs/classes/').mkdirs();
+        print("generating ...")
+		convert = convert || function(name, ob, everything, path){
+			var toJSON = DocumentJS.toJSON(ob)
+			
+			new DocumentJS.File(path+"/"+name+".json").save("C("+toJSON+")");
+		}
+		
+		var types = [ DocumentJS.Class, DocumentJS.Constructor, DocumentJS.Function, DocumentJS.Page, DocumentJS.Attribute]
+		for(var t = 0; t< types.length; t++){
+			for(var i = 0; i <  types[t].listing.length; i++){
+				var ob = types[t].listing[i];
+
+				var oliteral = ob.serialize();
+
+				var name = oliteral.name.replace(/ /g, "_").replace(/&#46;/g, ".").replace(/&gt;/g, "_gt_").replace(/\*/g,"_star_");
+				convert(name, oliteral, this.all_sorted, path)
+	        }
+		}
+        this.searchData(path, convert);
+        this.summary_page(path, convert)
+    },
+    /**
+     * Creates a page for all classes and constructors
+     * @param {String} summary the left hand side.
+     */
+    summary_page : function(path, convert){
+        //find index page
+        var base = path.replace(/[^\/]*$/,"");
+		for(var p = 0; p < DocumentJS.Page.listing.length; p++){
+            if(DocumentJS.Page.listing[p].full_name() == 'index')
+                this.indexPage = DocumentJS.Page.listing[p];
+        }
+        //checks if you have a summary
+        if( readFile(path+"/summary.ejs") ){
+            DocumentJS.render_to(base+"docs.html",path+"/summary.ejs" , this)
+        }else{
+            print("Using default page layout.  Overwrite by creating: "+path+"/summary.ejs");
+            DocumentJS.render_to(base+"docs.html","documentjs/jmvcdoc/summary.ejs" , {
+				pathToRoot: new DocumentJS.File(base.replace(/\/[^\/]*$/, "")).pathToRoot(),
+				path: path
+			}); //default 
+        }
+        
+        
+    },
+    indexOf : function(array, item){
+        var i = 0, length = array.length;
+        for (; i < length; i++)
+          if (array[i] === item) return i;
+        return -1;
+    },
+    addTagToSearchData : function(data, tag, searchData){
+        
+        var letter, l, depth=2, current= searchData;
+        
+        for(l=0; l < depth; l++){
+            letter = tag.substring(l,l+1);
+            if(!current[letter]){
+                current[letter] = {};
+                current[letter].list = [];
+            }
+            if(this.indexOf(current[letter].list, data) == -1)
+                current[letter].list.push(data);
+            current = current[letter];
+        }
+    },
+	addToSearchData : function(list, searchData){
+		var c, parts, part,  p,  fullName;
+		for(var i =0; i < list.length; i++){
+            c = list[i];
+            //break up into parts
+            fullName = c.full_name();
+            searchData.list[fullName] = {name: fullName, shortName: c.Class.shortName.toLowerCase(), title: c.title, tags: c.tags};
+			parts = fullName.split(".");
+            for(p=0; p< parts.length; p++){
+                part = parts[p].toLowerCase();
+                if(part == "jquery") continue;
+                this.addTagToSearchData(fullName, part, searchData)
+            }
+            //now add tags if there are tags
+            if(c.tags){
+                for(var t=0; t< c.tags.length; t++)
+                    this.addTagToSearchData(fullName, c.tags[t], searchData);
+            }
+            
+        }
+	},
+    searchData : function(path, convert){
+        var sortedClasses = DocumentJS.Class.listing.sort( DocumentJS.Pair.sort_by_name )
+        
+		//go through and create 2 level hash structure
+        var searchData = {list: {}};
+        
+        var docData = {};
+        
+        
+        
+        this.addToSearchData(sortedClasses, searchData)
+        this.addToSearchData(DocumentJS.Function.listing, searchData)
+        this.addToSearchData(DocumentJS.Constructor.listing, searchData)
+		this.addToSearchData(DocumentJS.Static.listing, searchData)
+		this.addToSearchData(DocumentJS.Prototype.listing, searchData)
+		this.addToSearchData(DocumentJS.Page.listing, searchData)
+        this.addToSearchData(DocumentJS.Attribute.listing, searchData)
+        
+		
+		new DocumentJS.File(path+"/searchData.json").save("C("+DocumentJS.toJSON(searchData, false)+")");
+		
+        //new DocumentJS.File(this.name+"/docs/searchData.json").save("C("+DocumentJS.toJSON(searchData, false)+")");
+
+    },
+    /**
+     * Only shows five folders in a path.
+     * @param {String} path a file path to convert
+     * @return {String}
+     */
+    clean_path : function(path){
+        return path;
+        var parts = path.split("/")
+         if(parts.length > 5) parts = parts.slice(parts.length - 5);
+         return parts.join("/");
+    }
+}