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

use tree_sitter::Node;

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

/// Lint/IneffectiveAccessModifier — private/protected before defs of self.
pub struct IneffectiveAccessModifier;

fn access_name(source: &SourceFile, node: Node<'_>) -> Option<&'static str> {
    if node.kind() != "identifier" {
        return None;
    }
    match node_bytes(source, node) {
        b"private" => Some("private"),
        b"protected" => Some("protected"),
        b"public" => Some("public"),
        _ => None,
    }
}

fn report_singleton(
    cop: &IneffectiveAccessModifier,
    source: &SourceFile,
    child: Node<'_>,
    line: usize,
    modifier: &str,
    diagnostics: &mut Vec<Diagnostic>,
) {
    if modifier == "public" {
        return;
    }
    let (l, col) = source.offset_to_line_col(child.start_byte());
    diagnostics.push(cop.diagnostic(
        source,
        l,
        col,
        format!(
            "`{modifier}` (on line {line}) does not make singleton methods private. Use `private_class_method` or `private` inside a `class << self` block instead."
        ),
    ));
}

fn scan_body(
    cop: &IneffectiveAccessModifier,
    source: &SourceFile,
    body: Node<'_>,
    diagnostics: &mut Vec<Diagnostic>,
) {
    let mut cur = body.walk();
    let mut current_mod: Option<(usize, &str)> = None;
    for child in body.named_children(&mut cur) {
        if let Some(modifier) = access_name(source, child) {
            let (line, _) = source.offset_to_line_col(child.start_byte());
            current_mod = Some((line, modifier));
            continue;
        }
        if child.kind() != "singleton_method" {
            continue;
        }
        if let Some((line, modifier)) = current_mod {
            report_singleton(cop, source, child, line, modifier, diagnostics);
        }
    }
}

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

    fn default_severity(&self) -> Severity {
        Severity::Warning
    }

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

    fn check_node(
        &self,
        source: &SourceFile,
        node: Node<'_>,
        _config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>,
        _corrections: Option<&mut Vec<crate::correction::Correction>>,
    ) {
        let Some(body) = node.child_by_field_name("body") else {
            return;
        };
        scan_body(self, source, body, diagnostics);
    }
}