sproutit-sproutcore 1.0.20090721145280 → 1.0.20090721145281

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :minor: 0
-:patch: 20090721145280
-:digest: a7b4c9fd0f255164097a428ff3b8b6a640bdd389
+:patch: 20090721145281
+:digest: ba83b210ad765939b203da70844f9799493ef006
 :major: 1

data/bin/sc-docs

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib sproutcore]))
+
+SC::Tools.invoke :docs
+
+# EOF

data/{vendor/jsdoc/templates → doc_templates}/jsdoc/publish.js

@@ -2,11 +2,15 @@ function publish(symbolSet) {
 	publish.conf = {  // trailing slash expected for dirs
 		ext: ".html",
 		outDir: JSDOC.opt.d || SYS.pwd+"../out/jsdoc/",
-		templatesDir: SYS.pwd+"../templates/jsdoc/",
+		templatesDir: JSDOC.opt.t || SYS.pwd+"../doc_templates/jsdoc/",
 		symbolsDir: "symbols/",
 		srcDir: "symbols/src/"
 	};
-	
+
+  if (!publish.conf.templatesDir.match(/\/$/)) {
+    publish.conf.templatesDir += '/'; // add trailing slash
+  }
+  	
 	
 	if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
 		Link.prototype._makeSrcLink = function(srcFilePath) {

data/{vendor/jsdoc/templates → doc_templates}/sproutcore/publish.js

@@ -168,11 +168,14 @@ 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/",
+    templatesDir: JSDOC.opt.t || SYS.pwd+"../templates/sproutcore/",
     symbolsDir: "symbols/",
     srcDir: "symbols/src/"
   };
   
+  if (!publish.conf.templatesDir.match(/\/$/)) {
+    publish.conf.templatesDir += '/'; // add trailing slash
+  }
   
   if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
     Link.prototype._makeSrcLink = function(srcFilePath) {
@@ -226,13 +229,22 @@ function publish(symbolSet) {
   publish.classesIndex = classesTemplate.process(classes);
   
   try {
-    var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
+    var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"classes-json.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);
+  IO.saveFile(publish.conf.outDir, "classes.json", classesIndex);
+  classesindexTemplate = classesIndex = null;
+
+  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);
   classesindexTemplate = classesIndex = classes = null;
   
   try {

data/{vendor/jsdoc/templates → doc_templates}/sproutcore/static/default.css

@@ -1,4 +1,3 @@
-/* @override http://localhost:4020/static/sproutcore/-docs/data/default.css */
 
 /* @group Core */
 
@@ -8,8 +7,9 @@ body.sc-doc {
 }
 
 .sc-doc {
-  font: 64.5% Helvetica, Arial, Verdana, sans-serif;
-  line-height: 1em ;
+	font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+	font-size: 10px;
+	line-height: 1;
 }
 
 /* Set standard size on some things. */
@@ -18,8 +18,8 @@ body.sc-doc {
 .sc-doc dt, 
 .sc-doc li, 
 .sc-doc table {
-  line-height: 1.3em;
-  font-size: 1.2em ;
+	font-size: 12px;
+	line-height: 1.4;
 }
 
 hr
@@ -35,10 +35,10 @@ hr
 
 .sc-doc h2 {
   padding: 0;
-  padding-bottom: 4px;
-  border-bottom: 1px #555 solid;
+  padding-bottom: 3px;
+  border-bottom: 1px #aaa solid;
   text-transform: capitalize;
-  margin: 1.5em 0 0;
+  margin: 2em 0 0.5em;
   font-size: 2.2em;
 }
 
@@ -61,7 +61,7 @@ hr
   margin: 1.3em 0 0.5em 0;
 }
 
-.sc-doc p { margin: 0.5em 0; }
+.sc-doc p { margin: 1.5em 0; }
  
 .sc-doc a {
   text-decoration: none ;
@@ -81,10 +81,11 @@ hr
 
 .sc-doc dt {
   font-style: italic;
+  line-height: 2;
 }
 
 .sc-doc dd {
- margin: 0 0 1em 1em;
+ margin: 0 1em 1em 1em;
 }
 
 /* @end */
@@ -132,7 +133,7 @@ hr
 }
 
 .sc-doc .summary li code {
-  font-size: 1.1em;
+  font-size: 1em;
 }
 
 .sc-doc .summary li .description {
@@ -141,14 +142,14 @@ hr
 
 .sc-doc .summary li:hover .description {
   display: block ;
-  font-size: 0.86em;
+  font-size: 1em;
   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; */
+  -webkit-box-shadow: rgba(0,0,0,0.3) 0px 2px 5px;
   color: #4b4000;
   z-index: 100;
 }
@@ -210,3 +211,48 @@ span.sc-label
   overflow: hidden;
   width: 50px;
 }
+
+/* @group Index */
+
+#index {
+	padding-bottom: 2em;
+}
+
+#index > div {
+	clear: both;
+	position:  relative;
+	font-size: 12px;
+	padding: 10px;
+	padding-left: 220px;
+	min-height: 14px;	
+	border-bottom: 1px #ddd solid;
+}
+
+#index hr {
+	display: none;
+}
+
+#index h2 {
+	font-size: 14px;
+	border: none;
+	position: absolute;
+	left: 0;
+	top: 50%;
+	height: 14px;
+	margin: 0;
+	margin-top: -7px;
+	width: 200px;
+	text-align: right;
+}
+
+#index h2 a {
+	padding: 2px;
+}
+
+#index h2 a:hover {
+	background-color: blue;
+	color: white;
+}
+
+/* @end */
+

