peace_code_gen 0.0.14

Code generation macros for the peace automation framework.
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

use syn::{parse_quote, Path};

use crate::cmd::{FlowCount, ProfileCount};

/// Scope to generate the `CmdCtxBuilder` impl for.
#[allow(clippy::enum_variant_names)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Scope {
    /// A command that works with multiple profiles, without any items.
    MultiProfileNoFlow,
    /// A command that works with multiple profiles, and a single flow.
    MultiProfileSingleFlow,
    /// A command that only works with workspace parameters.
    NoProfileNoFlow,
    /// A command that works with a single profile, without any items.
    SingleProfileNoFlow,
    /// A command that works with one profile and one flow.
    SingleProfileSingleFlow,
}

impl Scope {
    /// Returns the scope's type for the built command.
    pub fn type_path(self) -> Path {
        match self {
            Scope::MultiProfileNoFlow => parse_quote!(crate::scopes::MultiProfileNoFlow),
            Scope::MultiProfileSingleFlow => {
                parse_quote!(crate::scopes::MultiProfileSingleFlow)
            }
            Scope::NoProfileNoFlow => parse_quote!(crate::scopes::NoProfileNoFlow),
            Scope::SingleProfileNoFlow => parse_quote!(crate::scopes::SingleProfileNoFlow),
            Scope::SingleProfileSingleFlow => {
                parse_quote!(crate::scopes::SingleProfileSingleFlow)
            }
        }
    }

    /// Returns this scope as a snake case `&str`.
    pub fn as_str(self) -> &'static str {
        match self {
            Scope::MultiProfileNoFlow => "multi_profile_no_flow",
            Scope::MultiProfileSingleFlow => "multi_profile_single_flow",
            Scope::NoProfileNoFlow => "no_profile_no_flow",
            Scope::SingleProfileNoFlow => "single_profile_no_flow",
            Scope::SingleProfileSingleFlow => "single_profile_single_flow",
        }
    }

    /// Returns the number of profiles accessed by this scope.
    pub fn profile_count(self) -> ProfileCount {
        match self {
            Scope::MultiProfileNoFlow => ProfileCount::Multiple,
            Scope::MultiProfileSingleFlow => ProfileCount::Multiple,
            Scope::NoProfileNoFlow => ProfileCount::None,
            Scope::SingleProfileNoFlow => ProfileCount::One,
            Scope::SingleProfileSingleFlow => ProfileCount::One,
        }
    }

    /// Returns the number of flows accessed by this scope.
    pub fn flow_count(self) -> FlowCount {
        match self {
            Scope::MultiProfileNoFlow => FlowCount::None,
            Scope::MultiProfileSingleFlow => FlowCount::One,
            Scope::NoProfileNoFlow => FlowCount::None,
            Scope::SingleProfileNoFlow => FlowCount::None,
            Scope::SingleProfileSingleFlow => FlowCount::One,
        }
    }

    /// Returns whether this scope supports accessing profile params.
    pub fn profile_params_supported(self) -> bool {
        match self.profile_count() {
            ProfileCount::None => false,
            ProfileCount::One | ProfileCount::Multiple => true,
        }
    }

    /// Returns whether this scope supports accessing flow params.
    pub fn flow_params_supported(self) -> bool {
        match self.flow_count() {
            FlowCount::None => false,
            FlowCount::One => true,
        }
    }
}