Enhanced EOL support

appveyor.yml

@@ -1,8 +1,16 @@
 version: '{build}'
 os: Windows Server 2012
+
 environment:
   appveyor_build_worker_cloud: gce
+
+init:
+  # Setup autocrlf -- by default, appveyor uses autocrlf input
+  # ... This affects tests which expect resource files to have the systems's line separator.
+  - git config --global core.autocrlf true
+
 install:
+  # Download maven
   - ps: |
       Add-Type -AssemblyName System.IO.Compression.FileSystem
       if (!(Test-Path -Path "C:\maven" )) {
@@ -12,15 +20,23 @@ install:
         )
         [System.IO.Compression.ZipFile]::ExtractToDirectory("C:\maven-bin.zip", "C:\maven")
       }
-  - cmd: SET PATH=C:\maven\apache-maven-3.6.3\bin;%JAVA_HOME%\bin;%PATH%
+  # Setup environment variables for Maven and Java
+  - cmd: SET JAVA_HOME=C:\Program Files\Java\jdk10
+  - cmd: SET M2_HOME=C:\maven\apache-maven-3.6.3
   - cmd: SET MAVEN_OPTS=-Xmx1g
   - cmd: SET JAVA_OPTS=-Xmx1g
-  - cmd: SET M2_HOME=C:\maven\apache-maven-3.6.3
-  - cmd: SET JAVA_HOME=C:\Program Files\Java\jdk10
+  - cmd: SET PATH=C:\maven\apache-maven-3.6.3\bin;%JAVA_HOME%\bin;%PATH%
+  # Output the git config re: autocrlf to verify the "current" setting
+  - cmd: git config core.autocrlf
+
+# Appveyor is used for testing only -- the build script is not required.
 build_script:
   - echo ignore this
+
 test_script:
   - mvn -B clean install --batch-mode
+
+# Use of the cache speeds up future tests, meaning that dependencies do not need to be re-downloaded on every run.
 cache:
   - C:\maven\
   - C:\Users\appveyor\.m2

changelog.md

