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

use ahash::AHashMap;
use itertools::Itertools;

use crate::core::config::Value;
use crate::core::rules::base::{ErasedRule, LintFix, LintResult, Rule};
use crate::core::rules::context::RuleContext;
use crate::core::rules::crawlers::{Crawler, RootOnlyCrawler};
use crate::utils::functional::segments::Segments;

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

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

    fn name(&self) -> &'static str {
        "layout.start_of_file"
    }

    fn description(&self) -> &'static str {
        "Files must not begin with newlines or whitespace."
    }

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        let mut raw_segments = Vec::new();

        for seg in context.segment.recursive_crawl_all(false) {
            if !seg.segments().is_empty() {
                continue;
            }

            if matches!(seg.get_type(), "newline" | "whitespace" | "indent" | "dedent") {
                raw_segments.push(seg);
                continue;
            }

            let raw_stack =
                Segments::from_vec(raw_segments.clone(), context.templated_file.clone());
            // Non-whitespace segment.
            if !raw_stack.all(Some(|seg| seg.is_meta())) {
                return vec![LintResult::new(
                    context.segment.into(),
                    raw_stack.into_iter().map(LintFix::delete).collect_vec(),
                    None,
                    None,
                    None,
                )];
            } else {
                break;
            }
        }

        Vec::new()
    }

    fn crawl_behaviour(&self) -> Crawler {
        RootOnlyCrawler.into()
    }
}

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

    fn rules() -> Vec<ErasedRule> {
        vec![RuleLT13::default().erased()]
    }

    #[test]
    fn test_pass_leading_whitespace_statement() {
        let lints =
            lint("SELECT foo FROM bar\n".into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    fn test_pass_leading_whitespace_comment() {
        let lints = lint(
            "/*I am a comment*/\nSELECT foo FROM bar\n".into(),
            "ansi".into(),
            rules(),
            None,
            None,
        )
        .unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    fn test_pass_leading_whitespace_inline_comment() {
        let lints = lint(
            "--I am a comment\nSELECT foo FROM bar\n".into(),
            "ansi".into(),
            rules(),
            None,
            None,
        )
        .unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    #[ignore = "dialect: bigquery"]
    fn test_pass_leading_whitespace_inline_comment_hash() {}

    #[test]
    fn test_pass_leading_whitespace_jinja_comment() {
        let lints = lint(
            "{# I am a comment #}\nSELECT foo FROM bar\n".into(),
            "ansi".into(),
            rules(),
            None,
            None,
        )
        .unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    fn test_pass_leading_whitespace_jinja_if() {
        let lints = lint(
            "{% if True %}\nSELECT foo\nFROM bar;\n{% endif %}\n".into(),
            "ansi".into(),
            rules(),
            None,
            None,
        )
        .unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    fn test_pass_leading_whitespace_jinja_for() {
        let lints = lint(
            "{% for item in range(10) %}\nSELECT foo_{{ item }}\nFROM bar;\n{% endfor %}\n".into(),
            "ansi".into(),
            rules(),
            None,
            None,
        )
        .unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    fn test_fail_leading_whitespace_statement() {
        let fixed = fix("\n  SELECT foo FROM bar\n".into(), rules());
        assert_eq!(fixed, "SELECT foo FROM bar\n");
    }

    #[test]
    fn test_fail_leading_whitespace_comment() {
        let fixed = fix("\n  /*I am a comment*/\nSELECT foo FROM bar\n".into(), rules());
        assert_eq!(fixed, "/*I am a comment*/\nSELECT foo FROM bar\n");
    }

    #[test]
    fn test_fail_leading_whitespace_inline_comment() {
        let fixed = fix("\n  --I am a comment\nSELECT foo FROM bar\n".into(), rules());
        assert_eq!(fixed, "--I am a comment\nSELECT foo FROM bar\n");
    }

    #[test]
    fn test_fail_leading_whitespace_jinja_comment() {
        let fixed = fix("\n  {# I am a comment #}\nSELECT foo FROM bar\n".into(), rules());
        assert_eq!(fixed, "{# I am a comment #}\nSELECT foo FROM bar\n");
    }

    #[test]
    fn test_fail_leading_whitespace_jinja_if() {
        let fixed = fix("\n  {% if True %}\nSELECT foo\nFROM bar;\n{% endif %}\n".into(), rules());
        assert_eq!(fixed, "{% if True %}\nSELECT foo\nFROM bar;\n{% endif %}\n");
    }

    #[test]
    fn test_fail_leading_whitespace_jinja_for() {
        let fixed = fix(
            "\n  {% for item in range(10) %}\nSELECT foo_{{ item }}\nFROM bar;\n{% endfor %}\n"
                .into(),
            rules(),
        );
        assert_eq!(
            fixed,
            "{% for item in range(10) %}\nSELECT foo_{{ item }}\nFROM bar;\n{% endfor %}\n"
        );
    }
}