sproutcore 0.9.13 → 0.9.14

data/jsdoc/templates/sproutcore/index.tmpl

@@ -1,8 +1,8 @@
 {!
 function keys(o) {
-	var keys = [];
-	for (var k in o) { keys.push(k); }
-	return keys;
+  var keys = [];
+  for (var k in o) { keys.push(k); }
+  return keys;
 }
 
 function groupName(path) {
@@ -19,38 +19,37 @@ function groupName(path) {
   }
 };
 
-function getSymbols(className, thisClass) {
-  var ret = [className.toLowerCase()] ;
+function getSymbols(thisClass) {
+  var ret = [thisClass.alias.toLowerCase()] ;
+  var len = thisClass.properties.length ;
   
-  var f = function(data) {
-    if (data && data.length) {
-      var idx = data.length ;
-      while(--idx >= 0) { 
-        var name = data[idx].name ;
-        if (name) ret.push(name.toLowerCase()) ;
-      }
-    }
-  };
-  
-  f(thisClass.properties) ;
-  f(thisClass.methods) ;
+  while (--len>=0) {
+    ret.push(thisClass.properties[len].alias.toLowerCase()) ;
+  }
   
   return ret.join(' ') ;
 };
 
 !}
-{ records: [<for each="classname" in="keys(data).sort()">
-  { "type": "Doc", 
-    "guid": "{+classname+}", 
-    "title": "{+classname+}", 
-    "url": "{+data[classname][0].docs+}", 
-    "group": "{+groupName(data[classname][0].file.path)+}", 
-    "symbols": "{+getSymbols(classname, data[classname][0])+}",
-    "path": "{+data[classname][0].file.path+}"
-  },</for>
-  { "type": "Doc", 
-    "guid": "_GLOBALS", 
-    "title": "GLOBALS", 
-    "url": "globals.html" 
-  }]
+{ records: [
+  <for each="thisClass" in="data">
+    <if test="groupName(thisClass.srcFile) !== undefined">
+      { "type": "Doc", 
+        "guid": "{+(thisClass.alias)+}", 
+        <if test="!(thisClass.alias == 'SC')">
+          "title": "{+(thisClass.alias)+}",
+        </if>
+        <if test="(thisClass.alias == 'SC')">
+          "title": "SproutCore (SC)",
+        </if>
+        "url": "{+(thisClass.alias)+}.html",
+        <if test="!(thisClass.alias == 'SC')">
+          "group": "{+groupName(thisClass.srcFile)+}",
+        </if>
+        "symbols": "{+getSymbols(thisClass)+}",
+        "path": "{+thisClass.srcFile+}"
+      },
+    </if>
+  </for>
+  ]
 }

data/jsdoc/templates/sproutcore/publish.js

@@ -1,10 +1,3 @@
-require("app/JsHilite.js");
-
-function basename(filename) {
-  filename.match(/([^\/\\]+)\.[^\/\\]+$/);
-  return RegExp.$1;
-}
-
 // This is the orginial function from Stuart Langridge at http://www.kryogenix.org/
 // This is the update function from Jeff Minard - http://www.jrm.cc/
 function superTextile(s) {
@@ -21,13 +14,13 @@ function superTextile(s) {
             ['~', '~', 'sub'],   
             ['\\^', '\\^', 'sup'], // me
             ['{{{', '}}}', 'code']];
-  
+
   for (var i=0;i<qtags.length;i++) {
     var ttag_o = qtags[i][0], ttag_c = qtags[i][1], htag = qtags[i][2];
     re = new RegExp(ttag_o+'\\b(.+?)\\b'+ttag_c,'g');
     r = r.replace(re,'<'+htag+'>'+'$1'+'</'+htag+'>');
   };
-  
+
   // underscores count as part of a word, so do them separately
   re = new RegExp('\\b_(.+?)_\\b','g');
   r = r.replace(re,'<em>$1</em>');
@@ -61,16 +54,16 @@ function superTextile(s) {
 
     // handle incode behavior.
     if (incode) {
-      
+
       // Look for end closing bracket and process it.
       if (line.match(/^\s*}}}\s*$/)) {
         incode = 0 ;
         out.push("<p class=\"code\"><code>" + cur_block.join("<br />") + "</code></p>") ;
         cur_block = [] ;
-        
-      // otherwise, just add the line to the current block
+
+      // otherwise, just add the line to the current block, escaping HTML entities
       } else {
-        cur_block.push(line) ;
+        cur_block.push(line.split("&").join("&amp;").split("<").join("&lt;").split(">").join("&gt;")) ;
       }
 
     // for normal text, look for line-level items to replace.  If no
@@ -81,17 +74,17 @@ function superTextile(s) {
       if ((line == '') || line.match(/^\s+$/)) {
         changed = 1 ;
         line = '' ;
-        
+
       // convert bq. => blockquote.
       } else if (line.search(/^\s*bq\.\s+/) != -1) { 
         line = line.replace(/^\s*bq\.\s+/,'\t<blockquote>')+'</blockquote>'; 
         changed = 1; 
-        
+
       // convert h* => heading
       } else if (line.search(/^\s*h[1|2|3|4|5|6]\.\s+/) != -1) { 
         line = line.replace(/^\s*h([1|2|3|4|5|6])\.(.+)/, '<h$1>$2</h$1>');
         changed = 1; 
-        
+
       // convert - to bulletted list.  liu tag will be fixed later.
       } else if (line.search(/^\s*-\s+/) != -1) { 
         line = line.replace(/^\s*-\s+/,'\t<liu>') + '</liu>'; changed = 1;
@@ -101,12 +94,12 @@ function superTextile(s) {
       } else if (line.search(/^\s*\*\s+/) != -1) { 
         line = line.replace(/^\s*\*\s+/,'\t<liu>') + '</liu>'; changed = 1;
         changed = 1;
-        
+
       // convert # to numbered list. lio tag will be fixed later. 
       } else if (line.search(/^\s*#\s+/) != -1) { 
         line = line.replace(/^\s*#\s+/,'\t<lio>') + '</lio>'; changed = 1; 
         changed = 1;
-        
+
       // open code tag will start code
       } else if (line.match(/^\s*\{\{\{\s*$/)) {
         incode++ ;
@@ -141,19 +134,19 @@ function superTextile(s) {
   for (var i=0;i<out.length;i++) {
     line = out[i];
     var addin = null ;
-    
+
     if (inlist && listtype == 'ul' && !line.match(/^\t<liu/)) { 
       addin = '</ul>\n'; inlist = 0; 
     }
-    
+
     if (inlist && listtype == 'ol' && !line.match(/^\t<lio/)) { 
       addin = '</ol>\n'; inlist = 0; 
     }
-    
+
     if (!inlist && line.match(/^\t<liu/)) { 
       line = '<ul>' + line; inlist = 1; listtype = 'ul'; 
     }
-    
+
     if (!inlist && line.match(/^\t<lio/)) { 
       line = '<ol>' + line; inlist = 1; listtype = 'ol'; 
     }
@@ -169,73 +162,172 @@ function superTextile(s) {
   r = r.replace(/li[o|u]>/g,'li>');
 
   return r;
-} ;
+};
 
-function publish(fileGroup, context) {
-  var classTemplate = new JsPlate(context.t+"class.tmpl");
-  var indexTemplate = new JsPlate(context.t+"index.tmpl");
+function publish(symbolSet) {
+  publish.conf = {  // trailing slash expected for dirs
+    ext: ".html",
+    outDir: JSDOC.opt.d || SYS.pwd+"../out/jsdoc/",
+    templatesDir: SYS.pwd+"../templates/sproutcore/",
+    symbolsDir: "symbols/",
+    srcDir: "symbols/src/"
+  };
   
-  var allFiles = {};
-  var allClasses = {};
-  var globals = {methods:[], properties:[], alias:"GLOBALS", isStatic:true};
   
-  for (var i = 0; i < fileGroup.files.length; i++) {
-    var file_basename = basename(fileGroup.files[i].filename);
-    var file_srcname = file_basename+".src.html";
-    
-    for (var s = 0; s < fileGroup.files[i].symbols.length; s++) {
-      if (fileGroup.files[i].symbols[s].isa == "CONSTRUCTOR") {
-        var thisClass = fileGroup.files[i].symbols[s];
-        // sort inherited methods by class
-        var inheritedMethods = fileGroup.files[i].symbols[s].getInheritedMethods();
-        if (inheritedMethods.length > 0) {
-          thisClass.inherited = {};
-          for (var n = 0; n < inheritedMethods.length; n++) {
-            if (! thisClass.inherited[inheritedMethods[n].memberof]) thisClass.inherited[inheritedMethods[n].memberof] = [];
-            thisClass.inherited[inheritedMethods[n].memberof].push(inheritedMethods[n]);
-          }
-        }
-        
-        thisClass.name = fileGroup.files[i].symbols[s].alias;
-        thisClass.source = file_srcname;
-        thisClass.filename = fileGroup.files[i].filename;
-        thisClass.docs = thisClass.name+".html";
-        
-        if (!allClasses[thisClass.name]) allClasses[thisClass.name] = [];
-        allClasses[thisClass.name].push(thisClass);
-      }
-      else if (fileGroup.files[i].symbols[s].alias == fileGroup.files[i].symbols[s].name) {
-        if (fileGroup.files[i].symbols[s].isa == "FUNCTION") {
-          globals.methods.push(fileGroup.files[i].symbols[s]);
-        }
-        else {
-          globals.properties.push(fileGroup.files[i].symbols[s]);
-        }
-      }
+  if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
+    Link.prototype._makeSrcLink = function(srcFilePath) {
+      return "&lt;"+srcFilePath+"&gt;";
     }
+  }
+  
+  IO.mkPath((publish.conf.outDir+"symbols/src").split("/"));
     
-    // if (!allFiles[fileGroup.files[i].path]) {
-    //   var hiliter = new JsHilite(IO.readFile(fileGroup.files[i].path), JsDoc.opt.e);
-    //   IO.saveFile(context.d, file_srcname, hiliter.hilite());
-    // }
-    fileGroup.files[i].source = file_srcname;
-    allFiles[fileGroup.files[i].path] = true;
+  // used to check the details of things being linked to
+  Link.symbolSet = symbolSet;
+
+  try {
+    var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl");
+    var classesTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allclasses.tmpl");
+  }
+  catch(e) {
+    print(e.message);
+    quit();
   }
   
-  for (var c in allClasses) {
-    outfile = c+".html";
-    allClasses[c].outfile = outfile;
-    var output = classTemplate.process(allClasses[c]);
-    IO.saveFile(context.d, outfile, output);
+  // filters
+  function hasNoParent($) {return ($.memberOf == "")}
+  function isaFile($) {return ($.is("FILE"))}
+  function isaClass($) {return ($.is("CONSTRUCTOR") || $.isNamespace)}
+  
+  var symbols = symbolSet.toArray();
+  
+  var files = JSDOC.opt.srcFiles;
+   for (var i = 0, l = files.length; i < l; i++) {
+     var file = files[i];
+     var srcDir = publish.conf.outDir + "symbols/src/";
+    makeSrcFile(file, srcDir);
+   }
+   
+   var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
+  
+  Link.base = "../";
+   publish.classesIndex = classesTemplate.process(classes); // kept in memory
+  
+  for (var i = 0, l = classes.length; i < l; i++) {
+    var symbol = classes[i];
+    var output = "";
+    output = classTemplate.process(symbol);
+    
+    IO.saveFile(publish.conf.outDir+"symbols/", symbol.alias+publish.conf.ext, output);
+  }
+  
+  // regenrate the index with different relative links
+  Link.base = "";
+  publish.classesIndex = classesTemplate.process(classes);
+  
+  try {
+    var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
+  }
+  catch(e) { print(e.message); quit(); }
+  
+  var classesIndex = classesindexTemplate.process(classes);
+  // IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex);
+  IO.saveFile(publish.conf.outDir, "classes.js", classesIndex);
+  classesindexTemplate = classesIndex = classes = null;
+  
+  try {
+    var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl");
   }
+  catch(e) { print(e.message); quit(); }
   
-  output = classTemplate.process([globals]);
-  IO.saveFile(context.d, "globals.html", output);
+  var documentedFiles = symbols.filter(isaFile);
+  var allFiles = [];
   
-  var output = indexTemplate.process(allClasses);
-  IO.saveFile(context.d, "classes.js", output);
-  IO.copyFile(context.t+"index.html", context.d);
-  IO.copyFile(context.t+"splash.html", context.d);
-  IO.copyFile(context.t+"default.css", context.d) ;
-  IO.copyFile(context.t+"prototype.js", context.d) ;
+  for (var i = 0; i < files.length; i++) {
+    allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
+  }
+  
+  for (var i = 0; i < documentedFiles.length; i++) {
+    var offset = files.indexOf(documentedFiles[i].alias);
+    allFiles[offset] = documentedFiles[i];
+  }
+    
+  allFiles = allFiles.sort(makeSortby("name"));
+
+  var filesIndex = fileindexTemplate.process(allFiles);
+  IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex);
+  fileindexTemplate = filesIndex = files = null;
+}
+
+
+/** Just the first sentence. */
+function summarize(desc) {
+  if (typeof desc != "undefined")
+    return desc.match(/([\w\W]+?\.)[^a-z0-9]/i)? RegExp.$1 : desc;
+}
+
+/** make a symbol sorter by some attribute */
+function makeSortby(attribute) {
+  return function(a, b) {
+    if (a[attribute] != undefined && b[attribute] != undefined) {
+      a = a[attribute].toLowerCase();
+      b = b[attribute].toLowerCase();
+      if (a < b) return -1;
+      if (a > b) return 1;
+      return 0;
+    }
+  }
 }
+
+function include(path) {
+  var path = publish.conf.templatesDir+path;
+  return IO.readFile(path);
+}
+
+function makeSrcFile(path, srcDir, name) {
+  if (JSDOC.opt.s) return;
+  
+  if (!name) {
+    name = path.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
+    name = name.replace(/\:/g, "_");
+  }
+  
+  var src = {path: path, name:name, charset: IO.encoding, hilited: ""};
+  
+  if (defined(JSDOC.PluginManager)) {
+    JSDOC.PluginManager.run("onPublishSrc", src);
+  }
+
+  if (src.hilited) {
+    IO.saveFile(srcDir, name+publish.conf.ext, src.hilited);
+  }
+}
+
+function makeSignature(params) {
+  if (!params) return "()";
+  var signature = "("
+  +
+  params.filter(
+    function($) {
+      return $.name.indexOf(".") == -1; // don't show config params in signature
+    }
+  ).map(
+    function($) {
+      return $.name;
+    }
+  ).join(", ")
+  +
+  ")";
+  return signature;
+}
+
+/** Find symbol {@link ...} strings in text and turn into html links */
+function resolveLinks(str, from) {
+  str = str.replace(/\{@link ([^} ]+) ?\}/gi,
+    function(match, symbolName) {
+      return new Link().toSymbol(symbolName);
+    }
+  );
+  
+  return str;
+}

data/jsdoc/templates/sproutcore/static/default.css

@@ -0,0 +1,191 @@
+/* @override http://localhost:4020/static/sproutcore/-docs/data/default.css */
+
+/* @group Core */
+
+body.sc-doc {
+  background-color: white  ;
+  padding: 20px;
+}
+
+.sc-doc {
+  font: 64.5% Helvetica, Arial, Verdana, sans-serif;
+  line-height: 1em ;
+}
+
+/* Set standard size on some things. */
+.sc-doc p, 
+.sc-doc dd, 
+.sc-doc dt, 
+.sc-doc li, 
+.sc-doc table {
+  line-height: 1.3em;
+  font-size: 1.3em ;
+}
+
+.sc-doc h1 {
+  font-size: 3em;
+  margin: 0 0 1em 0;
+  text-transform: capitalize;
+}
+
+.sc-doc h2 {
+  padding: 0;
+  padding-bottom: 4px;
+  border-bottom: 1px #555 solid;
+  text-transform: capitalize;
+  margin: 1.5em 0 0;
+  font-size: 2.2em;
+}
+
+.sc-doc h3 {
+  font-size: 2em;
+  padding: 0;
+  margin: 3em 0 0 0;  
+}
+
+.sc-doc h4 {
+  font-weight: normal ;
+  font-size: 1.4em;
+  margin: 0.5em 0 0 0;
+  padding: 0;
+}
+
+.sc-doc h5 {
+  font-size: 1.3em;
+  padding: 0;
+  margin: 1.3em 0 0.5em 0;
+}
+
+.sc-doc p { margin: 0.5em 0; }
+ 
+.sc-doc a {
+  text-decoration: none ;
+}
+
+.sc-doc label {
+  font-weight: bold ;
+}
+
+.sc-doc .sc-theme .ghost {
+  -moz-user-select: none;
+  -khtml-user-select: none;
+  user-select: none;
+  opacity: 0.45;
+  -moz-opacity: .45 ;
+}
+
+.sc-doc dt {
+  font-style: italic;
+}
+
+.sc-doc dd {
+ margin: 0 0 1em 1em;
+}
+
+/* @end */
+
+/* @group Summary Table */
+
+.sc-doc table.summary {
+  min-width: 600px;
+  border: 1px #999 solid;
+  border-bottom: none ;
+  border-spacing: 0;
+  margin-bottom: 2em;
+}
+
+.sc-doc table.summary td {
+  border-bottom: 1px #999 solid;
+  border-collapse: collapse;
+  padding: 0.5em;
+  text-align: left ;
+}
+
+.sc-doc table.summary .even td {
+  background-color: #eef;
+}
+
+.sc-doc table.summary td.label {
+  font-weight: bold ;
+  width: 100px;
+  text-align: right ;
+  padding-right: 4px;
+}
+
+.sc-doc table.summary td.value {
+  min-width: 300px;
+  width: 300px;
+}
+
+/* @end */
+
+/* @group Field & Method Summary */
+
+.sc-doc .summary li {
+  list-style-type: none ;
+  position: relative;
+}
+
+.sc-doc .summary li code {
+  font-size: 1.1em;
+}
+
+.sc-doc .summary li .description {
+  display: none ;
+}
+
+.sc-doc .summary li:hover .description {
+  display: block ;
+  font-size: 0.86em;
+  position: absolute ;
+  left: 80px;
+  bottom: 2em;
+  padding: 0.3em 1em ;
+  background-color: #fff898;
+  border: 1px solid #bbae2f;
+  /* -webkit-box-shadow: rgba(0,0,0,0.3) 0px 2px 5px; */
+  color: #4b4000;
+  z-index: 100;
+}
+
+/* @end */
+
+/* @group Detail */
+
+.sc-doc .detail p.signature {
+  padding: 0;
+  margin: 1em 0;
+  font-family: Courier, mono;
+}
+
+.sc-doc .detail p.signature .type {
+  font-style: italic;
+}
+
+.sc-doc .detail p.signature .name {
+  font-weight: bold ;
+}
+
+/* @end */
+
+.sc-doc .jsdoc_ctime {
+  border-top: 1px #ccc solid ;
+  padding: 4px 0;
+  margin-top: 20px;
+  margin-bottom: 0px;
+  font-size: 1.0em;
+  text-align: center ;
+  color: #888 ;
+}
+
+/* @group Description */
+
+.sc-doc .description blockquote,
+.sc-doc .description p.code {
+  padding:  10px ;
+  margin: 10px 20px;
+  background-color: #f5f5f5 ;
+  border: 1px #ccc solid ;
+}
+
+/* @end */

data/jsdoc/templates/sproutcore/static/header.html

@@ -0,0 +1,2 @@
+<div id="header">
+</div>

data/jsdoc/templates/sproutcore/static/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>Generated Javascript Documentation</title>
+</head>
+<frameset cols="20%,80%">
+  <frame src="allclasses-frame.html" name="packageFrame" />
+  <frame src="splash.html" name="classFrame" />
+  <noframes>
+    <body>
+    <p>
+    This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
+    </p>
+    </body>
+  </noframes>
+</frameset>
+</html>

data/jsdoc/templates/sproutcore/symbol.tmpl

@@ -0,0 +1,35 @@
+<symbol alias="{+data.alias+}">
+  <name>{+data.name+}</name>
+  <memberOf>{+data.memberOf+}</memberOf>
+  <isStatic>{+data.isStatic+}</isStatic>
+  <isa>{+data.isa+}</isa>
+  <desc>{+data.desc+}</desc>
+  <classDesc>{+data.classDesc+}</classDesc>
+  
+  <methods><for each="method" in="data.methods">
+    <method>
+      <name>{+method.name+}</name>
+      <memberOf>{+method.memberOf+}</memberOf>
+      <isStatic>{+method.isStatic+}</isStatic>
+      <desc>{+method.desc+}</desc>
+      <params><for each="param" in="method.params">
+        <param>
+          <type>{+param.type+}</type>
+          <name>{+param.name+}</name>
+          <desc>{+param.desc+}</desc>
+          <defaultValue>{+param.defaultValue+}</defaultValue>
+        </param></for>
+      </params>
+    </method></for>
+  </methods>
+  
+  <properties><for each="property" in="data.properties">
+    <property>
+      <name>{+property.name+}</name>
+      <memberOf>{+property.memberOf+}</memberOf>
+      <isStatic>{+property.isStatic+}</isStatic>
+      <desc>{+property.desc+}</desc>
+      <type>{+property.type+}</type>
+    </property></for>
+  </properties>
+</symbol>

data/jsdoc/test/addon.js

@@ -0,0 +1,24 @@
+String.prototype.reverse = function() {
+}
+
+String.prototype.reverse.utf8 = function() {
+}
+
+Function.count = function() {
+}
+
+/** @memberOf Function */
+Function.count.reset = function() {
+}
+
+/** @memberOf Function */
+count.getValue = function() {
+}
+
+/** @memberOf Function.prototype */
+getSig = function() {
+}
+
+/** @memberOf Function.prototype */
+Function.prototype.getProps = function() {
+}