sc-docs 0.0.1

data/lib/sc_docs/docs/apps/docs/theme.js

@@ -0,0 +1,29 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+
+/*globals Docs */
+
+// This is the theme that defines how your app renders.
+//
+// Your app is given its own theme so it is easier and less
+// messy for you to override specific things just for your
+// app.
+//
+// You don't have to create the whole theme on your own, though:
+// your app's theme is based on SproutCore's Ace theme.
+//
+// NOTE: if you want to change the theme this one is based on, don't
+// forget to change the :css_theme property in your buildfile.
+Docs.Theme = SC.AceTheme.create({
+  name: 'docs'
+});
+
+// SproutCore needs to know that your app's theme exists
+SC.Theme.addTheme(Docs.Theme);
+
+// Setting it as the default theme makes every pane SproutCore
+// creates default to this theme unless otherwise specified.
+SC.defaultTheme = 'docs';

data/lib/sc_docs/docs/apps/docs/views/detail_list.js

@@ -0,0 +1,24 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+
+Docs.DetailListView = SC.ListView.extend({
+
+  masterPropertyPath: 'mainPage.mainPane.classList.contentView',
+
+  keyDown: function(evt){
+
+    if(evt.keyCode === 37) {
+      var propPath = this.get('masterPropertyPath');
+      var masterView = Docs.getPath(propPath);
+
+      masterView.becomeFirstResponder();
+
+      //return YES;
+    }
+
+    return sc_super();
+  }
+});

data/lib/sc_docs/docs/apps/docs/views/master_list.js

@@ -0,0 +1,35 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+
+Docs.MasterListView = SC.ListView.extend({
+
+  detailPropertyPath: 'mainPage.mainPane.detailView.workspace.symbolList.contentView',
+
+  keyDown: function(evt){
+
+    if(evt.keyCode === 39) {
+      var propPath = this.get('detailPropertyPath');
+      var detailView = Docs.getPath(propPath);
+
+      detailView.becomeFirstResponder();
+
+      var sel = Docs.selectedClassController.get('symbolSelection');
+      if (!sel || !sel.get('length')) {
+        console.log('getting content');
+        var firstObject = Docs.selectedClassController.getPath('symbols.firstObject');
+
+        var sel = SC.SelectionSet.create();
+        sel.addObjects([firstObject]).freeze();
+
+        Docs.selectedClassController.set('symbolSelection',sel);
+      }
+
+      //return YES;
+    }
+
+    return sc_super();
+  }
+});

data/lib/sc_docs/docs/apps/docs/views/methods_collection.js

@@ -0,0 +1,80 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+
+Docs.MethodsCollectionView = SC.TemplateCollectionView.extend({
+  contentBinding: 'Docs.selectedClassController.methods'
+});
+
+Handlebars.registerHelper('signature', function(object) {
+
+  var method = this.get(object);
+
+  var name = method.get('name');
+  var params = method.get('params');
+  var param, suffix;
+
+  var out = '<div class="method-signature">';
+  out += name + '(';
+
+  for(var i=0, l=params.length; i<l; i++) {
+    param = params[i];
+
+    if ( i < (l-1)) {
+      suffix = ", ";
+    } 
+    else {
+      suffix = "";
+    }
+
+    if(param.type) {
+      out += '<span class="data-type" name="%@">%@</span>'.fmt(param.type,param.type);
+    }
+
+    if(param.name) {
+      out += '<span class="method-param-name">%@%@</span>'.fmt(param.name,suffix);
+    }
+  }
+
+  out += ')';
+  out += "</div>";
+
+  return new Handlebars.SafeString(out);
+});
+
+
+Handlebars.registerHelper('returns', function(object) {
+
+  var method = this.get(object);
+  var returns = method.get('returns');
+  if (!returns) return "";
+  
+	var out = "";
+
+  out = '<div class="returns">';
+    out += '<span class="name">Returns: </span>'; 
+    out += '<span class="data-type" name="'+returns.type+'">'+returns.type+'</span>';
+    out += '<span class="return-text">'+returns.desc+'</span>';
+  out += "</div>";
+
+  return new Handlebars.SafeString(out);
+});
+
+Handlebars.registerHelper('extends', function(object) {
+
+  var extendsFrom = this.getPath(object);
+  if (!extendsFrom) return "";
+  
+	var out = "";
+  var len = extendsFrom.length;
+
+  for(var i=0; i<len; i++) {
+    var extendFrom = extendsFrom[i];
+    out += '<span class="data-type" name="'+extendFrom+'">'+extendFrom+'</span>';
+  }
+  
+
+  return new Handlebars.SafeString(out);
+});

