support for text wrapping

Author: patrickomatic

book/src/language_reference/cell_and_row_options.md

@@ -157,6 +157,13 @@ Bind a variable (specified by `VARIABLE_ID`) to reference this cell.
 `v = VARIABLE_ID`
 
 
+#### wrap = wrap | overflow | clip
+Whether to wrap the text in the cell.  By default it is `wrap`
+
+##### Alias
+`w = w | o | c`
+
+
 ### Examples
 
 * Align the second cell left, align the last cell to the center and make it bold and italicized:

docs/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## v0.8.0
 
+### Features
+
+* Slashes are no longer needed to separate cell options
+    - `[[text=bold halign=left]]` is now equivalent to `[[text=bold/halign=left]]`.
+* Support for multi-line cells
+* Support for text wrapping cell option
+* [csv++ User Guide](https://patrickomatic.github.io/csv-plus-plus/)
+* Switch to custom CSV parser (`csvp`)
+* Switch from CBOR to bincode for object file serialization
+
 ### **Breaking Changes**
 
 * Added enum variant `Error::CsvParseError`
@@ -17,15 +27,6 @@
     - `TextFormat`
     - `VerticalAlign`
 
-### Features
-
-* Slashes are no longer needed to separate cell options
-    - `[[text=bold halign=left]]` is now equivalent to `[[text=bold/halign=left]]`.
-* Support for multi-line cells
-* [csv++ User Guide](https://patrickomatic.github.io/csv-plus-plus/)
-* Switch to custom CSV parser (`csvp`)
-* Switch from CBOR to bincode for object file serialization
-
 ### Deprecated Features
 
 * You should no longer use `/` to separate cell options

src/cell/mod.rs

@@ -2,7 +2,7 @@
 //!
 use crate::ast::Ast;
 use crate::cell_options::{
-    BorderSide, BorderStyle, DataValidation, HorizontalAlign, NumberFormat, TextFormat,
+    BorderSide, BorderStyle, DataValidation, HorizontalAlign, NumberFormat, TextFormat, TextWrap,
     VerticalAlign,
 };
 use crate::parser::ast_parser::AstParser;
@@ -31,6 +31,7 @@ pub struct Cell {
     pub note: Option<String>,
     pub number_format: Option<NumberFormat>,
     pub text_formats: collections::HashSet<TextFormat>,
+    pub text_wrap: TextWrap,
     pub var: Option<String>,
     pub vertical_align: Option<VerticalAlign>,
 }
@@ -66,6 +67,7 @@ impl Cell {
             number_format: Option::default(),
             parsed_value: String::default(),
             text_formats: collections::HashSet::default(),
+            text_wrap: TextWrap::default(),
             var: Option::default(),
             vertical_align: Option::default(),
         }
@@ -97,6 +99,7 @@ impl Cell {
             number_format: row.number_format,
             parsed_value: String::default(),
             text_formats: row.text_formats,
+            text_wrap: row.text_wrap,
             var: None,
             vertical_align: row.vertical_align,
         }

src/cell_options/mod.rs

@@ -5,6 +5,7 @@ mod fill;
 mod horizontal_align;
 mod number_format;
 mod text_format;
+mod text_wrap;
 mod vertical_align;
 
 pub(crate) use border_side::BorderSide;
@@ -14,4 +15,5 @@ pub(crate) use fill::{Fill, ROW_MAX};
 pub(crate) use horizontal_align::HorizontalAlign;
 pub(crate) use number_format::NumberFormat;
 pub(crate) use text_format::TextFormat;
+pub(crate) use text_wrap::TextWrap;
 pub(crate) use vertical_align::VerticalAlign;

src/cell_options/text_wrap.rs

@@ -0,0 +1,55 @@
+//! # `TextWrap`
+use crate::error::CellParseError;
+use crate::parser::cell_lexer::TokenMatch;
+
+#[derive(Copy, Clone, Debug, Default, PartialEq, serde::Deserialize, serde::Serialize)]
+pub enum TextWrap {
+    #[default]
+    Wrap,
+    Overflow,
+    Clip,
+}
+
+impl TryFrom<TokenMatch> for TextWrap {
+    type Error = CellParseError;
+
+    fn try_from(input: TokenMatch) -> Result<Self, Self::Error> {
+        match input.str_match.to_lowercase().as_str() {
+            "c" | "clip" => Ok(Self::Clip),
+            "o" | "overflow" => Ok(Self::Overflow),
+            "w" | "wrap" => Ok(Self::Wrap),
+            _ => Err(CellParseError::new(
+                "wrap",
+                input,
+                &["clip (c)", "overflow (o)", "wrap (w)"],
+            )),
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::test_utils::*;
+
+    #[test]
+    fn try_from_clip() {
+        assert_eq!(
+            TextWrap::Clip,
+            TextWrap::try_from(build_cell_token_match("c")).unwrap()
+        );
+        assert_eq!(
+            TextWrap::Clip,
+            TextWrap::try_from(build_cell_token_match("clip")).unwrap()
+        );
+        assert_eq!(
+            TextWrap::Clip,
+            TextWrap::try_from(build_cell_token_match("CLIP")).unwrap()
+        );
+    }
+
+    #[test]
+    fn try_from_invalid() {
+        assert!(TextWrap::try_from(build_cell_token_match("foo")).is_err());
+    }
+}

src/parser/cell_parser/mod.rs

@@ -4,7 +4,8 @@ mod validate;
 
 use super::cell_lexer::{CellLexer, Token, TokenMatch};
 use crate::cell_options::{
-    BorderSide, BorderStyle, Fill, HorizontalAlign, NumberFormat, TextFormat, VerticalAlign,
+    BorderSide, BorderStyle, Fill, HorizontalAlign, NumberFormat, TextFormat, TextWrap,
+    VerticalAlign,
 };
 use crate::error::{BadInput, ParseResult, Result};
 use crate::{deprecated_feature, ArcSourceCode, Cell, Rgb, Row};
@@ -220,6 +221,16 @@ where
         })
     }
 
+    fn wrap_option(&mut self) -> ParseResult<()> {
+        let value = TextWrap::try_from(self.lexer.take_option_right_side()?)?;
+        if self.is_row_options {
+            self.row.text_wrap = value;
+        } else {
+            self.cell.text_wrap = value;
+        }
+        Ok(())
+    }
+
     fn option(&mut self) -> ParseResult<()> {
         let option_name = self.lexer.take_token(Token::OptionName)?;
         match option_name.str_match.as_str() {
@@ -239,6 +250,7 @@ where
             "t" | "text" => self.text_option(),
             "v" | "var" => self.var_option(),
             "va" | "valign" => self.valign_option(),
+            "w" | "wrap" => self.wrap_option(),
             _ => Err(option_name.into_parse_error("Expected a valid cell option")),
         }
     }

src/row/mod.rs

@@ -2,7 +2,7 @@ mod display;
 
 use crate::cell_options::{
     BorderSide, BorderStyle, DataValidation, Fill, HorizontalAlign, NumberFormat, TextFormat,
-    VerticalAlign,
+    TextWrap, VerticalAlign,
 };
 use crate::{ArcSourceCode, Cell, Result, Rgb, Scope};
 use csvp::Field;
@@ -25,6 +25,7 @@ pub struct Row {
     pub note: Option<String>,
     pub number_format: Option<NumberFormat>,
     pub text_formats: collections::HashSet<TextFormat>,
+    pub text_wrap: TextWrap,
     pub var: Option<String>,
     pub vertical_align: Option<VerticalAlign>,
 }

src/target/excel/excel_cell.rs

@@ -3,7 +3,7 @@
 //! Converts between a Cell and an `umya_spreadsheet::Style` (which feature-wise actually happen
 //! to map pretty nicely)
 use crate::cell_options::{
-    BorderSide, BorderStyle, HorizontalAlign, NumberFormat, TextFormat, VerticalAlign,
+    BorderSide, BorderStyle, HorizontalAlign, NumberFormat, TextFormat, TextWrap, VerticalAlign,
 };
 use crate::{Cell, Rgb};
 
@@ -83,6 +83,15 @@ impl From<VerticalAlign> for umya_spreadsheet::VerticalAlignmentValues {
     }
 }
 
