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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
use ahash::{AHashMap, AHashSet};
use itertools::Itertools;

use crate::core::config::Value;
use crate::core::parser::segments::base::ErasedSegment;
use crate::core::rules::base::{Erased, ErasedRule, LintFix, LintResult, Rule};
use crate::core::rules::context::RuleContext;
use crate::core::rules::crawlers::{Crawler, SegmentSeekerCrawler};
use crate::helpers::capitalize;

fn is_capitalizable(character: char) -> bool {
    character.to_lowercase().ne(character.to_uppercase())
}

#[derive(Debug, Clone)]
pub struct RuleCP01 {
    pub(crate) capitalisation_policy: String,
    pub(crate) cap_policy_name: String,
    pub(crate) skip_literals: bool,
    pub(crate) exclude_parent_types: &'static [&'static str],
}

impl Default for RuleCP01 {
    fn default() -> Self {
        Self {
            capitalisation_policy: "consistent".into(),
            cap_policy_name: "capitalisation_policy".into(),
            skip_literals: true,
            exclude_parent_types: &[
                "data_type",
                "datetime_type_identifier",
                "primitive_type",
                "naked_identifier",
            ],
        }
    }
}

impl Rule for RuleCP01 {
    fn load_from_config(&self, config: &AHashMap<String, Value>) -> ErasedRule {
        RuleCP01 {
            capitalisation_policy: config["capitalisation_policy"].as_string().unwrap().into(),
            ..Default::default()
        }
        .erased()
    }

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

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

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        let parent = context.parent_stack.last().unwrap();

        if (self.skip_literals && context.segment.is_type("literal"))
            || !self.exclude_parent_types.is_empty()
                && self.exclude_parent_types.iter().all(|it| parent.is_type(it))
        {
            return vec![LintResult::new(None, Vec::new(), None, None, None)];
        }

        if parent.get_type() == "function_name" && parent.segments().len() != 1 {
            return vec![LintResult::new(None, Vec::new(), None, None, None)];
        }

        vec![handle_segment(
            &self.capitalisation_policy,
            &self.cap_policy_name,
            context.segment.clone(),
            &context,
        )]
    }

    fn crawl_behaviour(&self) -> Crawler {
        SegmentSeekerCrawler::new(["keyword", "binary_operator", "date_part"].into()).into()
    }
}

