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

use ahash::AHashMap;

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

fn get_trailing_newlines(segment: &ErasedSegment) -> Vec<ErasedSegment> {
    let mut result = Vec::new();

    for seg in segment.recursive_crawl_all(true) {
        if seg.is_type("newline") {
            result.push(seg.clone_box());
        } else if !seg.is_whitespace() && !seg.is_type("dedent") && !seg.is_type("end_of_file") {
            break;
        }
    }

    result
}

fn get_last_segment(mut segment: Segments) -> (Vec<ErasedSegment>, Segments) {
    let mut parent_stack = Vec::new();

    loop {
        let children = segment.children(None);

        if !children.is_empty() {
            parent_stack.push(segment.first().unwrap().clone_box());
            segment = children.find_last(Some(|s| !s.is_type("end_of_file")));
        } else {
            return (parent_stack, segment);
        }
    }
}

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

impl Rule for RuleLT12 {
    fn load_from_config(&self, _config: &AHashMap<String, Value>) -> ErasedRule {
        RuleLT12::default().erased()
    }

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

    fn description(&self) -> &'static str {
        "Files must end with a single trailing newline."
    }

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        let (parent_stack, segment) =
            get_last_segment(FunctionalContext::new(context.clone()).segment());

        if segment.is_empty() {
            return Vec::new();
        }

        let trailing_newlines = Segments::from_vec(get_trailing_newlines(&context.segment), None);
        if trailing_newlines.is_empty() {
            let fix_anchor_segment = if parent_stack.len() == 1 {
                segment.first().unwrap().clone_box()
            } else {
                parent_stack[1].clone()
            };

            vec![LintResult::new(
                segment.first().unwrap().clone_box().into(),
                vec![LintFix::create_after(
                    fix_anchor_segment,
                    vec![NewlineSegment::create("\n", &<_>::default(), <_>::default())],
                    None,
                )],
                None,
                None,
                None,
            )]
        } else if trailing_newlines.len() > 1 {
            vec![LintResult::new(
                segment.first().unwrap().clone_box().into(),
                trailing_newlines.into_iter().skip(1).map(|d| LintFix::delete(d.clone())).collect(),
                None,
                None,
                None,
            )]
        } else {
            vec![]
        }
    }

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

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

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

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

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

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

    #[test]
    fn test_pass_templated_plus_raw_newlines() {
        let lints = lint("{{ '\n\n' }}\n".into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    fn test_fail_templated_plus_raw_newlines() {
        let fixed = fix("{{ '\n\n' }}".into(), rules());
        assert_eq!(fixed, "{{ '\n\n' }}\n");
    }

    #[test]
    fn test_fail_templated_plus_raw_newlines_extra_newline() {
        let fixed = fix("{{ '\n\n' }}\n\n".into(), rules());
        assert_eq!(fixed, "{{ '\n\n' }}\n");
    }

    #[test]
    #[ignore = "parser needs further development"]
    fn test_pass_templated_macro_newlines() {
        let macro_code = "{% macro get_keyed_nulls(columns) %}\n  {{ columns }}\n{% endmacro \
                          %}\nSELECT {{ get_keyed_nulls(\"other_id\") }}";
        let lints = lint(macro_code.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(lints, []);
    }

    #[test]
    fn test_fail_templated_no_newline() {
        let fixed = fix("{% if true %}\nSELECT 1 + 1\n{%- endif %}".into(), rules());
        assert_eq!(fixed, "{% if true %}\nSELECT 1 + 1\n{%- endif %}\n");
    }
}