code_passenger 0.6.0

Scans a Rust workspace with klepto and does the writing: feature gates across every crate from one features document, proven by cargo check, Cargo.toml edits, file headers from the plan, and the history of it.
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

//! What code_passenger reads of a package's manifest, and where it finds it.
//!
//! Nothing here parses a `Cargo.toml`: the features, the dependencies and
//! which features enable which optional dependency are klepto's feature model
//! (cargo metadata underneath); the packages and their manifest paths are
//! klepto's `PackageInfo`. The only manifest code_passenger touches as TOML is
//! the one it edits (`gate.rs`, through `toml_edit`).

use crate::error::{PassengerError, Result};
use crate::model::ManifestInfo;
use klepto::{FeatureEnable, FeatureModel, Klepto, KleptoBuilder, PackageInfo};
use std::collections::{BTreeMap, BTreeSet};
use std::path::{Path, PathBuf};

/// A feature entry as Cargo spells it: `other`, `dep:beta`, `beta/feat`, `beta?/feat`.
pub fn enable_text(e: &FeatureEnable) -> String {
    match e {
        FeatureEnable::Feature(f) => f.clone(),
        FeatureEnable::Dep(d) => format!("dep:{d}"),
        FeatureEnable::DepFeature { dep, feature, weak } => format!("{dep}{}/{feature}", if *weak { "?" } else { "" }),
    }
}

/// One package's manifest facts, from its feature model.
pub fn manifest_info(model: &FeatureModel) -> ManifestInfo {
    let mut features_raw: BTreeMap<String, Vec<String>> = BTreeMap::new();
    let mut feature_deps: BTreeMap<String, BTreeSet<String>> = BTreeMap::new();
    for (name, info) in model.features.iter().filter(|(_, i)| !i.implicit) {
        features_raw.insert(name.clone(), info.enables.iter().map(enable_text).collect());
        feature_deps.insert(name.clone(), model.deps_enabled_by(name));
    }
    let mut dep_features: BTreeMap<String, BTreeSet<String>> = BTreeMap::new();
    for (feat, deps) in &feature_deps {
        for dep in deps {
            dep_features.entry(dep.clone()).or_default().insert(feat.clone());
        }
    }
    ManifestInfo {
        crate_name: model.package.clone(),
        features_raw,
        all_deps: model.dependencies.iter().map(|d| d.name.clone()).collect(),
        optional_deps: model.dependencies.iter().filter(|d| d.optional).map(|d| d.name.clone()).collect(),
        feature_deps,
        dep_features,
    }
}

/// The builder over every workspace member of `root`, generated files left
/// out: what every command scans (cargo metadata has run; nothing is parsed).
pub fn builder(root: &Path) -> Result<KleptoBuilder> {
    Klepto::new("workspace")
        .scan_workspace_root(root)
        .map_err(|e| PassengerError::unsupported(e.to_string()))?
        .exclude_generated()
        .map_err(|e| PassengerError::unsupported(e.to_string()))
}

fn same_file(a: &Path, b: &Path) -> bool {
    a == b || std::fs::canonicalize(a).ok().is_some_and(|ca| std::fs::canonicalize(b).ok().is_some_and(|cb| ca == cb))
}

/// The package whose manifest is `manifest`, among `packages`.
pub fn package_with_manifest<'p>(packages: &'p BTreeMap<String, PackageInfo>, manifest: &Path) -> Option<&'p PackageInfo> {
    packages.values().find(|p| same_file(&p.manifest_path, manifest))
}

/// The manifest of `package` (`-` or `_` spelled), from cargo metadata.
pub fn manifest_of(packages: &BTreeMap<String, PackageInfo>, package: &str) -> Option<PathBuf> {
    packages.get(&package.replace('-', "_")).map(|p| p.manifest_path.clone())
}

/// The name cargo knows a package by (`-p`), from its manifest's `[package] name`: klepto's names are the crates'
/// (`recipe_session_transfer_plan_adapter`), cargo's keep the manifest's `-` (`recipe-session-transfer-plan-adapter`).
pub fn manifest_name(manifest: &Path) -> Option<String> {
    let text = std::fs::read_to_string(manifest).ok()?;
    let doc: toml::Table = text.parse().ok()?;
    doc.get("package")?.get("name")?.as_str().map(str::to_string)
}

/// Each workspace member's cargo name by klepto's name, where the two differ.
pub fn cargo_names(root: &Path) -> std::collections::BTreeMap<String, String> {
    let Ok(b) = builder(root) else { return Default::default() };
    b.packages().iter().filter_map(|(n, p)| manifest_name(&p.manifest_path).filter(|m| m != n).map(|m| (n.clone(), m))).collect()
}