nils-plan-issue 1.12.0

CLI crate for nils-plan-issue in the nils-cli workspace.
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

//! Registry-driven lifecycle comment renderer.
//!
//! Task 1.1 introduces the boundary; Tasks 3.2 and 6.3 migrate the real
//! Markdown assembly from [`crate::lifecycle_record`] onto this surface so
//! `record post`, `record open`, `record attach`, and `tracking checkpoint`
//! all share one rendering engine per role.

use crate::lifecycle_record::{self, CommentInput, PayloadRole};
use crate::lifecycle_vnext::registry::{self, RoleSpec};

/// Outcome of rendering one lifecycle comment.
#[derive(Debug, Clone)]
pub struct RenderedComment {
    pub role: PayloadRole,
    pub spec: &'static RoleSpec,
    pub body: String,
}

/// Render a lifecycle comment for the given [`CommentInput`].
///
/// Until Task 6.3 migrates the renderer wholesale, this adapter delegates to
/// the existing [`crate::lifecycle_record::render_comment`] implementation
/// while exposing the vNext-shaped result. Errors are surfaced verbatim so
/// upstream callers see the same stable strings.
pub fn render(input: CommentInput) -> Result<RenderedComment, String> {
    let role = derive_role(&input);
    let spec = registry::role(role);
    let body = lifecycle_record::render_comment(input)?;
    Ok(RenderedComment { role, spec, body })
}

fn derive_role(input: &CommentInput) -> PayloadRole {
    use crate::commands::record::LifecycleCommentKind;
    match input.kind {
        LifecycleCommentKind::Source => PayloadRole::Source,
        LifecycleCommentKind::Plan => PayloadRole::Plan,
        LifecycleCommentKind::State => PayloadRole::State,
        LifecycleCommentKind::Session => PayloadRole::Session,
        LifecycleCommentKind::Validation => PayloadRole::Validation,
        LifecycleCommentKind::Review => PayloadRole::Review,
        LifecycleCommentKind::Closeout => PayloadRole::Closeout,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::commands::record::{LifecycleCommentKind, RecordProfile};

    fn input(kind: LifecycleCommentKind) -> CommentInput {
        CommentInput {
            profile: RecordProfile::Tracking,
            kind,
            path: Some("plans/demo.md".to_string()),
            commit: Some("abc123".to_string()),
            content: Some("visible body".to_string()),
            title: None,
            details_summary: None,
        }
    }

    #[test]
    fn render_maps_every_comment_kind_to_registry_role() {
        let cases = [
            (LifecycleCommentKind::Source, PayloadRole::Source, "source"),
            (LifecycleCommentKind::Plan, PayloadRole::Plan, "plan"),
            (LifecycleCommentKind::State, PayloadRole::State, "state"),
            (
                LifecycleCommentKind::Session,
                PayloadRole::Session,
                "session",
            ),
            (
                LifecycleCommentKind::Validation,
                PayloadRole::Validation,
                "validation",
            ),
            (LifecycleCommentKind::Review, PayloadRole::Review, "review"),
            (
                LifecycleCommentKind::Closeout,
                PayloadRole::Closeout,
                "closeout",
            ),
        ];

        for (kind, role, marker_role) in cases {
            let rendered = render(input(kind)).expect("comment renders");
            assert_eq!(rendered.role, role);
            assert_eq!(rendered.spec.role, role);
            assert_eq!(rendered.spec.marker_role, marker_role);
            assert!(rendered.body.contains("- Profile: tracking"));
        }
    }
}