alisql 0.2.0

Analyze SQL
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
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

use alisql::sql_analyzer::analyzer::Table;
use clap::{Parser, Subcommand, ValueEnum};

#[derive(Parser)]
#[command(name = "alisql", about = "Analyze SQL files with Jinja2 ref() macros")]
struct Cli {
    #[command(subcommand)]
    command: Commands,
}

#[derive(Subcommand)]
enum Commands {
    /// Show table dependencies extracted from SQL files
    Deps {
        /// Root directory containing SQL files
        dir: String,

        /// Maximum directory depth to search
        #[arg(short, long, default_value_t = 5)]
        max_depth: usize,

        /// Output format
        #[arg(short, long, default_value = "text")]
        format: Format,
    },
    /// Generate a Mermaid dependency graph
    Graph {
        /// Root directory containing SQL files
        dir: String,

        /// Maximum directory depth to search
        #[arg(short, long, default_value_t = 5)]
        max_depth: usize,

        /// Graph orientation
        #[arg(short, long, default_value = "td")]
        orientation: Orientation,
    },
}

#[derive(ValueEnum, Clone)]
enum Format {
    Text,
    Json,
}

#[derive(ValueEnum, Clone)]
enum Orientation {
    Tb,
    Td,
    Bt,
    Rl,
    Lr,
}

impl Orientation {
    fn as_str(&self) -> &'static str {
        match self {
            Orientation::Tb => "TB",
            Orientation::Td => "TD",
            Orientation::Bt => "BT",
            Orientation::Rl => "RL",
            Orientation::Lr => "LR",
        }
    }
}

fn format_deps_text(tables: &[Table]) -> String {
    let mut lines = Vec::new();
    for table in tables {
        lines.push(format!("[{}]", table.table));
        if table.depends_on.is_empty() {
            lines.push("  (no dependencies)".to_string());
        } else {
            for dep in &table.depends_on {
                lines.push(format!("  <- {}", dep));
            }
        }
    }
    lines.join("\n")
}

fn format_deps_json(tables: &[Table]) -> String {
    serde_json::to_string_pretty(tables).unwrap()
}

fn main() {
    let cli = Cli::parse();

    match cli.command {
        Commands::Deps {
            dir,
            max_depth,
            format,
        } => {
            let tables = alisql::get_dependencies(&dir, max_depth);
            let output = match format {
                Format::Json => format_deps_json(&tables),
                Format::Text => format_deps_text(&tables),
            };
            println!("{}", output);
        }
        Commands::Graph {
            dir,
            max_depth,
            orientation,
        } => {
            let graph = alisql::get_mermaid(&dir, orientation.as_str(), max_depth);
            println!("{}", graph);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use alisql::sql_analyzer::analyzer::{Analyzer, RegexSQLAnalyser};
    use std::ffi::OsString;
    use std::str::FromStr;

    fn sample_table() -> Table {
        let path = OsString::from_str("src/sample_sqls/level1/sample.sql").unwrap();
        RegexSQLAnalyser::new(path).get_analized_table()
    }

    #[test]
    fn test_format_deps_text_with_dependencies() {
        let table = sample_table();
        let output = format_deps_text(&[table]);
        assert!(output.contains("[sample]"));
        assert!(output.contains("  <- db.users"));
        assert!(output.contains("  <- role"));
    }

    #[test]
    fn test_format_deps_text_no_dependencies() {
        use alisql::sql_analyzer::analyzer::SQL;
        let sql = SQL::new(
            OsString::from("dummy.sql"),
            "select 1".to_string(),
            "select 1".to_string(),
        );
        let table = Table::new("dummy".to_string(), sql, vec![]);
        let output = format_deps_text(&[table]);
        assert!(output.contains("[dummy]"));
        assert!(output.contains("(no dependencies)"));
    }

    #[test]
    fn test_format_deps_json() {
        let table = sample_table();
        let output = format_deps_json(&[table]);
        let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();
        assert!(parsed.is_array());
        assert_eq!(parsed[0]["table"], "sample");
        assert_eq!(parsed[0]["depends_on"][0], "db.users");
        assert_eq!(parsed[0]["depends_on"][1], "role");
    }

    #[test]
    fn test_orientation_as_str() {
        assert_eq!(Orientation::Td.as_str(), "TD");
        assert_eq!(Orientation::Lr.as_str(), "LR");
        assert_eq!(Orientation::Bt.as_str(), "BT");
        assert_eq!(Orientation::Rl.as_str(), "RL");
        assert_eq!(Orientation::Tb.as_str(), "TB");
    }
}