Multiline flattening now handled at correct layer; Fixes #23

Author: RPG-Alex

src/comments.rs

@@ -389,12 +389,17 @@ impl Comments {
 
     /// Collapse this collection of comments and separate each comment with `\n` as a single [`Comment`].
     #[must_use]
-    pub fn collapse_comments(self) -> Option<Comment> {
+    pub fn collapse_comments(self, flatten: MultiFlatten) -> Option<Comment> {
         let mut iter = self.comments.into_iter();
         let first = iter.next()?;
 
         let Some(second) = iter.next() else {
-            return Some(first);
+            let text = first.text();
+            return Some(Comment::new(
+                flatten_lines(text, flatten),
+                first.kind().to_owned(),
+                first.span().to_owned(),
+            ));
         };
 
         let start = *first.span().start();
@@ -411,8 +416,28 @@ impl Comments {
             end = *c.span().end();
         }
 
-        Some(Comment::new(text, CommentKind::MultiLine, Span::new(start, end)))
+        Some(Comment::new(
+            flatten_lines(&text, flatten),
+            CommentKind::MultiLine,
+            Span::new(start, end),
+        ))
+    }
+}
+
+fn flatten_lines(lines: &str, flatten: MultiFlatten) -> String {
+    let mut out = String::new();
+    let sep = match flatten {
+        MultiFlatten::FlattenWithNone => String::new(),
+        MultiFlatten::NoFlat => return lines.to_owned(),
+        MultiFlatten::Flatten(chars) => chars.to_owned(),
+    };
+    for (i, line) in lines.lines().enumerate() {
+        if i > 0 {
+            out.push_str(&sep);
+        }
+        out.push_str(line);
     }
+    out
 }
 
 /// Controls how leading comments are captured for a statement.
@@ -427,6 +452,18 @@ pub enum LeadingCommentCapture {
     AllSingleOneMulti,
 }
 
+/// Enum for multiline comment flattening.
+#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
+pub enum MultiFlatten<'a> {
+    /// Default option, retains multiline structure with `\n`
+    #[default]
+    NoFlat,
+    /// Sets multiline comments to be flattened and combined without adding formatting
+    FlattenWithNone,
+    /// Will flatten comments and amend the content of [`String`] to the end of the former leading lines
+    Flatten(&'a str),
+}
+
 #[cfg(test)]
 mod tests {
     use std::{env, fs};
@@ -937,7 +974,7 @@ CREATE TABLE t (id INTEGER);
     #[test]
     fn collapse_comments_empty_returns_none() {
         let comments = Comments::new(vec![]);
-        assert!(comments.collapse_comments().is_none());
+        assert!(comments.collapse_comments(crate::comments::MultiFlatten::NoFlat).is_none());
     }
 
     #[test]
@@ -949,8 +986,9 @@ CREATE TABLE t (id INTEGER);
         );
         let comments = Comments::new(vec![c]);
 
-        let collapsed =
-            comments.collapse_comments().unwrap_or_else(|| panic!("should return a comment"));
+        let collapsed = comments
+            .collapse_comments(crate::comments::MultiFlatten::NoFlat)
+            .unwrap_or_else(|| panic!("should return a comment"));
         assert_eq!(collapsed.text(), "solo");
         assert_eq!(collapsed.kind(), &CommentKind::SingleLine);
         assert_eq!(collapsed.span(), &Span::new(Location::new(10, 3), Location::new(10, 11)));
@@ -976,7 +1014,9 @@ CREATE TABLE t (id INTEGER);
 
         let comments = Comments::new(vec![c1, c2, c3]);
 
-        let collapsed = comments.collapse_comments().unwrap_or_else(|| panic!("should collapse"));
+        let collapsed = comments
+            .collapse_comments(crate::comments::MultiFlatten::NoFlat)
+            .unwrap_or_else(|| panic!("should collapse"));
         assert_eq!(collapsed.text(), "a\nb\nc");
         assert_eq!(collapsed.kind(), &CommentKind::MultiLine);
         assert_eq!(collapsed.span(), &Span::new(Location::new(1, 1), Location::new(4, 3)));
@@ -995,7 +1035,9 @@ CREATE TABLE t (id INTEGER);
         let leading = parsed.leading_comments(3, LeadingCommentCapture::AllLeading);
         assert_eq!(texts(&leading), vec!["c1".to_owned(), "c2".to_owned()]);
 
-        let collapsed = leading.collapse_comments().unwrap_or_else(|| panic!("should collapse"));
+        let collapsed = leading
+            .collapse_comments(crate::comments::MultiFlatten::NoFlat)
+            .unwrap_or_else(|| panic!("should collapse"));
         assert_eq!(collapsed.text(), "c1\nc2");
         assert_eq!(collapsed.kind(), &CommentKind::MultiLine);
 
@@ -1018,10 +1060,23 @@ CREATE TABLE t (id INTEGER);
         let leading = parsed.leading_comments(3, LeadingCommentCapture::SingleNearest);
         assert_eq!(texts(&leading), vec!["c2".to_owned()]);
 
-        let collapsed = leading.collapse_comments().unwrap_or_else(|| panic!("should collapse"));
+        let collapsed = leading
+            .collapse_comments(crate::comments::MultiFlatten::NoFlat)
+            .unwrap_or_else(|| panic!("should collapse"));
         assert_eq!(collapsed.text(), "c2");
         assert_eq!(collapsed.kind(), &CommentKind::SingleLine);
 
         Ok(())
     }