+impl From<TextWrap> for bool {
+    fn from(value: TextWrap) -> Self {
+        match value {
+            TextWrap::Wrap => true,
+            _ => false,
+        }
+    }
+}
+
 impl<'a> ExcelCell<'a> {
     pub(super) fn has_style(&self) -> bool {
         let cell = self.0;
@@ -113,6 +122,8 @@ impl<'a> ExcelCell<'a> {
             alignment.set_vertical(v.into());
         }
 
+        alignment.set_wrap_text(self.0.text_wrap.into());
+
         s.set_alignment(alignment);
     }
 

src/target/google_sheets/google_sheets_cell.rs

@@ -6,7 +6,7 @@
 //! payloads should reflect only the things the user specified on the cell.
 //!
 use crate::cell_options::{
-    BorderSide, BorderStyle, DataValidation, HorizontalAlign, NumberFormat, TextFormat,
+    BorderSide, BorderStyle, DataValidation, HorizontalAlign, NumberFormat, TextFormat, TextWrap,
     VerticalAlign,
 };
 use crate::{Cell, Rgb};
@@ -68,6 +68,7 @@ impl<'a> GoogleSheetsCell<'a> {
         let number_format = self.number_format();
         let text_format = self.text_format();
         let vertical_alignment = self.vertical_alignment();
+        let wrap_strategy = self.wrap_strategy();
 
         if borders.is_none()
             && background_color_style.is_none()
@@ -87,6 +88,9 @@ impl<'a> GoogleSheetsCell<'a> {
             number_format,
             text_format,
             vertical_alignment,
+            // TODO: this doesn't jive with the caching strategy above, maybe it's time to give up
+            // on that
+            wrap_strategy: Some(wrap_strategy),
             ..Default::default()
         })
     }
@@ -291,6 +295,15 @@ impl<'a> GoogleSheetsCell<'a> {
             .to_string()
         })
     }
+
+    fn wrap_strategy(&self) -> String {
+        match self.0.text_wrap {
+            TextWrap::Wrap => "WRAP",
+            TextWrap::Overflow => "OVERFLOW",
+            TextWrap::Clip => "CLIP",
+        }
+        .to_string()
+    }
 }
 
 #[cfg(test)]