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
169
170
171
172
173
174
175
176
177
178
179
180
181
use crate::core::config::Value;
use crate::core::parser::segments::base::ErasedSegment;
use crate::core::rules::base::{Erased, ErasedRule, LintResult, Rule};
use crate::core::rules::context::RuleContext;
use crate::core::rules::crawlers::{Crawler, SegmentSeekerCrawler};
use crate::utils::functional::context::FunctionalContext;

#[derive(Debug, Clone, Default)]
pub struct RuleAL06 {
    min_alias_lenght: Option<usize>,
    max_alias_lenght: Option<usize>,
}

impl RuleAL06 {
    fn lint_aliases(&self, from_expression_elements: Vec<ErasedSegment>) -> Vec<LintResult> {
        let mut violation_buff = Vec::new();

        for from_expression_element in from_expression_elements {
            let table_ref =
                from_expression_element.child(&["table_expression"]).and_then(|table_expression| {
                    table_expression.child(&["object_reference", "table_reference"])
                });

            let Some(_table_ref) = table_ref else {
                return Vec::new();
            };

            let Some(alias_exp_ref) = from_expression_element.child(&["alias_expression"]) else {
                return Vec::new();
            };

            if let Some(min_alias_lenght) = self.min_alias_lenght {
                if let Some(alias_identifier_ref) =
                    alias_exp_ref.child(&["identifier", "naked_identifier"])
                {
                    let alias_identifier = alias_identifier_ref.get_raw().unwrap();
                    if alias_identifier.len() < min_alias_lenght {
                        violation_buff.push(LintResult::new(
                            Some(alias_identifier_ref),
                            Vec::new(),
                            None,
                            format!(
                                "Aliases should be at least '{:?}' character(s) long",
                                self.min_alias_lenght
                            )
                            .into(),
                            None,
                        ))
                    }
                }
            }

            if let Some(max_alias_lenght) = self.max_alias_lenght {
                if let Some(alias_identifier_ref) =
                    alias_exp_ref.child(&["identifier", "naked_identifier"])
                {
                    let alias_identifier = alias_identifier_ref.get_raw().unwrap();

                    if alias_identifier.len() > max_alias_lenght {
                        violation_buff.push(LintResult::new(
                            Some(alias_identifier_ref),
                            Vec::new(),
                            None,
                            format!(
                                "Aliases should be no more than '{:?}' character(s) long.",
                                self.max_alias_lenght
                            )
                            .into(),
                            None,
                        ))
                    }
                }
            }
        }

        violation_buff
    }
}

impl Rule for RuleAL06 {
    fn name(&self) -> &'static str {
        "aliasing.lenght"
    }

    fn description(&self) -> &'static str {
        "Identify aliases in from clause and join conditions"
    }

    fn load_from_config(&self, _config: &ahash::AHashMap<String, Value>) -> ErasedRule {
        RuleAL06::default().erased()
    }

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        let children = FunctionalContext::new(context.clone()).segment().children(None);
        let from_expression_elements = children.recursive_crawl(&["from_expression_element"], true);
        self.lint_aliases(from_expression_elements.base)
    }

    fn crawl_behaviour(&self) -> Crawler {
        SegmentSeekerCrawler::new(["select_statement"].into()).into()
    }
}

#[cfg(test)]
mod tests {
    use crate::api::simple::lint;
    use crate::core::rules::base::{Erased, ErasedRule};
    use crate::rules::aliasing::AL06::RuleAL06;

    fn rules(min_alias_lenght: Option<usize>, max_alias_lenght: Option<usize>) -> Vec<ErasedRule> {
        vec![RuleAL06 { min_alias_lenght, max_alias_lenght }.erased()]
    }

    #[test]
    fn test_pass_no_config() {
        let sql = r#"
        SELECT x.a, x_2.b
            FROM x 
            LEFT JOIN x AS x_2 ON x.foreign_key = x.foreign_key"#;

        let violations = lint(sql.into(), "ansi".into(), rules(None, None), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_fail_alias_too_short() {
        let fail_str = r#"
        SELECT u.id, c.first_name, c.last_name,
            COUNT(o.user_id)
                FROM users AS u
                    JOIN customers AS c ON u.id = c.user_id
                    JOIN orders AS o ON u.id = o.user_id"#;

        let violations =
            lint(fail_str.into(), "ansi".into(), rules(4.into(), None), None, None).unwrap();

        assert_eq!(violations.len(), 3);
    }

    #[test]
    fn test_fail_alias_too_long() {
        let fail_str = r#"
    SELECT u.id, customers_customers_customers.first_name, customers_customers_customers.last_name,
        COUNT(o.user_id)
        FROM users AS u
        JOIN customers AS customers_customers_customers ON u.id = customers_customers_customers.user_id
        JOIN orders AS o ON u.id = o.user_id;"#;

        let violations =
            lint(fail_str.into(), "ansi".into(), rules(None, 10.into()), None, None).unwrap();
        assert_eq!(violations.len(), 1);
    }

    #[test]
    fn test_fail_alias_min_and_max() {
        let fail_str = r#"
    SELECT u.id, customers_customers_customers.first_name, customers_customers_customers.last_name,
        COUNT(o.user_id)
        FROM users AS u
        JOIN customers AS customers_customers_customers ON u.id = customers_customers_customers.user_id
        JOIN orders AS o ON u.id = o.user_id;"#;

        let violations =
            lint(fail_str.into(), "ansi".into(), rules(4.into(), 10.into()), None, None).unwrap();
        assert_eq!(violations.len(), 3);
    }

    #[test]
    fn test_pass_with_config() {
        let pass_str = r#"
    SELECT users.id, customers_customers_customers.first_name, customers_customers_customers.last_name,
        COUNT(latest_orders.user_id)
        FROM users
        JOIN customers AS customers_customers_customers ON users.id = customers_customers_customers.user_id
        JOIN orders AS latest_orders ON users.id = latest_orders.user_id;"#;

        let violations =
            lint(pass_str.into(), "ansi".into(), rules(10.into(), 30.into()), None, None).unwrap();
        assert_eq!(violations, []);
    }
}