X-Git-Url: http://source.jalview.org/gitweb/?p=jalview.git;a=blobdiff_plain;f=build.gradle;h=51c7eb2cc4d3536f730717bb267fe3f80428f45c;hp=a6d0e779b80c6e96392e2f8c0cd9215a67c38c32;hb=1778cdd563831459f049be5864f04581c2f32187;hpb=a55b066dfc2bae86cf321b83a5a0731de9de16be diff --git a/build.gradle b/build.gradle index a6d0e77..51c7eb2 100644 --- a/build.gradle +++ b/build.gradle @@ -138,6 +138,7 @@ ext { if (findProperty("JALVIEW_VERSION")==null || "".equals(JALVIEW_VERSION)) { JALVIEW_VERSION = releaseProps.get("jalview.version") } + println("JALVIEW_VERSION is set to '${JALVIEW_VERSION}'") // this property set when running Eclipse headlessly j2sHeadlessBuildProperty = string("net.sf.j2s.core.headlessbuild") @@ -1199,7 +1200,348 @@ task convertMdFiles { } +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, + DRAFT: "false", + JVL_HEADER: "" + ] + 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 +} + +def mdFileComponents(File mdFile, def dateOnly=false) { + def map = [:] + def content = "" + if (mdFile.exists()) { + def inFrontMatter = false + def firstLine = true + mdFile.eachLine { line -> + if (line.matches("---")) { + def prev = inFrontMatter + inFrontMatter = firstLine + if (inFrontMatter != prev) + return false + } + if (inFrontMatter) { + def m = null + if (m = line =~ /^date:\s*(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})/) { + map["date"] = new Date().parse("yyyy-MM-dd HH:mm:ss", m[0][1]) + } else if (m = line =~ /^date:\s*(\d{4}-\d{2}-\d{2})/) { + map["date"] = new Date().parse("yyyy-MM-dd", m[0][1]) + } else if (m = line =~ /^channel:\s*(\S+)/) { + map["channel"] = m[0][1] + } else if (m = line =~ /^version:\s*(\S+)/) { + map["version"] = m[0][1] + } else if (m = line =~ /^\s*([^:]+)\s*:\s*(\S.*)/) { + map[ m[0][1] ] = m[0][2] + } + if (dateOnly && map["date"] != null) { + return false + } + } else { + if (dateOnly) + return false + content += line+"\n" + } + firstLine = false + } + } + return dateOnly ? map["date"] : [map, content] +} + +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 oldJvlFile = file("${jalviewDir}/${hugo_old_jvl}") + def jalviewjsFile = file("${jalviewDir}/${hugo_jalviewjs}") + + 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 (map, content) = mdFileComponents(releaseMdFile) + givenDate = map.date + givenChannel = map.channel + givenVersion = map.version + changes = content + 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 oldJvl = oldJvlFile.exists() ? oldJvlFile.collect{it} : [] + def jalviewjsLink = jalviewjsFile.exists() ? jalviewjsFile.collect{it} : [] + + def changesHugo = null + if (changes != null) { + changesHugo = '
\n\n' + def inSection = false + changes.eachLine { line -> + def m = null + if (m = line =~ /^##([^#].*)$/) { + if (inSection) { + changesHugo += "
\n\n" + } + def section = m[0][1].trim() + section = section.toLowerCase() + section = section.replaceAll(/ +/, "_") + section = section.replaceAll(/[^a-z0-9_\-]/, "") + changesHugo += "
\n\n" + inSection = true + } else if (m = line =~ /^(\s*-\s*)(.*?)()?\s*$/) { + def comment = m[0][2].trim() + if (comment != "") { + comment = comment.replaceAll('"', """) + def issuekeys = [] + comment.eachMatch(/JAL-\d+/) { jal -> issuekeys += jal } + def newline = m[0][1] + if (comment.trim() != "") + newline += "{{}}${comment}{{}} " + newline += m[0][3].trim() + if (issuekeys.size() > 0) + newline += " {{< jal issue=\"${issuekeys.join(",")}\" alt=\"${comment}\" >}}" + if (m[0][4] != null) + newline += m[0][4] + line = newline + } + } + changesHugo += line+"\n" + } + if (inSection) { + changesHugo += "\n
\n\n" + } + changesHugo += '' + } + + 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 == null ? "" : givenDate.format("yyyy-MM-dd"), + DRAFT: givenDate == null ? "true" : "false", + JALVIEWJSLINK: jalviewjsLink.contains(JALVIEW_VERSION) ? "true" : "false", + JVL_HEADER: oldJvl.contains(JALVIEW_VERSION) ? "jvl: true" : "" + ] + ) + } + + } + + inputs.file(oldJvlFile) + inputs.dir(hugoTemplatesDir) + inputs.property("JALVIEW_VERSION", { JALVIEW_VERSION }) + inputs.property("CHANNEL", { CHANNEL }) +} + +def getMdDate(File mdFile) { + return mdFileComponents(mdFile, true) +} + +def getMdSections(String content) { + def sections = [:] + def sectionContent = "" + def sectionName = null + content.eachLine { line -> + def m = null + if (m = line =~ /^##([^#].*)$/) { + if (sectionName != null) { + sections[sectionName] = sectionContent + sectionName = null + sectionContent = "" + } + sectionName = m[0][1].trim() + sectionName = sectionName.toLowerCase() + sectionName = sectionName.replaceAll(/ +/, "_") + sectionName = sectionName.replaceAll(/[^a-z0-9_\-]/, "") + } else if (sectionName != null) { + sectionContent += line+"\n" + } + } + if (sectionContent != null) { + sections[sectionName] = sectionContent + } + return sections +} + +task releasesTemplates { + group "help" + description "Recreate whatsNew.html and releases.html from markdown files and templates in help" + + def releasesTemplateFile = file("${jalviewDir}/${releases_template}") + def whatsnewTemplateFile = file("${jalviewDir}/${whatsnew_template}") + def releasesHtmlFile = file("${helpSourceDir}/${releases_html}") + def whatsnewHtmlFile = file("${helpSourceDir}/${whatsnew_html}") + def releasesMdDir = "${jalviewDir}/${releases_dir}" + def whatsnewMdDir = "${jalviewDir}/${whatsnew_dir}" + + doFirst { + def releaseMdFile = file("${releasesMdDir}/release-${JALVIEW_VERSION_UNDERSCORES}.md") + def whatsnewMdFile = file("${whatsnewMdDir}/whatsnew-${JALVIEW_VERSION_UNDERSCORES}.md") + + if (CHANNEL == "RELEASE") { + if (!releaseMdFile.exists()) { + throw new GradleException("File ${releaseMdFile} must be created for RELEASE") + } + if (!whatsnewMdFile.exists()) { + throw new GradleException("File ${whatsnewMdFile} must be created for RELEASE") + } + } + + def releaseFiles = fileTree(dir: releasesMdDir, include: "release-*.md") + def releaseFilesDates = releaseFiles.collectEntries { + [(it): getMdDate(it)] + } + releaseFiles = releaseFiles.sort { a,b -> releaseFilesDates[a].compareTo(releaseFilesDates[b]) } + + def releasesTemplate = releasesTemplateFile.text + def m = releasesTemplate =~ /(?s)__VERSION_LOOP_START__(.*)__VERSION_LOOP_END__/ + def versionTemplate = m[0][1] + + MutableDataSet options = new MutableDataSet() + + def extensions = new ArrayList<>() + options.set(Parser.EXTENSIONS, extensions) + options.set(Parser.HTML_BLOCK_COMMENT_ONLY_FULL_LINE, true) + + Parser parser = Parser.builder(options).build() + HtmlRenderer renderer = HtmlRenderer.builder(options).build() + + def actualVersions = releaseFiles.collect { rf -> + def (rfMap, rfContent) = mdFileComponents(rf) + return rfMap.version + } + def versionsHtml = "" + def linkedVersions = [] + releaseFiles.reverse().each { rFile -> + def (rMap, rContent) = mdFileComponents(rFile) + + def versionLink = "" + def partialVersion = "" + def firstPart = true + rMap.version.split("\\.").each { part -> + def displayPart = ( firstPart ? "" : "." ) + part + partialVersion += displayPart + if ( + linkedVersions.contains(partialVersion) + || ( actualVersions.contains(partialVersion) && partialVersion != rMap.version ) + ) { + versionLink += displayPart + } else { + versionLink += "${displayPart}" + linkedVersions += partialVersion + } + firstPart = false + } + def displayDate = releaseFilesDates[rFile].format("dd/MM/yyyy") + + def lm = null + def rContentProcessed = "" + rContent.eachLine { line -> + if (lm = line =~ /^(\s*-)(\s*)(.*)$/) { + line = "${lm[0][1]}${lm[0][3]}${lm[0][2]}" + } else if (lm = line =~ /^###([^#]+.*)$/) { + line = "_${lm[0][1].trim()}_" + } + rContentProcessed += line + "\n" + } + + def rContentSections = getMdSections(rContentProcessed) + def rVersion = versionTemplate + if (rVersion != "") { + def rNewFeatures = rContentSections["new_features"] + def rIssuesResolved = rContentSections["issues_resolved"] + Node newFeaturesNode = parser.parse(rNewFeatures) + String newFeaturesHtml = renderer.render(newFeaturesNode) + Node issuesResolvedNode = parser.parse(rIssuesResolved) + String issuesResolvedHtml = renderer.render(issuesResolvedNode) + rVersion = hugoTemplateSubstitutions(rVersion, + [ + VERSION: rMap.version, + VERSION_LINK: versionLink, + DISPLAY_DATE: displayDate, + NEW_FEATURES: newFeaturesHtml, + ISSUES_RESOLVED: issuesResolvedHtml + ] + ) + versionsHtml += rVersion + } + } + + releasesTemplate = releasesTemplate.replaceAll("(?s)__VERSION_LOOP_START__.*__VERSION_LOOP_END__", versionsHtml) + releasesTemplate = hugoTemplateSubstitutions(releasesTemplate) + releasesHtmlFile.text = releasesTemplate + + if (whatsnewMdFile.exists()) { + def wnDisplayDate = releaseFilesDates[releaseMdFile] != null ? releaseFilesDates[releaseMdFile].format("dd MMMM yyyy") : "" + def whatsnewMd = hugoTemplateSubstitutions(whatsnewMdFile.text) + Node whatsnewNode = parser.parse(whatsnewMd) + String whatsnewHtml = renderer.render(whatsnewNode) + whatsnewHtml = whatsnewTemplateFile.text.replaceAll("__WHATS_NEW__", whatsnewHtml) + whatsnewHtmlFile.text = hugoTemplateSubstitutions(whatsnewHtml, + [ + DISPLAY_DATE: wnDisplayDate + ] + ) + } + + } + + inputs.file(releasesTemplateFile) + inputs.file(whatsnewTemplateFile) + inputs.dir(releasesMdDir) + inputs.dir(whatsnewMdDir) + outputs.file(releasesHtmlFile) + outputs.file(whatsnewHtmlFile) +} + + task copyHelp(type: Copy) { + dependsOn releasesTemplates + def inputDir = helpSourceDir def outputDir = "${helpBuildDir}/${help_dir}" from(inputDir) { @@ -2388,235 +2730,10 @@ task dataInstallersJson { } } -def hugoTemplateSubstitutions(String input) { - def output = input - output = output.replaceAll("__DATE__", getDate("yyyy-MM-dd")) - output = output.replaceAll("__CHANNEL__", propertiesChannelName) - output = output.replaceAll("__APPLICATION_NAME__", applicationName) - output = output.replaceAll("__GIT_HASH__", gitHash) - output = output.replaceAll("__GIT_BRANCH__", gitBranch) - output = output.replaceAll("__VERSION__", JALVIEW_VERSION) - output = output.replaceAll("__JAVA_VERSION__", JAVA_VERSION) - output = output.replaceAll("__VERSION_UNDERSCORES__", JALVIEW_VERSION_UNDERSCORES) - return output -} - -def ulToList(Element ul, int indent) { - def list = "" - ul.children().each { e -> - if (e.tagName().toLowerCase() == "ul") { - list = list.stripTrailing() + "\n" - list += ulToList(e, indent+1) - } else if (e.tagName().toLowerCase() == "li") { - def issues = [] - def issuesText = "" - def mdItem = " " * indent + "- " - e.childNodes().any {n -> - if (n.nodeName().equals("#comment")) { - mdItem += "{{}}${n.getData()}{{}} " - issuesText = n.getData().trim() - issues = n.getData().trim().split(/[,\s]+/).findAll { it.startsWith("JAL-") } - return true - } - } - def safeText = issuesText.replaceAll('"', '\"') - def joinedIssues = issues.join(",") - def issuesLink = (issues.size() > 0) ? - " {{< jal issue=\"${joinedIssues}\" alt=\"${safeText}\" >}}" - : "" - def addedIssues = false - e.childNodes().each { node -> - if (node.nodeName().toLowerCase() == "ul") { - // add issues link before sub list if it's last - if (node.nextSibling() == null) { - mdItem += "${issuesLink}" - addedIssues = true - } - mdItem = mdItem.stripTrailing() + "\n" - mdItem += ulToList(node, indent+1) - } else if (node.nodeName() == "#text") { - mdItem += node.text() - } else if (node.nodeName().toLowerCase() == "strong") { - mdItem += "**${node.text()}**" - } else if (node.nodeName().toLowerCase() == "em") { - // if (true || (node.text().length() > 50 && node.text().count(" ") > 10) || (!node.nextSibling().text().startsWith("\\s*\\n"))) { - mdItem += "*${node.text()}*" - // } else { - // mdItem += "### "+node.text() - // } - } else if (node.nodeName().toLowerCase() == "br") { - mdItem += "
\n" - } else if (node.nodeName().toLowerCase() == "a") { - mdItem += "[${node.text()}](${node.attr('href')})" - } - } - if (!addedIssues) { - mdItem += issuesLink - } - list += mdItem.stripTrailing()+"\n" - } else if (e.tagName().toLowerCase() == "div") { - e.children().each { eee -> - list += ulToList(eee, indent) - } - } else if (e.tagName().toLowerCase() == "strong") { - list += "**${e.text()}**" - } else if (e.tagName().toLowerCase() == "em") { - if (e.text().length() > 50 && e.text().count(" ") > 20) { - list += "*${e.text()}*" - } else { - list += "\n\n### ${e.text()}\n\n" - } - } - } - return list -} - -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) - - doFirst { - // specific release template for version archive - def summary = "${applicationName} ${JALVIEW_VERSION}" - def changes = "" - def oldDate = null - if (CHANNEL == "RELEASE") { - def releasesHtmlFile = file("${helpSourceDir}/${releases_html}") - //HTMLPARSE - def html = releasesHtmlFile.text - def doc = Jsoup.parse(html) - def table = doc.select("table").first() - def headings = table.select("tr").first().select("th").collect { it.text() } - def releaseRow = null - def trs = table.select("tr") - trs.any { tr -> - def tds = tr.select("td") - if (tds.size() == 0) - return false - def releaseTd = tds.first() - if (releaseTd.text().startsWith("${JALVIEW_VERSION} ")) { - releaseRow = tr - return true - } - } - - if (releaseRow != null && headings != null && headings.size() == 3) { - def releaseTd = releaseRow.select("td").first() - def spaceIndex = releaseTd.text().indexOf(" ") - if (spaceIndex >= 0) { - oldDate = new Date().parse("dd/MM/yyyy", releaseTd.text().substring(spaceIndex+1)) - } - def releaseCells = releaseRow.select("td") - if (releaseCells.size() == 3) { - def title1 = headings[1] - def title2 = headings[2] - - def lastDotIndex = JALVIEW_VERSION.lastIndexOf(".") - if (lastDotIndex > 0) { - try { - def patchRelease = JALVIEW_VERSION.substring(lastDotIndex+1) as Integer - def patchReleaseString = null - if (patchRelease == 0) { - patchReleaseString = "first minor" - } else if (patchRelease == 1) { - patchReleaseString = "first patch" - } else if (patchRelease == 2) { - patchReleaseString = "second patch" - } else if (patchRelease == 3) { - patchReleaseString = "third patch" - } else if (patchRelease == 4) { - patchReleaseString = "fourth patch" - } else if (patchRelease == 5) { - patchReleaseString = "fifth patch" - } else if (patchRelease == 6) { - patchReleaseString = "sixth patch" - } else if (patchRelease == 7) { - patchReleaseString = "seventh patch" - } else if (patchRelease > 13 && (patchRelease % 10 == 1)) { - patchReleaseString += "st" - } else if (patchRelease > 13 && (patchRelease % 10 == 2)) { - patchReleaseString += "nd" - } else if (patchRelease > 13 && (patchRelease % 10 == 3)) { - patchReleaseString += "rd" - } else if (patchRelease != null) { - patchReleaseString += "th" - } - summary += (patchReleaseString != null) ? " is the ${patchReleaseString} release in the ${JALVIEW_VERSION.substring(0,lastDotIndex)} series." : "" - } catch(Exception e) { - summary = "" - } - } - - [1,2].each { col -> - def colChanges = "" - if (headings[col] != null && headings[col].size() > 0) { - releaseCells[col].children().each { e -> - if (e.tagName().toLowerCase() == "ul" || e.tagName().toLowerCase() == "div") { - if (colChanges != "") { - colChanges = colChanges.stripTrailing() + "\n" - } - colChanges += ulToList(e, 0) - } else if (e.tagName().toLowerCase() == "em") { - colChanges += "\n\n### ${e.text()}\n\n" - } - } - } - if (colChanges != "") { - def className = headings[col].replaceAll(" ","_").toLowerCase().replaceAll("[^_a-z]","") - changes += "
\n\n## ${headings[col]}\n\n${colChanges}\n
\n\n" - } - } - - if (changes != "") { - changes = "
\n\n${changes}\n\n
" - } - } - } - } - - 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 - // summary in version archive release pages only appears from 2.10.5 onwards - if (oldDate.format("yyyy") as Integer >= 2019 || JALVIEW_VERSION == "2.10.5") { - content = content.replaceAll("__SUMMARY__", summary) - } else { - content = content.replaceAll("__SUMMARY__", "") - } - content = content.replaceAll("__CHANGES__", changes) - if (oldDate != null) { - if (oldDate[java.util.Calendar.YEAR] < 90) { - oldDate[java.util.Calendar.YEAR] += 2000 - } - content = content.replaceAll("__DATE__", oldDate.format("yyyy-MM-dd")) - } - newFile.text = hugoTemplateSubstitutions(content) - } - } - - inputs.dir(hugoTemplatesDir) - inputs.property("JALVIEW_VERSION", { JALVIEW_VERSION }) - inputs.property("CHANNEL", { CHANNEL }) -} - - task helppages { + group "help" + description "Copies all help pages to build dir. Runs ant task 'pubhtmlhelp'." + dependsOn copyHelp dependsOn pubhtmlhelp