refactoring: extract inner classes and renamings

and improve http resource handling

lib/src/main/java/com/diffplug/spotless/npm/JsonEscaper.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2016 DiffPlug
+ *
+ * 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.diffplug.spotless.npm;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Simple implementation on how to escape values when printing json.
+ * Implementation is partly based on https://github.com/stleary/JSON-java
+ */
+final class JsonEscaper {
+	private JsonEscaper() {
+		// no instance
+	}
+
+	public static String jsonEscape(Object val) {
+		requireNonNull(val);
+		if (val instanceof JsonRawValue) {
+			return jsonEscape((JsonRawValue) val);
+		}
+		if (val instanceof String) {
+			return jsonEscape((String) val);
+		}
+		return val.toString();
+	}
+
+	private static String jsonEscape(JsonRawValue jsonRawValue) {
+		return jsonRawValue.getRawJson();
+	}
+
+	private static String jsonEscape(String unescaped) {
+		/**
+		 * the following characters are reserved in JSON and must be properly escaped to be used in strings:
+		 *
+		 * Backspace is replaced with \b
+		 * Form feed is replaced with \f
+		 * Newline is replaced with \n
+		 * Carriage return is replaced with \r
+		 * Tab is replaced with \t
+		 * Double quote is replaced with \"
+		 * Backslash is replaced with \\
+		 *
+		 * additionally we handle xhtml '</bla>' string
+		 * and non-ascii chars
+		 */
+		StringBuilder escaped = new StringBuilder();
+		escaped.append('"');
+		char b;
+		char c = 0;
+		for (int i = 0; i < unescaped.length(); i++) {
+			b = c;
+			c = unescaped.charAt(i);
+			switch (c) {
+			case '\"':
+				escaped.append('\\').append('"');
+				break;
+			case '\n':
+				escaped.append('\\').append('n');
+				break;
+			case '\r':
+				escaped.append('\\').append('r');
+				break;
+			case '\t':
+				escaped.append('\\').append('t');
+				break;
+			case '\b':
+				escaped.append('\\').append('b');
+				break;
+			case '\f':
+				escaped.append('\\').append('f');
+				break;
+			case '\\':
+				escaped.append('\\').append('\\');
+				break;
+			case '/':
+				if (b == '<') {
+					escaped.append('\\');
+				}
+				escaped.append(c);
+				break;
+			default:
+				if (c < ' ' || (c >= '\u0080' && c < '\u00a0')
+						|| (c >= '\u2000' && c < '\u2100')) {
+					escaped.append('\\').append('u');
+					String hexString = Integer.toHexString(c);
+					escaped.append("0000", 0, 4 - hexString.length());
+					escaped.append(hexString);
+				} else {
+					escaped.append(c);
+				}
+			}
+		}
+		escaped.append('"');
+		return escaped.toString();
+	}
+
+}

lib/src/main/java/com/diffplug/spotless/npm/JsonRawValue.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2016 DiffPlug
+ *
+ * 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.diffplug.spotless.npm;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Wrapper class to signal the contained string must not be escaped when printing to json.
+ */
+class JsonRawValue {
+	private final String rawJson;
+
+	private JsonRawValue(String rawJson) {
+		this.rawJson = requireNonNull(rawJson);
+	}
+
+	static JsonRawValue wrap(String rawJson) {
+		return new JsonRawValue(rawJson);
+	}
+
+	public String getRawJson() {
+		return rawJson;
+	}
+}

lib/src/main/java/com/diffplug/spotless/npm/NpmFormatterStepStateBase.java

