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 volume.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum VolumeUnit {
    Ml,
    L,
    M3,
    FlOz,
    Gal,
}

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

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

impl std::fmt::Display for VolumeUnit {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            VolumeUnit::Ml => write!(f, "ml"),
            VolumeUnit::L => write!(f, "l"),
            VolumeUnit::M3 => write!(f, ""),
            VolumeUnit::FlOz => write!(f, "fl oz"),
            VolumeUnit::Gal => write!(f, "gal"),
        }
    }
}

/// Input for [`Volume`].
#[derive(Debug, Clone, PartialEq)]
pub struct VolumeInput {
    pub value: f64,
    pub unit: VolumeUnit,
}

/// A validated volume measurement.
///
/// **Validation:** value must be finite and non-negative.
///
/// # Example
///
/// ```rust,ignore
/// use arvo::measurement::{Volume, VolumeInput, VolumeUnit};
/// use arvo::traits::ValueObject;
///
/// let v = Volume::new(VolumeInput { value: 1.5, unit: VolumeUnit::L })?;
/// assert_eq!(v.value(), "1.5 l");
/// ```
#[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 Volume {
    value: f64,
    unit: VolumeUnit,
    canonical: String,
}

impl ValueObject for Volume {
    type Input = VolumeInput;
    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("Volume", &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 {
        VolumeInput {
            value: self.value,
            unit: self.unit,
        }
    }
}

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

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

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

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        let err = || ValidationError::invalid("Volume", 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() {
            "ml" => VolumeUnit::Ml,
            "l" => VolumeUnit::L,
            "" => VolumeUnit::M3,
            "fl oz" => VolumeUnit::FlOz,
            "gal" => VolumeUnit::Gal,
            _ => return Err(err()),
        };
        Self::new(VolumeInput { value: val, unit })
    }
}

impl std::fmt::Display for Volume {
    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 v = Volume::new(VolumeInput {
            value: 1.5,
            unit: VolumeUnit::L,
        })
        .unwrap();
        assert_eq!(v.value(), "1.5 l");
    }

    #[test]
    fn accepts_zero() {
        assert!(
            Volume::new(VolumeInput {
                value: 0.0,
                unit: VolumeUnit::Ml
            })
            .is_ok()
        );
    }

    #[test]
    fn rejects_negative() {
        assert!(
            Volume::new(VolumeInput {
                value: -1.0,
                unit: VolumeUnit::L
            })
            .is_err()
        );
    }

    #[test]
    fn rejects_nan() {
        assert!(
            Volume::new(VolumeInput {
                value: f64::NAN,
                unit: VolumeUnit::L
            })
            .is_err()
        );
    }

    #[test]
    fn try_from_parses_valid() {
        let v = Volume::try_from("1.5 l").unwrap();
        assert_eq!(v.value(), "1.5 l");
    }

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

    #[test]
    fn try_from_rejects_unknown_unit() {
        assert!(Volume::try_from("1.5 cups").is_err());
    }

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

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