Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Apply consistent formatting to the core project

Browse Source
This commit is contained in:
Andy Wilkinson
2015-01-13 12:11:44 +00:00
parent 8b2174cb84
commit bbec60bf8e
9 changed files with 131 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
spring-restdocs-core/src/main/java/org/springframework/restdocs/core/DocumentationProperties.java
View File

@@ -51,7 +51,8 @@ class DocumentationProperties {
}
File getOutputDir() {
String outputDir = this.properties.getProperty("org.springframework.restdocs.outputDir");
String outputDir = this.properties
.getProperty("org.springframework.restdocs.outputDir");
if (StringUtils.hasText(outputDir)) {
return new File(outputDir).getAbsoluteFile();
}

4
spring-restdocs-core/src/main/java/org/springframework/restdocs/core/DocumentationWriter.java
View File

@@ -38,7 +38,8 @@ public class DocumentationWriter extends PrintWriter {
});
}
public void codeBlock(String language, DocumentationAction... actions) throws Exception {
public void codeBlock(String language, DocumentationAction... actions)
throws Exception {
println();
if (language != null) {
println("[source," + language + "]");
@@ -52,6 +53,7 @@ public class DocumentationWriter extends PrintWriter {
}
public interface DocumentationAction {
void perform() throws Exception;
}

31
spring-restdocs-core/src/main/java/org/springframework/restdocs/core/RestDocumentation.java
View File

@@ -20,22 +20,23 @@ import java.util.Map;
public class RestDocumentation {
public static RestDocumentationResultHandler document(String outputDir) throws Exception {
return new RestDocumentationResultHandler(outputDir);
}
public static RestDocumentationResultHandler document(String outputDir)
throws Exception {
return new RestDocumentationResultHandler(outputDir);
}
public static LinkDescriptor linkWithRel(String rel) {
return new LinkDescriptor(rel);
}
public static LinkDescriptor linkWithRel(String rel) {
return new LinkDescriptor(rel);
}
public static LinkExtractor halLinks() {
return new LinkExtractor() {
public static LinkExtractor halLinks() {
return new LinkExtractor() {
@SuppressWarnings("unchecked")
@Override
public Map<String, Object> extractLinks(Map<String, Object> responseJson) {
return (Map<String, Object>) responseJson.get("_links");
}
};
}
@SuppressWarnings("unchecked")
@Override
public Map<String, Object> extractLinks(Map<String, Object> responseJson) {
return (Map<String, Object>) responseJson.get("_links");
}
};
}
}

39
spring-restdocs-core/src/main/java/org/springframework/restdocs/core/RestDocumentationResultHandler.java
View File

@@ -28,25 +28,28 @@ import org.springframework.test.web.servlet.ResultHandler;
public class RestDocumentationResultHandler implements ResultHandler {
private final String outputDir;
private ResultHandler linkDocumentingResultHandler;
private final String outputDir;
public RestDocumentationResultHandler(String outputDir) {
this.outputDir = outputDir;
}
private ResultHandler linkDocumentingResultHandler;
@Override
public void handle(MvcResult result) throws Exception {
documentCurlRequest(outputDir).includeResponseHeaders().handle(result);
documentCurlResponse(outputDir).includeResponseHeaders().handle(result);
documentCurlRequestAndResponse(outputDir).includeResponseHeaders().handle(result);
if(linkDocumentingResultHandler != null) {
linkDocumentingResultHandler.handle(result);
}
}
public RestDocumentationResultHandler(String outputDir) {
this.outputDir = outputDir;
}
public RestDocumentationResultHandler withLinks(LinkExtractor linkExtractor, LinkDescriptor... descriptors) {
linkDocumentingResultHandler = new LinkDocumentingResultHandler(outputDir, linkExtractor, Arrays.asList(descriptors));
return this;
}
@Override
public void handle(MvcResult result) throws Exception {
documentCurlRequest(outputDir).includeResponseHeaders().handle(result);
documentCurlResponse(outputDir).includeResponseHeaders().handle(result);
documentCurlRequestAndResponse(outputDir).includeResponseHeaders().handle(result);
if (linkDocumentingResultHandler != null) {
linkDocumentingResultHandler.handle(result);
}
}
public RestDocumentationResultHandler withLinks(LinkExtractor linkExtractor,
LinkDescriptor... descriptors) {
linkDocumentingResultHandler = new LinkDocumentingResultHandler(outputDir,
linkExtractor, Arrays.asList(descriptors));
return this;
}
}

42
spring-restdocs-core/src/main/java/org/springframework/restdocs/core/RestDocumentationResultHandlers.java
View File

@@ -16,8 +16,8 @@
package org.springframework.restdocs.core;
import static org.springframework.restdocs.core.IterableEnumeration.iterable;
import static org.junit.Assert.fail;
import static org.springframework.restdocs.core.IterableEnumeration.iterable;
import java.io.File;
import java.io.FileNotFoundException;
@@ -47,6 +47,7 @@ public abstract class RestDocumentationResultHandlers {
public static CurlResultHandler documentCurlRequest(String outputDir) {
return new CurlResultHandler(outputDir, "request") {
@Override
public void handle(MvcResult result, DocumentationWriter writer)
throws Exception {
@@ -58,24 +59,26 @@ public abstract class RestDocumentationResultHandlers {
public static CurlResultHandler documentCurlResponse(String outputDir) {
return new CurlResultHandler(outputDir, "response") {
@Override
public void handle(MvcResult result, DocumentationWriter writer)
throws Exception {
writer.codeBlock("http", new CurlResponseDocumentationAction(writer, result,
getCurlConfiguration()));
writer.codeBlock("http", new CurlResponseDocumentationAction(writer,
result, getCurlConfiguration()));
}
};
}
public static CurlResultHandler documentCurlRequestAndResponse(String outputDir) {
return new CurlResultHandler(outputDir, "request-response") {
@Override
public void handle(MvcResult result, DocumentationWriter writer)
throws Exception {
writer.shellCommand(new CurlRequestDocumentationAction(writer, result,
getCurlConfiguration()));
writer.codeBlock("http", new CurlResponseDocumentationAction(writer, result,
getCurlConfiguration()));
writer.codeBlock("http", new CurlResponseDocumentationAction(writer,
result, getCurlConfiguration()));
}
};
}
@@ -174,16 +177,16 @@ public abstract class RestDocumentationResultHandlers {
}
public static abstract class RestDocumentationResultHandler implements ResultHandler {
private String outputDir;
private String fileName;
public RestDocumentationResultHandler(String outputDir, String fileName) {
this.outputDir = outputDir;
this.fileName = fileName;
}
abstract void handle(MvcResult result, DocumentationWriter writer)
throws Exception;
@@ -198,19 +201,18 @@ public abstract class RestDocumentationResultHandlers {
}
}
protected PrintStream createPrintStream()
throws FileNotFoundException {
protected PrintStream createPrintStream() throws FileNotFoundException {
File outputFile = new File(this.outputDir, this.fileName + ".asciidoc");
if (!outputFile.isAbsolute()) {
outputFile = makeAbsolute(outputFile);
}
if (outputFile != null) {
outputFile.getParentFile().mkdirs();
return new PrintStream(new FileOutputStream(outputFile));
}
return System.out;
}
@@ -249,10 +251,11 @@ public abstract class RestDocumentationResultHandlers {
private final LinkExtractor extractor;
public LinkDocumentingResultHandler(String outputDir, LinkExtractor linkExtractor, List<LinkDescriptor> descriptors) {
public LinkDocumentingResultHandler(String outputDir,
LinkExtractor linkExtractor, List<LinkDescriptor> descriptors) {
super(outputDir, "links");
this.extractor = linkExtractor;
for (LinkDescriptor descriptor: descriptors) {
for (LinkDescriptor descriptor : descriptors) {
Assert.hasText(descriptor.getRel());
Assert.hasText(descriptor.getDescription());
this.descriptorsByRel.put(descriptor.getRel(), descriptor);
@@ -262,7 +265,8 @@ public abstract class RestDocumentationResultHandlers {
@SuppressWarnings("unchecked")
@Override
void handle(MvcResult result, DocumentationWriter writer) throws Exception {
Map<String, Object> json = this.objectMapper.readValue(result.getResponse().getContentAsString(), Map.class);
Map<String, Object> json = this.objectMapper.readValue(result.getResponse()
.getContentAsString(), Map.class);
Map<String, Object> links = this.extractor.extractLinks(json);
Set<String> actualRels = links.keySet();
@@ -277,10 +281,12 @@ public abstract class RestDocumentationResultHandlers {
if (!undocumentedRels.isEmpty() || !missingRels.isEmpty()) {
String message = "";
if (!undocumentedRels.isEmpty()) {
message += "Links with the following relations were not documented: " + undocumentedRels;
message += "Links with the following relations were not documented: "
+ undocumentedRels;
}
if (!missingRels.isEmpty()) {
message += "Links with the following relations were not found in the response: " + missingRels;
message += "Links with the following relations were not found in the response: "
+ missingRels;
}
fail(message);
}