Fix Properties.store(OutputStream os, String comment)

This fixes the store method taking an `OutputStream` by flushing and closing the writer created to wrap it.

It also introduces ApprovalTests (https://approvaltests.com/) to open a diff window when comparing Strings and File contents

Author: gastaldi

pom.xml

@@ -34,6 +34,7 @@
         <assertj.version>3.21.0</assertj.version>
         <spotless.version>2.12.2</spotless.version>
         <google-java-format.version>1.7</google-java-format.version>
+        <approvaltests.version>24.2.0</approvaltests.version>
     </properties>
 
     <dependencies>
@@ -49,6 +50,12 @@
             <version>${assertj.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.approvaltests</groupId>
+            <artifactId>approvaltests</artifactId>
+            <version>${approvaltests.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -66,6 +73,9 @@
                                 <include>.gitignore</include>
                                 <include>.gitattributes</include>
                             </includes>
+                            <excludes>
+                                <exclude>src/test/approvals/**</exclude>
+                            </excludes>
                             <trimTrailingWhitespace />
                             <endWithNewline />
                             <indent>
@@ -187,4 +197,4 @@
             <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
         </repository>
     </distributionManagement>
-</project>
+</project>

src/main/java/org/codejive/properties/Properties.java

@@ -898,7 +898,9 @@ public void store(Path file, String... comment) throws IOException {
      * @throws IOException Thrown when any IO error occurs during operation
      */
     public void store(OutputStream out, String... comment) throws IOException {
-        store(new OutputStreamWriter(out, StandardCharsets.ISO_8859_1), comment);
+        try (Writer writer = new OutputStreamWriter(out, StandardCharsets.ISO_8859_1)) {
+            store(writer, comment);
+        }
     }
 
     /**

src/test/approvals/org/codejive/properties/TestProperties.testStoreOutputStream.approved.txt

@@ -0,0 +1,17 @@
+#comment1
+#  comment2
+
+! comment3
+one=simple
+two=value containing spaces
+# another comment
+! and a comment
+! block
+three=and escapes\n\t\r\f
+\ with\ spaces   =    everywhere  
+altsep:value
+multiline = one \
+    two  \
+	three
+key.4 = \u1234\u1234
+# final comment

src/test/java/org/codejive/properties/PackageSettings.java

@@ -0,0 +1,12 @@
+package org.codejive.properties;
+
+/**
+ * This class is used by the ApprovalTests framework
+ *
+ * @see <a
+ *     href="https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/docs/Configuration.md#package-level-settings">ApprovalTests
+ *     Configuration</a>
+ */
+public class PackageSettings {
+    public static String ApprovalBaseDirectory = "../approvals";
+}

src/test/java/org/codejive/properties/TestProperties.java

@@ -11,6 +11,7 @@
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.NoSuchElementException;
+import org.approvaltests.Approvals;
 import org.junit.jupiter.api.Test;
 
 public class TestProperties {
@@ -118,6 +119,15 @@ void testStore() throws IOException, URISyntaxException {
         assertThat(sw.toString()).isEqualTo(readAll(f));
     }
 
+    @Test
+    void testStoreOutputStream() throws IOException, URISyntaxException {
+        Path f = getResource("/test-escaped.properties");
+        Properties p = Properties.loadProperties(f);
+        ByteArrayOutputStream os = new ByteArrayOutputStream();
+        p.store(os);
+        Approvals.verify(os.toString());
+    }
+
     @Test
     void testStoreCrLf() throws IOException, URISyntaxException {
         Path f = getResource("/testcrlf.properties");