pgevolve-core 0.4.1

Postgres declarative schema management — core library (parser, IR, diff, planner) powering the pgevolve CLI.
Documentation 
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

//! Layout-profile lint rules. Spec §12.
//!
//! Each profile expresses *where* an object should live on disk. The
//! universal rules don't care about paths; this module does.

pub mod custom;
pub mod feature_grouped;
pub mod free_form;
pub mod kind_grouped;
pub mod schema_mirror;

use std::path::Path;

pub use custom::{Assertion, CustomProfile, PathPattern};

use super::finding::Finding;
use super::source_tree::SourceTree;

/// One of the five layout profiles.
#[derive(Debug, Clone)]
pub enum Profile {
    /// `schema/<schema>/<kind>/<name>.sql` — strictest.
    SchemaMirror,
    /// `schema/<kind>/<schema>.<name>.sql`.
    KindGrouped,
    /// `schema/<feature>/*.sql` — files grouped by feature.
    FeatureGrouped,
    /// No path constraints; universal rules only.
    FreeForm,
    /// User-defined regex + assertion rules.
    Custom(CustomProfile),
}

impl Profile {
    /// Resolve a profile name (built-in keyword or path to a custom TOML).
    ///
    /// Recognized keywords: `schema-mirror`, `kind-grouped`,
    /// `feature-grouped`, `free-form`. Any other string is treated as a path
    /// to a custom-profile TOML file.
    pub fn from_name(name: &str) -> Result<Self, ProfileLoadError> {
        match name {
            "schema-mirror" => Ok(Self::SchemaMirror),
            "kind-grouped" => Ok(Self::KindGrouped),
            "feature-grouped" => Ok(Self::FeatureGrouped),
            "free-form" => Ok(Self::FreeForm),
            other => {
                let path = Path::new(other);
                let content = std::fs::read_to_string(path)
                    .map_err(|e| ProfileLoadError::Io(path.to_path_buf(), e.to_string()))?;
                let custom: CustomProfile = toml::from_str(&content)
                    .map_err(|e| ProfileLoadError::Parse(path.to_path_buf(), e.to_string()))?;
                Ok(Self::Custom(custom))
            }
        }
    }
}

/// Failure mode for [`Profile::from_name`].
#[derive(Debug, thiserror::Error)]
pub enum ProfileLoadError {
    /// I/O reading the custom profile TOML.
    #[error("reading custom profile {0}: {1}")]
    Io(std::path::PathBuf, String),
    /// Custom profile TOML didn't parse.
    #[error("parsing custom profile {0}: {1}")]
    Parse(std::path::PathBuf, String),
}

/// Dispatch to the chosen profile's rules.
pub fn check_profile(profile: &Profile, tree: &SourceTree, schema_dir: &Path) -> Vec<Finding> {
    match profile {
        Profile::SchemaMirror => schema_mirror::check(tree, schema_dir),
        Profile::KindGrouped => kind_grouped::check(tree, schema_dir),
        Profile::FeatureGrouped => feature_grouped::check(tree, schema_dir),
        Profile::FreeForm => free_form::check(tree, schema_dir),
        Profile::Custom(c) => custom::check(c, tree, schema_dir),
    }
}