@@ -62,9 +62,9 @@ protected NpmFormatterStepStateBase(String stepName, NpmConfig npmConfig, File b
 
 	private File prepareNodeServer(File buildDir) throws IOException {
 		File targetDir = new File(buildDir, "spotless-node-modules-" + stepName);
-		SimpleResourceHelper.assertDirectoryExists(targetDir);
-		SimpleResourceHelper.writeUtf8StringToFile(targetDir, "package.json", this.npmConfig.getPackageJsonContent());
-		SimpleResourceHelper.writeUtf8StringToFile(targetDir, "serve.js", this.npmConfig.getServeScriptContent());
+		NpmResourceHelper.assertDirectoryExists(targetDir);
+		NpmResourceHelper.writeUtf8StringToFile(targetDir, "package.json", this.npmConfig.getPackageJsonContent());
+		NpmResourceHelper.writeUtf8StringToFile(targetDir, "serve.js", this.npmConfig.getServeScriptContent());
 		runNpmInstall(targetDir);
 		return targetDir;
 	}
@@ -78,13 +78,13 @@ protected ServerProcessInfo npmRunServer() throws ServerStartException {
 			// The npm process will output the randomly selected port of the http server process to 'server.port' file
 			// so in order to be safe, remove such a file if it exists before starting.
 			final File serverPortFile = new File(this.nodeModulesDir, "server.port");
-			SimpleResourceHelper.deleteFileIfExists(serverPortFile);
+			NpmResourceHelper.deleteFileIfExists(serverPortFile);
 			// start the http server in node
 			Process server = new NpmProcess(this.nodeModulesDir, this.npmExecutable).start();
 
 			// await the readiness of the http server - wait for at most 60 seconds
 			try {
-				SimpleResourceHelper.awaitReadableFile(serverPortFile, Duration.ofSeconds(60));
+				NpmResourceHelper.awaitReadableFile(serverPortFile, Duration.ofSeconds(60));
 			} catch (TimeoutException timeoutException) {
 				// forcibly end the server process
 				try {
@@ -98,7 +98,7 @@ protected ServerProcessInfo npmRunServer() throws ServerStartException {
 				throw timeoutException;
 			}
 			// read the server.port file for resulting port and remember the port for later formatting calls
-			String serverPort = SimpleResourceHelper.readUtf8StringFromFile(serverPortFile).trim();
+			String serverPort = NpmResourceHelper.readUtf8StringFromFile(serverPortFile).trim();
 			return new ServerProcessInfo(server, serverPort, serverPortFile);
 		} catch (IOException | TimeoutException e) {
 			throw new ServerStartException(e);
@@ -155,7 +155,7 @@ public String getBaseUrl() {
 
 		@Override
 		public void close() throws Exception {
-			SimpleResourceHelper.deleteFileIfExists(serverPortFile);
+			NpmResourceHelper.deleteFileIfExists(serverPortFile);
 			if (this.server.isAlive()) {
 				this.server.destroy();
 			}

lib/src/main/java/com/diffplug/spotless/npm/SimpleResourceHelper.java → lib/src/main/java/com/diffplug/spotless/npm/NpmResourceHelper.java

@@ -15,25 +15,27 @@
  */
 package com.diffplug.spotless.npm;
 
-import java.io.ByteArrayOutputStream;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
+import java.io.*;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.time.Duration;
 import java.util.concurrent.TimeoutException;
 
 import com.diffplug.spotless.ThrowingEx;
 
-final class SimpleResourceHelper {
-	private SimpleResourceHelper() {
+final class NpmResourceHelper {
+	private NpmResourceHelper() {
 		// no instance required
 	}
 
-	static void writeUtf8StringToFile(File targetDir, String fileName, String packageJsonContent) throws IOException {
+	static void writeUtf8StringToFile(File targetDir, String fileName, String stringToWrite) throws IOException {
 		File packageJsonFile = new File(targetDir, fileName);
-		Files.write(packageJsonFile.toPath(), packageJsonContent.getBytes(StandardCharsets.UTF_8));
+		Files.write(packageJsonFile.toPath(), stringToWrite.getBytes(StandardCharsets.UTF_8));
+	}
+
+	static void writeUtf8StringToOutputStream(String stringToWrite, OutputStream outputStream) throws IOException {
+		final byte[] bytes = stringToWrite.getBytes(StandardCharsets.UTF_8);
+		outputStream.write(bytes);
 	}
 
 	static void deleteFileIfExists(File file) throws IOException {
@@ -45,14 +47,8 @@ static void deleteFileIfExists(File file) throws IOException {
 	}
 
 	static String readUtf8StringFromClasspath(Class<?> clazz, String resourceName) {
-		ByteArrayOutputStream output = new ByteArrayOutputStream();
 		try (InputStream input = clazz.getResourceAsStream(resourceName)) {
-			byte[] buffer = new byte[1024];
-			int numRead;
-			while ((numRead = input.read(buffer)) != -1) {
-				output.write(buffer, 0, numRead);
-			}
-			return output.toString(StandardCharsets.UTF_8.name());
+			return readUtf8StringFromInputStream(input);
 		} catch (IOException e) {
 			throw ThrowingEx.asRuntime(e);
 		}
@@ -66,6 +62,20 @@ static String readUtf8StringFromFile(File file) {
 		}
 	}
 
+	static String readUtf8StringFromInputStream(InputStream input) {
+		try {
+			ByteArrayOutputStream output = new ByteArrayOutputStream();
+			byte[] buffer = new byte[1024];
+			int numRead;
+			while ((numRead = input.read(buffer)) != -1) {
+				output.write(buffer, 0, numRead);
+			}
+			return output.toString(StandardCharsets.UTF_8.name());
+		} catch (IOException e) {
+			throw ThrowingEx.asRuntime(e);
+		}
+	}
+
 	static void assertDirectoryExists(File directory) throws IOException {
 		if (!directory.exists()) {
 			if (!directory.mkdirs()) {

lib/src/main/java/com/diffplug/spotless/npm/PrettierFormatterStep.java

@@ -67,10 +67,10 @@ public static class State extends NpmFormatterStepStateBase implements Serializa
 			super(stepName,
 					new NpmConfig(
 							replaceDevDependencies(
-									SimpleResourceHelper.readUtf8StringFromClasspath(PrettierFormatterStep.class, "/com/diffplug/spotless/npm/prettier-package.json"),
+									NpmResourceHelper.readUtf8StringFromClasspath(PrettierFormatterStep.class, "/com/diffplug/spotless/npm/prettier-package.json"),
 									new TreeMap<>(devDependencies)),
 							"prettier",
-							SimpleResourceHelper.readUtf8StringFromClasspath(PrettierFormatterStep.class, "/com/diffplug/spotless/npm/prettier-serve.js")),
+							NpmResourceHelper.readUtf8StringFromClasspath(PrettierFormatterStep.class, "/com/diffplug/spotless/npm/prettier-serve.js")),
 					buildDir,
 					npm);
 			this.prettierConfig = requireNonNull(prettierConfig);

lib/src/main/java/com/diffplug/spotless/npm/PrettierRestService.java

@@ -19,8 +19,6 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
-import com.diffplug.spotless.npm.SimpleJsonWriter.RawJsonValue;
-
 public class PrettierRestService {
 
 	private final SimpleRestClient restClient;
@@ -35,7 +33,7 @@ public String resolveConfig(File prettierConfigPath, Map<String, Object> prettie
 			jsonProperties.put("prettier_config_path", prettierConfigPath.getAbsolutePath());
 		}
 		if (prettierConfigOptions != null) {
-			jsonProperties.put("prettier_config_options", SimpleJsonWriter.of(prettierConfigOptions).toRawJsonValue());
+			jsonProperties.put("prettier_config_options", SimpleJsonWriter.of(prettierConfigOptions).toJsonRawValue());
 
 		}
 		return restClient.postJson("/prettier/config-options", jsonProperties);
@@ -45,7 +43,7 @@ public String format(String fileContent, String configOptionsJsonString) {
 		Map<String, Object> jsonProperties = new LinkedHashMap<>();
 		jsonProperties.put("file_content", fileContent);
 		if (configOptionsJsonString != null) {
-			jsonProperties.put("config_options", RawJsonValue.wrap(configOptionsJsonString));
+			jsonProperties.put("config_options", JsonRawValue.wrap(configOptionsJsonString));
 		}
 
 		return restClient.postJson("/prettier/format", jsonProperties);