Rewrite NSL class to drop System.getProperty call

Update `EclipseRewriter` so that the NSL class is rewritten to remove
the System.getProperty("osgi.nls.warnings") call. This update should
allow us to support Gradle's configuration caching feature.

Closes gh-262

Author: philwebb

spring-javaformat/spring-javaformat-formatter-eclipse-rewriter/src/main/java/io/spring/javaformat/formatter/eclipse/rewrite/EclipseRewriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2019 the original author or authors.
+ * Copyright 2017-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@
 import java.util.Collections;
 import java.util.LinkedHashSet;
 import java.util.Set;
+import java.util.function.Function;
 
 import org.objectweb.asm.ClassReader;
 import org.objectweb.asm.ClassVisitor;
@@ -72,20 +73,30 @@ public void rewrite(String file) throws IOException {
 	}
 
 	private void rewrite(FileSystem zip) throws IOException {
-		Path path = zip.getPath("org/eclipse/jdt/internal/formatter/DefaultCodeFormatter.class");
-		ClassWriter writer = new ClassWriter(0);
+		rewrite(zip, "org/eclipse/jdt/internal/formatter/DefaultCodeFormatter.class",
+				DefaultCodeFormatterManipulator::new);
+		rewrite(zip, "org/eclipse/osgi/util/NLS$1.class", NlsManipulator::new);
+	}
+
+	private void rewrite(FileSystem zip, String name, Function<ClassWriter, ClassVisitor> manipulator)
+			throws IOException {
+		ClassWriter classWriter = new ClassWriter(0);
+		Path path = zip.getPath(name);
 		try (InputStream in = Files.newInputStream(path)) {
-			DefaultCodeFormatterManipulator manipulator = new DefaultCodeFormatterManipulator(writer);
 			ClassReader reader = new ClassReader(in);
-			reader.accept(manipulator, 0);
+			reader.accept(manipulator.apply(classWriter), 0);
 		}
-		Files.copy(new ByteArrayInputStream(writer.toByteArray()), path, StandardCopyOption.REPLACE_EXISTING);
+		Files.copy(new ByteArrayInputStream(classWriter.toByteArray()), path, StandardCopyOption.REPLACE_EXISTING);
 	}
 
 	public static void main(String[] args) throws Exception {
 		new EclipseRewriter().rewrite(args[0]);
 	}
 
