invr 0.2.1

Declarative data validation engine using invariants executed on Polars DataFrames.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use std::{error::Error, fmt};

use crate::invariant::value_object::id::InvariantIdError;
use crate::scope::error::ScopeError;
use crate::severity::Severity;

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum InvariantError {
    InvalidId {
        id: String,
    },
    MissingParam {
        invariant_id: String,
        key: String,
    },
    InvalidParam {
        invariant_id: String,
        key: String,
        reason: String,
    },
    UnknownInvariant {
        name: String,
    },
    InvalidScope {
        expected: String,
    },
    UnexpectedSeverity {
        invariant_id: String,
        expected: Severity,
        found: Severity,
    },
}

impl InvariantError {
    pub fn invalid_id(id: impl Into<String>) -> Self {
        Self::InvalidId { id: id.into() }
    }

    pub fn missing_param(invariant_id: impl Into<String>, key: impl Into<String>) -> Self {
        Self::MissingParam {
            invariant_id: invariant_id.into(),
            key: key.into(),
        }
    }

    pub fn invalid_param(
        invariant_id: impl Into<String>,
        key: impl Into<String>,
        reason: impl Into<String>,
    ) -> Self {
        Self::InvalidParam {
            invariant_id: invariant_id.into(),
            key: key.into(),
            reason: reason.into(),
        }
    }

    pub fn unknown(name: impl Into<String>) -> Self {
        Self::UnknownInvariant { name: name.into() }
    }

    pub fn invalid_scope(expected: impl Into<String>) -> Self {
        Self::InvalidScope {
            expected: expected.into(),
        }
    }

    pub fn unexpected_severity(
        invariant_id: impl Into<String>,
        expected: Severity,
        found: Severity,
    ) -> Self {
        Self::UnexpectedSeverity {
            invariant_id: invariant_id.into(),
            expected,
            found,
        }
    }
}

impl fmt::Display for InvariantError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            InvariantError::InvalidId { id } => {
                write!(f, "invalid invariant id: {id}")
            }
            InvariantError::MissingParam { invariant_id, key } => {
                write!(
                    f,
                    "invariant '{invariant_id}' is missing required param '{key}'"
                )
            }
            InvariantError::InvalidParam {
                invariant_id,
                key,
                reason,
            } => {
                write!(
                    f,
                    "invalid param '{key}' for invariant '{invariant_id}': {reason}"
                )
            }
            InvariantError::UnknownInvariant { name } => {
                write!(f, "unknown invariant: {name}")
            }
            InvariantError::InvalidScope { expected } => {
                write!(f, "{expected}")
            }
            InvariantError::UnexpectedSeverity {
                invariant_id,
                expected,
                found,
            } => {
                write!(
                    f,
                    "unexpected severity for invariant '{invariant_id}': expected {expected}, found {found}"
                )
            }
        }
    }
}

impl Error for InvariantError {}

impl From<InvariantIdError> for InvariantError {
    fn from(value: InvariantIdError) -> Self {
        InvariantError::InvalidId {
            id: value.to_string(),
        }
    }
}

impl From<ScopeError> for InvariantError {
    fn from(value: ScopeError) -> Self {
        InvariantError::InvalidScope {
            expected: value.to_string(),
        }
    }
}

pub type InvariantResult<T> = Result<T, InvariantError>;