arvo 1.0.0

Validated, immutable value objects for common domain types (email, money, identifiers, …)
Documentation
use crate::errors::ValidationError;
use crate::traits::ValueObject;

/// Unit of frequency.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum FrequencyUnit {
    Hz,
    KHz,
    MHz,
    GHz,
}

#[cfg(feature = "serde")]
impl From<Frequency> for String {
    fn from(v: Frequency) -> String {
        v.canonical
    }
}

impl TryFrom<String> for Frequency {
    type Error = ValidationError;
    fn try_from(s: String) -> Result<Self, Self::Error> {
        Self::try_from(s.as_str())
    }
}

impl std::fmt::Display for FrequencyUnit {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            FrequencyUnit::Hz => write!(f, "Hz"),
            FrequencyUnit::KHz => write!(f, "kHz"),
            FrequencyUnit::MHz => write!(f, "MHz"),
            FrequencyUnit::GHz => write!(f, "GHz"),
        }
    }
}

/// Input for [`Frequency`].
#[derive(Debug, Clone, PartialEq)]
pub struct FrequencyInput {
    pub value: f64,
    pub unit: FrequencyUnit,
}

/// A validated frequency measurement.
///
/// **Validation:** value must be finite and strictly positive (> 0).
///
/// # Example
///
/// ```rust,ignore
/// use arvo::measurement::{Frequency, FrequencyInput, FrequencyUnit};
/// use arvo::traits::ValueObject;
///
/// let f = Frequency::new(FrequencyInput { value: 2.4, unit: FrequencyUnit::GHz })?;
/// assert_eq!(f.value(), "2.4 GHz");
/// ```
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(try_from = "String", into = "String"))]
pub struct Frequency {
    value: f64,
    unit: FrequencyUnit,
    canonical: String,
}

impl ValueObject for Frequency {
    type Input = FrequencyInput;
    type Error = ValidationError;

    fn new(input: Self::Input) -> Result<Self, Self::Error> {
        if !input.value.is_finite() || input.value <= 0.0 {
            return Err(ValidationError::invalid(
                "Frequency",
                &input.value.to_string(),
            ));
        }
        let canonical = format!("{} {}", input.value, input.unit);
        Ok(Self {
            value: input.value,
            unit: input.unit,
            canonical,
        })
    }

    fn into_inner(self) -> Self::Input {
        FrequencyInput {
            value: self.value,
            unit: self.unit,
        }
    }
}

impl Frequency {
    pub fn value(&self) -> &str {
        &self.canonical
    }

    pub fn amount(&self) -> f64 {
        self.value
    }
    pub fn unit(&self) -> &FrequencyUnit {
        &self.unit
    }
}

impl TryFrom<&str> for Frequency {
    type Error = ValidationError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        let err = || ValidationError::invalid("Frequency", value);
        let (val_str, unit_str) = value.trim().split_once(' ').ok_or_else(err)?;
        let val: f64 = val_str.trim().parse().map_err(|_| err())?;
        let unit = match unit_str.trim() {
            "Hz" => FrequencyUnit::Hz,
            "kHz" => FrequencyUnit::KHz,
            "MHz" => FrequencyUnit::MHz,
            "GHz" => FrequencyUnit::GHz,
            _ => return Err(err()),
        };
        Self::new(FrequencyInput { value: val, unit })
    }
}

impl std::fmt::Display for Frequency {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.canonical)
    }
}

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

    #[test]
    fn accepts_valid() {
        let f = Frequency::new(FrequencyInput {
            value: 2.4,
            unit: FrequencyUnit::GHz,
        })
        .unwrap();
        assert_eq!(f.value(), "2.4 GHz");
    }

    #[test]
    fn rejects_zero() {
        assert!(
            Frequency::new(FrequencyInput {
                value: 0.0,
                unit: FrequencyUnit::Hz
            })
            .is_err()
        );
    }

    #[test]
    fn rejects_negative() {
        assert!(
            Frequency::new(FrequencyInput {
                value: -1.0,
                unit: FrequencyUnit::Hz
            })
            .is_err()
        );
    }

    #[test]
    fn rejects_nan() {
        assert!(
            Frequency::new(FrequencyInput {
                value: f64::NAN,
                unit: FrequencyUnit::Hz
            })
            .is_err()
        );
    }

    #[test]
    fn try_from_parses_valid() {
        let f = Frequency::try_from("2.4 GHz").unwrap();
        assert_eq!(f.value(), "2.4 GHz");
    }

    #[test]
    fn try_from_rejects_no_space() {
        assert!(Frequency::try_from("2.4").is_err());
    }

    #[test]
    fn try_from_rejects_unknown_unit() {
        assert!(Frequency::try_from("2.4 THz").is_err());
    }

    #[cfg(feature = "serde")]
    #[test]
    fn serde_roundtrip() {
        let v = Frequency::try_from("2.4 GHz").unwrap();
        let json = serde_json::to_string(&v).unwrap();
        let back: Frequency = serde_json::from_str(&json).unwrap();
        assert_eq!(v.value(), back.value());
    }

    #[cfg(feature = "serde")]
    #[test]
    fn serde_serializes_as_canonical_string() {
        let v = Frequency::try_from("2.4 GHz").unwrap();
        let json = serde_json::to_string(&v).unwrap();
        assert!(json.contains("2.4 GHz"));
    }
}