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
use crate::core::config::Value;
use crate::core::parser::segments::base::{
    ErasedSegment, WhitespaceSegment, WhitespaceSegmentNewArgs,
};
use crate::core::parser::segments::keyword::KeywordSegment;
use crate::core::rules::base::{ErasedRule, LintResult, Rule};
use crate::core::rules::context::RuleContext;
use crate::core::rules::crawlers::{Crawler, SegmentSeekerCrawler};
use crate::helpers::ToErasedSegment;
use crate::utils::functional::segments::Segments;
use crate::utils::reflow::sequence::{Filter, ReflowSequence};

#[derive(Debug)]
enum CorrectionListItem {
    WhitespaceSegment,
    KeywordSegment(String),
}

type CorrectionList = Vec<CorrectionListItem>;

#[derive(Default, Clone, Debug)]
pub struct RuleCV05 {}

fn create_base_is_null_sequence(is_upper: bool, operator_raw: String) -> CorrectionList {
    let is_seg = CorrectionListItem::KeywordSegment(if is_upper { "IS" } else { "is" }.to_string());
    let not_seg =
        CorrectionListItem::KeywordSegment(if is_upper { "NOT" } else { "not" }.to_string());

    if operator_raw == "=" {
        vec![is_seg]
    } else {
        vec![is_seg, CorrectionListItem::WhitespaceSegment, not_seg]
    }
}

