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

//! `inherit_gem` config loading.

use std::collections::{HashMap, HashSet};
use std::path::{Path, PathBuf};

use anyhow::{Context, Result};
use serde_yml::Value;

use super::gem_path::{self, GemConfigSrc};
use super::load_recursive::{load_config_recursive, load_config_recursive_inner};
use super::load_require::collect_yaml_strings;
use super::merge::merge_layer_into;
use super::types::ConfigLayer;

fn load_inherit_gem_yaml(
    gem_name: &str,
    rel_path: &str,
    working_dir: &Path,
    visited: &mut HashSet<PathBuf>,
    gem_cache: Option<&HashMap<String, PathBuf>>,
) -> Result<ConfigLayer> {
    // Unknown → bundle path (hard error if missing).
    let src = gem_path::resolve_gem_config(gem_name, rel_path, working_dir, gem_cache)
        .with_context(|| format!("Unable to find gem {gem_name}; is the gem installed?"))?;
    match src {
        GemConfigSrc::Disk(root) => {
            let full_path = root.join(rel_path);
            load_config_recursive(&full_path, working_dir, visited, gem_cache).with_context(|| {
                format!(
                    "inherit_gem: failed to load config {} from gem '{gem_name}'",
                    full_path.display()
                )
            })
        }
        GemConfigSrc::Embed { version, yaml } => {
            let path = gem_path::virtual_config_path(gem_name, &version, rel_path);
            // Do NOT make excludes absolute to a gem dir — patterns stay project-relative.
            load_config_recursive_inner(&path, working_dir, visited, gem_cache, Some(yaml))
                .with_context(|| {
                    format!("inherit_gem: failed to load config {rel_path} from gem '{gem_name}'")
                })
        }
    }
}

/// Resolve `inherit_gem` entries to config layers.
pub(crate) fn resolve_inherit_gem(
    gem_name: &str,
    paths_value: &Value,
    working_dir: &Path,
    visited: &mut HashSet<PathBuf>,
    gem_cache: Option<&HashMap<String, PathBuf>>,
) -> Result<Vec<ConfigLayer>> {
    let mut layers = Vec::new();
    for rel_path in &collect_yaml_strings(paths_value) {
        layers.push(load_inherit_gem_yaml(
            gem_name,
            rel_path,
            working_dir,
            visited,
            gem_cache,
        )?);
    }
    Ok(layers)
}

fn merge_inherit_layers(base_layer: &mut ConfigLayer, layers: Vec<ConfigLayer>) {
    for layer in layers {
        base_layer
            .user_mentioned_cops
            .extend(layer.user_mentioned_cops.iter().cloned());
        base_layer
            .user_mentioned_depts
            .extend(layer.user_mentioned_depts.iter().cloned());
        base_layer.extend_plugin_excludes(&layer.plugin_excludes);
        merge_layer_into(base_layer, &layer, None);
    }
}

/// Process `inherit_gem:` map entries into `base_layer`.
///
/// Vendored gems use embedded YAML (no install check). Unknown gems resolve
/// via `bundle info --path` and fail hard if missing (RuboCop `Gem::LoadError`).
pub(crate) fn process_inherit_gem(
    map: &serde_yml::Mapping,
    working_dir: &Path,
    visited: &mut HashSet<PathBuf>,
    gem_cache: Option<&HashMap<String, PathBuf>>,
    base_layer: &mut ConfigLayer,
) -> Result<()> {
    let Some(Value::Mapping(gem_map)) = map.get(Value::String("inherit_gem".to_string())) else {
        return Ok(());
    };
    for (gem_key, gem_paths) in gem_map {
        let Some(gem_name) = gem_key.as_str() else {
            continue;
        };
        let layers = resolve_inherit_gem(gem_name, gem_paths, working_dir, visited, gem_cache)?;
        merge_inherit_layers(base_layer, layers);
    }
    Ok(())
}