cargo-mend 0.15.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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

use std::collections::BTreeSet;

use super::cli::FixCli;
use super::cli::FixExecution;
use super::cli::FixRequest;

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) enum FixKind {
    ShortenImport,
    PreferModuleImport,
    InlinePathQualifiedType,
    UnusedPub,
    NarrowToPubCrate,
    FieldVisibility,
    ImportsAtTop,
    PubUse,
}

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

impl From<&FixCli> for FixSelection {
    fn from(fix_cli: &FixCli) -> Self {
        match fix_cli.execution {
            FixExecution::ApplyAll | FixExecution::PreviewAll => Self::all_fix_kinds(),
            FixExecution::ReadOnly => Self::default(),
            FixExecution::ApplyRequested | FixExecution::PreviewRequested => {
                let mut fix_kinds = BTreeSet::new();
                if fix_cli.includes(FixRequest::Mend) {
                    fix_kinds.insert(FixKind::ShortenImport);
                    fix_kinds.insert(FixKind::PreferModuleImport);
                    fix_kinds.insert(FixKind::InlinePathQualifiedType);
                    fix_kinds.insert(FixKind::UnusedPub);
                    fix_kinds.insert(FixKind::NarrowToPubCrate);
                    fix_kinds.insert(FixKind::FieldVisibility);
                    fix_kinds.insert(FixKind::ImportsAtTop);
                }
                if fix_cli.includes(FixRequest::PubUse) {
                    fix_kinds.insert(FixKind::PubUse);
                }
                Self { fix_kinds }
            },
        }
    }
}

impl FixSelection {
    fn all_fix_kinds() -> Self {
        let mut fix_kinds = BTreeSet::new();
        fix_kinds.insert(FixKind::ShortenImport);
        fix_kinds.insert(FixKind::PreferModuleImport);
        fix_kinds.insert(FixKind::InlinePathQualifiedType);
        fix_kinds.insert(FixKind::UnusedPub);
        fix_kinds.insert(FixKind::NarrowToPubCrate);
        fix_kinds.insert(FixKind::FieldVisibility);
        fix_kinds.insert(FixKind::ImportsAtTop);
        fix_kinds.insert(FixKind::PubUse);
        Self { fix_kinds }
    }

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

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

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

impl From<&FixCli> for OperationMode {
    fn from(fix_cli: &FixCli) -> Self {
        let fixes = FixSelection::from(fix_cli);
        match fix_cli.execution {
            FixExecution::PreviewRequested | FixExecution::PreviewAll => Self {
                intent: OperationIntent::DryRun,
                fixes,
            },
            FixExecution::ReadOnly => Self {
                intent: OperationIntent::ReadOnly,
                fixes,
            },
            FixExecution::ApplyRequested | FixExecution::ApplyAll => Self {
                intent: OperationIntent::Apply,
                fixes,
            },
        }
    }
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeSet;

    use super::FixKind;
    use super::OperationIntent;
    use super::OperationMode;
    use crate::config::cli::FixCli;
    use crate::config::cli::FixExecution;
    use crate::config::cli::FixRequest;

    #[test]
    fn operation_mode_is_read_only_without_fix_flags() {
        let cli = FixCli::default();
        let operation_mode = OperationMode::from(&cli);
        assert_eq!(operation_mode.intent, OperationIntent::ReadOnly);
    }

    #[test]
    fn operation_mode_dry_run_alone_implies_all_fix_kinds() {
        let cli = FixCli {
            execution: FixExecution::PreviewAll,
            ..FixCli::default()
        };
        let operation_mode = OperationMode::from(&cli);
        assert_eq!(operation_mode.intent, OperationIntent::DryRun);
        assert!(operation_mode.fixes.contains(FixKind::ShortenImport));
        assert!(operation_mode.fixes.contains(FixKind::PreferModuleImport));
        assert!(
            operation_mode
                .fixes
                .contains(FixKind::InlinePathQualifiedType)
        );
        assert!(operation_mode.fixes.contains(FixKind::NarrowToPubCrate));
        assert!(operation_mode.fixes.contains(FixKind::UnusedPub));
        assert!(operation_mode.fixes.contains(FixKind::PubUse));
    }

    #[test]
    fn operation_mode_allows_previewing_multiple_fix_kinds() {
        let cli = FixCli {
            execution:       FixExecution::PreviewRequested,
            requested_fixes: BTreeSet::from([FixRequest::Mend, FixRequest::PubUse]),
        };
        let operation_mode = OperationMode::from(&cli);
        assert_eq!(operation_mode.intent, OperationIntent::DryRun);
        assert!(operation_mode.fixes.contains(FixKind::ShortenImport));
        assert!(operation_mode.fixes.contains(FixKind::NarrowToPubCrate));
        assert!(operation_mode.fixes.contains(FixKind::UnusedPub));
        assert!(operation_mode.fixes.contains(FixKind::PubUse));
    }

    #[test]
    fn operation_mode_allows_applying_multiple_fix_kinds() {
        let cli = FixCli {
            execution:       FixExecution::ApplyRequested,
            requested_fixes: BTreeSet::from([FixRequest::Mend, FixRequest::PubUse]),
        };
        let operation_mode = OperationMode::from(&cli);
        assert_eq!(operation_mode.intent, OperationIntent::Apply);
        assert!(operation_mode.fixes.contains(FixKind::ShortenImport));
        assert!(operation_mode.fixes.contains(FixKind::NarrowToPubCrate));
        assert!(operation_mode.fixes.contains(FixKind::UnusedPub));
        assert!(operation_mode.fixes.contains(FixKind::PubUse));
    }
}