jdrouet/mrml

//! Module containing the trait for implementing an [`IncludeLoader`].

use std::io::ErrorKind;
use std::sync::Arc;

#[derive(Debug, Clone)]
pub struct IncludeLoaderError {
    pub path: String,
    pub reason: ErrorKind,
    pub message: Option<&'static str>,
    pub cause: Option<Arc<dyn std::error::Error + Send + Sync + 'static>>,
}

impl IncludeLoaderError {
    pub fn new<P: ToString>(path: P, reason: ErrorKind) -> Self {
        Self {
            path: path.to_string(),
            reason,
            message: None,
            cause: None,
        }
    }

    pub fn not_found<P: ToString>(path: P) -> Self {
        Self {
            path: path.to_string(),
            reason: ErrorKind::NotFound,
            message: None,
            cause: None,
        }
    }

    pub fn with_message(mut self, message: &'static str) -> Self {
        self.message = Some(message);
        self
    }

    pub fn with_cause(mut self, cause: Arc<dyn std::error::Error + Send + Sync + 'static>) -> Self {
        self.cause = Some(cause);
        self
    }
}

impl std::fmt::Display for IncludeLoaderError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if let Some(msg) = self.message {
            write!(f, "{} {} ({msg})", self.path, self.reason)
        } else {
            write!(f, "{} {}", self.path, self.reason)
        }
    }
}

impl std::error::Error for IncludeLoaderError {
    fn cause(&self) -> Option<&dyn std::error::Error> {
        self.cause
            .as_ref()
            .map(|c| c.as_ref() as &dyn std::error::Error)
    }
}

pub trait IncludeLoader: std::fmt::Debug {
    /// This function is used to fetch the included template using the `path`
    /// attribute.
    ///
    /// You can have an example of simple resolve function with the
    /// [`MemoryIncludeLoader`](crate::prelude::parser::memory_loader::MemoryIncludeLoader).
    fn resolve(&self, path: &str) -> Result<String, IncludeLoaderError>;
}

#[cfg(feature = "async")]
#[cfg_attr(target_arch = "wasm32", async_trait::async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait::async_trait)]
pub trait AsyncIncludeLoader: std::fmt::Debug {
    /// This function is used to fetch the included template using the `path`
    /// attribute.
    ///
    /// You can have an example of simple resolve function with the
    /// [`MemoryIncludeLoader`](crate::prelude::parser::memory_loader::MemoryIncludeLoader).
    async fn async_resolve(&self, path: &str) -> Result<String, IncludeLoaderError>;
}

#[cfg(test)]
mod tests {
    use std::io::ErrorKind;
    use std::sync::Arc;

    use super::IncludeLoaderError;

    #[test]
    fn should_display_basic() {
        assert_eq!(
            IncludeLoaderError::new("foo.mjml", ErrorKind::NotFound).to_string(),
            "foo.mjml entity not found",
        );
    }

    #[test]
    fn should_display_with_message() {
        assert_eq!(
            IncludeLoaderError::new("foo.mjml", ErrorKind::NotFound)
                .with_message("oops")
                .to_string(),
            "foo.mjml entity not found (oops)",
        );
    }

    #[test]
    fn should_display_with_cause() {
        assert_eq!(
            IncludeLoaderError::new("foo.mjml", ErrorKind::NotFound)
                .with_cause(Arc::new(IncludeLoaderError::new(
                    "bar.mjml",
                    ErrorKind::InvalidInput
                )))
                .to_string(),
            "foo.mjml entity not found",
        );
    }
}