fix: fixed unexpected hidden fields indicators in flatten mode (#380)

Cargo.toml

@@ -4,7 +4,7 @@ members = [".", "crate/encstr"]
 [workspace.package]
 repository = "https://github.com/pamburus/hl"
 authors = ["Pavel Ivanov <[email protected]>"]
-version = "0.29.7"
+version = "0.29.8"
 edition = "2021"
 license = "MIT"
 

src/formatting.rs

@@ -202,7 +202,7 @@ impl RecordFormatter {
                     some_fields_hidden |= !self.format_field(s, k, *v, &mut fs, Some(&self.fields));
                 }
             }
-            if some_fields_hidden {
+            if some_fields_hidden || (fs.some_nested_fields_hidden && fs.flatten) {
                 s.element(Element::Ellipsis, |s| {
                     s.batch(|buf| buf.extend_from_slice(self.cfg.punctuation.hidden_fields_indicator.as_bytes()))
                 });
@@ -288,6 +288,7 @@ struct FormattingState {
     key_prefix: KeyPrefix,
     flatten: bool,
     empty: bool,
+    some_nested_fields_hidden: bool,
 }
 
 impl FormattingState {
@@ -297,6 +298,7 @@ impl FormattingState {
             key_prefix: KeyPrefix::default(),
             flatten,
             empty: true,
+            some_nested_fields_hidden: false,
         }
     }
 
@@ -436,19 +438,20 @@ impl<'a> FieldFormatter<'a> {
                     for (k, v) in item.fields.iter() {
                         some_fields_hidden |= !self.format(s, k, *v, fs, filter, setting);
                     }
-                    if some_fields_hidden {
-                        s.element(Element::Ellipsis, |s| {
-                            s.batch(|buf| buf.extend(self.rf.cfg.punctuation.hidden_fields_indicator.as_bytes()))
-                        });
-                    }
                     if !fs.flatten {
+                        if some_fields_hidden {
+                            s.element(Element::Ellipsis, |s| {
+                                s.batch(|buf| buf.extend(self.rf.cfg.punctuation.hidden_fields_indicator.as_bytes()))
+                            });
+                        }
                         s.batch(|buf| {
                             if item.fields.len() != 0 {
                                 buf.push(b' ');
                             }
                             buf.push(b'}');
                         });
                     }
+                    fs.some_nested_fields_hidden |= some_fields_hidden;
                 });
             }
             RawValue::Array(value) => {
@@ -1382,4 +1385,40 @@ mod tests {
         let result = format_no_color(&rec);
         assert_eq!(&result, r#""#, "{}", result);
     }
+
+    #[test]
+    fn test_nested_hidden_fields_flatten() {
+        let val = json_raw_value(r#"{"b":{"c":{"d":1,"e":2},"f":3}}"#);
+        let rec = Record::from_fields(&[("a", RawObject::Json(&val).into())]);
+        let mut fields = IncludeExcludeKeyFilter::default();
+        let b = fields.entry("a").entry("b");
+        b.exclude();
+        b.entry("c").entry("d").include();
+        let formatter = RecordFormatter {
+            flatten: true,
+            theme: Default::default(),
+            fields: Arc::new(fields),
+            ..formatter()
+        };
+
+        assert_eq!(&formatter.format_to_string(&rec), "a.b.c.d=1 ...");
+    }
+
+    #[test]
+    fn test_nested_hidden_fields_no_flatten() {
+        let val = json_raw_value(r#"{"b":{"c":{"d":1,"e":2},"f":3}}"#);
+        let rec = Record::from_fields(&[("a", RawObject::Json(&val).into())]);
+        let mut fields = IncludeExcludeKeyFilter::default();
+        let b = fields.entry("a").entry("b");
+        b.exclude();
+        b.entry("c").entry("d").include();
+        let formatter = RecordFormatter {
+            flatten: false,
+            theme: Default::default(),
+            fields: Arc::new(fields),
+            ..formatter()
+        };
+
+        assert_eq!(&formatter.format_to_string(&rec), "a={ b={ c={ d=1 ... } ... } }");
+    }
 }