synwire 0.1.0

Convenience re-exports and reference implementations for Synwire
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Regex-based output parser.

use std::collections::HashMap;

use regex::Regex;
use synwire_core::error::{ParseError, SynwireError};
use synwire_core::output_parsers::OutputParser;

/// Parses text using a regex pattern with named capture groups.
///
/// Each named capture group in the regex becomes a key in the output map.
///
/// # Examples
///
/// ```
/// use synwire::output_parsers::RegexParser;
/// use synwire_core::output_parsers::OutputParser;
///
/// let parser = RegexParser::new(
///     r"Name: (?P<name>\w+), Age: (?P<age>\d+)",
///     vec!["name".into(), "age".into()],
/// ).unwrap();
/// let result = parser.parse("Name: Alice, Age: 30").unwrap();
/// assert_eq!(result["name"], "Alice");
/// assert_eq!(result["age"], "30");
/// ```
pub struct RegexParser {
    regex: Regex,
    output_keys: Vec<String>,
}

impl RegexParser {
    /// Creates a new regex parser.
    ///
    /// # Errors
    ///
    /// Returns an error if the regex pattern is invalid.
    pub fn new(pattern: &str, output_keys: Vec<String>) -> Result<Self, SynwireError> {
        let regex = Regex::new(pattern).map_err(|e| {
            SynwireError::from(ParseError::ParseFailed {
                message: format!("invalid regex pattern: {e}"),
            })
        })?;
        Ok(Self { regex, output_keys })
    }
}

impl OutputParser for RegexParser {
    type Output = HashMap<String, String>;

    fn parse(&self, text: &str) -> Result<HashMap<String, String>, SynwireError> {
        let captures = self.regex.captures(text).ok_or_else(|| {
            SynwireError::from(ParseError::ParseFailed {
                message: format!("regex did not match text: '{text}'"),
            })
        })?;

        let mut result = HashMap::new();
        for key in &self.output_keys {
            let value = captures
                .name(key)
                .map(|m| m.as_str().to_owned())
                .ok_or_else(|| {
                    SynwireError::from(ParseError::ParseFailed {
                        message: format!("named capture group '{key}' not found"),
                    })
                })?;
            let _ = result.insert(key.clone(), value);
        }

        Ok(result)
    }

    fn get_format_instructions(&self) -> String {
        format!(
            "Respond so the output matches this pattern with fields: {}",
            self.output_keys.join(", ")
        )
    }
}

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

    #[test]
    fn parses_named_groups() {
        let parser = RegexParser::new(
            r"Name: (?P<name>\w+), Age: (?P<age>\d+)",
            vec!["name".into(), "age".into()],
        )
        .unwrap();
        let result = parser.parse("Name: Bob, Age: 25").unwrap();
        assert_eq!(result["name"], "Bob");
        assert_eq!(result["age"], "25");
    }

    #[test]
    fn no_match_returns_error() {
        let parser = RegexParser::new(r"(?P<num>\d+)", vec!["num".into()]).unwrap();
        let result = parser.parse("no numbers here");
        assert!(result.is_err());
    }

    #[test]
    fn invalid_regex_returns_error() {
        let result = RegexParser::new(r"(invalid[", vec![]);
        assert!(result.is_err());
    }

    #[test]
    fn missing_named_group_returns_error() {
        let parser =
            RegexParser::new(r"(?P<name>\w+)", vec!["name".into(), "missing".into()]).unwrap();
        let result = parser.parse("Alice");
        assert!(result.is_err());
    }

    #[test]
    fn format_instructions_list_keys() {
        let parser = RegexParser::new(r".", vec!["x".into(), "y".into()]).unwrap();
        let instructions = parser.get_format_instructions();
        assert!(instructions.contains('x'));
        assert!(instructions.contains('y'));
    }
}