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
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

//! Shared empty-line checks for Layout/EmptyLinesAround*Body cops.

use tree_sitter::Node;

use crate::cop::shared;
use crate::cop::Cop;
use crate::correction::Correction;
use crate::diagnostic::Diagnostic;
use crate::parse::source::SourceFile;

struct BodyEdges {
    start_line: usize,
    end_line: usize,
    first_body: usize,
    last_body: usize,
}

fn body_edges(source: &SourceFile, node: Node<'_>) -> Option<BodyEdges> {
    let start_line = shared::node_line(source, node);
    let end_line = shared::end_keyword(node)
        .map(|e| shared::node_line(source, e))
        .unwrap_or_else(|| {
            let (l, _) = source.offset_to_line_col(node.end_byte().saturating_sub(1));
            l
        });
    if end_line <= start_line + 1 {
        return None;
    }
    Some(BodyEdges {
        start_line,
        end_line,
        first_body: start_line + 1,
        last_body: end_line - 1,
    })
}

fn insert_blank(
    cop: &dyn Cop,
    source: &SourceFile,
    line: usize,
    msg: String,
    diagnostics: &mut Vec<Diagnostic>,
    corrections: &mut Option<&mut Vec<Correction>>,
) {
    let mut diag = cop.diagnostic(source, line, 0, msg);
    if let Some(corr) = corrections {
        if let Some(off) = source.line_start(line) {
            corr.push(Correction {
                start: off,
                end: off,
                replacement: "\n".into(),
                cop_name: cop.name(),
                cop_index: 0,
            });
            diag.corrected = true;
        }
    }
    diagnostics.push(diag);
}

fn remove_blank(
    cop: &dyn Cop,
    source: &SourceFile,
    line: usize,
    msg: String,
    diagnostics: &mut Vec<Diagnostic>,
    corrections: &mut Option<&mut Vec<Correction>>,
) {
    let mut diag = cop.diagnostic(source, line, 0, msg);
    if let Some(corr) = corrections {
        if let Some(s) = source.line_start(line) {
            corr.push(Correction {
                start: s,
                end: source.line_start(line + 1).unwrap_or(s),
                replacement: String::new(),
                cop_name: cop.name(),
                cop_index: 0,
            });
            diag.corrected = true;
        }
    }
    diagnostics.push(diag);
}

fn want_empty_edges(
    cop: &dyn Cop,
    source: &SourceFile,
    edges: &BodyEdges,
    label: &str,
    diagnostics: &mut Vec<Diagnostic>,
    corrections: &mut Option<&mut Vec<Correction>>,
) {
    let beginning_blank = shared::line_blank(source, edges.first_body);
    let ending_blank = shared::line_blank(source, edges.last_body);
    if !beginning_blank && edges.first_body < edges.end_line {
        insert_blank(
            cop,
            source,
            edges.first_body,
            format!("Empty line missing at {label} body beginning."),
            diagnostics,
            corrections,
        );
    }
    if !ending_blank && edges.last_body > edges.start_line {
        insert_blank(
            cop,
            source,
            edges.end_line,
            format!("Empty line missing at {label} body end."),
            diagnostics,
            corrections,
        );
    }
}

fn no_empty_edges(
    cop: &dyn Cop,
    source: &SourceFile,
    edges: &BodyEdges,
    label: &str,
    diagnostics: &mut Vec<Diagnostic>,
    corrections: &mut Option<&mut Vec<Correction>>,
) {
    let beginning_blank = shared::line_blank(source, edges.first_body);
    let ending_blank = shared::line_blank(source, edges.last_body);
    if beginning_blank {
        remove_blank(
            cop,
            source,
            edges.first_body,
            format!("Extra empty line detected at {label} body beginning."),
            diagnostics,
            corrections,
        );
    }
    if ending_blank && edges.last_body != edges.first_body {
        remove_blank(
            cop,
            source,
            edges.last_body,
            format!("Extra empty line detected at {label} body end."),
            diagnostics,
            corrections,
        );
    }
}

/// Enforce empty / no-empty lines around a body for the given label.
pub fn check_body(
    cop: &dyn Cop,
    source: &SourceFile,
    node: Node<'_>,
    want_empty: bool,
    label: &str,
    diagnostics: &mut Vec<Diagnostic>,
    corrections: &mut Option<&mut Vec<Correction>>,
) {
    let Some(edges) = body_edges(source, node) else {
        return;
    };
    if want_empty {
        want_empty_edges(cop, source, &edges, label, diagnostics, corrections);
    } else {
        no_empty_edges(cop, source, &edges, label, diagnostics, corrections);
    }
}