hitt-parser 0.0.22

Parser for http files for the hitt http testing tool
Documentation
use crate::error::RequestParseError;

#[inline]
pub fn parse_variable_declaration(
    chars: &mut core::iter::Enumerate<core::str::Chars>,
    vars: &std::collections::HashMap<String, String>,
) -> Result<Option<(String, String)>, RequestParseError> {
    let mut declaration = String::new();

    let mut value = String::new();

    let mut is_declaration = true;

    while let Some((_, ch)) = chars.next() {
        if is_declaration {
            if ch == '=' {
                is_declaration = false;
            } else {
                declaration.push(ch);
            }
        } else {
            if ch == '{' {
                // FIXME: remove cloning of enumerator
                if let Some((var, jumps)) = parse_variable(&mut chars.clone()) {
                    if let Some(variable_value) = vars.get(&var) {
                        value.push_str(variable_value);

                        for _ in 0..jumps {
                            chars.next();
                        }

                        continue;
                    }

                    return Err(RequestParseError::VariableNotFound(var));
                }
            }

            value.push(ch);
        }
    }

    if is_declaration {
        return Ok(None);
    }

    Ok(Some((
        declaration.trim().to_owned(),
        value.trim().to_owned(),
    )))
}

#[cfg(test)]
mod test_parse_variable_declarations {
    use super::parse_variable_declaration;
    use crate::{error::RequestParseError, to_enum_chars};

    static EMPTY_VARS: std::sync::LazyLock<std::collections::HashMap<String, String>> =
        std::sync::LazyLock::new(std::collections::HashMap::new);

    #[test]
    fn it_should_parse_variable_declarations() {
        for i in i8::MIN..i8::MAX {
            let input_declaration = format!("var{i}");
            let input_value = format!("{i}");

            // NOTE: we do not start with a '@' here since it is expected to already be removed
            let input = format!("{input_declaration}={input_value}");

            let (key, value) = parse_variable_declaration(&mut to_enum_chars(&input), &EMPTY_VARS)
                .expect("it to not return an error")
                .expect("it to return a variable declaration");

            assert_eq!(input_declaration, key);
            assert_eq!(input_value, value);
        }
    }

    #[test]
    fn it_should_allow_emails() {
        let mut extra_spaces = String::new();

        for i in i8::MIN..i8::MAX {
            extra_spaces.push(' ');

            let input_declaration = format!("var{i}");
            let input_value = format!("mads{i}@mhouge.dk");

            // NOTE: we do not start with a '@' here since it is expected to already be removed
            let input = format!(
                "{input_declaration}{extra_spaces}={extra_spaces}{input_value}{extra_spaces}"
            );

            let (key, value) = parse_variable_declaration(&mut to_enum_chars(&input), &EMPTY_VARS)
                .expect("it to not return an error")
                .expect("it to return a variable declaration");

            assert_eq!(input_declaration, key);
            assert_eq!(input_value, value);
        }
    }

    #[test]
    fn it_must_include_an_equal_sign() {
        let input = "mads hougesen";

        let result = parse_variable_declaration(&mut to_enum_chars(input), &EMPTY_VARS)
            .expect("it to not return an error");

        assert_eq!(None, result);
    }

    #[test]
    fn it_should_support_variables() {
        let input = "host={{ hostname }}:{{ port }}";

        {
            let vars = std::collections::HashMap::from([
                ("hostname".to_owned(), "localhost".to_owned()),
                ("port".to_owned(), "5000".to_owned()),
            ]);

            let (name, value) = parse_variable_declaration(&mut to_enum_chars(input), &vars)
                .expect("it to not return an error")
                .expect("it to be some");

            assert_eq!(name, "host");
            assert_eq!(value, "localhost:5000");
        };

        {
            let result = parse_variable_declaration(&mut to_enum_chars(input), &EMPTY_VARS)
                .expect_err("it should return RequestParseError::VariableNotFound");

            assert!(
                matches!(result, RequestParseError::VariableNotFound(var) if var == "hostname")
            );
        };

        {
            let vars =
                std::collections::HashMap::from([("hostname".to_owned(), "localhost".to_owned())]);

            let result = parse_variable_declaration(&mut to_enum_chars(input), &vars)
                .expect_err("it should return RequestParseError::VariableNotFound");

            assert!(matches!(result, RequestParseError::VariableNotFound(var) if var == "port"));
        };
    }
}

#[inline]
pub fn parse_variable(
    chars: &mut core::iter::Enumerate<core::str::Chars>,
) -> Option<(String, usize)> {
    if chars.next().is_some_and(|(_, ch)| ch != '{') {
        return None;
    }

    let mut jumps = 1;

    let mut name = String::new();

    let mut is_key = true;

    while let Some((_, ch)) = chars.next() {
        jumps += 1;

        if ch == '{' {
            return None;
        }

        if ch == '}' {
            if let Some((_, '}')) = chars.next() {
                if name.is_empty() {
                    // NOTE: should this raise?
                    return None;
                }

                jumps += 1;

                return Some((name, jumps));
            }

            return None;
        }

        if ch.is_whitespace() {
            if !name.is_empty() {
                is_key = false;
            }
        } else if !is_key {
            return None;
        } else {
            name.push(ch);
        }
    }

    None
}

#[cfg(test)]
mod test_parse_variable {
    use super::parse_variable;
    use crate::to_enum_chars;

    #[test]
    fn it_should_parse_variables() {
        let before = "{";
        let after = "}}";

        for i in i8::MIN..i8::MAX {
            let input_name = format!("name{i}");

            // NOTE: the first '{' was consumed by the caller
            let input = format!("{before}{input_name}{after}");

            let (output_name, jumps) =
                parse_variable(&mut to_enum_chars(&input)).expect("it to parse as variable");
            assert_eq!(input_name, output_name);
            assert_eq!(input.len(), jumps);
        }
    }

    #[test]
    fn should_trim_variable_whitespace() {
        let mut extra_whitespace = String::new();

        let before = "{";
        let after = "}}";

        for i in i8::MIN..i8::MAX {
            extra_whitespace.push(' ');

            let input_name = format!("name{i}");

            // NOTE: the first '{' was consumed by the caller
            let input = format!("{before}{extra_whitespace}{input_name}{extra_whitespace}{after}");

            let (output_name, jumps) =
                parse_variable(&mut to_enum_chars(&input)).expect("it to parse as variable");

            assert_eq!(input_name, output_name);
            assert_eq!(input.len(), jumps);
        }
    }

    #[test]
    fn it_should_ignore_non_variables() {
        let inputs = [
            " name ",
            " { name n }} ",
            " { name } }",
            " { name",
            " { name} }",
            " { name}",
            " { name}{",
            "name   }}  ",
            "name }}  ",
            "name",
            "name} ",
            "{ name",
            "{ name} }",
            "{ {name} }",
            "{name n}}",
            "{name",
            "{name} }",
            "{name}",
            "{{name x}",
            "{{name}",
            "{{name}}",
            "{} name }}",
        ];

        for input in inputs {
            assert_eq!(None, parse_variable(&mut to_enum_chars(input)));
        }
    }

    #[test]
    fn it_should_not_parse_nested() {
        let input = "{{data}}";

        assert_eq!(None, parse_variable(&mut to_enum_chars(input)));
    }

    #[test]
    fn it_should_ignore_empty_variables() {
        // NOTE: should this be an error?

        let input = "{}}";

        assert_eq!(None, parse_variable(&mut to_enum_chars(input)));
    }
}