@@ -1,7 +1,13 @@
-Next Release (Version 3.16.1)
+Next Release (Version 3.16.2)
+------------------
+[issues resolved](https://github.com/javaparser/javaparser/milestone/176?closed=1)
+* FIXED: Enhanced the handling of line separator, introducing an enum `LineSeparator` that can be used.
+    (PR [#2685](https://github.com/javaparser/javaparser/pull/2685), by [@MysterAitch](https://github.com/MysterAitch))
+
+Version 3.16.1
 ------------------
 [issues resolved](https://github.com/javaparser/javaparser/milestone/175?closed=1)
-* FIXED: Fixed type 
+* FIXED: Fixed typo
     (PR [#2697](https://github.com/javaparser/javaparser/pull/2697), by [@hfreeb](https://github.com/hfreeb))
 
 Version 3.16.0

javaparser-core-serialization/src/test/java/com/github/javaparser/serialization/JavaParserJsonDeserializerTest.java

@@ -32,6 +32,7 @@
 import com.github.javaparser.javadoc.JavadocBlockTag;
 import com.github.javaparser.resolution.SymbolResolver;
 import com.github.javaparser.resolution.types.ResolvedType;
+import com.github.javaparser.utils.LineSeparator;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.Test;
 
@@ -40,7 +41,6 @@
 
 import static com.github.javaparser.StaticJavaParser.*;
 import static com.github.javaparser.serialization.JavaParserJsonSerializerTest.serialize;
-import static com.github.javaparser.utils.Utils.EOL;
 import static com.github.javaparser.utils.Utils.normalizeEolInTextBlock;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -55,7 +55,7 @@ void simpleTest() {
 
         Node deserialized = deserializer.deserializeObject(Json.createReader(new StringReader(serialized)));
 
-        assertEqualsNoEol("public class X {\n}\n\nclass Z {\n}\n", deserialized.toString());
+        assertEqualsStringIgnoringEol("public class X {\n}\n\nclass Z {\n}\n", deserialized.toString());
         assertEquals(cu.hashCode(), deserialized.hashCode());
     }
 
@@ -66,7 +66,7 @@ void testRawType() {
 
         Node deserialized = deserializer.deserializeObject(Json.createReader(new StringReader(serialized)));
 
-        assertEqualsNoEol("Blub", deserialized.toString());
+        assertEqualsStringIgnoringEol("Blub", deserialized.toString());
         assertEquals(type.hashCode(), deserialized.hashCode());
     }
 
@@ -77,7 +77,7 @@ void testDiamondType() {
 
         Node deserialized = deserializer.deserializeObject(Json.createReader(new StringReader(serialized)));
 
-        assertEqualsNoEol("Blub<>", deserialized.toString());
+        assertEqualsStringIgnoringEol("Blub<>", deserialized.toString());
         assertEquals(type.hashCode(), deserialized.hashCode());
     }
 
@@ -88,7 +88,7 @@ void testGenerics() {
 
         Node deserialized = deserializer.deserializeObject(Json.createReader(new StringReader(serialized)));
 
-        assertEqualsNoEol("Blub<Blab, Bleb>", deserialized.toString());
+        assertEqualsStringIgnoringEol("Blub<Blab, Bleb>", deserialized.toString());
         assertEquals(type.hashCode(), deserialized.hashCode());
     }
 
@@ -99,7 +99,7 @@ void testOperator() {
 
         Node deserialized = deserializer.deserializeObject(Json.createReader(new StringReader(serialized)));
 
-        assertEqualsNoEol("1 + 1", deserialized.toString());
+        assertEqualsStringIgnoringEol("1 + 1", deserialized.toString());
         assertEquals(expr.hashCode(), deserialized.hashCode());
     }
 
@@ -110,7 +110,7 @@ void testPrimitiveType() {
 
         Node deserialized = deserializer.deserializeObject(Json.createReader(new StringReader(serialized)));
 
-        assertEqualsNoEol("int", deserialized.toString());
+        assertEqualsStringIgnoringEol("int", deserialized.toString());
         assertEquals(type.hashCode(), deserialized.hashCode());
     }
 
@@ -214,8 +214,11 @@ static void clearConfiguration() {
     /**
      * Assert that "actual" equals "expected", and that any EOL characters in "actual" are correct for the platform.
      */
-    private static void assertEqualsNoEol(String expected, String actual) {
-        assertEquals(normalizeEolInTextBlock(expected, EOL), actual);
+    private static void assertEqualsStringIgnoringEol(String expected, String actual) {
+        assertEquals(
+                normalizeEolInTextBlock(expected, LineSeparator.ARBITRARY),
+                normalizeEolInTextBlock(actual, LineSeparator.ARBITRARY)
+        );
     }
 
 }

javaparser-core-testing/src/test/java/com/github/javaparser/CommentsInserterTest.java

@@ -32,8 +32,8 @@
 import static com.github.javaparser.StaticJavaParser.parse;
 import static com.github.javaparser.StaticJavaParser.parseResource;
 import static com.github.javaparser.utils.TestUtils.assertEqualToTextResource;
-import static com.github.javaparser.utils.TestUtils.assertEqualsNoEol;
-import static com.github.javaparser.utils.Utils.EOL;
+import static com.github.javaparser.utils.TestUtils.assertEqualsStringIgnoringEol;
+import static com.github.javaparser.utils.Utils.SYSTEM_EOL;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 class CommentsInserterTest {
@@ -69,13 +69,13 @@ void issue624() throws IOException {
 
     @Test
     void issue200EnumConstantsWithCommentsForceVerticalAlignment() {
-        CompilationUnit cu = TestParser.parseCompilationUnit("public enum X {" + EOL +
-                "    /** const1 javadoc */" + EOL +
-                "    BORDER_CONSTANT," + EOL +
-                "    /** const2 javadoc */" + EOL +
-                "    ANOTHER_CONSTANT" + EOL +
+        CompilationUnit cu = TestParser.parseCompilationUnit("public enum X {" + SYSTEM_EOL +
+                "    /** const1 javadoc */" + SYSTEM_EOL +
+                "    BORDER_CONSTANT," + SYSTEM_EOL +
+                "    /** const2 javadoc */" + SYSTEM_EOL +
+                "    ANOTHER_CONSTANT" + SYSTEM_EOL +
                 "}");
-        assertEqualsNoEol("public enum X {\n" +
+        assertEqualsStringIgnoringEol("public enum X {\n" +
                 "\n" +
                 "    /**\n" +
                 "     * const1 javadoc\n" +
@@ -90,16 +90,16 @@ void issue200EnumConstantsWithCommentsForceVerticalAlignment() {
 
     @Test
     void issue234LosingCommentsInArrayInitializerExpr() {
-        CompilationUnit cu = TestParser.parseCompilationUnit("@Anno(stuff={" + EOL +
-                "    // Just," + EOL +
-                "    // an," + EOL +
-                "    // example" + EOL +
-                "})" + EOL +
-                "class ABC {" + EOL +
-                "" + EOL +
+        CompilationUnit cu = TestParser.parseCompilationUnit("@Anno(stuff={" + SYSTEM_EOL +
+                "    // Just," + SYSTEM_EOL +
+                "    // an," + SYSTEM_EOL +
+                "    // example" + SYSTEM_EOL +
+                "})" + SYSTEM_EOL +
+                "class ABC {" + SYSTEM_EOL +
+                "" + SYSTEM_EOL +
                 "}");
 
-        assertEqualsNoEol("@Anno(stuff = {// Just,\n" +
+        assertEqualsStringIgnoringEol("@Anno(stuff = {// Just,\n" +
                 "// an,\n" +
                 "// example\n" +
                 "})\n" +

javaparser-core-testing/src/test/java/com/github/javaparser/JavaParserTest.java

@@ -47,7 +47,7 @@
 import static com.github.javaparser.Range.range;
 import static com.github.javaparser.StaticJavaParser.*;
 import static com.github.javaparser.utils.TestUtils.assertInstanceOf;
-import static com.github.javaparser.utils.Utils.EOL;
+import static com.github.javaparser.utils.Utils.SYSTEM_EOL;
 import static org.junit.jupiter.api.Assertions.*;
 
 class JavaParserTest {
@@ -163,9 +163,9 @@ void parseIntersectionType() {
 
     @Test
     void rangeOfIntersectionType() {
-        String code = "class A {" + EOL
-                + "  Object f() {" + EOL
-                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + EOL
+        String code = "class A {" + SYSTEM_EOL
+                + "  Object f() {" + SYSTEM_EOL
+                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + SYSTEM_EOL
                 + "}}";
         CompilationUnit cu = parse(code);
         MethodDeclaration methodDeclaration = cu.getClassByName("A").get().getMember(0).asMethodDeclaration();
@@ -177,9 +177,9 @@ void rangeOfIntersectionType() {
 
     @Test
     void rangeOfCast() {
-        String code = "class A {" + EOL
-                + "  Object f() {" + EOL
-                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + EOL
+        String code = "class A {" + SYSTEM_EOL
+                + "  Object f() {" + SYSTEM_EOL
+                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + SYSTEM_EOL
                 + "}}";
         CompilationUnit cu = parse(code);
         MethodDeclaration methodDeclaration = cu.getClassByName("A").get().getMember(0).asMethodDeclaration();
@@ -190,9 +190,9 @@ void rangeOfCast() {
 
     @Test
     void rangeOfCastNonIntersection() {
-        String code = "class A {" + EOL
-                + "  Object f() {" + EOL
-                + "    return (Comparator<Map.Entry<K, V>>               )(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + EOL
+        String code = "class A {" + SYSTEM_EOL
+                + "  Object f() {" + SYSTEM_EOL
+                + "    return (Comparator<Map.Entry<K, V>>               )(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + SYSTEM_EOL
                 + "}}";
         CompilationUnit cu = parse(code);
         MethodDeclaration methodDeclaration = cu.getClassByName("A").get().getMember(0).asMethodDeclaration();
@@ -203,9 +203,9 @@ void rangeOfCastNonIntersection() {
 
     @Test
     void rangeOfLambda() {
-        String code = "class A {" + EOL
-                + "  Object f() {" + EOL
-                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + EOL
+        String code = "class A {" + SYSTEM_EOL
+                + "  Object f() {" + SYSTEM_EOL
+                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + SYSTEM_EOL
                 + "}}";
         CompilationUnit cu = parse(code);
         MethodDeclaration methodDeclaration = cu.getClassByName("A").get().getMember(0).asMethodDeclaration();
@@ -219,9 +219,9 @@ void rangeOfLambda() {
 
     @Test
     void rangeOfLambdaBody() {
-        String code = "class A {" + EOL
-                + "  Object f() {" + EOL
-                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + EOL
+        String code = "class A {" + SYSTEM_EOL
+                + "  Object f() {" + SYSTEM_EOL
+                + "    return (Comparator<Map.Entry<K, V>> & Serializable)(c1, c2) -> c1.getKey().compareTo(c2.getKey()); " + SYSTEM_EOL
                 + "}}";
         CompilationUnit cu = parse(code);
         MethodDeclaration methodDeclaration = cu.getClassByName("A").get().getMember(0).asMethodDeclaration();