rubyfast 1.2.3

An ultra-fast Ruby performance linter rewritten in Rust — detects 19 common anti-patterns
Documentation
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
use std::collections::BTreeMap;

use colored::Colorize;

use crate::analyzer::ParseError;
use crate::cli::OutputFormat;
use crate::file_traverser::TraversalResult;
use crate::offense::OffenseKind;

/// Print analysis results using the selected output format.
pub fn print_results(result: &TraversalResult, format: &OutputFormat) {
    match format {
        OutputFormat::File => print_results_by_file(result),
        OutputFormat::Rule => print_results_by_rule(result),
        OutputFormat::Plain => print_results_plain(result),
    }

    if !result.parse_errors.is_empty() {
        print_parse_errors(&result.parse_errors);
    }

    print_statistics(result);
}

/// `--format file` — group offenses by file path.
///
/// ```text
/// app/controllers/concerns/lottery_common.rb
///   L13  Hash#fetch with second argument is slower than Hash#fetch with block
///
/// tests/fixtures/19_for_loop.rb
///   L1   For loop is slower than using each (fixable)
/// ```
fn print_results_by_file(result: &TraversalResult) {
    for analysis in &result.results {
        if analysis.offenses.is_empty() {
            continue;
        }
        println!("{}", analysis.path.bold());
        for offense in &analysis.offenses {
            let fixable_tag = if offense.kind.is_fixable() {
                format!(" {}", "(fixable)".green())
            } else {
                String::new()
            };
            println!(
                "  {}  {}{}",
                format!("L{}", offense.line).cyan(),
                offense.kind.explanation(),
                fixable_tag
            );
        }
        println!();
    }
}

/// `--format rule` — group offenses by rule kind.
///
/// ```text
/// Hash#fetch with second argument is slower than Hash#fetch with block. (5 offenses)
///   app/controllers/api/v1/health_articles_controller.rb:11
///   app/controllers/concerns/lottery_common.rb:13
/// ```
fn print_results_by_rule(result: &TraversalResult) {
    let mut grouped: BTreeMap<OffenseKind, Vec<(String, usize)>> = BTreeMap::new();

    for analysis in &result.results {
        for offense in &analysis.offenses {
            grouped
                .entry(offense.kind)
                .or_default()
                .push((analysis.path.clone(), offense.line));
        }
    }

    for (kind, locations) in &grouped {
        let count = locations.len();
        println!(
            "{} ({} {})",
            kind.explanation().yellow(),
            count,
            pluralize("offense", count)
        );
        for (path, line) in locations {
            println!("  {}:{}", path, line);
        }
        println!();
    }
}

/// `--format plain` — one offense per line (original format, for grep/reviewdog).
///
/// ```text
/// app/controllers/api/v1/health_articles_controller.rb:11 Hash#fetch with second argument ...
/// ```
fn print_results_plain(result: &TraversalResult) {
    for analysis in &result.results {
        if analysis.offenses.is_empty() {
            continue;
        }
        for offense in &analysis.offenses {
            let location = format!("{}:{}", analysis.path, offense.line);
            println!("{} {}.", location.red(), offense.kind.explanation());
        }
        println!();
    }
}

fn print_parse_errors(errors: &[ParseError]) {
    println!(
        "rubyfast was unable to process some files because the\n\
         internal parser is not able to read some characters or\n\
         has timed out. Unprocessable files were:"
    );
    println!("-----------------------------------------------------");
    for err in errors {
        println!("{} - {}", err.path, err.message);
    }
    println!();
}

fn print_statistics(result: &TraversalResult) {
    let files = result.files_inspected;
    let offenses = result.total_offenses();
    let parse_errors = result.parse_errors.len();
    let fixable: usize = result
        .results
        .iter()
        .flat_map(|r| &r.offenses)
        .filter(|o| o.kind.is_fixable())
        .count();

    let files_str = format!("{} {} inspected", files, pluralize("file", files));

    let offenses_str = format!("{} {} detected", offenses, pluralize("offense", offenses));

    let colored_offenses = if offenses == 0 {
        offenses_str.green().to_string()
    } else {
        offenses_str.red().to_string()
    };

    let fixable_hint = if fixable > 0 {
        format!(
            ", {}",
            format!(
                "{} {} autocorrectable (run rubyfast --fix)",
                fixable,
                pluralize("offense", fixable)
            )
            .yellow()
        )
    } else {
        String::new()
    };

    if parse_errors > 0 {
        let errors_str = format!(
            "{} unparsable {} found",
            parse_errors,
            pluralize("file", parse_errors)
        );
        println!(
            "{}, {}, {}{}",
            files_str.green(),
            colored_offenses,
            errors_str.red(),
            fixable_hint
        );
    } else {
        println!(
            "{}, {}{}",
            files_str.green(),
            colored_offenses,
            fixable_hint
        );
    }
}

