[4/4] git commit: Generate CoffeeScript documentation along with JavaDocs

[hl...@apache.org]

Updated Branches:
  refs/heads/master 108db6b77 -> a12ef646b


Generate CoffeeScript documentation along with JavaDocs


Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo
Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/a12ef646
Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/a12ef646
Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/a12ef646

Branch: refs/heads/master
Commit: a12ef646b70a11b904d7df914444a630e6b5b3c2
Parents: 2cf7589
Author: Howard M. Lewis Ship <hl...@apache.org>
Authored: Thu Jan 3 12:11:54 2013 -0800
Committer: Howard M. Lewis Ship <hl...@apache.org>
Committed: Thu Jan 3 12:11:54 2013 -0800

----------------------------------------------------------------------
 build.gradle                                       |   68 +++++++++----
 .../bootstrap-2.2.2/css/bootstrap.min.css          |    9 ++
 .../img/glyphicons-halflings-white.png             |  Bin 0 -> 8777 bytes
 .../bootstrap-2.2.2/img/glyphicons-halflings.png   |  Bin 0 -> 12799 bytes
 src/docroot-template/index.html                    |   83 +++++++++++++++
 src/docroot-template/tapestry-logo.png             |  Bin 0 -> 15412 bytes
 6 files changed, 141 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/a12ef646/build.gradle
----------------------------------------------------------------------
diff --git a/build.gradle b/build.gradle
index 398fe5a..340d121 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,5 +1,7 @@
 description = "Apache Tapestry 5 Project"
 
+import org.apache.tools.ant.filters.ReplaceTokens
+
 apply plugin: "base"
 apply plugin: "sonar"
 
@@ -7,22 +9,22 @@ apply from: "ssh.gradle"
 apply from: "md5.gradle"
 
 project.ext.versions = [
-  // Remember that when generating a release, this should be incremented. Also don"t forget to
-  // tag the release in Subversion.
-  // Version number is always "5.x(.y)?-SNAPSHOT" and only gets fixed, e.g. to 5.4-alpha-1
-  // during a release
-  jetty: "7.0.0.v20091005",
-  tomcat: "6.0.30",
-  testng: "6.5.2",
-  easymock: "3.0",
-  servletapi: "2.5",
-  spock: "0.7-groovy-2.0",
-  hibernate: "4.1.2.Final",
-  groovy: "2.0.5"
+    // Remember that when generating a release, this should be incremented. Also don"t forget to
+    // tag the release in Subversion.
+    // Version number is always "5.x(.y)?-SNAPSHOT" and only gets fixed, e.g. to 5.4-alpha-1
+    // during a release
+    jetty: "7.0.0.v20091005",
+    tomcat: "6.0.30",
+    testng: "6.5.2",
+    easymock: "3.0",
+    servletapi: "2.5",
+    spock: "0.7-groovy-2.0",
+    hibernate: "4.1.2.Final",
+    groovy: "2.0.5"
 ]
 
 // Provided so that the CI server can override the normal version number for nightly builds.
-project.version =  "5.4-alpha-2" + suffix()
+project.version = "5.4-alpha-2" + suffix()
 
 def suffix() {
     // When building on the CI server, make sure -SNAPSHOT is appended, as it is a nightly build.
@@ -280,7 +282,7 @@ task aggregateJavadoc(type: Javadoc) {
 
     // As part of generating the documentation, ALSO copy any related files:
     // Any extra images (Tapestry logo)
-    // Any images stored under src/main/java ... everything exclude .java, .xdoc and package.html
+    // Any images stored under src/main/java ... everything but .java, .xdoc and package.html
 
     doLast {
         copy {
@@ -298,6 +300,27 @@ task aggregateJavadoc(type: Javadoc) {
     }
 }
 
+task coffeeScriptDocs(type: Exec) {
+    group "Documentation"
+    description "Build docco documentation for all CoffeeScript sources"
+
+    def outputDir = file("$buildDir/documentation/coffeescript")
+
+    def sources = subprojects*.fileTree("src/main", {
+        include "**/*.coffee"
+    })*.files.flatten()
+
+    // Needs to be installed via "npm install -g docco"
+    executable "docco"
+    args "--output", outputDir
+    args sources
+
+    inputs.files sources
+    outputs.dir outputDir
+}
+
+
+
 dependencies {
     meta aggregateJavadoc.outputs.files
 }
@@ -335,7 +358,7 @@ task zippedSources(type: Zip) {
 
 task zippedJavadoc(type: Zip) {
     dependsOn aggregateJavadoc
-    description "Zip archive of the project's aggregate JavaDoc"
+    description "Zip archive of the project's aggregate JavaDoc and CoffeeScript documentation"
     group "Release artifact"
 
     destinationDir buildDir
@@ -343,8 +366,15 @@ task zippedJavadoc(type: Zip) {
     version project.version
     classifier "javadocs"
 
-    from aggregateJavadoc.outputs.files
-    into "apidocs"
+    from file("src/docroot-template"), {
+        filter ReplaceTokens, tokens: [version: project.version]
+    }
+
+    into "apidocs", { from aggregateJavadoc.outputs.files }
+
+
+    into "coffeescript", { from coffeeScriptDocs.outputs.files }
+
 }
 
 task zippedBinaries(type: Zip) {
@@ -373,7 +403,7 @@ task zippedBinaries(type: Zip) {
         include "*.txt"
     }
 
-    subprojects.each {  sub ->
+    subprojects.each { sub ->
         from(sub.projectDir) {
             include "*.txt"
             into sub.name
@@ -425,7 +455,7 @@ if (canDeploy) {
 
         doFirst {
             logger.info "Uploading the following files to people.apache.org (as user '${userName}'):"
-            source.files.each { logger.info "  $it"}
+            source.files.each { logger.info "  $it" }
         }
     }