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

mod display;
pub mod error;
pub mod value_object;

use crate::invariant::error::{InvariantError, InvariantResult};
use crate::invariant::value_object::id::InvariantId;
use crate::scope::Scope;
use crate::severity::Severity;
use std::collections::BTreeMap;

/// A declared rule applied to a dataset.
///
/// An `Invariant<K>` describes a validation rule but does not contain
/// execution logic or results.
///
/// The type parameter `K` represents the invariant kind,
/// defined by the infrastructure (e.g. `PolarsKind`, `SqlKind`).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Invariant<K> {
    id: InvariantId,
    kind: K,
    scope: Scope,
    severity: Severity,
    params: BTreeMap<String, String>,
}

impl<K> Invariant<K> {
    pub fn new(id: InvariantId, kind: K, scope: Scope) -> Self {
        Self {
            id,
            kind,
            scope,
            severity: Severity::Error,
            params: BTreeMap::new(),
        }
    }

    pub fn id(&self) -> &InvariantId {
        &self.id
    }

    pub fn kind(&self) -> &K {
        &self.kind
    }

    pub fn scope(&self) -> &Scope {
        &self.scope
    }

    pub fn severity(&self) -> Severity {
        self.severity
    }

    pub fn params(&self) -> &BTreeMap<String, String> {
        &self.params
    }

    #[must_use]
    pub fn with_severity(mut self, severity: Severity) -> Self {
        self.severity = severity;
        self
    }

    #[must_use]
    pub fn with_params(mut self, params: BTreeMap<String, String>) -> Self {
        self.params = params;
        self
    }

    #[must_use]
    pub fn with_param_value(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.params.insert(key.into(), value.into());
        self
    }

    pub fn has_param(&self, key: &str) -> bool {
        self.params.contains_key(key)
    }

    pub fn param(&self, key: &str) -> Option<&str> {
        self.params.get(key).map(std::string::String::as_str)
    }

    pub fn require_param(&self, key: &str) -> InvariantResult<&str> {
        self.param(key)
            .ok_or_else(|| InvariantError::missing_param(self.id.as_str(), key))
    }
}