openequella#555 Create a scripting api javadoc zip (openequella#597)

* openequella#555 Create a scripting api javadoc zip

* Log before the zip

Author: doolse

.travis.yml

@@ -12,11 +12,12 @@ before_install:
 install:
 - git fetch --unshallow
 script:
-- sbt headerCheck test installerZip writeLanguagePack
+- sbt headerCheck test installerZip writeLanguagePack writeScriptingJavadoc
 after_success:
 - aws s3 --region us-east-1 cp Source/Server/equellaserver/target/tle-upgrade*.zip s3://edalexdev/equella_artifacts/$TRAVIS_BRANCH/$TRAVIS_BUILD_NUMBER/
 - aws s3 --region us-east-1 cp Installer/target/equella-installer*.zip s3://edalexdev/equella_artifacts/$TRAVIS_BRANCH/$TRAVIS_BUILD_NUMBER/
 - aws s3 --region us-east-1 cp target/reference-language-pack.zip s3://edalexdev/equella_artifacts/$TRAVIS_BRANCH/$TRAVIS_BUILD_NUMBER/
+- aws s3 --region us-east-1 cp target/scriptingapi-javadoc-*.zip s3://edalexdev/equella_artifacts/$TRAVIS_BRANCH/$TRAVIS_BUILD_NUMBER/
 - aws s3 --region us-east-1 rm --recursive s3://edalexdev/equella_artifacts/$TRAVIS_BRANCH/latest/
 - aws s3 --region us-east-1 cp --recursive s3://edalexdev/equella_artifacts/$TRAVIS_BRANCH/$TRAVIS_BUILD_NUMBER/ s3://edalexdev/equella_artifacts/$TRAVIS_BRANCH/latest/
 env:

Source/Plugins/Core/com.equella.core/build.sbt

@@ -1,7 +1,6 @@
 import Path.rebase
 import Path.flat
 
-import scala.io.Source
 import _root_.io.circe.parser._
 
 langStrings := {

Source/Plugins/Core/com.equella.core/plugin-jpf.xml

@@ -31,7 +31,7 @@
 
 @Bind
 @Singleton
-public class UserScriptObject implements UserScriptObjectContributor
+public class UserScriptObjectImpl implements UserScriptObjectContributor
 {
 	@Inject
 	private UserScriptsDao userScriptDao;

Source/Plugins/Core/com.equella.core/src/com/tle/core/userscript/scriptobject/UserScriptObject.java Source/Plugins/Core/com.equella.core/src/com/tle/core/userscript/scriptobject/UserScriptObjectImpl.java

@@ -1,10 +1,10 @@
+
 import java.util.Properties
 
-import complete.DefaultParsers._
 import com.typesafe.sbt.license.LicenseReport
-
-import scala.collection.JavaConverters._
 import sbt.io.Using
+import Path.rebase
+import scala.collection.JavaConverters._
 
 lazy val learningedge_config = project in file("Dev/learningedge-config")
 
@@ -130,6 +130,9 @@ val pluginAndLibs = Def.task {
 }
 
 mergeJPF := {
+
+  import complete.DefaultParsers._
+
   val adminConsole = false
   val args = spaceDelimited("<arg>").parsed
   val _allPluginDirs = pluginAndLibs.all(ScopeFilter(inAggregates(allPlugins, includeRoot = false))).value
@@ -145,3 +148,32 @@ mergeJPF := {
     PluginRefactor.mergePlugins(allPluginDirs, basePlugin, newPlugin, args.tail, adminConsole = adminConsole)
   }
 }
+
+writeScriptingJavadoc := {
+  val javadocDir = (doc in Compile).value 
+  val ver = version.value
+  val outZip = target.value / s"scriptingapi-javadoc-$ver.zip"
+  sLog.value.info(s"Writing ${outZip.absolutePath}")
+  IO.zip((javadocDir ** "*").pair(rebase(javadocDir, "")), outZip)
+  outZip
+}
+
+
+val userBeans : FileFilter = ("GroupBean.java" || "UserBean.java" || "RoleBean.java") && 
+  new SimpleFileFilter(_.getParentFile.getName == "valuebean")
+
+// Globs came from the original ant scripts
+
+def javadocSources(base: File): PathFinder = {
+  (base / "src") ** ("package-info.java" || "*ScriptType.java"
+    || "*ScriptObject.java" || userBeans)
+}
+
+aggregate in (Compile, doc) := false
+sources in (Compile, doc) := {
+  (javadocSources((baseDirectory in LocalProject("com_equella_base")).value)
+    +++ javadocSources((baseDirectory in LocalProject("com_equella_core")).value))
+      .get
+}
+javacOptions in (Compile, doc) := Seq()
+

build.sbt

@@ -11,7 +11,7 @@ phases:
       - setupBuild
   build:
     commands:
-      - sbt -no-colors -Dconfig.file=${HOME}/build.conf test installerZip writeLanguagePack
+      - sbt -no-colors -Dconfig.file=${HOME}/build.conf test installerZip writeLanguagePack writeScriptingJavadoc
   post_build:
     commands:
       - publishBuild

buildspec.yml

@@ -20,6 +20,7 @@ object CommonSettings extends AutoPlugin {
     lazy val writeSourceZip = taskKey[File]("Write out a zip containing all sources")
     lazy val langStrings = taskKey[Seq[LangStrings]]("Fully qualified language strings")
     lazy val writeLanguagePack = taskKey[File]("Write the default language pack")
+    lazy val writeScriptingJavadoc = taskKey[File]("Write the scripting javadoc")
     lazy val mergeJPF = inputKey[Unit]("Merge all")
     lazy val buildJS = taskKey[Seq[File]]("Build JS resources")