feat: add fitText support to run properties (#869)

Support OOXML fitText in both writer and reader so runs can preserve fixed-width text settings including optional grouping id.

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: bokuweb

docx-core/src/documents/elements/fit_text.rs

@@ -0,0 +1,56 @@
+use crate::documents::BuildXML;
+use crate::xml_builder::*;
+use serde::Serialize;
+use std::io::Write;
+
+#[derive(Debug, Clone, PartialEq, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct FitText {
+    pub val: usize,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub id: Option<u32>,
+}
+
+impl FitText {
+    pub fn new(val: usize) -> Self {
+        Self { val, id: None }
+    }
+
+    pub fn id(mut self, id: u32) -> Self {
+        self.id = Some(id);
+        self
+    }
+}
+
+impl BuildXML for FitText {
+    fn build_to<W: Write>(
+        &self,
+        stream: crate::xml::writer::EventWriter<W>,
+    ) -> crate::xml::writer::Result<crate::xml::writer::EventWriter<W>> {
+        XMLBuilder::from(stream).fit_text(self.val, self.id)?.into_inner()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+
+    use super::*;
+    #[cfg(test)]
+    use pretty_assertions::assert_eq;
+    use std::str;
+
+    #[test]
+    fn test_fit_text() {
+        let b = FitText::new(840).id(1266434317).build();
+        assert_eq!(
+            str::from_utf8(&b).unwrap(),
+            r#"<w:fitText w:val="840" w:id="1266434317" />"#
+        );
+    }
+
+    #[test]
+    fn test_fit_text_without_id() {
+        let b = FitText::new(840).build();
+        assert_eq!(str::from_utf8(&b).unwrap(), r#"<w:fitText w:val="840" />"#);
+    }
+}

docx-core/src/documents/elements/mod.rs

@@ -30,6 +30,7 @@ mod doc_var;
 mod drawing;
 mod dstrike;
 mod fld_char;
+mod fit_text;
 mod font;
 mod font_scheme;
 mod footer_reference;
@@ -170,6 +171,7 @@ pub use doc_var::*;
 pub use drawing::*;
 pub use dstrike::*;
 pub use fld_char::*;
+pub use fit_text::*;
 pub use font::*;
 pub use font_scheme::*;
 pub use footer_reference::*;

docx-core/src/documents/elements/run_property.rs

@@ -40,6 +40,8 @@ pub struct RunProperty {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub character_spacing: Option<CharacterSpacing>,
     #[serde(skip_serializing_if = "Option::is_none")]
+    pub fit_text: Option<FitText>,
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub stretch: Option<Stretch>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub fonts: Option<RunFonts>,
@@ -176,6 +178,15 @@ impl RunProperty {
         self
     }
 
+    pub fn fit_text(mut self, val: usize, id: Option<u32>) -> RunProperty {
+        let mut fit_text = FitText::new(val);
+        if let Some(id) = id {
+            fit_text = fit_text.id(id);
+        }
+        self.fit_text = Some(fit_text);
+        self
+    }
+
     pub fn text_border(mut self, b: TextBorder) -> Self {
         self.text_border = Some(b);
         self
@@ -229,6 +240,7 @@ impl BuildXML for RunProperty {
             .add_optional_child(&self.del)?
             .add_optional_child(&self.vert_align)?
             .add_optional_child(&self.character_spacing)?
+            .add_optional_child(&self.fit_text)?
             .add_optional_child(&self.stretch)?
             .add_optional_child(&self.style)?
             .add_optional_child(&self.positional_tab)?
@@ -336,6 +348,16 @@ mod tests {
         );
     }
 
+    #[test]
+    fn test_fit_text() {
+        let c = RunProperty::new().fit_text(840, Some(1266434317));
+        let b = c.build();
+        assert_eq!(
+            str::from_utf8(&b).unwrap(),
+            r#"<w:rPr><w:fitText w:val="840" w:id="1266434317" /></w:rPr>"#
+        );
+    }
+
     #[test]
     fn test_ptab() {
         let c = RunProperty::new().ptab(PositionalTab::new(

docx-core/src/reader/run.rs

@@ -311,4 +311,25 @@ mod tests {
             }
         );
     }
+
+    #[test]
+    fn test_read_fit_text() {
+        let c = r#"<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:r><w:rPr>
+    <w:fitText w:val="840" w:id="1266434317"/>
+  </w:rPr></w:r>
+</w:document>"#;
+        let mut parser = EventReader::new(c.as_bytes());
+        let run = Run::read(&mut parser, &[]).unwrap();
+        assert_eq!(
+            run,
+            Run {
+                children: vec![],
+                run_property: RunProperty {
+                    fit_text: Some(FitText::new(840).id(1266434317)),
+                    ..RunProperty::default()
+                },
+            }
+        );
+    }
 }

docx-core/src/reader/run_property.rs

@@ -115,6 +115,15 @@ impl ElementReader for RunProperty {
                                 }
                             }
                         }
+                        XMLElement::FitText => {
+                            if let Some(v) = read_val(&attributes) {
+                                if let Ok(val) = usize::from_str(&v) {
+                                    let id = read(&attributes, "id")
+                                        .and_then(|id| u32::from_str(&id).ok());
+                                    rp = rp.fit_text(val, id);
+                                }
+                            }
+                        }
                         XMLElement::RunFonts => {
                             if let Ok(f) = read_run_fonts(&attributes) {
                                 rp = rp.fonts(f);

docx-core/src/reader/xml_element.rs

@@ -18,6 +18,7 @@ pub enum XMLElement {
     Size,
     SizeCs,
     Spacing,
+    FitText,
     Vanish,
     SpecVanish,
     TextBorder,
@@ -356,6 +357,7 @@ impl FromStr for XMLElement {
             "next" => Ok(XMLElement::Next),
             "vertAlign" => Ok(XMLElement::VertAlign),
             "spacing" => Ok(XMLElement::Spacing),
+            "fitText" => Ok(XMLElement::FitText),
             "styles" => Ok(XMLElement::Styles),
             "Relationships" => Ok(XMLElement::Relationships),
             "Relationship" => Ok(XMLElement::Relationship),

docx-core/src/xml_builder/elements.rs

@@ -284,6 +284,17 @@ impl<W: Write> XMLBuilder<W> {
             .close()
     }
 
+    // i.e. <w:fitText ... >
+    pub(crate) fn fit_text(self, val: usize, id: Option<u32>) -> Result<Self> {
+        let mut fit_text = XmlEvent::start_element("w:fitText").attr("w:val", &format!("{}", val));
+        let id_value;
+        if let Some(id) = id {
+            id_value = format!("{}", id);
+            fit_text = fit_text.attr("w:id", &id_value);
+        }
+        self.write(fit_text)?.close()
+    }
+
     // i.e. <w:spacing ... >
     pub(crate) fn line_spacing(
         self,