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

use crate::domain::model::decision_record::DecisionRecord;
use crate::domain::model::record_ref::DecisionRecordRef;
use crate::domain::usecases::decision_record::DecisionRecordRepository;

/// Retrieve a single decision record by ID.
///
/// Returns `Ok(Some(record))` if found, `Ok(None)` if not found, or `Err` on
/// repository failure.
pub fn show_decision_record(
    repo: &dyn DecisionRecordRepository,
    id: &DecisionRecordRef,
) -> anyhow::Result<Option<DecisionRecord>> {
    repo.find_by_id(id)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::domain::usecases::decision_record::tests::{
        adr, FakeDecisionRecordRepository, RecordFixture,
    };

    // ── Tests ─────────────────────────────────────────────────────────────────

    #[test]
    fn show_returns_the_record_when_it_exists() {
        scenario()
            .given(adr("Use Rust").with_id("ADR-0001"))
            .when_show("ADR-0001")
            .then_title("Use Rust");
    }

    #[test]
    fn show_returns_none_for_an_unknown_id() {
        scenario().when_show("ADR-0099").then_not_found();
    }

    // ── Scenario ──────────────────────────────────────────────────────────────

    fn scenario() -> Scenario {
        Scenario {
            repo: FakeDecisionRecordRepository::with_records(vec![]),
        }
    }

    struct Scenario {
        repo: FakeDecisionRecordRepository,
    }

    impl Scenario {
        fn given(mut self, fixture: RecordFixture) -> Self {
            let raw = fixture
                .id
                .as_deref()
                .expect("given() requires an explicit id — use .with_id()")
                .to_string();
            let numeric = DecisionRecordRef::new(&raw)
                .unwrap_or_else(|_| panic!("given(): invalid id {raw:?}"));
            self.repo.push_record(fixture.build(numeric));
            self
        }

        fn when_show(self, id: &str) -> ShowOutcome {
            let record_ref = DecisionRecordRef::new(id)
                .unwrap_or_else(|_| panic!("when_show: invalid id {id:?}"));
            ShowOutcome {
                result: show_decision_record(&self.repo, &record_ref)
                    .expect("show_decision_record failed unexpectedly"),
            }
        }
    }

    struct ShowOutcome {
        result: Option<DecisionRecord>,
    }

    impl ShowOutcome {
        fn then_title(self, expected: &str) -> Self {
            let record = self.result.as_ref().expect("expected Some, got None");
            assert_eq!(record.title.as_str(), expected);
            self
        }

        fn then_not_found(self) -> Self {
            assert!(self.result.is_none(), "expected None, got Some");
            self
        }
    }
}