-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
release-notes-transform.gradle
222 lines (191 loc) · 7.73 KB
/
release-notes-transform.gradle
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath ('com.uwyn:jhighlight:1.0') {
exclude module: "servlet-api"
}
}
}
import org.jsoup.nodes.Element
import org.jsoup.select.Elements
import com.uwyn.jhighlight.renderer.XhtmlRendererFactory
decorateReleaseNotes {
ext {
baseStyleFile = file("$cssFiles.dir/base.css")
releaseNotesStyleFile = file("$cssFiles.dir/release-notes.css")
scriptFile = file("src/docs/release/content/script.js")
}
inputs.files([baseStyleFile, releaseNotesStyleFile, configurations.jquery, scriptFile])
transform {
outputSettings().indentAmount(2).prettyPrint(true)
prependChild(new org.jsoup.nodes.DocumentType("html", "", "", ""))
head().
append("<meta charset='utf-8'>").
append("<title>Gradle @version@ Release Notes</title>")
head().append("<style>p{}</style>").children().last().childNode(0).attr("data", baseStyleFile.text + releaseNotesStyleFile.text)
head().append("<script type='text/javascript'>1;</script>").children().last().childNode(0).attr("data", configurations.jquery.singleFile.text)
head().append("<script type='text/javascript'>1;</script>").children().last().childNode(0).attr("data", scriptFile.text)
}
// Add the extra doc links
transform {
body().append("""
<h2>Gradle @version@ documentation links</h2>
<ul>
<li><a href='dsl/index.html'>DSL Reference</a></li>
<li><a href='userguide/userguide.html'>User Guide</a></li>
<li><a href='javadoc/index.html'>Javadoc</a></li>
<li><a href='groovydoc/index.html'>Groovdoc</a></li>
</ul>
""")
}
// wrap each h2 section in section.topic
transform {
def heading = body().select("h2").first()
def inSection = [heading]
Element next = heading.nextElementSibling()
while (true) {
if (next == null || next.tagName() == "h2") {
def section = heading.before("<section class='topic'/>").previousElementSibling()
Elements inSectionElements = new Elements(inSection)
section.html(inSectionElements.outerHtml())
inSectionElements.remove()
if (next == null) {
break
} else {
inSection = [next]
heading = next
}
} else {
inSection << next
}
next = next.nextElementSibling()
}
}
// wrap all content after the first element after a h3 (up to the next same level heading)
// in a section.major-detail block
transform {
for (heading in body().select(".topic").select("h3")) {
def detail = []
Element next = heading.nextElementSibling()
while (next != null && next.tagName() != "h4") {
next = next.nextElementSibling()
}
while (true) {
if (next == null || next.tagName() ==~ /h[123]/) {
break
}
detail << next
next = next.nextElementSibling()
}
if (detail) {
def section = detail.first().before("<section class='major-detail'/>").previousElementSibling()
Elements detailElements = new Elements(detail)
section.html(detailElements.outerHtml())
detailElements.remove()
}
}
}
// wrap all content after a h4 until the next heading in a section.minor-detail
transform {
for (heading in body().select("h4")) {
def detail = []
Element next = heading.nextElementSibling()
while (true) {
if (next == null || next.tagName() ==~ /h[1234]/) {
break
}
detail << next
next = next.nextElementSibling()
}
if (detail) {
def section = detail.first().before("<section class='minor-detail'/>").previousElementSibling()
Elements detailElements = new Elements(detail)
section.html(detailElements.outerHtml())
detailElements.remove()
}
}
}
// add anchors for all of the headings
transform {
for (heading in body().select("h2,h3")) {
def anchorName = heading.text().toLowerCase().replaceAll(' ', '-')
heading.attr("id", anchorName)
}
}
// Add the TOC
transform {
def tocSection = body().select("section.topic").first().before("<section class='table-of-contents'/>").previousElementSibling()
tocSection.append("<h2>Table Of Contents</h2>")
def toc = tocSection.append("<ul class='toc'/>").children().last()
for (topic in body().select(".topic")) {
def topicHeading = topic.select("h2").first()
def name = topicHeading.text()
def anchor = topicHeading.attr("id")
toc.append("<li><a href='#$anchor'>$name</a></li>").children().last()
def subs = topic.select("h3")
if (subs) {
def sublist = toc.children().last().append("<ul class='toc-sub'/>").children().last()
subs.each {
def subName = it.text()
def subAnchorName = it.attr("id")
sublist.append("<li><a href='#$subAnchorName'>$subName</a></li>")
}
}
}
}
// Add the heading
transform {
body().prepend("<h3 class='releaseinfo'>Version @version@</h3>")
body().prepend("<h1>Gradle Release Notes</h1>")
}
// Add the footer
transform {
def footer = body().append("<section class='footer'/>").children().last()
footer.html("Gradle @version@ Release Notes<br />")
}
// Syntax highlighting
transform {
body().select("code").each { code ->
def parent = code.parent()
if (parent.tagName() == "pre") {
def text = code.text()
def input = new ByteArrayInputStream(code.text().getBytes("utf-8"))
def renderer = XhtmlRendererFactory.getRenderer("groovy")
def out = new ByteArrayOutputStream()
renderer.highlight("test", input, out, "utf-8", true)
code.html(new String(out.toByteArray(), "utf-8"))
code.select("br").remove()
code.childNodes().findAll { it.nodeName().equals("#comment") }*.remove()
code.html(code.html().trim())
parent.addClass("code")
}
}
}
// Terminal styling
transform {
body().select("tt").each { tt ->
def parent = tt.parent()
if (parent.tagName() == "pre") {
tt.select("br").remove()
tt.childNodes().findAll { it.nodeName().equals("#comment") }*.remove()
tt.html(tt.html().trim())
parent.addClass("tt")
}
}
}
// Wrap the page in a text container to get the margins
transform {
def bodyContent = body().children().remove()
body().prepend("<div class='text-container'/>")
body().children()[0].html(bodyContent.outerHtml())
}
// Turn Gradle issue numbers into issue links
transform {
def rewritten = body().html().replaceAll(~/GRADLE-\d+/) {
"<a href='http://issues.gradle.org/browse/${it}'>${it}</a>"
}
body().html(rewritten)
}
}