alumet 0.8.0

use std::fmt::Display;

pub mod generate;
pub mod matching;
pub mod namespace;
pub mod parsing;

/// The name of a plugin.
///
/// The purpose of this type is to avoid any ambiguity or potential mistake when working with names.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct PluginName(pub String);

/// Indicates the type of a pipeline element.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ElementKind {
    Source,
    Transform,
    Output,
}

/// The full name of a pipeline element.
///
/// # Example
/// ```
/// use alumet::pipeline::naming::{ElementKind, ElementName};
///
/// let source_name = ElementName {
///     kind: ElementKind::Source,
///     plugin: String::from("example"),
///     element: String::from("the_source"),
/// };
/// ```
///
/// Note: if you know the type (as it is the case here), prefer specialized types such as [`SourceName`]:
/// ```
/// use alumet::pipeline::naming::SourceName;
///
/// let source_name = SourceName::new(String::from("example"), String::from("the_source"));
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ElementName {
    /// Which type of element this is.
    pub kind: ElementKind,
    /// Name of the plugin that registered this element.
    pub plugin: String,
    /// Name of the element.
    pub element: String,
}

/// The full name of a source.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SourceName(pub(super) ElementName);

/// The full name of a transform.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TransformName(pub(super) ElementName);

/// The full name of an output.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct OutputName(pub(super) ElementName);

impl SourceName {
    pub fn new(plugin: String, source_name: String) -> Self {
        Self(ElementName {
            plugin,
            kind: ElementKind::Source,
            element: source_name,
        })
    }

    pub fn from_str(plugin: &str, source: &str) -> Self {
        Self::new(plugin.to_owned(), source.to_owned())
    }

    pub fn plugin(&self) -> &str {
        &self.0.plugin
    }

    pub fn source(&self) -> &str {
        &self.0.element
    }
}

impl TransformName {
    pub fn new(plugin: String, transform_name: String) -> Self {
        Self(ElementName {
            plugin,
            kind: ElementKind::Transform,
            element: transform_name,
        })
    }

    pub fn from_str(plugin: &str, transform: &str) -> Self {
        Self::new(plugin.to_owned(), transform.to_owned())
    }

    pub fn plugin(&self) -> &str {
        &self.0.plugin
    }

    pub fn transform(&self) -> &str {
        &self.0.element
    }
}

impl OutputName {
    pub fn new(plugin: String, output_name: String) -> Self {
        Self(ElementName {
            plugin,
            kind: ElementKind::Output,
            element: output_name,
        })
    }

    pub fn from_str(plugin: &str, output: &str) -> Self {
        Self::new(plugin.to_owned(), output.to_owned())
    }

    pub fn plugin(&self) -> &str {
        &self.0.plugin
    }

    pub fn output(&self) -> &str {
        &self.0.element
    }
}

impl ElementName {
    pub fn from_str(kind: ElementKind, plugin: &str, element: &str) -> Self {
        Self {
            kind,
            plugin: plugin.to_owned(),
            element: element.to_owned(),
        }
    }

    pub fn as_source(self) -> Option<SourceName> {
        match self.kind {
            ElementKind::Source => Some(SourceName(self)),
            _ => None,
        }
    }

    pub fn as_transform(self) -> Option<TransformName> {
        match self.kind {
            ElementKind::Transform => Some(TransformName(self)),
            _ => None,
        }
    }

    pub fn as_output(self) -> Option<OutputName> {
        match self.kind {
            ElementKind::Output => Some(OutputName(self)),
            _ => None,
        }
    }
}

// ===== Conversion from specific names to generic name

impl From<SourceName> for ElementName {
    fn from(value: SourceName) -> Self {
        value.0
    }
}

impl<'a> From<&'a SourceName> for &'a ElementName {
    fn from(value: &'a SourceName) -> Self {
        &value.0
    }
}

impl From<TransformName> for ElementName {
    fn from(value: TransformName) -> Self {
        value.0
    }
}

impl<'a> From<&'a TransformName> for &'a ElementName {
    fn from(value: &'a TransformName) -> Self {
        &value.0
    }
}

impl From<OutputName> for ElementName {
    fn from(value: OutputName) -> Self {
        value.0
    }
}

impl<'a> From<&'a OutputName> for &'a ElementName {
    fn from(value: &'a OutputName) -> Self {
        &value.0
    }
}

// ===== Implementations of Display

impl Display for ElementKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let s = match self {
            ElementKind::Source => "source",
            ElementKind::Transform => "transform",
            ElementKind::Output => "output",
        };
        f.write_str(s)
    }
}

impl Display for ElementName {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}s/{}/{}", self.kind, self.plugin, self.element)
    }
}

impl Display for SourceName {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

impl Display for TransformName {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

impl Display for OutputName {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}