Merge pull request #15 from LaunchPlatform/fix-13-bug-handling-tailin…

…g-comments Fix #13 tailing comments causing error throwing issue. Get rid of standalone comments group
LaunchPlatform · Mar 10, 2023 · d8ea7fd · d8ea7fd
2 parents 13b485f + 0360c52
commit d8ea7fd
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 16 deletions.
diff --git a/beancount_black/formatter.py b/beancount_black/formatter.py
@@ -518,17 +518,6 @@ def format_statement_group(self, group: StatementGroup) -> str:
                 else:
                     raise ValueError(f"Unexpected token {first_child.type}")
             else:
-                if comments and comments[-1].line + 1 != statement.meta.line:
-                    # Standalone comment group
-                    entry = Entry(
-                        type=EntryType.COMMENTS,
-                        comments=comments,
-                        statement=statement,
-                        metadata=[],
-                        postings=[],
-                    )
-                    entries.append(entry)
-                    comments = []
                 if first_child.data == "posting":
                     last_entry = entries[-1]
                     if last_entry.type != EntryType.TXN:
@@ -558,18 +547,16 @@ def format_statement_group(self, group: StatementGroup) -> str:
                 entries.append(entry)
                 comments = []
 
+        tailing_comments_entry: typing.Optional[Entry] = None
         if comments:
-            entry = Entry(
+            tailing_comments_entry = Entry(
                 type=EntryType.COMMENTS,
                 comments=comments,
                 # TODO: maybe pass None makes more sense here?
                 statement=statement,
                 metadata=[],
                 postings=[],
             )
-            entries.append(entry)
-            comments = []
-            # TODO: or add to tail comments?
 
         # breaking down entries into groups by leading entry type, comments or
         # None (means doesn't belong to the leading groups or comments)
@@ -598,6 +585,10 @@ def format_statement_group(self, group: StatementGroup) -> str:
         for entry in remain_entries:
             sections.append(self.format_entry(entry))
 
+        # Dealing with the special case when there's tailing comments in the file
+        if tailing_comments_entry is not None:
+            sections.append(self.format_entry(tailing_comments_entry))
+
         return "\n\n".join(sections)
 
     def calculate_column_widths(self, tree: ParseTree):

diff --git a/tests/fixtures/expected_output/sections.bean b/tests/fixtures/expected_output/sections.bean
@@ -11,7 +11,6 @@
 ; standalone comment
 ; line 2
 ; line 3
-
 2022-05-01 note Assets:Cash "0"
 
 2022-05-02 note Assets:Cash "1"

diff --git a/tests/fixtures/expected_output/tailing_comment.bean b/tests/fixtures/expected_output/tailing_comment.bean
@@ -0,0 +1,9 @@
+2000-01-01 open Assets:Cash
+2000-01-01 open Expenses:Food
+
+;; comment OK
+2010-01-01 txn "P. Escobar" "White flour"
+  Assets:Cash                                         1,000.00 USD
+  Expenses:Food
+
+;; this comment blows up
diff --git a/tests/fixtures/expected_output/tailing_comments.bean b/tests/fixtures/expected_output/tailing_comments.bean
@@ -0,0 +1,12 @@
+2000-01-01 open Assets:Cash
+2000-01-01 open Expenses:Food
+
+;; comment OK
+2010-01-01 txn "P. Escobar" "White flour"
+  Assets:Cash                                         1,000.00 USD
+  Expenses:Food
+
+;; comment 1
+;; comment 2
+;; comment 3
+;; comment 4
diff --git a/tests/fixtures/input/tailing_comment.bean b/tests/fixtures/input/tailing_comment.bean
@@ -0,0 +1,10 @@
+2000-01-01 open Assets:Cash
+2000-01-01 open Expenses:Food
+
+;; comment OK
+
+2010-01-01 txn "P. Escobar" "White flour"
+  Assets:Cash 1000.00 USD
+  Expenses:Food
+
+;; this comment blows up
diff --git a/tests/fixtures/input/tailing_comments.bean b/tests/fixtures/input/tailing_comments.bean
@@ -0,0 +1,15 @@
+2000-01-01 open Assets:Cash
+2000-01-01 open Expenses:Food
+
+;; comment OK
+
+2010-01-01 txn "P. Escobar" "White flour"
+  Assets:Cash 1000.00 USD
+  Expenses:Food
+
+;; comment 1
+;; comment 2
+
+;; comment 3
+
+;; comment 4
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -39,6 +39,8 @@ def test_create_backup_with_conflicts(tmp_path: pathlib.Path):
         ("column_width.bean", "column_width.bean"),
         ("txn.bean", "txn.bean"),
         ("number_expr.bean", "number_expr.bean"),
+        ("tailing_comment.bean", "tailing_comment.bean"),
+        ("tailing_comments.bean", "tailing_comments.bean"),
     ],
 )
 @pytest.mark.parametrize("stdin_mode", [False, True])