rrubocop 0.8.15

10x faster RuboCop drop-in. Same output format and configs, without maintaining RuboCop gems.
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

//! Layout/ClosingHeredocIndentation.

use tree_sitter::Node;

use crate::cop::layout::report;
use crate::cop::shared;
use crate::cop::{Cop, CopConfig};
use crate::correction::Correction;
use crate::diagnostic::Diagnostic;
use crate::parse::source::SourceFile;

pub struct ClosingHeredocIndentation;

fn root_of(node: Node<'_>) -> Node<'_> {
    let mut x = node;
    while let Some(p) = x.parent() { x = p; }
    x
}

fn consider_end<'a>(
    source: &SourceFile, node: Node<'a>, after: usize, delim: &str, best: &mut Option<Node<'a>>,
) {
    if node.kind() != "heredoc_end" || node.start_byte() <= after { return; }
    if shared::node_text(source, node).trim() != delim { return; }
    let replace = match *best {
        None => true,
        Some(prev) => node.start_byte() < prev.start_byte(),
    };
    if replace { *best = Some(node); }
}

fn walk<'a>(
    source: &SourceFile, node: Node<'a>, after: usize, delim: &str, best: &mut Option<Node<'a>>,
) {
    consider_end(source, node, after, delim, best);
    let mut cur = node.walk();
    for child in node.children(&mut cur) {
        walk(source, child, after, delim, best);
    }
}

fn find_heredoc_end<'a>(
    source: &SourceFile, node: Node<'a>, after: usize, delim: &str,
) -> Option<Node<'a>> {
    let mut best = None;
    walk(source, node, after, delim, &mut best);
    best
}

fn heredoc_type(open_text: &str) -> &str {
    if open_text.starts_with("<<~") {
        "<<~"
    } else if open_text.starts_with("<<-") {
        "<<-"
    } else {
        "<<"
    }
}

fn delim_of(open_text: &str) -> &str {
    open_text
        .trim_start_matches('<')
        .trim_start_matches(['~', '-', '\'', '"'])
        .trim_matches(['\'', '"'])
}

impl Cop for ClosingHeredocIndentation {
    fn name(&self) -> &'static str { "Layout/ClosingHeredocIndentation" }
    fn supports_autocorrect(&self) -> bool { true }
    fn interested_node_kinds(&self) -> &'static [&'static str] { &["heredoc_beginning"] }

    fn check_node(
        &self, source: &SourceFile, node: Node<'_>, _config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>, mut corrections: Option<&mut Vec<Correction>>,
    ) {
        let open_text = shared::node_text(source, node);
        // RuboCop skips plain `<<EOF` (terminator must stay at column 0).
        if heredoc_type(&open_text) == "<<" {
            return;
        }
        let delim = delim_of(&open_text);
        // RuboCop compares leading indent of the *lines*, not the column of `<<~`.
        let open_indent = shared::line_indent(source, node.start_byte());
        let Some(end_n) = find_heredoc_end(source, root_of(node), node.start_byte(), delim) else {
            return;
        };
        if shared::line_indent(source, end_n.start_byte()) == open_indent {
            return;
        }
        report::fix_indent(
            self, source, end_n.start_byte(),
            format!("`{delim}` is not aligned with `{open_text}`."),
            diagnostics, &mut corrections,
            shared::line_indent(source, end_n.start_byte()), open_indent,
        );
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    crate::cop_fixture_tests!(ClosingHeredocIndentation, "cops/layout/closing_heredoc_indentation");
}