+	/**
+	 * {@link ClassVisitor} to make some fields and methods from
+	 * {@code DefaultCodeFormatter} public.
+	 */
 	private static class DefaultCodeFormatterManipulator extends ClassVisitor {
 
 		DefaultCodeFormatterManipulator(ClassVisitor visitor) {
@@ -111,6 +122,10 @@ public MethodVisitor visitMethod(int access, String name, String desc, String si
 
 	}
 
+	/**
+	 * {@link MethodVisitor} to make some fields and methods from
+	 * {@code DefaultCodeFormatter} public.
+	 */
 	private static class DefaultCodeFormatterMethodManipulator extends MethodVisitor {
 
 		DefaultCodeFormatterMethodManipulator(MethodVisitor mv) {
@@ -127,4 +142,49 @@ public void visitMethodInsn(int opcode, String owner, String name, String desc,
 
 	}
 
+	/**
+	 * {@link ClassVisitor} to update the {@code NLS} class so it doesn't use a System
+	 * property to disable warning messages.
+	 */
+	private static class NlsManipulator extends ClassVisitor {
+
+		NlsManipulator(ClassVisitor visitor) {
+			super(Opcodes.ASM5, visitor);
+		}
+
+		@Override
+		public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
+			if ("run".equals(name) && desc.contains("Boolean")) {
+				return new NslMethodManipulator(super.visitMethod(access, name, desc, signature, exceptions));
+			}
+			return super.visitMethod(access, name, desc, signature, exceptions);
+		}
+
+	}
+
+	/**
+	 * {@link MethodVisitor} to update the {@code NLS} class so it doesn't use a System
+	 * property to disable warning messages.
+	 */
+	private static class NslMethodManipulator extends MethodVisitor {
+
+		private final MethodVisitor methodVisitor;
+
+		NslMethodManipulator(MethodVisitor mv) {
+			super(Opcodes.ASM5, null);
+			this.methodVisitor = mv;
+		}
+
+		@Override
+		public void visitEnd() {
+			MethodVisitor mv = this.methodVisitor;
+			mv.visitCode();
+			mv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/Boolean", "TRUE", "Ljava/lang/Boolean;");
+			mv.visitInsn(Opcodes.ARETURN);
+			mv.visitMaxs(1, 1);
+			mv.visitEnd();
+		}
+
+	}
+
 }

spring-javaformat/spring-javaformat-formatter/src/main/java/io/spring/javaformat/formatter/FileFormatter.java

@@ -41,12 +41,8 @@ public FileFormatter() {
 		this(new Formatter());
 	}
 
-	public FileFormatter(FormatterOption... options) {
-		this(new Formatter(options));
-	}
-
-	public FileFormatter(JavaFormatConfig javaFormatConfig, FormatterOption... options) {
-		this(new Formatter(javaFormatConfig, options));
+	public FileFormatter(JavaFormatConfig javaFormatConfig) {
+		this(new Formatter(javaFormatConfig));
 	}
 
 	public FileFormatter(Formatter formatter) {

spring-javaformat/spring-javaformat-formatter/src/main/java/io/spring/javaformat/formatter/Formatter.java

@@ -18,13 +18,9 @@
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.Arrays;
 import java.util.Collections;
-import java.util.HashSet;
 import java.util.Map;
 import java.util.Properties;
-import java.util.Set;
-import java.util.function.Supplier;
 
 import org.eclipse.jdt.core.formatter.CodeFormatter;
 import org.eclipse.jface.text.IRegion;
@@ -58,35 +54,21 @@ public class Formatter extends CodeFormatter {
 	 */
 	public static final String DEFAULT_LINE_SEPARATOR = null;
 
-	private static final FormatterOption[] EMPTY_OPTIONS = {};
-
-	private final Set<FormatterOption> options;
-
 	private final CodeFormatter delegate;
 
 	/**
 	 * Create a new formatter instance.
 	 */
 	public Formatter() {
-		this(JavaFormatConfig.DEFAULT, EMPTY_OPTIONS);
-	}
-
-	/**
-	 * Create a new formatter instance.
-	 * @param options formatter options
-	 */
-	public Formatter(FormatterOption... options) {
-		this(JavaFormatConfig.DEFAULT, options);
+		this(JavaFormatConfig.DEFAULT);
 	}
 
 	/**
 	 * Create a new formatter instance.
 	 * @param javaFormatConfig the java format config to use
-	 * @param options formatter options
 	 */
-	public Formatter(JavaFormatConfig javaFormatConfig, FormatterOption... options) {
+	public Formatter(JavaFormatConfig javaFormatConfig) {
 		this.delegate = new DelegateCodeFormatter(javaFormatConfig);
-		this.options = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(options)));
 	}
 
 	/**
@@ -134,9 +116,7 @@ public TextEdit format(String source, int offset, int length, String lineSeparat
 	@Override
 	public TextEdit format(int kind, String source, int offset, int length, int indentationLevel,
 			String lineSeparator) {
-		return nlsSafe(() -> {
-			return this.delegate.format(kind, source, offset, length, indentationLevel, lineSeparator);
-		});
+		return this.delegate.format(kind, source, offset, length, indentationLevel, lineSeparator);
 	}
 
 	/**
@@ -162,7 +142,7 @@ public TextEdit format(String source, IRegion[] regions, String lineSeparator) {
 
 	@Override
 	public TextEdit format(int kind, String source, IRegion[] regions, int indentationLevel, String lineSeparator) {
-		return nlsSafe(() -> this.delegate.format(kind, source, regions, indentationLevel, lineSeparator));
+		return this.delegate.format(kind, source, regions, indentationLevel, lineSeparator);
 	}
 
 	@Override
@@ -175,23 +155,6 @@ public void setOptions(Map<String, String> options) {
 		this.delegate.setOptions(options);
 	}
 
-	private <T> T nlsSafe(Supplier<T> formatted) {
-		if (this.options.contains(FormatterOption.SHOW_NLS_WARNINGS)) {
-			return formatted.get();
-		}
-		String nlsWarnings = System.getProperty("osgi.nls.warnings");
-		try {
-			System.setProperty("osgi.nls.warnings", "ignore");
-			return formatted.get();
-		}
-		finally {
-			if (nlsWarnings != null) {
-				System.setProperty("osgi.nls.warnings", nlsWarnings);
-			}
-		}
-
-	}
-
 	/**
 	 * Internal delegate code formatter to apply Spring {@literal formatter.prefs} and add
 	 * {@link Preparator Preparators}.