Merge pull request #1217 from hrdixon/master

Apply whitespace rules for LStrip and Trim to comment blocks, resolves #1218
HubSpot · Dec 3, 2024 · 703b11c · 703b11c
2 parents c392aac + d9a9d0b
commit 703b11c
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 14 deletions.
diff --git a/src/main/java/com/hubspot/jinjava/tree/TreeParser.java b/src/main/java/com/hubspot/jinjava/tree/TreeParser.java
@@ -170,14 +170,17 @@ private Node getLastSibling() {
 
   private Node text(TextToken textToken) {
     if (interpreter.getConfig().isLstripBlocks()) {
-      if (scanner.hasNext() && scanner.peek().getType() == symbols.getTag()) {
-        textToken =
-          new TextToken(
-            StringUtils.stripEnd(textToken.getImage(), "\t "),
-            textToken.getLineNumber(),
-            textToken.getStartPosition(),
-            symbols
-          );
+      if (scanner.hasNext()) {
+        final int nextTokenType = scanner.peek().getType();
+        if (nextTokenType == symbols.getTag() || nextTokenType == symbols.getNote()) {
+          textToken =
+            new TextToken(
+              StringUtils.stripEnd(textToken.getImage(), "\t "),
+              textToken.getLineNumber(),
+              textToken.getStartPosition(),
+              symbols
+            );
+        }
       }
     }
 

diff --git a/src/main/java/com/hubspot/jinjava/tree/parse/TokenScanner.java b/src/main/java/com/hubspot/jinjava/tree/parse/TokenScanner.java
@@ -253,13 +253,18 @@ private Token newToken(int kind) {
       lastStart - lastNewlinePos + 1
     );
 
-    if (t instanceof TagToken) {
-      if (config.isTrimBlocks() && currPost < length && is[currPost] == '\n') {
-        lastNewlinePos = currPost;
-        ++currPost;
-        ++tokenStart;
-      }
+    if (
+      (t instanceof TagToken || t instanceof NoteToken) &&
+      config.isTrimBlocks() &&
+      currPost < length &&
+      is[currPost] == '\n'
+    ) {
+      lastNewlinePos = currPost;
+      ++currPost;
+      ++tokenStart;
+    }
 
+    if (t instanceof TagToken) {
       TagToken tt = (TagToken) t;
       if ("raw".equals(tt.getTagName())) {
         inRaw = 1;

diff --git a/src/test/java/com/hubspot/jinjava/tree/TreeParserTest.java b/src/test/java/com/hubspot/jinjava/tree/TreeParserTest.java
@@ -147,6 +147,18 @@ public void trimAndLstripBlocks() {
       .isEqualTo("<div>\n" + "        yay\n" + "</div>\n");
   }
 
+  @Test
+  public void trimAndLstripCommentBlocks() {
+    interpreter =
+      new Jinjava(
+        JinjavaConfig.newBuilder().withLstripBlocks(true).withTrimBlocks(true).build()
+      )
+        .newInterpreter();
+
+    assertThat(interpreter.render(parse("parse/tokenizer/whitespace-comment-tags.jinja")))
+      .isEqualTo("<div>\n" + "        yay\n" + "        whoop\n" + "</div>\n");
+  }
+
   @Test
   public void itWarnsAgainstMissingStartTags() {
     String expression = "{% if true %} foo {% endif %} {% endif %}";

diff --git a/src/test/java/com/hubspot/jinjava/tree/parse/TokenWhitespaceTest.java b/src/test/java/com/hubspot/jinjava/tree/parse/TokenWhitespaceTest.java
@@ -21,6 +21,16 @@ public void trimBlocksTrimsAfterTag() {
     assertThat(tokens.get(2).getImage()).isEqualTo("        yay\n    ");
   }
 
+  @Test
+  public void trimBlocksTrimsAfterCommentTag() {
+    List<Token> tokens = scanTokens(
+      "parse/tokenizer/whitespace-comment-tags.jinja",
+      trimBlocksConfig()
+    );
+    assertThat(tokens.get(2).getImage()).isEqualTo("        yay\n    ");
+    assertThat(tokens.get(4).getImage()).isEqualTo("        whoop\n</div>\n");
+  }
+
   private List<Token> scanTokens(String srcPath, JinjavaConfig config) {
     try {
       return Lists.newArrayList(

diff --git a/src/test/resources/parse/tokenizer/whitespace-comment-tags.jinja b/src/test/resources/parse/tokenizer/whitespace-comment-tags.jinja
@@ -0,0 +1,8 @@
+<div>
+    {# a comment #}
+        yay
+    {# another comment
+       This time, over multiple lines
+     #}
+        whoop
+</div>