data/frameworks/sproutcore/lib/index.rhtml

@@ -13,7 +13,8 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-	<meta http-equiv="X-UA-Compatible" content="IE=8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=8" />
+    <meta http-equiv="Content-Script-Type" content="text/javascript" />
 <% # Set the 'title' in your config to alter this setting %>
     <title><%= title %></title>
 <% #

data/lib/sproutcore/models/project.rb

@@ -27,7 +27,7 @@ module SC
   #
   # When you load a project, here is what happens:
   #
-  # 1. Kocate and load Buildfiles, if any are found
+  # 1. Locate and load Buildfiles, if any are found
   # 2. Run project_type:target:find for all targets defined for the project.  
   #    this will locate and define the targets for the project
   # 3. If you request a build of a particular resource, a manifest will be
@@ -264,7 +264,4 @@ module SC
         
   end
   
-end
-
-
-  
+end

data/lib/sproutcore/models/target.rb

@@ -172,7 +172,7 @@ module SC
         t
       end
       ret = ret.compact.uniq
-      
+
       @required_targets[key] = ret
       return ret 
     end
@@ -397,6 +397,110 @@ module SC
       # None found
       return nil
     end
+
+    ######################################################
+    # BUILD DOCS METHODS
+    #
+
+    # Creates all of the documentation for the target.
+    # 
+    # === Options
+    #
+    #  :build_root:: the root path to place built documentation
+    #  :language::   the language to build.  defaults to preferred lang
+    #  :required::   include required targets.  defaults to true
+    def build_docs!(opts ={})
+
+      build_root   = opts[:build_root] || nil
+      language     = opts[:language] || self.config.preferred_language || :en
+      logger       = opts[:logger] || SC.logger
+      template_name = opts[:template] || 'jsdoc'
+      use_required = opts[:required]
+      use_required = true if use_required.nil? 
+      
+      # collect targets to build
+      doc_targets = [self]
+      doc_targets += self.expand_required_targets if use_required
+
+      # convert targets to manifests so we can get alll files
+      doc_manifests = doc_targets.map do |target| 
+        target.manifest_for(:language => language)
+      end
+
+      # Collect all source entries, in the order they should be loaded
+      file_list = []
+      doc_manifests.each do |manifest|
+        entry = manifest.build!.entry_for('javascript.js')
+        next if entry.nil?
+
+        # loop over entries, collecting their source entries until we get
+        # back to the original source files.  Since we expand these entries
+        # in their proper load order this should give us something suitable
+        # to hand to jsdoc.
+        entries = entry.ordered_entries || entry.source_entries
+        while entries && entries.size>0
+          new_entries = []
+          entries.each do |cur_entry|
+            sources = cur_entry.ordered_entries || cur_entry.source_entries
+            if sources
+              new_entries += sources
+            elsif entry.filename =~ /\.js$/
+              file_list << cur_entry.source_path
+            end
+          end
+          entries = new_entries
+        end
+      end
+
+      file_list = file_list.uniq # remove duplicates
+
+      logger.info "Building #{target_name} docs at #{build_root}"
+      FileUtils.mkdir_p(build_root)
+
+      # Prepare jsdoc opts
+      jsdoc_root    = SC::PATH / 'vendor' / 'jsdoc'
+      jar_path      = jsdoc_root / 'jsrun.jar'
+      runjs_path    = jsdoc_root / 'app' / 'run.js'
+      
+      # look for a directory matching the template name
+      cur_project = self.project
+      has_template = false
+      while cur_project 
+        template_path = cur_project.project_root / 'doc_templates' / template_name
+        has_template = File.directory?(template_path)
+        cur_project = has_template ? nil : cur_project.parent_project
+      end
+
+      if !has_template
+        cur_project = self.project
+        has_template = false
+        while cur_project 
+          template_path = cur_project.project_root / template_name
+          has_template = File.directory?(template_path)
+          cur_project = has_template ? nil : cur_project.parent_project
+        end
+      end
+      throw("could not find template named #{template_name}") if !has_template
+
+      # wrap files in quotes...
+      # Note: using -server gives an approx. 25% speed boost over -client 
+      # (the default)
+      js_doc_cmd = %(java -server -Djsdoc.dir="#{jsdoc_root}" -jar "#{jar_path}" "#{runjs_path}" -t="#{template_path}" -d="#{build_root}" "#{ file_list * '" "' }" -v)
+
+      logger.info "File Manifest:\r\n"
+      file_list.each { |file_path| logger.info(file_path) }
+      
+      puts "Generating docs for #{self.target_name}\r\nPlease be patient this could take awhile..."
+      
+      # use pipe so that we can immediately log output as it happens
+      IO.popen(js_doc_cmd) do |pipe|
+        while line = pipe.gets
+          logger.info line.sub(/\n$/,'')
+        end
+      end
+
+      puts "Finished."
+    end
     
   end
   

