deb822_fast/

convert.rs

//! Conversion between Deb822-like paragraphs and Rust objects.

/// Abstract trait for accessing and modifying key-value pairs in a paragraph.
pub trait Deb822LikeParagraph: FromIterator<(String, String)> {
    /// Get the value for the given key.
    fn get(&self, key: &str) -> Option<String>;

    /// Insert a key-value pair.
    fn set(&mut self, key: &str, value: &str);

    /// Remove a key-value pair.
    fn remove(&mut self, key: &str);
}

impl Deb822LikeParagraph for crate::Paragraph {
    fn get(&self, key: &str) -> Option<String> {
        crate::Paragraph::get(self, key).map(|v| v.to_string())
    }

    fn set(&mut self, key: &str, value: &str) {
        crate::Paragraph::set(self, key, value);
    }

    fn remove(&mut self, key: &str) {
        crate::Paragraph::remove(self, key);
    }
}

/// Convert a paragraph to this object.
pub trait FromDeb822Paragraph<P: Deb822LikeParagraph> {
    /// Convert a paragraph to this object.
    fn from_paragraph(paragraph: &P) -> Result<Self, String>
    where
        Self: Sized;
}

/// Convert this object to a paragraph.
pub trait ToDeb822Paragraph<P: Deb822LikeParagraph> {
    /// Convert this object to a paragraph.
    fn to_paragraph(&self) -> P;

    /// Update the given paragraph with the values from this object.
    fn update_paragraph(&self, paragraph: &mut P);
}

/// Format a field value as a single line.
///
/// # Panics
///
/// Panics if the value contains newline characters.
pub fn format_single_line(value: &str, field_name: &str) -> String {
    assert!(
        !value.contains('\n'),
        "Field '{}' is marked as single_line but contains newlines",
        field_name
    );
    value.to_string()
}

/// Format a field value as multi-line, ensuring continuation lines start with a space.
///
/// If the value is already single-line, it is returned as-is.
/// For multi-line values:
/// - The first line is kept as-is
/// - Empty continuation lines are replaced with " ." (space followed by dot)
/// - Non-empty continuation lines are prefixed with a space
pub fn format_multi_line(value: &str) -> String {
    if !value.contains('\n') {
        value.to_string()
    } else {
        value
            .lines()
            .enumerate()
            .map(|(i, line)| {
                if i == 0 {
                    line.to_string()
                } else if line.is_empty() {
                    " .".to_string()
                } else {
                    format!(" {}", line)
                }
            })
            .collect::<Vec<_>>()
            .join("\n")
    }
}

