cargo-mend 0.1.0

Opinionated visibility auditing for Rust crates and workspaces
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

use std::collections::BTreeSet;

use anyhow::Result;

use super::cli::FixCli;

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum FixKind {
    ShortenImport,
    FixPubUse,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct FixSelection {
    kinds: BTreeSet<FixKind>,
}

impl FixSelection {
    pub fn from_cli(fix_cli: &FixCli) -> Self {
        let mut kinds = BTreeSet::new();
        if fix_cli.fix {
            kinds.insert(FixKind::ShortenImport);
        }
        if fix_cli.fix_pub_use {
            kinds.insert(FixKind::FixPubUse);
        }
        Self { kinds }
    }

    pub fn contains(&self, kind: FixKind) -> bool { self.kinds.contains(&kind) }

    pub fn is_empty(&self) -> bool { self.kinds.is_empty() }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OperationIntent {
    ReadOnly,
    DryRun,
    Apply,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct OperationMode {
    pub intent: OperationIntent,
    pub fixes:  FixSelection,
}

impl OperationMode {
    pub fn from_cli(fix_cli: &FixCli) -> Result<Self> {
        let fixes = FixSelection::from_cli(fix_cli);
        if fix_cli.dry_run {
            if fixes.is_empty() {
                anyhow::bail!("`--dry-run` requires `--fix` or `--fix-pub-use`");
            }
            return Ok(Self {
                intent: OperationIntent::DryRun,
                fixes,
            });
        }

        if fixes.is_empty() {
            Ok(Self {
                intent: OperationIntent::ReadOnly,
                fixes,
            })
        } else {
            Ok(Self {
                intent: OperationIntent::Apply,
                fixes,
            })
        }
    }
}

#[cfg(test)]
mod tests {
    use super::FixKind;
    use super::OperationIntent;
    use super::OperationMode;
    use crate::cli::FixCli;

    #[test]
    fn operation_mode_is_read_only_without_fix_flags() {
        let cli = FixCli {
            fix:         false,
            fix_pub_use: false,
            dry_run:     false,
        };
        let Ok(mode) = OperationMode::from_cli(&cli) else {
            unreachable!("read-only mode should parse");
        };
        assert_eq!(mode.intent, OperationIntent::ReadOnly);
    }

    #[test]
    fn operation_mode_rejects_dry_run_without_fix_flags() {
        let cli = FixCli {
            fix:         false,
            fix_pub_use: false,
            dry_run:     true,
        };
        let mode = OperationMode::from_cli(&cli);
        let Err(err) = mode else {
            unreachable!("dry run without fix flags should be rejected");
        };
        assert!(
            err.to_string()
                .contains("`--dry-run` requires `--fix` or `--fix-pub-use`")
        );
    }

    #[test]
    fn operation_mode_allows_previewing_multiple_fix_kinds() {
        let cli = FixCli {
            fix:         true,
            fix_pub_use: true,
            dry_run:     true,
        };
        let Ok(mode) = OperationMode::from_cli(&cli) else {
            unreachable!("preview mode should parse");
        };
        assert_eq!(mode.intent, OperationIntent::DryRun);
        assert!(mode.fixes.contains(FixKind::ShortenImport));
        assert!(mode.fixes.contains(FixKind::FixPubUse));
    }

    #[test]
    fn operation_mode_allows_applying_multiple_fix_kinds() {
        let cli = FixCli {
            fix:         true,
            fix_pub_use: true,
            dry_run:     false,
        };
        let Ok(mode) = OperationMode::from_cli(&cli) else {
            unreachable!("apply mode should parse");
        };
        assert_eq!(mode.intent, OperationIntent::Apply);
        assert!(mode.fixes.contains(FixKind::ShortenImport));
        assert!(mode.fixes.contains(FixKind::FixPubUse));
    }
}