Skip to content

Nicer handling of root description and documentation elements of the … #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 30, 2020
Merged

Nicer handling of root description and documentation elements of the … #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 33 additions & 22 deletions boat-engine/src/main/java/com/backbase/oss/boat/Exporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ public class Exporter {
private static final Pattern placeholderPattern = Pattern.compile("(\\{[^\\}]*\\})");
public static final String X_EXAMPLES = "x-examples";
public static final String NO_DESCRIPTION_AVAILABLE = "No description available";
private static final String NEW_LINE = "\n";
private static ObjectMapper mapper = Utils.createObjectMapper();

private final ExporterOptions exporterOptions;
Expand Down Expand Up @@ -254,52 +255,62 @@ public OpenAPI export(String serviceName, File inputFile) throws ExportException
}

private Info setupInfo(Api ramlApi) {
String description = getDescription(ramlApi.description()); // todo not used
log.debug("Setup Description");

String value = ramlApi.version() != null ? ramlApi.version().value() : "1.0";
String version = ramlApi.version() != null ? ramlApi.version().value() : "1.0";
Info info = new Info()
.title(ramlApi.title().value())
.version(value);
.version(version);

if (ramlApi.documentation() != null && !ramlApi.documentation().isEmpty()) {
final StringBuilder markdown = new StringBuilder();
ramlApi.documentation().stream().forEach(
final StringBuilder markdown = new StringBuilder();
if (isNotBlank(ramlApi.description())) {
markdown
.append(ramlApi.description().value())
.append(NEW_LINE);
}
if (ramlApi.documentation() != null) {
ramlApi.documentation().forEach(
documentationItem -> {
MarkdownString content = documentationItem.content();

String markdownString = cleanupMarkdownString(content.value());

markdown.append(markdownString);
markdown.append("\n");
if (isNotBlank(documentationItem.title())) {
markdown
.append("# ")
.append(documentationItem.title().value())
.append(NEW_LINE);
}
if (isNotBlank(documentationItem.content())) {
markdown.append(cleanupMarkdownString(documentationItem.content().value()));
markdown.append(NEW_LINE);
}
}
);

if (info.getDescription() == null) {
info.setDescription(markdown.toString());
} else {
info.setDescription(info.getDescription() + "\n" + markdown);
}
}
if (markdown.length() != 0) {
info.setDescription( markdown.toString());
} else {
info.setDescription(NO_DESCRIPTION_AVAILABLE);
log.warn("No description available.");
}
return info;
}

private boolean isNotBlank(AnnotableStringType annotableStringType) {
return annotableStringType != null && StringUtils.isNotBlank(annotableStringType.value());
}

private List<Tag> setupTags(Api ramlApi) {
String title = ramlApi.title().value().toLowerCase(Locale.ROOT);
return Collections.singletonList(new Tag().name(title));
}

private String cleanupMarkdownString(String value) {
StringBuilder stringBuilder = new StringBuilder();
String[] lines = value.split("\n");
String[] lines = value.split(NEW_LINE);
for (int i = 0; i < lines.length; i++) {
if (i == 0 && lines[i].startsWith("#")) {
String title = "# " + StringUtils.substringAfterLast(lines[i], "#").trim();
stringBuilder.append(title).append("\n");
stringBuilder.append(title).append(NEW_LINE);
} else {
stringBuilder.append(lines[i]).append("\n");
stringBuilder.append(lines[i]).append(NEW_LINE);
}
}
return stringBuilder.toString().trim();
Expand Down Expand Up @@ -550,7 +561,7 @@ private String getSummary(MarkdownString description) {
if (description == null) {
return null;
}
return Stream.of(description.value().split("\n"))
return Stream.of(description.value().split(NEW_LINE))
.findFirst()
.map(firstLine -> firstLine.replaceAll("#", ""))
.map(String::trim)
Expand Down