/// Format a field value as folded, stripping whitespace and joining lines with spaces.
///
/// This implements RFC 822 folding behavior by:
/// - Trimming leading and trailing whitespace from each line
/// - Filtering out empty lines
/// - Joining the remaining lines with single spaces
pub fn format_folded(value: &str) -> String {
    value
        .lines()
        .map(|line| line.trim())
        .filter(|line| !line.is_empty())
        .collect::<Vec<_>>()
        .join(" ")
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_trait_impl_directly() {
        // Test the trait methods directly to improve coverage
        let mut para = crate::Paragraph {
            fields: vec![crate::Field {
                name: "Test".to_string(),
                value: "Value".to_string(),
            }],
        };

        // Test Deb822LikeParagraph::get
        let result: Option<String> = Deb822LikeParagraph::get(&para, "Test");
        assert_eq!(result, Some("Value".to_string()));

        // Test Deb822LikeParagraph::set
        Deb822LikeParagraph::set(&mut para, "Test", "NewValue");
        assert_eq!(para.get("Test"), Some("NewValue"));

        // Test Deb822LikeParagraph::remove
        Deb822LikeParagraph::remove(&mut para, "Test");
        assert_eq!(para.get("Test"), None);
    }

    #[test]
    fn test_deb822like_paragraph_impl() {
        // Create mock crate::Paragraph for tests
        let mut para = crate::Paragraph {
            fields: vec![crate::Field {
                name: "Name".to_string(),
                value: "Test".to_string(),
            }],
        };

        // Test get() - this calls the implementation on line 16-17
        assert_eq!(para.get("Name"), Some("Test"));
        assert_eq!(para.get("NonExistent"), None);

        // Test set() - this calls the implementation on line 20-21
        para.set("Name", "NewValue");
        assert_eq!(para.get("Name"), Some("NewValue"));

        // Test set() with new key
        para.set("NewKey", "Value");
        assert_eq!(para.get("NewKey"), Some("Value"));

        // Test remove() - this calls the implementation on line 24-25
        para.remove("Name");
        assert_eq!(para.get("Name"), None);
        assert_eq!(para.get("NewKey"), Some("Value"));

        // Create a new paragraph with multiple fields of the same name
        let mut para = crate::Paragraph {
            fields: vec![
                crate::Field {
                    name: "Duplicate".to_string(),
                    value: "Value1".to_string(),
                },
                crate::Field {
                    name: "Duplicate".to_string(),
                    value: "Value2".to_string(),
                },
            ],
        };

        // Test remove() removes all matches
        para.remove("Duplicate");
        assert_eq!(para.get("Duplicate"), None);
        assert_eq!(para.fields.len(), 0);
    }

    #[cfg(feature = "derive")]
    mod derive {
        use super::*;
        use crate as deb822_fast;
        use crate::{FromDeb822, ToDeb822};

        #[test]
        fn test_derive() {
            #[derive(ToDeb822)]
            struct Foo {
                bar: String,
                baz: i32,
                blah: Option<String>,
            }

            let foo = Foo {
                bar: "hello".to_string(),
                baz: 42,
                blah: None,
            };

            let paragraph: crate::Paragraph = foo.to_paragraph();
            assert_eq!(paragraph.get("bar"), Some("hello"));
            assert_eq!(paragraph.get("baz"), Some("42"));
            assert_eq!(paragraph.get("blah"), None);
        }

        #[test]
        fn test_optional_missing() {
            #[derive(ToDeb822)]
            struct Foo {
                bar: String,
                baz: Option<String>,
            }

            let foo = Foo {
                bar: "hello".to_string(),
                baz: None,
            };

            let paragraph: crate::Paragraph = foo.to_paragraph();
            assert_eq!(paragraph.get("bar"), Some("hello"));
            assert_eq!(paragraph.get("baz"), None);

            assert_eq!("bar: hello\n", paragraph.to_string());
        }

        #[test]
        fn test_deserialize_with() {
            let mut para: crate::Paragraph = "bar: bar\n# comment\nbaz: blah\n".parse().unwrap();

            fn to_bool(s: &str) -> Result<bool, String> {
                Ok(s == "ja")
            }

            fn from_bool(s: &bool) -> String {
                if *s {
                    "ja".to_string()
                } else {
                    "nee".to_string()
                }
            }

            #[derive(FromDeb822, ToDeb822)]
            struct Foo {
                bar: String,
                #[deb822(deserialize_with = to_bool, serialize_with = from_bool)]
                baz: bool,
            }

            let mut foo: Foo = Foo::from_paragraph(&para).unwrap();
            assert_eq!(foo.bar, "bar");
            assert!(!foo.baz);

            foo.bar = "new".to_string();

            foo.update_paragraph(&mut para);

            assert_eq!(para.get("bar"), Some("new"));
            assert_eq!(para.get("baz"), Some("nee"));
            assert_eq!(para.to_string(), "bar: new\nbaz: nee\n");
        }

        #[test]
        fn test_update_remove() {
            let mut para: crate::Paragraph = "bar: bar\n# comment\nbaz: blah\n".parse().unwrap();

            #[derive(FromDeb822, ToDeb822)]
            struct Foo {
                bar: Option<String>,
                baz: String,
            }

            let mut foo: Foo = Foo::from_paragraph(&para).unwrap();
            assert_eq!(foo.bar, Some("bar".to_string()));
            assert_eq!(foo.baz, "blah");

            foo.bar = None;

            foo.update_paragraph(&mut para);

            assert_eq!(para.get("bar"), None);
            assert_eq!(para.get("baz"), Some("blah"));
            assert_eq!(para.to_string(), "baz: blah\n");
        }
    }
}