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

//! Style/RegexpLiteral.

mod rewrite;

use tree_sitter::Node;

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

use rewrite::{delimiter_pair_ok, regex_body, rewrite_regexp, split_body_flags, PREFERRED_CLOSE, PREFERRED_OPEN};

pub struct RegexpLiteral;

impl Cop for RegexpLiteral {
    fn name(&self) -> &'static str {
        "Style/RegexpLiteral"
    }

    fn supports_autocorrect(&self) -> bool {
        true
    }

    fn interested_node_kinds(&self) -> &'static [&'static str] {
        &["regex"]
    }

    fn check_node(
        &self,
        source: &SourceFile,
        node: Node<'_>,
        config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>,
        mut corrections: Option<&mut Vec<Correction>>,
    ) {
        let style = config.get_str("EnforcedStyle", "slashes");
        let allow_inner = config.get_bool("AllowInnerSlashes", false);
        let b = node_bytes(source, node);
        let is_pct = b.starts_with(b"%r");
        let is_slash = b.starts_with(b"/");
        if !is_pct && !is_slash {
            return;
        }
        let want_percent = want_percent_r(source, node, b, style, allow_inner);
        if is_slash && want_percent && percent_r_delimiters_conflict(b) {
            return;
        }
        report(self, source, node, b, is_slash, is_pct, want_percent, diagnostics, &mut corrections);
    }
}

fn want_percent_r(
    source: &SourceFile,
    node: Node<'_>,
    bytes: &[u8],
    style: &str,
    allow_inner: bool,
) -> bool {
    let multiline = source.offset_to_line_col(node.start_byte()).0
        != source.offset_to_line_col(node.end_byte().saturating_sub(1)).0;
    let disallowed_slash = !allow_inner && regex_body(bytes).contains(&b'/');
    style == "percent_r"
        || (style == "mixed" && (multiline || disallowed_slash))
        || (style != "percent_r" && style != "mixed" && disallowed_slash)
}

fn percent_r_delimiters_conflict(bytes: &[u8]) -> bool {
    let Some(body) = split_body_flags(bytes).map(|(body, _)| body) else {
        return true;
    };
    !delimiter_pair_ok(&body, PREFERRED_OPEN, PREFERRED_CLOSE)
}

fn report(
    cop: &RegexpLiteral,
    source: &SourceFile,
    node: Node<'_>,
    bytes: &[u8],
    is_slash: bool,
    is_pct: bool,
    want_percent: bool,
    diagnostics: &mut Vec<Diagnostic>,
    corrections: &mut Option<&mut Vec<Correction>>,
) {
    let msg = if is_slash && want_percent {
        "Use `%r` around regular expression."
    } else if is_pct && !want_percent {
        "Use `//` around regular expression."
    } else {
        return;
    };
    let (line, col) = source.offset_to_line_col(node.start_byte());
    let mut diag = cop.diagnostic(source, line, col, msg.to_string());
    push_fix(cop, node, bytes, want_percent, corrections, &mut diag);
    diagnostics.push(diag);
}

fn push_fix(
    cop: &RegexpLiteral,
    node: Node<'_>,
    bytes: &[u8],
    to_percent: bool,
    corrections: &mut Option<&mut Vec<Correction>>,
    diag: &mut Diagnostic,
) {
    let Some(corr) = corrections.as_mut() else {
        return;
    };
    let Some(replacement) = rewrite_regexp(bytes, to_percent) else {
        return;
    };
    corr.push(Correction {
        start: node.start_byte(),
        end: node.end_byte(),
        replacement,
        cop_name: cop.name(),
        cop_index: 0,
    });
    diag.corrected = true;
}

#[cfg(test)]
mod tests {
    use super::*;
    crate::cop_fixture_tests!(RegexpLiteral, "cops/style/regexp_literal");
}