/// Print results when --fix mode is active.
pub fn print_fix_results(
    result: &TraversalResult,
    total_fixed: usize,
    total_errors: usize,
    format: &OutputFormat,
) {
    // Print unfixable offenses using the selected format
    let unfixable_result = filter_unfixable(result);
    match format {
        OutputFormat::File => print_results_by_file(&unfixable_result),
        OutputFormat::Rule => print_results_by_rule(&unfixable_result),
        OutputFormat::Plain => print_results_plain(&unfixable_result),
    }

    if !result.parse_errors.is_empty() {
        print_parse_errors(&result.parse_errors);
    }

    print_fix_statistics(result, total_fixed, total_errors);
}

/// Build a TraversalResult containing only unfixable offenses.
fn filter_unfixable(result: &TraversalResult) -> TraversalResult {
    use crate::analyzer::AnalysisResult;

    let results = result
        .results
        .iter()
        .map(|analysis| {
            let offenses = analysis
                .offenses
                .iter()
                .filter(|o| o.fix.is_none())
                .cloned()
                .collect();
            AnalysisResult {
                path: analysis.path.clone(),
                offenses,
            }
        })
        .collect();

    TraversalResult {
        results,
        parse_errors: vec![],
        files_inspected: result.files_inspected,
    }
}

fn print_fix_statistics(result: &TraversalResult, total_fixed: usize, total_errors: usize) {
    let files = result.files_inspected;
    let offenses = result.total_offenses();
    let fixable: usize = result
        .results
        .iter()
        .flat_map(|r| &r.offenses)
        .filter(|o| o.fix.is_some())
        .count();

    let files_str = format!("{} {} inspected", files, pluralize("file", files));
    let offenses_str = format!("{} {} detected", offenses, pluralize("offense", offenses));
    let fixed_str = format!(
        "{} {} fixed",
        total_fixed,
        pluralize("offense", total_fixed)
    );

    let colored_offenses = if offenses == 0 {
        offenses_str.green().to_string()
    } else {
        offenses_str.red().to_string()
    };

    let colored_fixed = if total_fixed > 0 {
        fixed_str.green().to_string()
    } else {
        fixed_str.to_string()
    };

    let unfixable = offenses.saturating_sub(fixable);
    if total_errors > 0 {
        let err_str = format!(
            "{} {} skipped (syntax error after fix)",
            total_errors,
            pluralize("file", total_errors)
        );
        println!(
            "{}, {}, {}, {}",
            files_str.green(),
            colored_offenses,
            colored_fixed,
            err_str.yellow()
        );
    } else if unfixable > 0 {
        let unfixable_str = format!(
            "{} {} cannot be auto-fixed",
            unfixable,
            pluralize("offense", unfixable)
        );
        println!(
            "{}, {}, {}, {}",
            files_str.green(),
            colored_offenses,
            colored_fixed,
            unfixable_str.yellow()
        );
    } else {
        println!(
            "{}, {}, {}",
            files_str.green(),
            colored_offenses,
            colored_fixed
        );
    }
}

