JAL-4004 Now generating hugo files from help/markdown/...
[jalview.git] / build.gradle
index 3573ac7..e6cc590 100644 (file)
@@ -26,6 +26,8 @@ import com.vladsch.flexmark.ext.toc.TocExtension
 import com.google.common.hash.HashCode
 import com.google.common.hash.Hashing
 import com.google.common.io.Files
+import org.jsoup.Jsoup
+import org.jsoup.nodes.Element
 
 buildscript {
   repositories {
@@ -34,6 +36,7 @@ buildscript {
   }
   dependencies {
     classpath "com.vladsch.flexmark:flexmark-all:0.62.0"
+    classpath "org.jsoup:jsoup:1.14.3"
   }
 }
 
@@ -226,6 +229,8 @@ ext {
   install4jBackground = string("${install4j_images_dir}/${install4j_background}")
   install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}"
   install4jCheckSums = true
+
+  applicationName = "${jalview_name}"
   switch (CHANNEL) {
 
     case "BUILD":
@@ -344,7 +349,8 @@ ext {
 
   }
   JALVIEW_VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_")
-  hugoDataJsonFile = file("${jalviewDir}/${hugo_build_dir}/data/installers/installers-${JALVIEW_VERSION_UNDERSCORES}.json")
+  hugoDataJsonFile = file("${jalviewDir}/${hugo_build_dir}/${hugo_data_installers_dir}/installers-${JALVIEW_VERSION_UNDERSCORES}.json")
+  hugoArchiveMdFile = file("${jalviewDir}/${hugo_build_dir}/${hugo_version_archive_dir}/Version-${JALVIEW_VERSION_UNDERSCORES}/_index.md")
   // override getdownAppBase if requested
   if (findProperty("getdown_appbase_override") != null) {
     // revert to LOCAL if empty string
@@ -363,11 +369,10 @@ ext {
   jvlChannelName = jvlChannelName.replaceAll("[^\\w\\-]+", "_")
   // install4j application and folder names
   if (install4jSuffix == "") {
-    install4jApplicationName = "${jalview_name}"
     install4jBundleId = "${install4j_bundle_id}"
     install4jWinApplicationId = install4j_release_win_application_id
   } else {
-    install4jApplicationName = "${jalview_name} ${install4jSuffix}"
+    applicationName = "${jalview_name} ${install4jSuffix}"
     install4jBundleId = "${install4j_bundle_id}-" + install4jSuffix.toLowerCase()
     // add int hash of install4jSuffix to the last part of the application_id
     def id = install4j_release_win_application_id
@@ -377,15 +382,15 @@ ext {
   }
   // sanitise folder and id names
   // install4jApplicationFolder = e.g. "Jalview Build"
-  install4jApplicationFolder = install4jApplicationName
+  install4jApplicationFolder = applicationName
                                     .replaceAll("[\"'~:/\\\\\\s]", "_") // replace all awkward filename chars " ' ~ : / \
                                     .replaceAll("_+", "_") // collapse __
-  install4jInternalId = install4jApplicationName
+  install4jInternalId = applicationName
                                     .replaceAll(" ","_")
                                     .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
                                     .replaceAll("_+", "") // collapse __
                                     //.replaceAll("_*-_*", "-") // collapse _-_
-  install4jUnixApplicationFolder = install4jApplicationName
+  install4jUnixApplicationFolder = applicationName
                                     .replaceAll(" ","_")
                                     .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
                                     .replaceAll("_+", "_") // collapse __
@@ -1434,7 +1439,7 @@ jar {
   manifest {
     attributes "Main-Class": main_class,
     "Permissions": "all-permissions",
-    "Application-Name": install4jApplicationName,
+    "Application-Name": applicationName,
     "Codebase": application_codebase,
     "Implementation-Version": JALVIEW_VERSION
   }
@@ -1507,7 +1512,7 @@ shadowJar {
   }
   manifest {
     attributes "Implementation-Version": JALVIEW_VERSION,
-    "Application-Name": install4jApplicationName
+    "Application-Name": applicationName
   }
 
   duplicatesStrategy "INCLUDE"
@@ -1569,7 +1574,7 @@ task getdownWebsite() {
     }
 
     props.put("getdown_txt_title", jalview_name)
-    props.put("getdown_txt_ui.name", install4jApplicationName)
+    props.put("getdown_txt_ui.name", applicationName)
 
     // start with appbase
     getdownTextLines += "appbase = ${getdownAppBase}"
@@ -2044,7 +2049,7 @@ task installerFiles(type: com.install4j.gradle.Install4jTask) {
 
   variables = [
     'JALVIEW_NAME': jalview_name,
-    'JALVIEW_APPLICATION_NAME': install4jApplicationName,
+    'JALVIEW_APPLICATION_NAME': applicationName,
     'JALVIEW_DIR': "../..",
     'OSX_KEYSTORE': OSX_KEYSTORE,
     'OSX_APPLEID': OSX_APPLEID,
@@ -2352,6 +2357,11 @@ task dataInstallersJson {
   group "website"
   description "Create the installers-VERSION.json data file for installer files created"
 
+  mustRunAfter installers
+  mustRunAfter shadowJar
+  mustRunAfter sourceDist
+  mustRunAfter getdownArchive
+
   def installersOutputTxt = file("${jalviewDir}/${install4jBuildDir}/output.txt")
   def installersSha256 = file("${jalviewDir}/${install4jBuildDir}/sha256sums")
 
@@ -2378,10 +2388,159 @@ task dataInstallersJson {
   }
 }
 
-dataInstallersJson.mustRunAfter installers
-dataInstallersJson.mustRunAfter shadowJar
-dataInstallersJson.mustRunAfter sourceDist
-dataInstallersJson.mustRunAfter getdownArchive
+def hugoTemplateSubstitutions(String input, Map extras=null) {
+  def replacements = [
+    DATE: getDate("yyyy-MM-dd"),
+    CHANNEL: propertiesChannelName,
+    APPLICATION_NAME: applicationName,
+    GIT_HASH: gitHash,
+    GIT_BRANCH: gitBranch,
+    VERSION: JALVIEW_VERSION,
+    JAVA_VERSION: JAVA_VERSION,
+    VERSION_UNDERSCORES: JALVIEW_VERSION_UNDERSCORES
+  ]
+  def output = input
+  if (extras != null) {
+    extras.each{ k, v ->
+      output = output.replaceAll("__${k}__", ((v == null)?"":v))
+    }
+  }
+  replacements.each{ k, v ->
+    output = output.replaceAll("__${k}__", ((v == null)?"":v))
+  }
+  return output
+}
+
+task hugoTemplates {
+  group "website"
+  description "Create partially populated md pages for hugo website build"
+
+  def hugoTemplatesDir = file("${jalviewDir}/${hugo_templates_dir}")
+  def hugoBuildDir = "${jalviewDir}/${hugo_build_dir}"
+  def templateFiles = fileTree(dir: hugoTemplatesDir)
+  def releaseMdFile = file("${jalviewDir}/${releases_dir}/release-${JALVIEW_VERSION_UNDERSCORES}.md")
+  def whatsnewMdFile = file("${jalviewDir}/${whatsnew_dir}/whatsnew-${JALVIEW_VERSION_UNDERSCORES}.md")
+  def releaseTemplateFile = file("${jalviewDir}/${releases_template}")
+  def releasesTemplateFile = file("${jalviewDir}/${releases_template}")
+  def whatsnewTemplateFile = file("${jalviewDir}/${whatsnew_template}")
+
+  doFirst {
+    // specific release template for version archive
+    def changes = ""
+    def whatsnew = null
+    def givenDate = null
+    def givenChannel = null
+    def givenVersion = null
+    if (CHANNEL == "RELEASE") {
+      def releasesHtmlFile = file("${helpSourceDir}/${releases_html}")
+      //MD_PARSE
+      if (releaseMdFile.exists()) {
+        def inFrontMatter = false
+        def itemComment = null
+        def firstLine = true
+        releaseMdFile.eachLine { line ->
+          if (line.matches("---")) {
+            def prev = inFrontMatter
+            inFrontMatter = firstLine
+            if (inFrontMatter != prev)
+              return
+          }
+          if (inFrontMatter) {
+            def m = null
+            if (m = line =~ /^date:\s*([0-9\-]+)/) {
+              givenDate = new Date().parse("yyyy-MM-dd", m[0][1])
+            } else if (m = line =~ /^channel:\s*(\S+)/) {
+              givenChannel = m[0][1]
+            } else if (m = line =~ /^version:\s*(\S+)/) {
+              givenVersion = m[0][1]
+            }
+          } else {
+            changes += line+"\n"
+          }
+          firstLine = false
+        }
+        if (givenVersion != null && givenVersion != JALVIEW_VERSION) {
+          throw new GradleException("'version' header (${givenVersion}) found in ${releaseMdFile} does not match JALVIEW_VERSION (${JALVIEW_VERSION})")
+        }
+        if (whatsnewMdFile.exists()) {
+          whatsnew = whatsnewMdFile.text
+        }
+        def content = releaseMdFile.text
+      }
+    }
+
+    def changesHugo = null
+    if (changes != null) {
+      changesHugo = '<div class="release_notes">\n\n'
+      def inSection = false
+      changes.eachLine { line ->
+        def m = null
+        if (m = line =~ /^##([^#].*)$/) {
+          if (inSection) {
+            changesHugo += "</div>\n\n"
+          }
+          def section = m[0][1].trim()
+          section = section.toLowerCase()
+          section = section.replaceAll(/ +/, "_")
+          section = section.replaceAll(/[^a-z0-9_\-]/, "")
+          changesHugo += "<div class=\"${section}\">\n\n"
+          inSection = true
+        } else if (m = line =~ /^(\s*-\s*)<!--([^>]+)-->(.*)/) {
+          def comment = m[0][2].trim()
+          if (comment != "") {
+            comment = comment.replaceAll('"', "&quot;")
+            def issuekeys = []
+            comment.eachMatch(/JAL-\d+/) { jal -> issuekeys += jal }
+            def newline = m[0][1]
+            if (comment.trim() != "")
+              newline += "{{<comment>}}${comment}{{</comment>}}  "
+            newline += m[0][3].trim()
+            if (issuekeys.size() > 0)
+              newline += "  {{< jal issue=\"${issuekeys.join(",")}\" alt=\"${comment}\" >}}"
+            line = newline
+          }
+        }
+        changesHugo += line+"\n"
+      }
+      if (inSection) {
+        changesHugo += "\n</div>\n\n"
+      }
+      changesHugo += '</div>'
+    }
+
+    templateFiles.each{ templateFile ->
+      def newFileName = string(hugoTemplateSubstitutions(templateFile.getName()))
+      def relPath = hugoTemplatesDir.toPath().relativize(templateFile.toPath()).getParent()
+      def newRelPathName = hugoTemplateSubstitutions( relPath.toString() )
+
+      def outPathName = string("${hugoBuildDir}/$newRelPathName")
+
+      copy {
+        from templateFile
+        rename(templateFile.getName(), newFileName)
+        into outPathName
+      }
+
+      def newFile = file("${outPathName}/${newFileName}".toString())
+      def content = newFile.text
+      newFile.text = hugoTemplateSubstitutions(content,
+        [
+          WHATSNEW: whatsnew,
+          CHANGES: changesHugo,
+          DATE: givenDate.format("yyyy-MM-dd")
+        ]
+      )
+    }
+
+  }
+
+  inputs.dir(hugoTemplatesDir)
+  inputs.file(releaseTemplateFile)
+  inputs.file(releasesTemplateFile)
+  inputs.file(whatsnewTemplateFile)
+  inputs.property("JALVIEW_VERSION", { JALVIEW_VERSION })
+  inputs.property("CHANNEL", { CHANNEL })
+}
 
 
 task helppages {