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
use ahash::AHashMap;

use super::CP01::RuleCP01;
use crate::core::config::Value;
use crate::core::rules::base::{Erased, ErasedRule, LintResult, Rule, RuleGroups};
use crate::core::rules::context::RuleContext;
use crate::core::rules::crawlers::{Crawler, SegmentSeekerCrawler};
use crate::dialects::{SyntaxKind, SyntaxSet};

#[derive(Debug, Clone)]
pub struct RuleCP03 {
    base: RuleCP01,
}

impl Default for RuleCP03 {
    fn default() -> Self {
        Self {
            base: RuleCP01 {
                skip_literals: false,
                exclude_parent_types: &[],
                ..Default::default()
            },
        }
    }
}

impl Rule for RuleCP03 {
    fn load_from_config(&self, _config: &AHashMap<String, Value>) -> Result<ErasedRule, String> {
        Ok(RuleCP03 {
            base: RuleCP01 {
                capitalisation_policy: _config["extended_capitalisation_policy"]
                    .as_string()
                    .unwrap()
                    .into(),
                description_elem: "Function names",
                ..Default::default()
            },
        }
        .erased())
    }

    fn name(&self) -> &'static str {
        "capitalisation.functions"
    }

    fn description(&self) -> &'static str {
        "Inconsistent capitalisation of function names."
    }

    fn long_description(&self) -> &'static str {
        r#"
**Anti-pattern**

In this example, the two `SUM` functions don’t have the same capitalisation.

```sql
SELECT
    sum(a) AS aa,
    SUM(b) AS bb
FROM foo
```

**Best practice**

Make the case consistent.


```sql
SELECT
    sum(a) AS aa,
    sum(b) AS bb
FROM foo
```
"#
    }

    fn groups(&self) -> &'static [RuleGroups] {
        &[RuleGroups::All, RuleGroups::Core, RuleGroups::Capitalisation]
    }

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        self.base.eval(context)
    }

    fn is_fix_compatible(&self) -> bool {
        true
    }

    fn crawl_behaviour(&self) -> Crawler {
        SegmentSeekerCrawler::new(const { SyntaxSet::new(&[
            SyntaxKind::FunctionNameIdentifier,
            SyntaxKind::BareFunction,
        ]) })
        .into()
    }
}

#[cfg(test)]
mod tests {
    use pretty_assertions::assert_eq;

    use super::RuleCP03;
    use crate::api::simple::fix;
    use crate::core::rules::base::Erased;
    use crate::rules::capitalisation::CP01::RuleCP01;

    #[test]
    fn test_fail_inconsistent_function_capitalisation_1() {
        let fail_str = "SELECT MAX(id), min(id) from table;";
        let fix_str = "SELECT MAX(id), MIN(id) from table;";

        let actual = fix(fail_str, vec![RuleCP03::default().erased()]);
        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_fail_inconsistent_function_capitalisation_2() {
        let fail_str = "SELECT MAX(id), min(id) from table;";
        let fix_str = "SELECT max(id), min(id) from table;";

        let actual = fix(
            fail_str,
            vec![
                RuleCP03 {
                    base: RuleCP01 { capitalisation_policy: "lower".into(), ..Default::default() },
                }
                .erased(),
            ],
        );

        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_bare_functions_3() {
        let fail_str = "SELECT current_timestamp, min(a) from table;";
        let fix_str = "SELECT Current_Timestamp, Min(a) from table;";

        let actual = fix(
            fail_str,
            vec![
                RuleCP03 {
                    base: RuleCP01 { capitalisation_policy: "pascal".into(), ..Default::default() },
                }
                .erased(),
            ],
        );

        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_fail_capitalization_after_comma() {
        let fail_str = "SELECT FLOOR(dt) ,count(*) FROM test;";
        let fix_str = "SELECT FLOOR(dt) ,COUNT(*) FROM test;";

        let actual = fix(fail_str, vec![RuleCP03::default().erased()]);
        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_pass_fully_qualified_function_mixed_functions() {
        let pass_str = "SELECT COUNT(*), project1.foo(value1) AS value2;";

        let actual = fix(pass_str, vec![RuleCP03::default().erased()]);
        assert_eq!(pass_str, actual);
    }

    #[test]
    fn test_pass_fully_qualified_function_pascal_case() {
        let pass_str = "SELECT project1.FoO(value1) AS value2";

        let actual = fix(pass_str, vec![RuleCP03::default().erased()]);
        assert_eq!(pass_str, actual);
    }
}