rrubocop 0.8.14

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

//! Style/SignalException — prefer raise or fail.

use tree_sitter::Node;

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

pub struct SignalException;

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

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

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

    fn interested_call_names(&self) -> &'static [&'static [u8]] {
        &[b"raise", b"fail", b"signal_exception"]
    }

    fn check_node(
        &self,
        source: &SourceFile,
        node: Node<'_>,
        config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>,
        mut corrections: Option<&mut Vec<Correction>>,
    ) {
        let Some(method) = call_method_name(source, node) else {
            return;
        };
        // `obj.fail` is not Kernel#fail (e.g. AASM `withdraw.fail`).
        if crate::cop::shared::call_receiver(node).is_some() {
            return;
        }
        let Some((bad, good)) = map_style(config.get_str("EnforcedStyle", "only_raise"), method)
        else {
            return;
        };
        report(self, source, node, bad, good, diagnostics, &mut corrections);
    }
}

fn map_style(style: &str, method: &[u8]) -> Option<(&'static str, &'static str)> {
    match (style, method) {
        ("only_raise", b"fail") => Some(("fail", "raise")),
        ("only_fail", b"raise") => Some(("raise", "fail")),
        _ => None,
    }
}

fn report(
    cop: &SignalException,
    source: &SourceFile,
    node: Node<'_>,
    bad: &str,
    good: &str,
    diagnostics: &mut Vec<Diagnostic>,
    corrections: &mut Option<&mut Vec<Correction>>,
) {
    let meth = node
        .child_by_field_name("method")
        .or_else(|| node.child_by_field_name("name"))
        .unwrap_or(node);
    let (line, col) = source.offset_to_line_col(meth.start_byte());
    let mut diag = cop.diagnostic(source, line, col, format!("Use `{good}` instead of `{bad}`."));
    if let Some(corr) = corrections.as_mut() {
        corr.push(Correction {
            start: meth.start_byte(),
            end: meth.end_byte(),
            replacement: good.to_string(),
            cop_name: cop.name(),
            cop_index: 0,
        });
        diag.corrected = true;
    }
    diagnostics.push(diag);
}