[ggj]fix: fix block comment to construct file header (#168)

xiaozhenliu-gg5 · web-flow · commit e415213a5da4 · 2020-08-14T17:11:36.000-07:00
* fix bazel rules

* multiple line comment

* add edge unit test

* use helper
diff --git a/src/main/java/com/google/api/generator/engine/ast/BlockComment.java b/src/main/java/com/google/api/generator/engine/ast/BlockComment.java
@@ -14,7 +14,6 @@
 
 package com.google.api.generator.engine.ast;
 
-import com.google.api.generator.engine.escaper.MetacharEscaper;
 import com.google.auto.value.AutoValue;
 
 @AutoValue
@@ -38,14 +37,6 @@ public static BlockComment withComment(String comment) {
   public abstract static class Builder {
     public abstract Builder setComment(String comment);
 
-    // Private accessor.
-    abstract String comment();
-
-    public abstract BlockComment autoBuild();
-
-    public BlockComment build() {
-      setComment(MetacharEscaper.escaper(comment()));
-      return autoBuild();
-    }
+    public abstract BlockComment build();
   }
 }
diff --git a/src/main/java/com/google/api/generator/engine/writer/JavaWriterVisitor.java b/src/main/java/com/google/api/generator/engine/writer/JavaWriterVisitor.java
@@ -64,14 +64,15 @@ public class JavaWriterVisitor implements AstNodeVisitor {
 
   private static final String COLON = ":";
   private static final String COMMA = ",";
-  private static final String BLOCK_COMMENT_START = "/**";
+  private static final String BLOCK_COMMENT_START = "/*";
   private static final String BLOCK_COMMENT_END = "*/";
   private static final String DOT = ".";
   private static final String ESCAPED_QUOTE = "\"";
   private static final String EQUALS = "=";
   private static final String LEFT_ANGLE = "<";
   private static final String LEFT_BRACE = "{";
   private static final String LEFT_PAREN = "(";
+  private static final String JAVADOC_COMMENT_START = "/**";
   private static final String QUESTION_MARK = "?";
   private static final String RIGHT_ANGLE = ">";
   private static final String RIGHT_BRACE = "}";
@@ -518,17 +519,21 @@ public void visit(LineComment lineComment) {
   }
 
   public void visit(BlockComment blockComment) {
-    // Split comments by new line and embrace the comment block with `/** */`.
-    String sourceComment = blockComment.comment();
-    String formattedSource =
-        JavaFormatter.format(
-            String.format("%s %s %s", BLOCK_COMMENT_START, sourceComment, BLOCK_COMMENT_END));
-    buffer.append(formattedSource);
+    // Split comments by new line and embrace the comment block with `/* */`.
+    StringBuilder sourceComment = new StringBuilder();
+    sourceComment.append(BLOCK_COMMENT_START).append(NEWLINE);
+    Arrays.stream(blockComment.comment().split("\\r?\\n"))
+        .forEach(
+            comment -> {
+              sourceComment.append(String.format("%s %s%s", ASTERISK, comment, NEWLINE));
+            });
+    sourceComment.append(BLOCK_COMMENT_END);
+    buffer.append(JavaFormatter.format(sourceComment.toString()));
   }
 
   public void visit(JavaDocComment javaDocComment) {
     StringBuilder sourceComment = new StringBuilder();
-    sourceComment.append(BLOCK_COMMENT_START).append(NEWLINE);
+    sourceComment.append(JAVADOC_COMMENT_START).append(NEWLINE);
     Arrays.stream(javaDocComment.comment().split("\\r?\\n"))
         .forEach(
             comment -> {
diff --git a/src/test/java/com/google/api/generator/engine/writer/ImportWriterVisitorTest.java b/src/test/java/com/google/api/generator/engine/writer/ImportWriterVisitorTest.java
@@ -94,7 +94,6 @@ public void writeNewObjectExprImports_withArgs() {
             .setArguments(Arrays.asList(fileExpr))
             .build();
     newObjectExpr.accept(writerVisitor);
-    System.out.println(writerVisitor.write());
     assertEquals(
         writerVisitor.write(),
         String.format(
diff --git a/src/test/java/com/google/api/generator/engine/writer/JavaWriterVisitorTest.java b/src/test/java/com/google/api/generator/engine/writer/JavaWriterVisitorTest.java
@@ -343,7 +343,7 @@ public void writeBlockCommentStatement_basic() {
     String content = "this is a test comment";
     BlockComment blockComment = BlockComment.builder().setComment(content).build();
     CommentStatement commentStatement = CommentStatement.withComment(blockComment);
-    String expected = "/** this is a test comment */\n";
+    String expected = String.format(createLines(3), "/*\n", "* this is a test comment\n", "*/\n");
     commentStatement.accept(writerVisitor);
     assertEquals(writerVisitor.write(), expected);
   }
@@ -421,11 +421,30 @@ public void writeJavaDocCommentStatement_allComponents() {
   }
 
   @Test
-  public void writeBlockComment_specialChar() {
-    String content = "Testing special characters: \b\t\n\r\"`'?/\\,.[]{}|-_!@#$%^()";
+  public void writeBlockComment_shortLines() {
+    String content = "Apache License \nThis is a test file header";
     BlockComment blockComment = BlockComment.builder().setComment(content).build();
     String expected =
-        "/** Testing special characters: \\b\\t\\n\\r\"`'?/\\\\,.[]{}|-_!@#$%^() */\n";
+        String.format(
+            createLines(4), "/*\n", "* Apache License\n", "* This is a test file header\n", "*/\n");
+    blockComment.accept(writerVisitor);
+    assertEquals(writerVisitor.write(), expected);
+  }
+
+  @Test
+  public void writeBlockComment_newLineInBetween() {
+    String content =
+        "Apache License \nLicensed under the Apache License, Version 2.0 (the \"License\");\n\nyou may not use this file except in compliance with the License.";
+    BlockComment blockComment = BlockComment.builder().setComment(content).build();
+    String expected =
+        String.format(
+            createLines(6),
+            "/*\n",
+            "* Apache License\n",
+            "* Licensed under the Apache License, Version 2.0 (the \"License\");\n",
+            "*\n",
+            "* you may not use this file except in compliance with the License.\n",
+            "*/\n");
     blockComment.accept(writerVisitor);
     assertEquals(writerVisitor.write(), expected);
   }
