-
Notifications
You must be signed in to change notification settings - Fork 951
/
_GrailsDocs.groovy
414 lines (337 loc) · 12.3 KB
/
_GrailsDocs.groovy
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/*
* Copyright 2004-2005 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import org.apache.tools.ant.types.Path
import org.codehaus.groovy.grails.documentation.DocumentationContext
import org.codehaus.groovy.grails.documentation.DocumentedMethod
import org.codehaus.groovy.grails.resolve.IvyDependencyManager
import grails.util.GrailsNameUtils
import grails.doc.DocPublisher
import grails.doc.LegacyDocMigrator
import grails.doc.PdfBuilder
/**
* @author Graeme Rocher
* @since 1.0
*
* Created: Sep 20, 2007
*/
includeTargets << grailsScript("_GrailsPackage")
javadocDir = "${grailsSettings.docsOutputDir}/api"
groovydocDir = "${grailsSettings.docsOutputDir}/gapi"
docEncoding = "UTF-8"
docSourceLevel = "1.5"
links = ['http://java.sun.com/j2se/1.5.0/docs/api/']
apiLinks = [:]
docsDisabled = { argsMap.nodoc == true }
pdfEnabled = { argsMap.pdf == true }
createdManual = false
createdPdf = false
target(docs: "Produces documentation for a Grails project") {
parseArguments()
if (argsMap.init) {
ant.mkdir(dir:"${basedir}/src/docs/guide")
ant.mkdir(dir:"${basedir}/src/docs/ref/Items")
new File("${basedir}/src/docs/guide/toc.yml").write '''\
introduction: Introduction
'''
new File("${basedir}/src/docs/guide/introduction.gdoc").write '''\
This is an example documentation template. The syntax format is similar to "Textile":http://textile.thresholdstate.com/.
You can apply formatting such as *bold*, _italic_ and @code@. Bullets are possible too:
* Bullet 1
* Bullet 2
As well as numbered lists:
# Number 1
# Number 2
The documentation also handles links to [guide items|guide:introduction] as well as [reference|items]
'''
new File("${basedir}/src/docs/ref/Items/reference.gdoc").write '''\
h1. example
h2. Purpose
This is an example reference item.
h2. Examples
You can use code snippets:
{code}
def example = new Example()
{code}
h2. Description
And provide a detailed description
'''
grailsConsole.updateStatus "Example documentation created in ${basedir}/src/docs. Use 'grails doc' to publish."
}
else {
docsInternal()
}
}
target(docsInternal:"Actual documentation task") {
depends(compile, javadoc, groovydoc, refdocs, pdf, createIndex)
}
target(setupDoc:"Sets up the doc directories") {
ant.mkdir(dir:grailsSettings.docsOutputDir)
ant.mkdir(dir:groovydocDir)
ant.mkdir(dir:javadocDir)
}
target(groovydoc:"Produces groovydoc documentation") {
depends(parseArguments, setupDoc)
if (docsDisabled()) {
event("DocSkip", ['groovydoc'])
return
}
ant.taskdef(name:"groovydoc", classname:"org.codehaus.groovy.ant.Groovydoc")
event("DocStart", ['groovydoc'])
def sourcePath = new Path(ant.project)
for (dir in projectCompiler.srcDirectories) {
sourcePath.add new Path(ant.project, dir)
}
if (isPluginProject) {
def pluginDescriptor = grailsSettings.baseDir.listFiles().find { it.name.endsWith "GrailsPlugin.groovy" }
def tmpDir = new File(grailsSettings.projectWorkDir, "pluginDescForDocs")
tmpDir.deleteOnExit()
// Copy the plugin descriptor to a temporary directory and add that
// directory to groovydoc's source path. This is because adding '.'
// will cause all Groovy files in the project to be included as source
// files (including test cases) and it will also cause duplication
// of classes in the generated docs - see
//
// http://jira.grails.org/browse/GRAILS-6530
//
// Also, we can't add a single file to the path. Only directories
// seem to work. There are quite a few limitations with the GroovyDoc
// task currently.
ant.copy file: pluginDescriptor, todir: tmpDir, overwrite: true
sourcePath.add new Path(ant.project, tmpDir.absolutePath)
}
// Prepare external API links
readApiLinks()
try {
ant.groovydoc(destdir:groovydocDir, sourcepath:sourcePath, use:"true",
windowtitle:grailsAppName,'private':"true") {
// Apply external API links
apiLinks?.each { pkg,href ->
if (pkg && href) {
link(packages:"${pkg}.", href:"${href}")
}
}
}
}
catch(Exception e) {
event("StatusError", ["Error generating groovydoc: ${e.message}"])
}
event("DocEnd", ['groovydoc'])
}
target(javadoc:"Produces javadoc documentation") {
depends(parseArguments, setupDoc)
if (docsDisabled()) {
event("DocSkip", ['javadoc'])
return
}
event("DocStart", ['javadoc'])
File javaDir = new File("${grailsSettings.sourceDir}/java")
if (javaDir.listFiles().find{ !it.name.startsWith(".")}) {
try {
ant.javadoc(access:"protected",
destdir:javadocDir,
encoding:docEncoding,
classpathref:"grails.compile.classpath",
use:"yes",
windowtitle:grailsAppName,
docencoding:docEncoding,
charset:docEncoding,
source:docSourceLevel,
useexternalfile:"yes",
breakiterator:"true",
linksource:"yes",
maxmemory:"128m",
failonerror:false,
sourcepath:javaDir.absolutePath) {
for (i in links) {
link(href:i)
}
}
}
catch (Exception e) {
event("StatusError", ["Error generating javadoc: ${e.message}"])
// ignore, empty src/java directory
}
}
event("DocEnd", ['javadoc'])
}
target(refdocs:"Generates Grails style reference documentation") {
depends(parseArguments, createConfig,loadPlugins, setupDoc)
if (docsDisabled()) {
event("DocSkip", ["refdocs"])
return
}
def srcDocs = new File("${basedir}/src/docs")
def context = DocumentationContext.getInstance()
if (context?.hasMetadata()) {
for (DocumentedMethod m in context.methods) {
if (m.artefact && m.artefact != 'Unknown') {
String refDir = "${srcDocs}/ref/${GrailsNameUtils.getNaturalName(m.artefact)}"
ant.mkdir(dir:refDir)
def refFile = new File("${refDir}/${m.name}.gdoc")
if (!refFile.exists()) {
grailsConsole.updateStatus "Generating documentation ${refFile}"
refFile.write """
h1. ${m.name}
h2. Purpose
${m.text ?: ''}
h2. Examples
{code:java}
foo.${m.name}(${m.arguments?.collect {GrailsNameUtils.getPropertyName(it)}.join(',')})
{code}
h2. Description
${m.text ?: ''}
Arguments:
${m.arguments?.collect { '* @'+GrailsNameUtils.getPropertyName(it)+'@\n' }}
"""
}
}
}
}
if (srcDocs.exists()) {
event("DocStart", ["refdocs"])
File refDocsDir = grailsSettings.docsOutputDir
def publisher = new DocPublisher(srcDocs, refDocsDir, grailsConsole)
publisher.ant = ant
publisher.title = grailsAppName
publisher.subtitle = grailsAppName
publisher.version = grailsAppVersion
publisher.authors = ""
publisher.license = ""
publisher.copyright = ""
publisher.footer = ""
publisher.engineProperties = config?.grails?.doc?.flatten()
// if this is a plugin obtain additional metadata from the plugin
readPluginMetadataForDocs(publisher)
readDocProperties(publisher)
configureAliases()
try {
publisher.publish()
createdManual = true
grailsConsole.updateStatus "Built user manual at ${refDocsDir}/index.html"
}
catch (RuntimeException ex) {
if (ex.message) {
grailsConsole.error "Failed to build user manual.", ex
}
else {
grailsConsole.error "Failed to build user manual."
}
exit 1
}
event("DocEnd", ["refdocs"])
}
}
target(pdf: "Produces PDF documentation") {
depends(parseArguments)
File refDocsDir = grailsSettings.docsOutputDir
File singleHtml = new File(refDocsDir, 'guide/single.html')
if (docsDisabled() || !pdfEnabled() || !singleHtml.exists()) {
event("DocSkip", ['pdf'])
return
}
event("DocStart", ['pdf'])
PdfBuilder.build(grailsSettings.docsOutputDir.canonicalPath, grailsHome.toString())
createdPdf = true
println "Built user manual PDF at ${refDocsDir}/guide/single.pdf"
event("DocEnd", ['pdf'])
}
target(createIndex: "Produces an index.html page in the root directory") {
if (docsDisabled()) {
return
}
new File("${grailsSettings.docsOutputDir}/all-docs.html").withWriter("UTF-8") { writer ->
writer.write """\
<html>
<head>
<title>$grailsAppName Documentation</title>
</head>
<body>
<a href="api/index.html">Java API docs</a><br />
<a href="gapi/index.html">Groovy API docs</a><br />
"""
if (createdManual) {
writer.write '\t\t<a href="guide/index.html">Manual (Page per chapter)</a><br />\n'
writer.write '\t\t<a href="guide/single.html">Manual (Single page)</a><br />\n'
}
if (createdPdf) {
writer.write '\t\t<a href="guide/single.pdf">Manual (PDF)</a><br />\n'
}
writer.write """\
</body>
</html>
"""
}
}
target(migrateDocs: "Migrates an old-style gdoc user guide to the current approach using a YAML TOC file.") {
depends createConfig
def guideDir = new File(grailsSettings.baseDir, "src/docs/guide")
if (guideDir.exists()) {
def outDir = new File(guideDir.parentFile, "migratedGuide")
def migrator = new LegacyDocMigrator(guideDir, outDir, config.grails.doc.alias)
migrator.migrate()
grailsConsole.updateStatus "Migrated user guide at ${outDir.path}"
}
}
def readPluginMetadataForDocs(DocPublisher publisher) {
def basePlugin = loadBasePlugin()?.instance
if (basePlugin) {
if (basePlugin.hasProperty("title")) {
publisher.title = basePlugin.title
}
if (basePlugin.hasProperty("description")) {
publisher.subtitle = basePlugin.description
}
if (basePlugin.hasProperty("version")) {
publisher.version = basePlugin.version
}
if (basePlugin.hasProperty("license")) {
publisher.license = basePlugin.license
}
if (basePlugin.hasProperty("author")) {
publisher.authors = basePlugin.author
}
}
}
def readDocProperties(DocPublisher publisher) {
['copyright', 'license', 'authors', 'footer', 'images',
'css', 'style', 'encoding', 'logo', 'sponsorLogo'].each { readIfSet publisher, it }
}
def configureAliases() {
// See http://jira.codehaus.org/browse/GRAILS-6484 for why this is soft loaded
def docEngineClassName = "grails.doc.DocEngine"
def docEngineClass = classLoader.loadClass(docEngineClassName)
if (!docEngineClass) {
throw new IllegalStateException("Failed to load $docEngineClassName to configure documentation aliases")
}
docEngineClass.ALIAS.putAll(config.grails.doc.alias)
}
private readIfSet(DocPublisher publisher,String prop) {
if (config.grails.doc."$prop") {
publisher[prop] = config.grails.doc."$prop"
}
}
private loadBasePlugin() {
pluginManager?.allPlugins?.find { it.basePlugin }
}
/**
* Read external API doc links from grails.doc.api in Config.groovy
*/
def readApiLinks() {
if (!config?.grails?.doc?.api) return
def apiLinksFromConfig = config.grails.doc.api.flatten()
if (apiLinks == null) apiLinks = apiLinksFromConfig
else apiLinks.putAll(apiLinksFromConfig)
}