data/lib/sc_docs/docs/apps/docs/views/properties_collection.js

@@ -0,0 +1,9 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+
+Docs.PropertiesCollectionView = SC.TemplateCollectionView.extend({
+  contentBinding: 'Docs.selectedClassController.properties'
+});

data/lib/sc_docs/generator.rb

@@ -0,0 +1,145 @@
+require 'fileutils'
+
+require 'sc_docs/server'
+
+module ScDocs
+  class Generator
+
+    attr_reader :input_dir
+
+    attr_reader :output_dir
+
+    attr_reader :template
+
+    attr_reader :verbose
+
+    def initialize(options={})
+      @input_dir  = File.expand_path(options[:input_dir])
+      @output_dir = File.expand_path(options[:output_dir])
+      @verbose    = options[:verbose]
+    end
+
+    def command
+      @command ||= begin
+        run_js_path = File.expand_path("../../../vendor/jsdoc/app/run.js", __FILE__)
+        command = "#{run_js_path} -apsv -r=20 -t=\"#{template}\" \"#{input_dir}\" -d=\"#{output_dir}\" -f=class.js -l=Docs.Class"
+      end
+    end
+
+    def generate
+      prep
+      run_command
+    end
+
+    def preview
+      prep
+      run_command
+      run_server
+    end
+
+    private
+
+      def prep
+        FileUtils.rm_rf output_dir
+        FileUtils.mkdir_p File.dirname(output_dir)
+      end
+
+      def run_command
+        puts "#{command}\n\n" if verbose
+        verbose ? system(command) : `#{command}`
+
+        copy_files
+
+        puts "Finished Building\n\n"
+      end
+
+      def copy_files
+        # Copy other files to output
+        path = File.join(template, "output")
+        if File.directory?(path)
+          puts "Copying additional files" if verbose
+          Dir["#{path}/*"].each{|p| FileUtils.cp_r(p, output_dir) }
+        end
+      end
+      
+      def run_server
+        Server.new(output_dir).start
+      end
+
+  end
+
+  class HtmlGenerator < Generator
+
+    def initialize(options={})
+      super
+      @template = File.expand_path(options[:template])
+    end
+
+  end
+
+  class ScGenerator < Generator
+
+    attr_reader :app_dir
+    
+    attr_reader :project_name
+
+    def initialize(options={})
+      super
+      @template = File.expand_path("../templates/sc_fixture", __FILE__)
+      @app_dir    = File.expand_path(options[:output_dir])
+      @output_dir = File.join(@app_dir, "apps", "docs", "fixtures")
+      @project_name = options[:project_name] || "docs_viewer"
+    end
+
+    def generate
+      prep
+      run_command
+      deploy
+    end
+
+    private
+
+      def prep
+        target_dir = File.dirname(app_dir)
+        FileUtils.rm_rf app_dir
+        FileUtils.mkdir_p target_dir
+        FileUtils.cp_r File.expand_path("../docs", __FILE__), target_dir
+      end
+
+      def run_server
+        # TODO: Run SC Inline
+        Dir.chdir app_dir
+        system("sc-server --port=9292")
+      end
+
+      def deploy
+        require 'tempfile' # For Dir.tmpdir
+
+        tmp_path = File.join(Dir.tmpdir, "docs#{rand(100000)}")
+
+        FileUtils.mv app_dir, tmp_path
+        
+        Dir.chdir tmp_path
+
+        build_cmd = "sc-build -r --languages=en --build-targets=docs --build=#{project_name}"
+        
+        puts "Deploying...\n\n"
+
+        puts "#{build_cmd}\n\n" if verbose
+        verbose ? system(build_cmd) : `#{build_cmd}`
+
+        FileUtils.rm_rf app_dir
+        FileUtils.mkdir_p app_dir
+
+        docs_dir = File.join(app_dir, "sc_docs")
+        FileUtils.cp_r File.join(tmp_path, "tmp", "build", "sc_docs"), docs_dir
+        FileUtils.cp File.join(docs_dir, "docs", "en", project_name, "index.html"), docs_dir
+
+        puts "Deployed"
+
+      ensure
+        FileUtils.rm_rf tmp_path
+      end
+  
+  end
+end

