Polish "Provide a preprocessor for modifying request and response headers"

See gh-584

Author: wilkinsona

docs/src/docs/asciidoc/customizing-requests-and-responses.adoc

@@ -108,12 +108,10 @@ You can also specify a different replacement if you wish.
 
 
 
-[[customizing-requests-and-responses-preprocessors-remove-headers]]
-==== Removing Headers
-
-`removeHeaders` on `Preprocessors` removes any headers from the request or response where the name is equal to any of the given header names.
+[[customizing-requests-and-responses-preprocessors-modify-headers]]
+==== Modifying Headers
 
-`removeMatchingHeaders` on `Preprocessors` removes any headers from the request or response where the name matches any of the given regular expression patterns.
+You can use `modifyHeaders` on `Preprocessors` to add, set, and remove request or response headers.
 
 
 
@@ -125,13 +123,6 @@ Any occurrences that match a regular expression are replaced.
 
 
 
-[[customizing-requests-and-responses-preprocessors-modify-headers]]
-==== Modifying Headers
-
-You can use `modifyHeaders` on `Preprocessors` to add, set, and remove request or response headers.
-
-
-
 [[customizing-requests-and-responses-preprocessors-modify-request-parameters]]
 ==== Modifying Request Parameters
 

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/HeaderRemovingOperationPreprocessor.java

@@ -30,10 +30,12 @@
 import org.springframework.util.Assert;
 
 /**
- * An {@link OperationPreprocessor} that can be used to modify a request's
- * {@link OperationRequest#getHeaders()} by adding, setting, and removing headers.
+ * An {@link OperationPreprocessor} that modifies a request or response by adding,
+ * setting, or removing headers.
  *
  * @author Jihoon Cha
+ * @author Andy Wilkinson
+ * @since 3.0.0
  */
 public class HeadersModifyingOperationPreprocessor implements OperationPreprocessor {
 
@@ -45,32 +47,21 @@ public class HeadersModifyingOperationPreprocessor implements OperationPreproces
 
 	@Override
 	public OperationRequest preprocess(OperationRequest request) {
-		HttpHeaders headers = copyHttpHeaders(request.getHeaders());
-		for (Modification modification : this.modifications) {
-			modification.applyTo(headers);
-		}
-		return this.requestFactory.createFrom(request, headers);
+		return this.requestFactory.createFrom(request, preprocess(request.getHeaders()));
 	}
 
 	@Override
 	public OperationResponse preprocess(OperationResponse response) {
-		HttpHeaders headers = copyHttpHeaders(response.getHeaders());
-		for (Modification modification : this.modifications) {
-			modification.applyTo(headers);
-		}
-		return this.responseFactory.createFrom(response, headers);
+		return this.responseFactory.createFrom(response, preprocess(response.getHeaders()));
 	}
 
-	private HttpHeaders copyHttpHeaders(HttpHeaders headers) {
-		HttpHeaders copy = new HttpHeaders();
-		for (String name : headers.keySet()) {
-			List<String> values = headers.get(name);
-			if (values == null) {
-				continue;
-			}
-			copy.put(name, new ArrayList<>(values));
+	private HttpHeaders preprocess(HttpHeaders headers) {
+		HttpHeaders modifiedHeaders = new HttpHeaders();
+		modifiedHeaders.putAll(headers);
+		for (Modification modification : this.modifications) {
+			modification.applyTo(modifiedHeaders);
 		}
-		return copy;
+		return modifiedHeaders;
 	}
 
 	/**
@@ -123,8 +114,8 @@ public HeadersModifyingOperationPreprocessor remove(String name, String value) {
 	 * @return {@code this}
 	 * @see Matcher#matches()
 	 */
-	public HeadersModifyingOperationPreprocessor remove(Pattern namePattern) {
-		this.modifications.add(new RemoveHeadersByNamePatternModification(namePattern));
+	public HeadersModifyingOperationPreprocessor removeMatching(String namePattern) {
+		this.modifications.add(new RemoveHeadersByNamePatternModification(Pattern.compile(namePattern)));
 		return this;
 	}
 

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/HeadersModifyingOperationPreprocessor.java

@@ -74,12 +74,17 @@ public static OperationPreprocessor prettyPrint() {
 	 * {@code headersToRemove}.
 	 * @param headerNames the header names
 	 * @return the preprocessor
-	 * @deprecated Use {@link #modifyHeaders()} instead
+	 * @deprecated since 3.0.0 in favor of {@link #modifyHeaders()} and
+	 * {@link HeadersModifyingOperationPreprocessor#remove(String)}
 	 * @see String#equals(Object)
 	 */
 	@Deprecated
 	public static OperationPreprocessor removeHeaders(String... headerNames) {
-		return new HeaderRemovingOperationPreprocessor(new ExactMatchHeaderFilter(headerNames));
+		HeadersModifyingOperationPreprocessor preprocessor = new HeadersModifyingOperationPreprocessor();
+		for (String headerName : headerNames) {
+			preprocessor.remove(headerName);
+		}
+		return preprocessor;
 	}
 
 	/**
@@ -88,12 +93,17 @@ public static OperationPreprocessor removeHeaders(String... headerNames) {
 	 * {@code headerNamePatterns} regular expressions.
 	 * @param headerNamePatterns the header name patterns
 	 * @return the preprocessor
-	 * @deprecated Use {@link #modifyHeaders()} instead
+	 * @deprecated since 3.0.0 in favor of {@link #modifyHeaders()} and
+	 * {@link HeadersModifyingOperationPreprocessor#removeMatching(String)}
 	 * @see java.util.regex.Matcher#matches()
 	 */
 	@Deprecated
 	public static OperationPreprocessor removeMatchingHeaders(String... headerNamePatterns) {
-		return new HeaderRemovingOperationPreprocessor(new PatternMatchHeaderFilter(headerNamePatterns));
+		HeadersModifyingOperationPreprocessor preprocessor = new HeadersModifyingOperationPreprocessor();
+		for (String headerNamePattern : headerNamePatterns) {
+			preprocessor.removeMatching(headerNamePattern);
+		}
+		return preprocessor;
 	}
 
 	/**
@@ -141,6 +151,7 @@ public static ParametersModifyingOperationPreprocessor modifyParameters() {
 	 * Returns a {@code HeadersModifyingOperationPreprocessor} that can then be configured
 	 * to modify the headers of the request.
 	 * @return the preprocessor
+	 * @since 3.0.0
 	 */
 	public static HeadersModifyingOperationPreprocessor modifyHeaders() {
 		return new HeadersModifyingOperationPreprocessor();