data/lib/sproutcore/tools/docs.rb

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'manifest'))
+
+module SC
+  class Tools
+
+    desc "sc-docs [TARGET..]", "Generates JSDoc's for specified targets."
+    method_options(:entries  => :optional,
+                   :clean    => true,
+                   :language => :optional,
+                   :template => :optional,
+                   ['--include-required', '-r'] => false)
+    def docs(*targets)
+
+      SC.env.build_prefix   = options.buildroot if options.buildroot
+      SC.env.clean          = options.clean
+      SC.env.build_required = options['include-required']
+      SC.env.language       = options.language
+      SC.env.template_name  = options.template
+
+      # Find all the targets
+      targets = find_targets(*targets)
+      targets.each do |target|
+        project_root = target.project.project_root
+        build_root = project_root / 'tmp' / 'docs' / target.target_name.to_s  
+
+        if [:framework, :app].include?(target.target_type)
+          if SC.env.clean
+            SC.logger.info "Cleaning #{build_root}"
+            FileUtils.rm_r(build_root) if File.directory?(build_root)
+          end
+          
+          target.build_docs!(:build_root => build_root,
+            :language => SC.env.language,
+            :required => SC.env.build_required,
+            :template => SC.env.template_name,
+            :logger   => SC.logger)
+        else
+          SC.logger.info "#{target.target_name} is not of type framework or app. Skipping."
+          SC.logger.info "#{target.target_name} is of type #{target.target_type}."
+          
+        end # if [:framework, :app]
+      end # targets.each
+    end # def docs
+  end # class Tools
+end # module SC

data/lib/sproutcore/tools.rb

@@ -259,7 +259,7 @@ module SC
     end
     
     # Core method to process command line options and then build a manifest.
-    # Shared by sc-manifest and sc-build commands.
+    # Shared by sc-manifest, sc-build and sc-docs commands.
     def build_manifests(*targets)
       
       requires_project! # get project

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sproutit-sproutcore
 version: !ruby/object:Gem::Version 
-  version: 1.0.20090721145280
+  version: 1.0.20090721145281
 platform: ruby
 authors: 
 - Sprout Systems, Inc.  Apple, Inc. and contributors
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-23 00:00:00 -07:00
+date: 2009-07-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ email: contact@sproutcore.com
 executables: 
 - sc-build
 - sc-build-number
+- sc-docs
 - sc-gen
 - sc-init
 - sc-manifest
@@ -86,6 +87,7 @@ files:
 - VERSION.yml
 - bin/sc-build
 - bin/sc-build-number
+- bin/sc-docs
 - bin/sc-gen
 - bin/sc-init
 - bin/sc-manifest
@@ -96,6 +98,14 @@ files:
 - buildtasks/manifest.rake
 - buildtasks/render.rake
 - buildtasks/target.rake
+- doc_templates/jsdoc/publish.js
+- doc_templates/jsdoc/static/default.css
+- doc_templates/jsdoc/static/header.html
+- doc_templates/jsdoc/static/index.html
+- doc_templates/sproutcore/publish.js
+- doc_templates/sproutcore/static/default.css
+- doc_templates/sproutcore/static/header.html
+- doc_templates/sproutcore/static/index.html
 - frameworks/sproutcore/Buildfile
 - frameworks/sproutcore/HISTORY
 - frameworks/sproutcore/README
@@ -798,6 +808,7 @@ files:
 - lib/sproutcore/tools.rb
 - lib/sproutcore/tools/build.rb
 - lib/sproutcore/tools/build_number.rb
+- lib/sproutcore/tools/docs.rb
 - lib/sproutcore/tools/gen.rb
 - lib/sproutcore/tools/init.rb
 - lib/sproutcore/tools/manifest.rb
@@ -918,14 +929,6 @@ files:
 - vendor/jsdoc/jsrun.jar
 - vendor/jsdoc/t/TestDoc.js
 - vendor/jsdoc/t/runner.js
-- vendor/jsdoc/templates/jsdoc/publish.js
-- vendor/jsdoc/templates/jsdoc/static/default.css
-- vendor/jsdoc/templates/jsdoc/static/header.html
-- vendor/jsdoc/templates/jsdoc/static/index.html
-- vendor/jsdoc/templates/sproutcore/publish.js
-- vendor/jsdoc/templates/sproutcore/static/default.css
-- vendor/jsdoc/templates/sproutcore/static/header.html
-- vendor/jsdoc/templates/sproutcore/static/index.html
 - vendor/jsdoc/test.js
 - vendor/jsdoc/test/addon.js
 - vendor/jsdoc/test/anon_inner.js
@@ -969,6 +972,7 @@ files:
 - vendor/yui-compressor/yuicompressor-2.4.2.jar
 has_rdoc: false
 homepage: http://www.sproutcore.com/sproutcore
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -989,7 +993,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sproutcore
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: SproutCore is a platform for building native look-and-feel applications on  the web