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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
use ahash::AHashMap;

use super::CP01::RuleCP01;
use crate::core::config::Value;
use crate::core::dialects::init::DialectKind;
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};
use crate::utils::identifers::identifiers_policy_applicable;

#[derive(Clone, Debug)]
pub struct RuleCP02 {
    base: RuleCP01,
    unquoted_identifiers_policy: &'static str,
}

impl Default for RuleCP02 {
    fn default() -> Self {
        Self {
            base: RuleCP01 {
                cap_policy_name: "extended_capitalisation_policy".into(),
                description_elem: "Unquoted identifiers",
                ..Default::default()
            },
            unquoted_identifiers_policy: "all",
        }
    }
}

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

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

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

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

In this example, unquoted identifier `a` is in lower-case but `B` is in upper-case.

```sql
select
    a,
    B
from foo
```

**Best practice**

Ensure all unquoted identifiers are either in upper-case or in lower-case.

```sql
select
    a,
    b
from foo

-- Also good

select
    A,
    B
from foo
```
"#
    }

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

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        // TODO: add databricks
        if context.dialect.name == DialectKind::Sparksql
            && context
                .parent_stack
                .last()
                .map_or(false, |it| it.get_type() == SyntaxKind::PropertyNameIdentifier)
            && context.segment.raw() == "enableChangeDataFeed"
        {
            return Vec::new();
        }

        if identifiers_policy_applicable(self.unquoted_identifiers_policy, &context.parent_stack) {
            self.base.eval(context)
        } else {
            vec![LintResult::new(None, Vec::new(), None, None, None)]
        }
    }

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

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

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

    use super::RuleCP02;
    use crate::api::simple::fix;
    use crate::core::rules::base::Erased;

    #[test]
    fn test_pass_consistent_capitalisation_1() {
        let pass_str = "SELECT a, b";

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

    #[test]
    fn test_pass_consistent_capitalisation_2() {
        let pass_str = "SELECT A, B";

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

    #[test]
    fn test_pass_consistent_capitalisation_with_null() {
        let pass_str = "SELECT NULL, a";
        let actual = fix(pass_str, vec![RuleCP02::default().erased()]);
        assert_eq!(pass_str, actual);
    }

    #[test]
    fn test_pass_consistent_capitalisation_with_single_letter_upper() {
        let pass_str = "SELECT A, Boo";
        let actual = fix(pass_str, vec![RuleCP02::default().erased()]);
        assert_eq!(pass_str, actual);
    }

    #[test]
    fn test_pass_consistent_capitalisation_with_single_word_snake() {
        let pass_str = "SELECT Apple, Banana_split";
        let actual = fix(pass_str, vec![RuleCP02::default().erased()]);
        assert_eq!(pass_str, actual);
    }

    #[test]
    fn test_pass_consistent_capitalisation_with_single_word_pascal() {
        let pass_str = "SELECT AppleFritter, Banana";
        let actual = fix(pass_str, vec![RuleCP02::default().erased()]);
        assert_eq!(pass_str, actual);
    }

    #[test]
    fn test_pass_consistent_capitalisation_with_multiple_words_with_numbers() {
        let pass_str = "SELECT AppleFritter, Apple123fritter, Apple123Fritter";
        let actual = fix(pass_str, vec![RuleCP02::default().erased()]);
        assert_eq!(pass_str, actual);
    }

    #[test]
    fn test_pass_consistent_capitalisation_with_leading_underscore() {
        let pass_str = "SELECT _a, b";
        let actual = fix(pass_str, vec![RuleCP02::default().erased()]);
        assert_eq!(pass_str, actual);
    }

    #[test]
    fn test_fail_inconsistent_capitalisation_lower_case() {
        // Test that fixes are consistent
        let fail_str = "SELECT a, B";
        let expected = "SELECT a, b";
        let actual = fix(fail_str, vec![RuleCP02::default().erased()]);
        assert_eq!(expected, actual);
    }

    #[test]
    fn test_fail_inconsistent_capitalisation_2() {
        let fail_str = "SELECT B,   a";
        let expected = "SELECT B,   A";

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