Merge pull request #2916 from jlerbsc/master

Fix issue 2578 Orphaned Comments exist but not printed on unrelated change to AST
javaparser · Nov 13, 2020 · 89ec332 · 89ec332
2 parents 2e55995 + 00fcc40
commit 89ec332
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 11 deletions.
diff --git a/javaparser-core-testing/src/test/java/com/github/javaparser/printer/PrettyPrinterTest.java b/javaparser-core-testing/src/test/java/com/github/javaparser/printer/PrettyPrinterTest.java
@@ -21,26 +21,31 @@
 
 package com.github.javaparser.printer;
 
+import static com.github.javaparser.ParseStart.COMPILATION_UNIT;
+import static com.github.javaparser.ParserConfiguration.LanguageLevel.JAVA_9;
+import static com.github.javaparser.Providers.provider;
+import static com.github.javaparser.StaticJavaParser.parse;
+import static com.github.javaparser.StaticJavaParser.parseBodyDeclaration;
+import static com.github.javaparser.StaticJavaParser.parseStatement;
+import static com.github.javaparser.printer.PrettyPrinterConfiguration.IndentType.TABS;
+import static com.github.javaparser.printer.PrettyPrinterConfiguration.IndentType.TABS_WITH_SPACE_ALIGN;
+import static com.github.javaparser.utils.TestUtils.assertEqualsStringIgnoringEol;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.jupiter.api.Test;
+
 import com.github.javaparser.JavaParser;
 import com.github.javaparser.ParseProblemException;
 import com.github.javaparser.ParseResult;
 import com.github.javaparser.ParserConfiguration;
+import com.github.javaparser.StaticJavaParser;
 import com.github.javaparser.ast.CompilationUnit;
 import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
 import com.github.javaparser.ast.body.FieldDeclaration;
+import com.github.javaparser.ast.body.TypeDeclaration;
 import com.github.javaparser.ast.expr.VariableDeclarationExpr;
 import com.github.javaparser.ast.stmt.Statement;
 import com.github.javaparser.ast.type.PrimitiveType;
-import org.junit.jupiter.api.Test;
-
-import static com.github.javaparser.ParseStart.COMPILATION_UNIT;
-import static com.github.javaparser.ParserConfiguration.LanguageLevel.JAVA_9;
-import static com.github.javaparser.Providers.provider;
-import static com.github.javaparser.StaticJavaParser.*;
-import static com.github.javaparser.printer.PrettyPrinterConfiguration.IndentType.TABS;
-import static com.github.javaparser.printer.PrettyPrinterConfiguration.IndentType.TABS_WITH_SPACE_ALIGN;
-import static com.github.javaparser.utils.TestUtils.assertEqualsStringIgnoringEol;
-import static org.junit.jupiter.api.Assertions.assertEquals;
 
 class PrettyPrinterTest {
 
@@ -471,4 +476,19 @@ void printAnnotationsAtPrettyPlaces() {
                 "module foo.bar {\n" +
                 "}\n", printed);
     }
+
+    @Test
+    public void testIssue2578() {
+        String code = 
+                "class C{\n" +
+                "  //orphan\n" +
+                "  /*orphan*/\n" +
+                "}";
+        CompilationUnit cu = StaticJavaParser.parse(code);
+        TypeDeclaration td = cu.findFirst(TypeDeclaration.class).get();
+        assertEquals(2, td.getAllContainedComments().size());
+        td.setPublic(true); // --- simple AST change -----
+        System.out.println(cu.toString()); // orphan and /*orphan*/ must be printed
+        assertEquals(2, td.getAllContainedComments().size()); // the orphaned comments exist
+    }
 }
diff --git a/javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrintVisitor.java b/javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrintVisitor.java
@@ -35,6 +35,7 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.stream.Collectors;
 
 import com.github.javaparser.ast.ArrayCreationLevel;
 import com.github.javaparser.ast.CompilationUnit;
@@ -1904,7 +1905,8 @@ private void printOrphanCommentsBeforeThisChildNode(final Node node) {
     private void printOrphanCommentsEnding(final Node node) {
         if (configuration.isIgnoreComments()) return;
 
-        List<Node> everything = new ArrayList<>(node.getChildNodes());
+        // extract all nodes for which the position/range is indicated to avoid to skip orphan comments
+        List<Node> everything = node.getChildNodes().stream().filter(n->n.getRange().isPresent()).collect(Collectors.toList());
         sortByBeginPosition(everything);
         if (everything.isEmpty()) {
             return;