data/lib/sc_docs/server.rb

@@ -0,0 +1,21 @@
+require 'rack'
+
+module ScDocs
+  class Server < ::Rack::Server
+    def initialize(directory)
+      @directory = directory
+
+      begin
+        require 'thin'
+        super(:server => ::Thin, :Port => 9292)
+      rescue LoadError
+        require 'webrick'
+        super(:server => ::WEBrick, :Host => "localhost", :Port => 9292)
+      end
+    end
+
+    def app
+      Rack::Directory.new(@directory)
+    end
+  end
+end

data/lib/sc_docs/templates/docs.sproutcore.com/allclasses.tmpl

@@ -0,0 +1,31 @@
+<span class="odd active"><a href="/">API Documentation Index</a></span>
+	<for each="thisClass" in="data">
+	{!
+		if (thisClass.alias == "_global_") {
+        if ($thisClass_i % 2 == 1) { 
+          output += "<span class='odd global'>";
+          output += new Link().toClass(thisClass.alias);
+          output += "</span>";
+          
+        };
+        if ($thisClass_i % 2 == 0) { 
+          output += "<span class='even' global>";
+          output += new Link().toClass(thisClass.alias);
+          output += "</span>";
+        };
+		}
+		else {
+        if ($thisClass_i % 2 == 1) { 
+          output += "<span class='odd'>";
+          output += new Link().toClass(thisClass.alias);
+          output += "</span>";
+          
+        };
+        if ($thisClass_i % 2 == 0) { 
+          output += "<span class='even'>";
+			    output += new Link().toClass(thisClass.alias);
+          output += "</span>";
+        };
+		}
+	!}
+	</for>

data/lib/sc_docs/templates/docs.sproutcore.com/allfiles.tmpl

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>SproutCore</title>
+  <meta name="description" content="A framework for building fast, desktop caliber web applications." />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <link rel="stylesheet" href="/css/api.css" />
+  <script src="js/lib/modernizr-1.7.min.js"></script>
+  <!--[if lt IE 9]>
+  <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+	
+	<body id="docs" class="blue">
+		{+include("static/header.html")+}
+		
+			<section id="list">
+    <header>
+    <h2>SproutCore API Classes</h2>
+      <form action="#" role="search">
+        <input type="text" />
+      </form>
+    </header>
+    <div>
+			{+publish.classesIndex+}
+		</div>
+  <footer>
+    <button>SUBSCRIBE TO MAILING LIST</button>
+  </footer>
+    </section>
+		
+		<div role="main">
+      <section id="documentation">
+			<h1 class="classTitle">File Index</h1>
+			
+			<for each="item" in="data">
+				<h2>{+new Link().toSrc(item.alias).withText(item.name)+}</h2>
+				<if test="item.desc">{+resolveLinks(item.desc)+}</if>
+				<dl>
+					<if test="item.author">
+						<dt class="heading">Author:</dt>
+						<dd>{+item.author+}</dd>
+					</if>
+					<if test="item.version">
+						<dt class="heading">Version:</dt>
+							<dd>{+item.version+}</dd>
+					</if>
+					{! var locations = item.comment.getTag('location').map(function($){return $.toString().replace(/(^\$ ?| ?\$$)/g, '').replace(/^HeadURL: https:/g, 'http:');}) !}
+					<if test="locations.length">
+						<dt class="heading">Location:</dt>
+							<for each="location" in="locations">
+							<dd><a href="{+location+}">{+location+}</a></dd>
+							</for>
+					</if>
+				</dl>
+			</for>
+			
+		<div class="fineprint" style="clear:both">
+			<if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
+			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
+		</div>
+</section>
+		</div>
+	</body>
+</html>