#[derive(Clone, Default)]
struct RefutedCases(AHashSet<&'static str>);

#[derive(Clone)]
struct LatestPossibleCase(String);

pub fn handle_segment(
    extended_capitalisation_policy: &str,
    cap_policy_name: &str,
    seg: ErasedSegment,
    context: &RuleContext,
) -> LintResult {
    if seg.get_raw().unwrap().is_empty() {
        return LintResult::new(None, Vec::new(), None, None, None);
    }

    let mut refuted_cases =
        context.memory.borrow().get::<RefutedCases>().cloned().unwrap_or_default().0;

    let mut first_letter_is_lowercase = false;
    for ch in seg.get_raw().unwrap().chars() {
        if is_capitalizable(ch) {
            first_letter_is_lowercase = Some(ch).into_iter().ne(ch.to_uppercase());
            break;
        }
        first_letter_is_lowercase = false;
    }

    if first_letter_is_lowercase {
        refuted_cases.extend(["upper", "capitalise", "pascal"]);
        if seg.get_raw().unwrap() != seg.get_raw().unwrap().to_lowercase() {
            refuted_cases.insert("lower");
        }
    } else {
        refuted_cases.insert("lower");

        let segment_raw = seg.get_raw().unwrap();
        if segment_raw != segment_raw.to_uppercase() {
            refuted_cases.insert("upper");
        }
        if segment_raw
            != segment_raw.to_uppercase().chars().next().unwrap().to_string()
                + segment_raw[1..].to_lowercase().as_str()
        {
            refuted_cases.insert("capitalise");
        }
        if !segment_raw.chars().all(|c| c.is_alphanumeric()) {
            refuted_cases.insert("pascal");
        }
    }

    context.memory.borrow_mut().insert(RefutedCases(refuted_cases.clone()));

    let concrete_policy = if extended_capitalisation_policy == "consistent" {
        let cap_policy_opts = match cap_policy_name {
            "capitalisation_policy" => ["upper", "lower", "capitalise"].as_slice(),
            "extended_capitalisation_policy" => {
                ["upper", "lower", "pascal", "capitalise"].as_slice()
            }
            _ => unimplemented!("Unknown capitalisation policy name: {cap_policy_name}"),
        };

        let possible_cases =
            cap_policy_opts.iter().filter(|&it| !refuted_cases.contains(it)).collect_vec();

        if !possible_cases.is_empty() {
            context.memory.borrow_mut().insert(LatestPossibleCase(possible_cases[0].to_string()));
            return LintResult::new(None, Vec::new(), None, None, None);
        } else {
            context
                .memory
                .borrow()
                .get::<LatestPossibleCase>()
                .cloned()
                .unwrap_or_else(|| LatestPossibleCase("upper".into()))
                .0
        }
    } else {
        extended_capitalisation_policy.to_string()
    };

    let concrete_policy = concrete_policy.as_str();

    let mut fixed_raw = seg.get_raw().unwrap();
    fixed_raw = match concrete_policy {
        "upper" => fixed_raw.to_uppercase(),
        "lower" => fixed_raw.to_lowercase(),
        "capitalise" => capitalize(&fixed_raw),
        "pascal" => {
            let re = lazy_regex::regex!(r"([^a-zA-Z0-9]+|^)([a-zA-Z0-9])([a-zA-Z0-9]*)");
            re.replace_all(&fixed_raw, |caps: &regex::Captures| {
                let mut replacement_string = String::from(&caps[1]);
                let capitalized = caps[2].to_uppercase();
                replacement_string.push_str(&capitalized);
                replacement_string.push_str(&caps[3]);
                replacement_string
            })
            .into()
        }
        _ => fixed_raw,
    };

    if fixed_raw == seg.get_raw().unwrap() {
        LintResult::new(None, Vec::new(), None, None, None)
    } else {
        let consistency = if concrete_policy == "consistent" { "consistently " } else { "" };
        let policy = match concrete_policy {
            concrete_policy @ ("upper" | "lower") => format!("{} case.", concrete_policy),
            "capitalise" => "capitalised.".to_string(),
            "pascal" => "pascal case.".to_string(),
            _ => "".to_string(),
        };

        LintResult::new(
            seg.clone().into(),
            vec![LintFix::replace(seg.clone(), vec![seg.edit(fixed_raw.into(), None)], None)],
            None,
            format!("{} must be {}{}", "Datatypes", consistency, policy).into(),
            None,
        )
    }
}

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

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

    #[test]
    fn test_fail_inconsistent_capitalisation_1() {
        let fail_str = "SeLeCt 1;";
        let fix_str = "SELECT 1;";

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

    #[test]
    fn test_fail_inconsistent_capitalisation_2() {
        let fail_str = "SeLeCt 1 from blah;";
        let fix_str = "SELECT 1 FROM blah;";

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

    #[test]
    fn test_fail_capitalisation_policy_lower() {
        let fail_str = "SELECT * FROM MOO ORDER BY dt DESC;";
        let fix_str = "select * from MOO order by dt desc;";

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

    #[test]
    fn test_fail_capitalisation_policy_upper() {
        let fail_str = "select * from MOO order by dt desc;";
        let fix_str = "SELECT * FROM MOO ORDER BY dt DESC;";

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

        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_fail_capitalisation_policy_capitalise() {
        let fail_str = "SELECT * FROM MOO ORDER BY dt DESC;";
        let fix_str = "Select * From MOO Order By dt Desc;";

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

        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_fail_date_part_inconsistent_capitalisation() {
        let fail_str = "SELECT dt + interval 2 day, interval 3 HOUR;";
        let fix_str = "SELECT dt + INTERVAL 2 DAY, INTERVAL 3 HOUR;";

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

        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_fail_date_part_capitalisation_policy_lower() {
        let fail_str = "SELECT dt + interval 2 day, interval 3 HOUR;";
        let fix_str = "select dt + interval 2 day, interval 3 hour;";

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

        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_fail_date_part_capitalisation_policy_upper() {
        let fail_str = "SELECT dt + interval 2 day, interval 3 HOUR;";
        let fix_str = "SELECT dt + INTERVAL 2 DAY, INTERVAL 3 HOUR;";

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

        assert_eq!(fix_str, actual);
    }

    #[test]
    fn test_pass_date_part_consistent_capitalisation() {
        let pass_str = "SELECT dt + INTERVAL 2 DAY, INTERVAL 3 HOUR;";
        let expected_str = "SELECT dt + INTERVAL 2 DAY, INTERVAL 3 HOUR;";

        let actual = fix(pass_str.into(), vec![RuleCP01::default().erased()]);

        assert_eq!(expected_str, actual);
    }

    #[test]
    fn test_pass_data_type_inconsistent_capitalisation() {
        let pass_str = "CREATE TABLE table1 (account_id bigint);";
        let expected_str = "CREATE TABLE table1 (account_id bigint);";

        let actual = fix(
            pass_str.into(),
            vec![RuleCP01 { capitalisation_policy: "upper".into(), ..Default::default() }.erased()],
        );

        assert_eq!(expected_str, actual);
    }
}