cartulary 0.3.0-alpha.1

The knowledge layer of your project — decisions, issues, docs, all in one place.
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

use crate::domain::model::body::Body;
use crate::domain::model::issue::IssueEdit;
use crate::domain::model::record_ref::IssueRef;
use crate::domain::usecases::edit::issue::commit_issue_edits;
use crate::domain::usecases::issue::IssueRepository;

/// Outcome of an `edit_issue_body` call.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum EditIssueBodyOutcome {
    /// The body was changed and saved.
    Updated,
    /// The body was unchanged — no write was performed.
    NoOp,
}

/// Replace the body of an existing issue.
///
/// Body edits are not tracked in the event log — use git history for that.
/// Returns `Err` if the issue is not found.
pub fn edit_issue_body(
    repo: &dyn IssueRepository,
    id: &IssueRef,
    new_body: Body,
) -> anyhow::Result<EditIssueBodyOutcome> {
    let issue = repo
        .find_by_id(id)?
        .ok_or_else(|| anyhow::anyhow!("issue {id} not found"))?;
    if issue.content == new_body {
        return Ok(EditIssueBodyOutcome::NoOp);
    }
    commit_issue_edits(
        repo,
        vec![IssueEdit::SetBody {
            issue: id.clone(),
            body: new_body,
        }],
    )?;
    Ok(EditIssueBodyOutcome::Updated)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::domain::model::record_ref::IssueRef;
    use crate::domain::usecases::issue::tests::{feature, FakeIssueRepository, IssueFixture};

    #[test]
    fn changing_the_body_saves_the_new_content() {
        scenario()
            .given(feature("Add login").with_id("ISSUE-0001"))
            .when_edit_body("ISSUE-0001", "New body content.")
            .then_saved_body("New body content.")
            .then_updated();
    }

    #[test]
    fn submitting_the_same_body_is_a_noop() {
        scenario()
            .given(
                feature("Add login")
                    .with_id("ISSUE-0001")
                    .with_body("Same body."),
            )
            .when_edit_body("ISSUE-0001", "Same body.")
            .then_noop();
    }

    #[test]
    fn editing_the_body_of_an_unknown_issue_returns_an_error() {
        scenario()
            .when_edit_body("ISSUE-0099", "body")
            .then_err_contains("not found");
    }

    fn scenario() -> Scenario {
        Scenario {
            repo: FakeIssueRepository::new(),
        }
    }

    struct Scenario {
        repo: FakeIssueRepository,
    }

    impl Scenario {
        fn given(mut self, fixture: IssueFixture) -> Self {
            let raw = fixture
                .id
                .as_deref()
                .expect("given() requires an explicit id — use .with_id()")
                .to_string();
            let numeric = IssueRef::new(&raw).unwrap();
            self.repo.push_issue(fixture.build(numeric));
            self
        }

        fn when_edit_body(self, id: &str, new_body: &str) -> EditOutcome {
            let issue_ref = IssueRef::new(id).unwrap();
            let result = edit_issue_body(&self.repo, &issue_ref, Body::new(new_body));
            EditOutcome {
                repo: self.repo,
                result,
            }
        }
    }

    struct EditOutcome {
        repo: FakeIssueRepository,
        result: anyhow::Result<EditIssueBodyOutcome>,
    }

    impl EditOutcome {
        fn then_saved_body(self, expected: &str) -> Self {
            let saved = self.repo.last_saved().expect("expected a save, got none");
            assert_eq!(saved.content, Body::new(expected));
            self
        }

        fn then_updated(self) -> Self {
            assert_eq!(
                self.result.as_ref().expect("expected Ok, got Err"),
                &EditIssueBodyOutcome::Updated
            );
            self
        }

        fn then_noop(self) -> Self {
            assert_eq!(
                self.result.as_ref().expect("expected Ok, got Err"),
                &EditIssueBodyOutcome::NoOp
            );
            assert!(self.repo.last_saved().is_none(), "expected nothing saved");
            self
        }

        fn then_err_contains(self, substring: &str) {
            let msg = self.result.expect_err("expected Err, got Ok").to_string();
            assert!(
                msg.contains(substring),
                "expected {substring:?}, got {msg:?}"
            );
        }
    }
}