fn pluralize(word: &str, count: usize) -> String {
    if count == 1 {
        word.to_string()
    } else {
        format!("{}s", word)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::analyzer::AnalysisResult;
    use crate::fix::Fix;
    use crate::offense::{Offense, OffenseKind};

    #[test]
    fn pluralize_singular() {
        assert_eq!(pluralize("file", 1), "file");
    }

    #[test]
    fn pluralize_plural() {
        assert_eq!(pluralize("file", 0), "files");
        assert_eq!(pluralize("offense", 2), "offenses");
    }

    fn make_result(offenses: Vec<Offense>) -> TraversalResult {
        TraversalResult {
            results: vec![AnalysisResult {
                path: "test.rb".to_string(),
                offenses,
            }],
            parse_errors: vec![],
            files_inspected: 1,
        }
    }

    #[test]
    fn filter_unfixable_keeps_only_no_fix() {
        let offenses = vec![
            Offense::new(OffenseKind::GsubVsTr, 1),
            Offense::with_fix(OffenseKind::ForLoopVsEach, 2, Fix::single(0, 3, "x")),
            Offense::new(OffenseKind::SortVsSortBy, 3),
        ];
        let result = make_result(offenses);
        let filtered = filter_unfixable(&result);
        assert_eq!(filtered.results[0].offenses.len(), 2);
        assert!(filtered.results[0].offenses.iter().all(|o| o.fix.is_none()));
    }

    #[test]
    fn filter_unfixable_empty_when_all_fixable() {
        let offenses = vec![Offense::with_fix(
            OffenseKind::ForLoopVsEach,
            1,
            Fix::single(0, 3, "x"),
        )];
        let result = make_result(offenses);
        let filtered = filter_unfixable(&result);
        assert_eq!(filtered.results[0].offenses.len(), 0);
    }

    #[test]
    fn print_results_by_file_no_panic() {
        let result = make_result(vec![Offense::new(OffenseKind::GsubVsTr, 5)]);
        print_results_by_file(&result);
    }

    #[test]
    fn print_results_by_file_empty_no_panic() {
        let result = make_result(vec![]);
        print_results_by_file(&result);
    }

    #[test]
    fn print_results_by_rule_no_panic() {
        let result = make_result(vec![
            Offense::new(OffenseKind::GsubVsTr, 5),
            Offense::new(OffenseKind::GsubVsTr, 10),
        ]);
        print_results_by_rule(&result);
    }

    #[test]
    fn print_results_plain_no_panic() {
        let result = make_result(vec![Offense::new(OffenseKind::GsubVsTr, 5)]);
        print_results_plain(&result);
    }

    #[test]
    fn print_results_plain_empty_no_panic() {
        let result = make_result(vec![]);
        print_results_plain(&result);
    }

    #[test]
    fn print_statistics_no_offenses() {
        let result = make_result(vec![]);
        print_statistics(&result);
    }

    #[test]
    fn print_statistics_with_offenses() {
        let result = make_result(vec![Offense::new(OffenseKind::GsubVsTr, 5)]);
        print_statistics(&result);
    }

    #[test]
    fn print_statistics_with_parse_errors() {
        let result = TraversalResult {
            results: vec![],
            parse_errors: vec![ParseError {
                path: "bad.rb".to_string(),
                message: "syntax error".to_string(),
            }],
            files_inspected: 1,
        };
        print_statistics(&result);
    }

    #[test]
    fn print_parse_errors_no_panic() {
        let errors = vec![ParseError {
            path: "bad.rb".to_string(),
            message: "oops".to_string(),
        }];
        print_parse_errors(&errors);
    }

    #[test]
    fn print_results_dispatches_all_formats() {
        let result = make_result(vec![Offense::new(OffenseKind::GsubVsTr, 1)]);
        print_results(&result, &OutputFormat::File);
        print_results(&result, &OutputFormat::Rule);
        print_results(&result, &OutputFormat::Plain);
    }

    #[test]
    fn print_fix_results_no_panic() {
        let offenses = vec![
            Offense::new(OffenseKind::GsubVsTr, 1),
            Offense::with_fix(OffenseKind::ForLoopVsEach, 2, Fix::single(0, 3, "x")),
        ];
        let result = make_result(offenses);
        print_fix_results(&result, 1, 0, &OutputFormat::File);
    }

    #[test]
    fn print_fix_results_with_errors() {
        let offenses = vec![Offense::with_fix(
            OffenseKind::ForLoopVsEach,
            1,
            Fix::single(0, 3, "x"),
        )];
        let result = make_result(offenses);
        print_fix_results(&result, 0, 1, &OutputFormat::File);
    }

    #[test]
    fn print_fix_results_all_fixed() {
        let offenses = vec![Offense::with_fix(
            OffenseKind::ForLoopVsEach,
            1,
            Fix::single(0, 3, "x"),
        )];
        let result = make_result(offenses);
        print_fix_results(&result, 1, 0, &OutputFormat::File);
    }

    #[test]
    fn print_fix_results_unfixable_remaining() {
        let offenses = vec![
            Offense::new(OffenseKind::GsubVsTr, 1),
            Offense::with_fix(OffenseKind::ForLoopVsEach, 2, Fix::single(0, 3, "x")),
        ];
        let result = make_result(offenses);
        print_fix_results(&result, 1, 0, &OutputFormat::Rule);
        print_fix_results(&result, 1, 0, &OutputFormat::Plain);
    }
}