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

//! Style/FrozenStringLiteralComment.

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

pub struct FrozenStringLiteralComment;

fn is_frozen_magic(line: &str) -> bool {
    let t = line.trim();
    t.starts_with('#')
        && t.contains("frozen_string_literal:")
        && (t.contains("true") || t.contains("false"))
}

fn is_leading_trivia(line: &str) -> bool {
    let t = line.trim();
    t.is_empty() || t.starts_with('#')
}

fn has_frozen_comment(source: &SourceFile) -> bool {
    for line in source.lines() {
        let Ok(s) = std::str::from_utf8(line) else {
            continue;
        };
        if is_frozen_magic(s) {
            return true;
        }
        if !is_leading_trivia(s) {
            break;
        }
    }
    false
}

fn insert_offset(bytes: &[u8]) -> usize {
    if !bytes.starts_with(b"#!") {
        return 0;
    }
    bytes.iter().position(|&b| b == b'\n').map_or(0, |nl| nl + 1)
}

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

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

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

    fn check_lines(
        &self,
        source: &SourceFile,
        config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>,
        corrections: Option<&mut Vec<Correction>>,
    ) {
        if config.get_str("EnforcedStyle", "always") == "never" || source.as_bytes().is_empty() {
            return;
        }
        if has_frozen_comment(source) {
            return;
        }
        let mut diag = self.diagnostic(
            source,
            1,
            0,
            "Missing magic comment # frozen_string_literal: true.".to_string(),
        );
        if let Some(corr) = corrections {
            let start = insert_offset(source.as_bytes());
            corr.push(Correction {
                start,
                end: start,
                replacement: "# frozen_string_literal: true\n".into(),
                cop_name: self.name(),
                cop_index: 0,
            });
            diag.corrected = true;
        }
        diagnostics.push(diag);
    }
}