impl Rule for RuleCV05 {
    fn name(&self) -> &'static str {
        "convention.is_null"
    }

    fn description(&self) -> &'static str {
        "Relational operators should not be used to check for NULL values."
    }

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

    fn load_from_config(&self, _config: &ahash::AHashMap<String, Value>) -> ErasedRule {
        unimplemented!()
    }

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        if context.parent_stack.len() >= 2 {
            for type_str in &["set_clause_list", "execute_script_statement", "options_segment"] {
                if context.parent_stack[context.parent_stack.len() - 2].is_type(type_str) {
                    return Vec::new();
                }
            }
        }

        if !context.parent_stack.is_empty() {
            for type_str in &["set_clause_list", "execute_script_statement", "assignment_operator"]
            {
                if context.parent_stack[context.parent_stack.len() - 1].is_type(type_str) {
                    return Vec::new();
                }
            }
        }

        if !context.parent_stack.is_empty()
            && context.parent_stack[context.parent_stack.len() - 1]
                .is_type("exclusion_constraint_element")
        {
            return Vec::new();
        }

        if let Some(raw_consist) = context.segment.get_raw() {
            if !["=", "!=", "<>"].contains(&raw_consist.as_str()) {
                return Vec::new();
            }
        }

        let segment = context.parent_stack.last().unwrap().segments().to_vec();

        let siblings = Segments::from_vec(segment, None);
        let after_op_list = siblings.select(None, None, Some(&context.segment), None);

        let next_code = after_op_list.find_first(Some(|sp: &ErasedSegment| sp.is_code()));

        if !next_code.all(Some(|it| it.is_type("null_literal"))) {
            return Vec::new();
        }

        let sub_seg = next_code.get(0, None);
        let edit = create_base_is_null_sequence(
            sub_seg.as_ref().unwrap().get_raw().unwrap().starts_with('N'),
            context.segment.get_raw().unwrap(),
        );

        let mut seg = Vec::with_capacity(edit.len());

        for item in edit {
            match item {
                CorrectionListItem::KeywordSegment(keyword) => {
                    seg.push(KeywordSegment::new(keyword, None).to_erased_segment());
                }
                CorrectionListItem::WhitespaceSegment => {
                    seg.push(WhitespaceSegment::create(
                        " ",
                        &<_>::default(),
                        WhitespaceSegmentNewArgs,
                    ));
                }
            };
        }

        let fixes = ReflowSequence::from_around_target(
            &context.segment,
            context.parent_stack[0].clone(),
            "both",
            context.config.unwrap(),
        )
        .replace(context.segment.clone(), &seg)
        .respace(false, Filter::All)
        .fixes();

        vec![LintResult::new(Some(context.segment.clone()), fixes, None, None, None)]
    }
}

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

    use crate::api::simple::{fix, lint};
    use crate::core::rules::base::Erased;
    use crate::rules::convention::CV05::RuleCV05;

    #[test]
    fn test_is_null() {
        let pass_str = r#"SELECT a 
                                FROM foo
                                WHERE a IS NULL"#;

        let violations = lint(
            pass_str.to_owned(),
            "ansi".into(),
            vec![RuleCV05::default().erased()],
            None,
            None,
        )
        .unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_is_not_null() {
        let pass_str = r#"SELECT a 
        FROM foo
        WHERE a IS NOT NULL"#;

        let violations = lint(
            pass_str.to_owned(),
            "ansi".into(),
            vec![RuleCV05::default().erased()],
            None,
            None,
        )
        .unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_not_equals_null_upper() {
        let fail_str = "SELECT a FROM foo WHERE a <> NULL";
        let fix_str = "SELECT a FROM foo WHERE a IS NOT NULL";

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

    #[test]
    fn test_not_equals_null_multi_nulls() {
        let fail_str = r#"SELECT a 
                                FROM foo
                                WHERE a <> NULL AND b != NULL AND c = 'foo'"#;

        let fix_str = r#"SELECT a 
                                FROM foo
                                WHERE a IS NOT NULL AND b IS NOT NULL AND c = 'foo'"#;

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

    #[test]
    fn test_not_equals_null_lower() {
        let fail_str = "SELECT a FROM foo WHERE a <> null";
        let fix_str = "SELECT a FROM foo WHERE a is not null";

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

    #[test]
    fn test_equals_null_spaces() {
        let fail_str = r#"SELECT a 
                                FROM foo
                                WHERE a = NULL"#;

        let fix_str = r#"SELECT a 
                                FROM foo
                                WHERE a IS NULL"#;

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

    #[test]
    fn test_equals_null_no_spaces() {
        let fail_str = "SELECT a FROM foo WHERE a=NULL";
        let fix_str = "SELECT a FROM foo WHERE a IS NULL";

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

    #[test]
    fn test_complex_case_1() {
        let fail_str = "SELECT a FROM foo WHERE a = b or (c > d or e = NULL)";
        let fix_str = "SELECT a FROM foo WHERE a = b or (c > d or e IS NULL)";

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

    #[test]
    fn test_set_clause() {
        let pass_str = r#"UPDATE table1 SET col = NULL 
                                WHERE col = """#;

        let violations = lint(
            pass_str.to_owned(),
            "ansi".into(),
            vec![RuleCV05::default().erased()],
            None,
            None,
        )
        .unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    #[ignore]
    fn test_bigquery_set_options() {
        let pass_str = r#"ALTER TABLE table
                                SET OPTIONS (expiration_timestamp = NULL);"#;

        let violations = lint(
            pass_str.to_owned(),
            "bigquery".into(),
            vec![RuleCV05::default().erased()],
            None,
            None,
        )
        .unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    #[ignore]
    fn test_tsql_exec_clause() {
        let pass_str = r#"exec something
                                @param1 = 'blah',
                                @param2 = 'blah',
                                @param3 = null,
                                @param4 = 'blah'"#;

        let violations = lint(
            pass_str.to_owned(),
            "tsql".into(),
            vec![RuleCV05::default().erased()],
            None,
            None,
        )
        .unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    #[ignore]
    fn test_tsql_alternate_alias_syntax() {
        let pass_str = r#"select name = null from t"#;

        let violations = lint(
            pass_str.to_owned(),
            "tsql".into(),
            vec![RuleCV05::default().erased()],
            None,
            None,
        )
        .unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    #[ignore]
    fn test_exclude_constraint() {
        let pass_str = r#"alter table abc add constraint xyz exclude (field WITH =);"#;

        let violations = lint(
            pass_str.to_owned(),
            "postgres".into(),
            vec![RuleCV05::default().erased()],
            None,
            None,
        )
        .unwrap();
        assert_eq!(violations, []);
    }
}