golem-rib 1.3.1

Parser for Golem's Rib language
Documentation
// Copyright 2024-2025 Golem Cloud
//
// Licensed under the Golem Source License v1.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://license.golem.cloud/LICENSE
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use combine::parser::char::alpha_num;
use combine::{
    attempt, choice, not_followed_by,
    parser::char::{char, string},
    ParseError, Parser,
};
use std::ops::Deref;

use super::rib_expr::rib_expr;
use crate::expr::Expr;
use crate::parser::errors::RibParseError;
use crate::rib_source_span::GetSourcePosition;

pub fn option<Input>() -> impl Parser<Input, Output = Expr>
where
    Input: combine::Stream<Token = char>,
    RibParseError: Into<
        <Input::Error as ParseError<Input::Token, Input::Range, Input::Position>>::StreamError,
    >,
    Input::Position: GetSourcePosition,
{
    (choice((
        attempt(string("some").skip(char('('))).with(
            rib_expr()
                .skip(char(')'))
                .map(|expr| Expr::option(Some(expr))),
        ),
        (attempt(string("none").skip(not_followed_by(alpha_num().or(char('-')).or(char('_')))))
            .map(|_| Expr::option(None))),
    )))
    .and_then(|expr| match expr {
        Expr::Option { expr, .. } => Ok(Expr::option(expr.map(|x| x.deref().clone()))),
        _ => Err(RibParseError::Message("Unable to parse option".to_string())),
    })
}

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

    use super::*;
    use crate::TypeName;

    #[test]
    fn test_some() {
        let input = "some(foo)";
        let result = Expr::from_text(input);
        assert_eq!(
            result,
            Ok(Expr::option(Some(Expr::identifier_global("foo", None))))
        );
    }

    #[test]
    fn test_some_with_type_annotation() {
        let input = "some(foo): option<string>";
        let result = Expr::from_text(input);
        assert_eq!(
            result,
            Ok(Expr::option(Some(Expr::identifier_global("foo", None)))
                .with_type_annotation(TypeName::Option(Box::new(TypeName::Str))))
        );
    }

    #[test]
    fn test_none() {
        let input = "none";
        let result = Expr::from_text(input);
        assert_eq!(result, Ok(Expr::option(None)));
    }

    #[test]
    fn test_none_with_type_annotation() {
        let input = "none: option<string>";
        let result = Expr::from_text(input);
        assert_eq!(
            result,
            Ok(Expr::option(None).with_type_annotation(TypeName::Option(Box::new(TypeName::Str))))
        );
    }

    #[test]
    fn test_nested_some() {
        let input = "some(some(foo))";
        let result = Expr::from_text(input);
        assert_eq!(
            result,
            Ok(Expr::option(Some(Expr::option(Some(
                Expr::identifier_global("foo", None)
            )))))
        );
    }

    #[test]
    fn test_nested_some_with_type_annotation() {
        let input = "some(some(foo): option<string>): option<option<string>>";
        let result = Expr::from_text(input);
        assert_eq!(
            result,
            Ok(Expr::option(Some(
                Expr::option(Some(Expr::identifier_global("foo", None)),)
                    .with_type_annotation(TypeName::Option(Box::new(TypeName::Str)))
            ))
            .with_type_annotation(TypeName::Option(Box::new(TypeName::Option(
                Box::new(TypeName::Str)
            )))))
        );
    }

    #[test]
    fn test_some_of_sequence() {
        let input = "some([foo, bar])";
        let result = Expr::from_text(input);
        assert_eq!(
            result,
            Ok(Expr::option(Some(Expr::sequence(
                vec![
                    Expr::identifier_global("foo", None),
                    Expr::identifier_global("bar", None)
                ],
                None
            ))))
        );
    }

    #[test]
    fn test_some_of_literal() {
        let input = "some(\"foo\")";
        let result = Expr::from_text(input);
        assert_eq!(result, Ok(Expr::option(Some(Expr::literal("foo")))));
    }
}