Introducing new endWithNewline parameter + test. (#403)

Also changing test behaviour for keepBlankLines, since it is true by default. Co-authored-by: Björn Ekryd <bjornatekryd.se>
Ekryd · Feb 19, 2024 · e80c8b9 · e80c8b9
1 parent 383bea6
commit e80c8b9
Show file tree

Hide file tree

Showing 29 changed files with 358 additions and 100 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -27,7 +27,7 @@ jobs:
     <<: *shared
   jdk21:
     docker:
-      - image: cimg/openjdk:21.0
+      - image: cimg/openjdk:21.0.2
     <<: *shared
   jdk17:
     docker:

diff --git a/maven-plugin/src/it/default-configuration/postbuild.groovy b/maven-plugin/src/it/default-configuration/postbuild.groovy
@@ -16,6 +16,7 @@ assert log.text.contains('lineSeparator = ')
 assert log.text.contains('expandEmptyElements = true')
 assert log.text.contains('spaceBeforeCloseEmptyElement = false')
 assert log.text.contains('keepBlankLines = true')
+assert log.text.contains('endWithNewline = true')
 assert log.text.contains('nrOfIndentSpace = 2')
 assert log.text.contains('ignoreLineSeparators = true')
 assert log.text.contains('indentBlankLines = false')

diff --git a/maven-plugin/src/it/mojo-description/expected_description.txt b/maven-plugin/src/it/mojo-description/expected_description.txt
@@ -52,6 +52,10 @@ sortpom:sort
       User property: sort.encoding
       Encoding for the files.
 
+    endWithNewline (Default: true)
+      User property: sort.endWithNewline
+      Whether to ensure that sorted pom ends with a newline.
+
     expandEmptyElements (Default: true)
       User property: sort.expandEmptyElements
       Should an empty xml element be expanded with start and end tag, or be
@@ -178,6 +182,10 @@ sortpom:verify
       User property: sort.encoding
       Encoding for the files.
 
+    endWithNewline (Default: true)
+      User property: sort.endWithNewline
+      Whether to ensure that sorted pom ends with a newline.
+
     expandEmptyElements (Default: true)
       User property: sort.expandEmptyElements
       Should an empty xml element be expanded with start and end tag, or be

diff --git a/maven-plugin/src/it/predefined-sort-order/expected/pom.xml b/maven-plugin/src/it/predefined-sort-order/expected/pom.xml
@@ -24,6 +24,7 @@
             <configuration>
               <predefinedSortOrder>default_1_0_0</predefinedSortOrder>
               <keepBlankLines>false</keepBlankLines>
+              <endWithNewline>false</endWithNewline>
               <spaceBeforeCloseEmptyElement>true</spaceBeforeCloseEmptyElement>
               <expandEmptyElements>false</expandEmptyElements>
             </configuration>
@@ -39,4 +40,4 @@
       </plugin>
     </plugins>
   </build>
-</project>
+</project>
diff --git a/maven-plugin/src/it/predefined-sort-order/pom.xml b/maven-plugin/src/it/predefined-sort-order/pom.xml
@@ -10,7 +10,7 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <simple-prop/>
   </properties>
-  
+
   <build>
     <plugins>
       <plugin>
@@ -32,8 +32,9 @@
             <configuration>
               <predefinedSortOrder>default_1_0_0</predefinedSortOrder>
               <keepBlankLines>false</keepBlankLines>
+                 <endWithNewline>false</endWithNewline>
               <spaceBeforeCloseEmptyElement>true</spaceBeforeCloseEmptyElement>
-              
+
               <expandEmptyElements>false</expandEmptyElements>
             </configuration>
           </execution>

diff --git a/maven-plugin/src/main/java/sortpom/AbstractParentMojo.java b/maven-plugin/src/main/java/sortpom/AbstractParentMojo.java
@@ -48,6 +48,10 @@ abstract class AbstractParentMojo extends AbstractMojo {
   @Parameter(property = "sort.keepBlankLines", defaultValue = "true")
   boolean keepBlankLines;
 
+  /** Whether to ensure that sorted pom ends with a newline. */
+  @Parameter(property = "sort.endWithNewline", defaultValue = "true")
+  boolean endWithNewline;
+
   /**
    * Number of space characters to use as indentation. A value of -1 indicates that tab character
    * should be used instead.

diff --git a/maven-plugin/src/main/java/sortpom/SortMojo.java b/maven-plugin/src/main/java/sortpom/SortMojo.java
@@ -28,7 +28,8 @@ public void setup(SortPomLogger mavenLogger) throws MojoFailureException {
                           lineSeparator,
                           expandEmptyElements,
                           spaceBeforeCloseEmptyElement,
-                          keepBlankLines)
+                          keepBlankLines,
+                          endWithNewline)
                       .setIndent(nrOfIndentSpace, indentBlankLines, indentSchemaLocation)
                       .setSortOrder(sortOrderFile, predefinedSortOrder)
                       .setSortEntities(

diff --git a/maven-plugin/src/main/java/sortpom/VerifyMojo.java b/maven-plugin/src/main/java/sortpom/VerifyMojo.java
@@ -48,7 +48,8 @@ public void setup(SortPomLogger mavenLogger) throws MojoFailureException {
                           lineSeparator,
                           expandEmptyElements,
                           spaceBeforeCloseEmptyElement,
-                          keepBlankLines)
+                          keepBlankLines,
+                          endWithNewline)
                       .setIndent(nrOfIndentSpace, indentBlankLines, indentSchemaLocation)
                       .setSortOrder(sortOrderFile, predefinedSortOrder)
                       .setSortEntities(

diff --git a/maven-plugin/src/test/java/sortpom/sort/SortMojoParametersTest.java b/maven-plugin/src/test/java/sortpom/sort/SortMojoParametersTest.java
@@ -184,10 +184,15 @@ void parameterSortPropertiesShouldEndUpInWrapperFactoryImpl() {
   }
 
   @Test
-  void parameterKeepBlankLineShouldEndUpInXmlProcessor() {
+  void parameterKeepBlankLineShouldEndUpInTextWrapperCreator() {
     assertParameterMoveFromMojoToRestOfApplicationForBoolean("keepBlankLines", textWrapperCreator);
   }
 
+  @Test
+  void parameterEndWithNewlineShouldEndUpInXmlProcessor() {
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean("endWithNewline", xmlOutputGenerator);
+  }
+
   @Test
   void parameterIndentBlankLineShouldEndUpInXmlProcessor() {
     assertParameterMoveFromMojoToRestOfApplicationForBoolean(

diff --git a/maven-plugin/src/test/java/sortpom/verify/VerifyMojoParametersTest.java b/maven-plugin/src/test/java/sortpom/verify/VerifyMojoParametersTest.java
@@ -59,12 +59,12 @@ void pomFileParameter() {
 
   @Test
   void createBackupFileParameter() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean("createBackupFile", sortPomService);
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean("createBackupFile", sortPomService);
   }
 
   @Test
   void keepTimestampParameter() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean("keepTimestamp", fileUtil);
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean("keepTimestamp", fileUtil);
   }
 
   @Test
@@ -106,13 +106,13 @@ void parameterNrOfIndentSpaceShouldEndUpInXmlProcessor() {
 
   @Test
   void expandEmptyElementsParameter() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean(
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean(
         "expandEmptyElements", xmlOutputGenerator);
   }
 
   @Test
   void spaceBeforeCloseEmptyElementParameter() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean(
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean(
         "spaceBeforeCloseEmptyElement", xmlOutputGenerator);
   }
 
@@ -160,32 +160,40 @@ void parameterSortPluginsShouldEndUpInWrapperFactoryImpl() {
 
   @Test
   void parameterSortModulesShouldEndUpInWrapperFactoryImpl() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean("sortModules", elementWrapperCreator);
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean("sortModules", elementWrapperCreator);
   }
 
   @Test
   void parameterSortExecutionsShouldEndUpInWrapperFactoryImpl() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean("sortExecutions", elementWrapperCreator);
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean(
+        "sortExecutions", elementWrapperCreator);
   }
 
   @Test
   void parameterSortPropertiesShouldEndUpInWrapperFactoryImpl() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean("sortProperties", elementWrapperCreator);
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean(
+        "sortProperties", elementWrapperCreator);
   }
 
   @Test
-  void parameterKeepBlankLineShouldEndUpInXmlProcessor() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean("keepBlankLines", textWrapperCreator);
+  void parameterKeepBlankLineShouldEndUpInTextWrapperCreator() {
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean("keepBlankLines", textWrapperCreator);
+  }
+
+  @Test
+  void parameterEndWithNewlineShouldEndUpInXmlProcessor() {
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean("endWithNewline", xmlOutputGenerator);
   }
 
   @Test
   void parameterIndentBlankLineShouldEndUpInXmlProcessor() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean("indentBlankLines", xmlOutputGenerator);
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean(
+        "indentBlankLines", xmlOutputGenerator);
   }
 
   @Test
   void parameterIndentSchemaLocationShouldEndUpInXmlProcessor() {
-    testParameterMoveFromMojoToRestOfApplicationForBoolean(
+    assertParameterMoveFromMojoToRestOfApplicationForBoolean(
         "indentSchemaLocation", xmlOutputGenerator);
   }
 
@@ -216,7 +224,7 @@ private void assertParameterMoveFromMojoToRestOfApplication(
     }
   }
 
-  private void testParameterMoveFromMojoToRestOfApplicationForBoolean(
+  private void assertParameterMoveFromMojoToRestOfApplicationForBoolean(
       String parameterName, Object... whereParameterCanBeFound) {
     new ReflectionHelper(verifyMojo).setField(parameterName, true);
 

diff --git a/sorter/src/main/java/sortpom/output/PatchedXMLWriter.java b/sorter/src/main/java/sortpom/output/PatchedXMLWriter.java
@@ -5,6 +5,7 @@
 import java.io.IOException;
 import java.io.Writer;
 import org.dom4j.Attribute;
+import org.dom4j.Document;
 import org.dom4j.Node;
 import org.dom4j.ProcessingInstruction;
 import org.dom4j.io.OutputFormat;
@@ -19,18 +20,21 @@ class PatchedXMLWriter extends XMLWriter {
   private final boolean indentBlankLines;
   private final boolean indentSchemaLocation;
   private final boolean spaceBeforeCloseEmptyElement;
+  private final boolean endWithNewline;
 
   public PatchedXMLWriter(
       Writer writer,
       OutputFormat format,
       boolean spaceBeforeCloseEmptyElement,
       boolean indentBlankLines,
-      boolean indentSchemaLocation) {
+      boolean indentSchemaLocation,
+      boolean endWithNewline) {
     super(writer, format);
     this.format = format;
     this.indentBlankLines = indentBlankLines;
     this.indentSchemaLocation = indentSchemaLocation;
     this.spaceBeforeCloseEmptyElement = spaceBeforeCloseEmptyElement;
+    this.endWithNewline = endWithNewline;
   }
 
   /** Handle spaceBeforeCloseEmptyElement option */
@@ -58,6 +62,25 @@ protected void writeProcessingInstruction(ProcessingInstruction pi) throws IOExc
     lastOutputNodeType = Node.PROCESSING_INSTRUCTION_NODE;
   }
 
+  @Override
+  public void write(Document doc) throws IOException {
+    writeDeclaration();
+
+    if (doc.getDocType() != null) {
+      indent();
+      writeDocType(doc.getDocType());
+    }
+
+    for (int i = 0, size = doc.nodeCount(); i < size; i++) {
+      Node node = doc.node(i);
+      writeNode(node);
+    }
+
+    if (endWithNewline) {
+      writePrintln();
+    }
+  }
+
   /** Handle Custom NewLineTest node and potential indent of empty line */
   @Override
   protected void writeNodeText(Node node) throws IOException {

diff --git a/sorter/src/main/java/sortpom/output/XmlOutputGenerator.java b/sorter/src/main/java/sortpom/output/XmlOutputGenerator.java
@@ -19,6 +19,7 @@ public class XmlOutputGenerator {
   private boolean indentSchemaLocation;
   private boolean spaceBeforeCloseEmptyElement;
   private String lineSeparator;
+  private boolean endWithNewline;
 
   /** Setup default configuration */
   public void setup(PluginParameters pluginParameters) {
@@ -28,7 +29,8 @@ public void setup(PluginParameters pluginParameters) {
     this.indentBlankLines = pluginParameters.indentBlankLines;
     this.indentSchemaLocation = pluginParameters.indentSchemaLocation;
     this.spaceBeforeCloseEmptyElement = pluginParameters.spaceBeforeCloseEmptyElement;
-    lineSeparator = pluginParameters.lineSeparatorUtil.toString();
+    this.lineSeparator = pluginParameters.lineSeparatorUtil.toString();
+    this.endWithNewline = pluginParameters.endWithNewline;
   }
 
   /**
@@ -45,7 +47,8 @@ public String getSortedXml(Document newDocument) {
               createPrettyFormat(),
               spaceBeforeCloseEmptyElement,
               indentBlankLines,
-              indentSchemaLocation);
+              indentSchemaLocation,
+              endWithNewline);
       xmlWriter.write(newDocument);
       writer.writeDelayedNewline();
       return writer.toString();

diff --git a/sorter/src/main/java/sortpom/parameter/PluginParameters.java b/sorter/src/main/java/sortpom/parameter/PluginParameters.java
@@ -23,6 +23,7 @@ public class PluginParameters {
   public final boolean sortModules;
   public final boolean sortExecutions;
   public final boolean keepBlankLines;
+  public final boolean endWithNewline;
   public final boolean indentBlankLines;
   public final boolean indentSchemaLocation;
   public final VerifyFailType verifyFailType;
@@ -40,6 +41,7 @@ private PluginParameters(
       boolean expandEmptyElements,
       boolean spaceBeforeCloseEmptyElement,
       boolean keepBlankLines,
+      boolean endWithNewline,
       String indentCharacters,
       boolean indentBlankLines,
       boolean indentSchemaLocation,
@@ -75,6 +77,7 @@ private PluginParameters(
     this.sortModules = sortModules;
     this.sortExecutions = sortExecutions;
     this.keepBlankLines = keepBlankLines;
+    this.endWithNewline = endWithNewline;
     this.indentBlankLines = indentBlankLines;
     this.indentSchemaLocation = indentSchemaLocation;
     this.verifyFailType = verifyFailType;
@@ -111,6 +114,7 @@ public static class Builder {
     private boolean sortModules;
     private boolean sortExecutions;
     private boolean keepBlankLines;
+    private boolean endWithNewline;
     private VerifyFailType verifyFailType;
     private VerifyFailOnType verifyFailOn;
     private boolean ignoreLineSeparators;
@@ -148,11 +152,13 @@ public Builder setFormatting(
         final String lineSeparator,
         final boolean expandEmptyElements,
         final boolean spaceBeforeCloseEmptyElement,
-        final boolean keepBlankLines) {
+        final boolean keepBlankLines,
+        final boolean endWithNewline) {
       this.lineSeparatorUtil = new LineSeparatorUtil(lineSeparator);
       this.expandEmptyElements = expandEmptyElements;
       this.spaceBeforeCloseEmptyElement = spaceBeforeCloseEmptyElement;
       this.keepBlankLines = keepBlankLines;
+      this.endWithNewline = endWithNewline;
       return this;
     }
 
@@ -217,6 +223,7 @@ public PluginParameters build() {
           expandEmptyElements,
           spaceBeforeCloseEmptyElement,
           keepBlankLines,
+          endWithNewline,
           indentCharacters,
           indentBlankLines,
           indentSchemaLocation,

diff --git a/sorter/src/test/java/sortpom/output/XmlOutputGeneratorTest.java b/sorter/src/test/java/sortpom/output/XmlOutputGeneratorTest.java
@@ -37,7 +37,7 @@ void simulateIOExceptionToTriggerExceptionMessage() {
 
     XmlOutputGenerator xmlOutputGenerator = new XmlOutputGenerator();
     xmlOutputGenerator.setup(
-        PluginParameters.builder().setFormatting("\n", true, true, false).build());
+        PluginParameters.builder().setFormatting("\n", true, true, false, true).build());
 
     final Executable testMethod = () -> xmlOutputGenerator.getSortedXml(document);
 
@@ -64,7 +64,7 @@ void definedParentNamespaceShouldBeReused() {
 
     XmlOutputGenerator xmlOutputGenerator = new XmlOutputGenerator();
     xmlOutputGenerator.setup(
-        PluginParameters.builder().setFormatting("\n", true, true, false).build());
+        PluginParameters.builder().setFormatting("\n", true, true, false, true).build());
 
     String sortedXml = xmlOutputGenerator.getSortedXml(document);
     assertThat(
@@ -89,7 +89,7 @@ void redefinedParentNamespaceShouldBeWrittenAgain() {
 
     XmlOutputGenerator xmlOutputGenerator = new XmlOutputGenerator();
     xmlOutputGenerator.setup(
-        PluginParameters.builder().setFormatting("\n", true, true, false).build());
+        PluginParameters.builder().setFormatting("\n", true, true, false, true).build());
 
     String sortedXml = xmlOutputGenerator.getSortedXml(document);
     assertThat(
@@ -107,7 +107,7 @@ void attributeCalledXmlnsShouldNotBePrinted() {
 
     XmlOutputGenerator xmlOutputGenerator = new XmlOutputGenerator();
     xmlOutputGenerator.setup(
-        PluginParameters.builder().setFormatting("\n", true, true, false).build());
+        PluginParameters.builder().setFormatting("\n", true, true, false, true).build());
 
     String sortedXml = xmlOutputGenerator.getSortedXml(document);
     assertThat(

diff --git a/sorter/src/test/java/sortpom/parameter/EncodingParameterTest.java b/sorter/src/test/java/sortpom/parameter/EncodingParameterTest.java
@@ -37,7 +37,7 @@ void illegalEncodingWhenGeneratingPomFileShouldWork() {
     xmlOutputGenerator.setup(
         PluginParameters.builder()
             .setEncoding("gurka-2000")
-            .setFormatting("\n", true, true, false)
+            .setFormatting("\n", true, true, false, true)
             .setIndent(2, false, false)
             .build());