gitbox 2.1.3

Git toolbox to simplify adoption of conventional commits and semantic version, among other things.
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
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
165
166

use crate::{
    application::error::describe_options_invariant_error::DescribeOptionsInvariantError,
    usecase::{metadata_spec::MetadataSpec, type_aliases::AnyError},
};

pub const PRERELEASE_NUM_PLACEHOLDER: &str = "%d";

pub struct DescribeOptions {
    prerelease_options: DescribePrereleaseOptions,
    diff: bool,
    metadata_options: DescribeMetadataOptions,
    trigger_options: DescribeTriggerOptions,
    tag_options: DescribeTagOptions,
}

impl DescribeOptions {
    pub fn new(
        prerelease_options: DescribePrereleaseOptions,
        diff: bool,
        metadata_options: DescribeMetadataOptions,
        trigger_options: DescribeTriggerOptions,
        tag_options: DescribeTagOptions,
    ) -> DescribeOptions {
        DescribeOptions {
            prerelease_options,
            diff,
            metadata_options,
            trigger_options,
            tag_options,
        }
    }

    pub fn prerelease(&self) -> &DescribePrereleaseOptions {
        &self.prerelease_options
    }

    pub fn diff(&self) -> bool {
        self.diff
    }
    pub fn metadata(&self) -> &DescribeMetadataOptions {
        &self.metadata_options
    }
    pub fn triggers(&self) -> &DescribeTriggerOptions {
        &self.trigger_options
    }
    pub fn tag(&self) -> &DescribeTagOptions {
        &self.tag_options
    }
}

#[derive(Debug)]
pub struct DescribePrereleaseOptions {
    enabled: bool,
    pattern: String,
    old_pattern: String,
}

impl DescribePrereleaseOptions {
    pub fn new(enabled: bool, pattern: String, old_pattern: String) -> Result<Self, AnyError> {
        Self::check_pattern_has_placeholder(&pattern, "prerelease pattern")?;
        Self::check_pattern_has_placeholder(&old_pattern, "old prerelease patter")?;

        Ok(DescribePrereleaseOptions {
            enabled,
            pattern,
            old_pattern,
        })
    }

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

    pub fn pattern(&self) -> &str {
        &self.pattern
    }

    pub fn old_pattern(&self) -> &str {
        &self.old_pattern
    }

    fn check_pattern_has_placeholder(
        pattern: &str,
        what: &str,
    ) -> Result<(), DescribeOptionsInvariantError> {
        if pattern.contains(PRERELEASE_NUM_PLACEHOLDER) {
            Ok(())
        } else {
            Err(DescribeOptionsInvariantError::new(&format!(
                "{} '{}' did not contain '{}' placeholder",
                what, pattern, PRERELEASE_NUM_PLACEHOLDER
            )))
        }
    }
}

#[derive(Debug)]
pub struct DescribeMetadataOptions {
    metadata: Vec<MetadataSpec>,
}

impl DescribeMetadataOptions {
    pub fn new(metadata: Vec<MetadataSpec>) -> Self {
        DescribeMetadataOptions { metadata }
    }

    pub fn specs(&self) -> &[MetadataSpec] {
        self.metadata.as_slice()
    }
}

#[derive(Debug)]
pub struct DescribeTriggerOptions {
    major_trigger: Option<String>,
    minor_trigger: Option<String>,
    patch_trigger: Option<String>,
}

impl DescribeTriggerOptions {
    pub fn new(
        major_trigger: Option<String>,
        minor_trigger: Option<String>,
        patch_trigger: Option<String>,
    ) -> Self {
        DescribeTriggerOptions {
            major_trigger,
            minor_trigger,
            patch_trigger,
        }
    }
    pub fn major(&self) -> Option<&str> {
        self.major_trigger.as_deref()
    }
    pub fn minor(&self) -> Option<&str> {
        self.minor_trigger.as_deref()
    }
    pub fn patch(&self) -> Option<&str> {
        self.patch_trigger.as_deref()
    }
}

#[derive(Debug)]
pub struct DescribeTagOptions {
    create_tag: bool,
    tag_message: Option<String>,
    sign_tag: bool,
}

impl DescribeTagOptions {
    pub fn new(create_tag: bool, tag_message: Option<String>, sign_tag: bool) -> Self {
        DescribeTagOptions {
            create_tag,
            tag_message,
            sign_tag,
        }
    }
    pub fn enabled(&self) -> bool {
        self.create_tag
    }
    pub fn message(&self) -> Option<&str> {
        self.tag_message.as_deref()
    }
    pub fn sign_enabled(&self) -> bool {
        self.sign_tag
    }
}