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
|
// Copyright 2018 The Bazel Authors. All rights reserved.
//
// 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.
package com.google.devtools.build.skydoc.rendering;
import com.google.common.base.Joiner;
import java.io.IOException;
import java.io.StringWriter;
import java.util.List;
import java.util.stream.Collectors;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.exception.MethodInvocationException;
import org.apache.velocity.exception.ParseErrorException;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
import org.apache.velocity.runtime.resource.loader.JarResourceLoader;
/**
* Produces skydoc output in markdown form.
*/
public class MarkdownRenderer {
private static final String TEMPLATE_FILENAME =
"com/google/devtools/build/skydoc/rendering/templates/rule.vm";
private final VelocityEngine velocityEngine;
public MarkdownRenderer() {
this.velocityEngine = new VelocityEngine();
velocityEngine.setProperty("resource.loader", "classpath, jar");
velocityEngine.setProperty("classpath.resource.loader.class",
ClasspathResourceLoader.class.getName());
velocityEngine.setProperty("jar.resource.loader.class", JarResourceLoader.class.getName());
velocityEngine.setProperty("input.encoding", "UTF-8");
velocityEngine.setProperty("output.encoding", "UTF-8");
velocityEngine.setProperty("runtime.references.strict", true);
}
/**
* Returns a markdown rendering of rule documentation for the given rule information object with
* the given rule name.
*/
public String render(String ruleName, RuleInfo ruleInfo) throws IOException {
VelocityContext context = new VelocityContext();
// TODO(cparsons): Attributes in summary form should have links.
context.put("summaryform", getSummaryForm(ruleName, ruleInfo));
context.put("ruleName", ruleName);
context.put("ruleInfo", ruleInfo);
StringWriter stringWriter = new StringWriter();
try {
velocityEngine.mergeTemplate(TEMPLATE_FILENAME, "UTF-8", context, stringWriter);
} catch (ResourceNotFoundException | ParseErrorException | MethodInvocationException e) {
throw new IOException(e);
}
return stringWriter.toString();
}
private static String getSummaryForm(String ruleName, RuleInfo ruleInfo) {
List<String> attributeNames = ruleInfo.getAttributes().stream()
.map(attr -> attr.getName())
.collect(Collectors.toList());
return String.format("%s(%s)", ruleName, Joiner.on(", ").join(attributeNames));
}
}
|