+    use crate::comments::flatten_lines;
+    #[test]
+    fn test_flatten_lines_behavior() {
+        let input = "a\nb\nc";
+        let no_sep = flatten_lines(input, crate::comments::MultiFlatten::FlattenWithNone);
+        assert_eq!(no_sep, "abc");
+        let dash_sep = flatten_lines(input, crate::comments::MultiFlatten::Flatten(" - "));
+        assert_eq!(dash_sep, "a - b - c");
+        let single = flatten_lines("solo", crate::comments::MultiFlatten::Flatten("XXX"));
+        assert_eq!(single, "solo");
+    }
 }

src/docs.rs

@@ -7,7 +7,7 @@ use sqlparser::ast::{Ident, ObjectName, ObjectNamePart, Spanned, Statement};
 
 use crate::{
     ast::ParsedSqlFile,
-    comments::{Comments, LeadingCommentCapture},
+    comments::{Comments, LeadingCommentCapture, MultiFlatten},
     error::DocError,
 };
 
@@ -222,6 +222,7 @@ impl SqlFileDoc {
         file: &ParsedSqlFile,
         comments: &Comments,
         capture: LeadingCommentCapture,
+        flatten: MultiFlatten,
     ) -> Result<Self, DocError> {
         let mut tables = Vec::new();
         for statement in file.statements() {
@@ -232,8 +233,9 @@ impl SqlFileDoc {
                     let mut column_docs = Vec::new();
                     for column in &table.columns {
                         let column_start = column.span().start.line;
-                        let column_leading =
-                            comments.leading_comments(column_start, capture).collapse_comments();
+                        let column_leading = comments
+                            .leading_comments(column_start, capture)
+                            .collapse_comments(flatten);
                         let column_name = column.name.value.clone();
                         let column_doc = match column_leading {
                             Some(col_comment) => {
@@ -243,7 +245,8 @@ impl SqlFileDoc {
                         };
                         column_docs.push(column_doc);
                     }
-                    let table_leading = comments.leading_comment(table_start);
+                    let table_leading =
+                        comments.leading_comments(table_start, capture).collapse_comments(flatten);
                     let (schema, name) = schema_and_table(&table.name)?;
                     let table_doc = TableDoc::new(
                         schema,
@@ -504,7 +507,12 @@ CREATE TABLE posts (
 
         for file in parsed_set.files() {
             let comments = Comments::parse_all_comments_from_file(file)?;
-            let docs = SqlFileDoc::from_parsed_file(file, &comments, capture);
+            let docs = SqlFileDoc::from_parsed_file(
+                file,
+                &comments,
+                capture,
+                crate::comments::MultiFlatten::NoFlat,
+            );
             let filename = file
                 .file()
                 .path()