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

use crate::{
    domain::conventional_commit::ConventionalCommit,
    usecase::{
        configuration::commit::CommitConfiguration,
        error::create_conventional_commit_error::CreateConventionalCommitError,
        repository::conventional_commit_egress_repository::ConventionalCommitEgressRepository,
    },
};

use super::usecase::UseCase;

pub struct CreateConventionalCommitUseCase<'a> {
    configuration: CommitConfiguration,
    commit_repository: &'a dyn ConventionalCommitEgressRepository,
}

impl<'a, 'b: 'a> CreateConventionalCommitUseCase<'a> {
    pub fn new(
        configuration: CommitConfiguration,
        commit_repository: &'b dyn ConventionalCommitEgressRepository,
    ) -> Self {
        CreateConventionalCommitUseCase {
            configuration,
            commit_repository,
        }
    }
}

impl UseCase<ConventionalCommit, CreateConventionalCommitError>
    for CreateConventionalCommitUseCase<'_>
{
    fn execute(&self) -> Result<ConventionalCommit, CreateConventionalCommitError> {
        let commit = ConventionalCommit::new(
            self.configuration.typ().to_owned(),
            self.configuration.scope().map(|it| it.to_owned()),
            self.configuration.is_breaking().into(),
            self.configuration.summary().to_owned(),
            self.configuration.message().map(|it| it.to_owned()),
        )?;
        if self.configuration.allow_empty() {
            self.commit_repository.create_empty_commit(&commit)?;
        } else {
            self.commit_repository.create_commit(&commit)?;
        }
        Ok(commit)
    }
}

#[cfg(test)]
mod tests {
    use std::{error::Error, fmt::Display};

    use crate::{
        domain::conventional_commit::ConventionalCommit,
        usecase::{
            configuration::commit::{AllowEmptyFlag, CommitConfiguration},
            repository::conventional_commit_egress_repository::ConventionalCommitEgressRepository,
            type_aliases::AnyError,
            usecases::{
                create_conventional_commit::CreateConventionalCommitUseCase, usecase::UseCase,
            },
        },
    };

    #[derive(Debug)]
    struct MockError {}

    impl Display for MockError {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            write!(f, "Mock error")
        }
    }

    impl Error for MockError {}

    struct MockCommitRepository {}

    impl ConventionalCommitEgressRepository for MockCommitRepository {
        fn create_commit(&self, commit: &ConventionalCommit) -> Result<(), AnyError> {
            if commit.summary().breaking() {
                Err(Box::new(MockError {}))
            } else {
                Ok(())
            }
        }

        fn create_empty_commit(&self, _commit: &ConventionalCommit) -> Result<(), AnyError> {
            unreachable!()
        }
    }

    fn simple_configuration() -> CommitConfiguration {
        CommitConfiguration::new(
            "feat".to_string(),
            None,
            false,
            "test".to_string(),
            None,
            AllowEmptyFlag::Disabled,
        )
        .expect("This configuration is well-formed")
    }

    fn full_configuration() -> CommitConfiguration {
        CommitConfiguration::new(
            "feat".to_string(),
            Some("test".to_string()),
            true,
            "test".to_string(),
            Some("Message body".to_string()),
            AllowEmptyFlag::Disabled,
        )
        .expect("This configuration is well-formed")
    }

    #[test]
    fn execute_usecase_correct() {
        let config = simple_configuration();
        let commit_repository = MockCommitRepository {};
        let usecase = CreateConventionalCommitUseCase::new(config, &commit_repository);
        let result = usecase.execute();
        assert!(result.is_ok());
    }

    #[test]
    fn execute_usecase_error() {
        let config = full_configuration();
        let commit_repository = MockCommitRepository {};
        let usecase = CreateConventionalCommitUseCase::new(config, &commit_repository);
        let result = usecase.execute();
        assert!(result.is_err());
    }
}