heddle-core 0.10.3

An AI-native version control system
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

// SPDX-License-Identifier: Apache-2.0
//! Pure repository-onboarding classification.

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OnboardingRepositoryState {
    NativeUninitialized,
    PlainGitUnborn,
    PlainGitCommitted,
    NativeInitialized,
    GitOverlayInitialized,
}

impl OnboardingRepositoryState {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::NativeUninitialized => "native_uninitialized",
            Self::PlainGitUnborn => "plain_git_unborn",
            Self::PlainGitCommitted => "plain_git_committed",
            Self::NativeInitialized => "native_initialized",
            Self::GitOverlayInitialized => "git_overlay_initialized",
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OnboardingMode {
    Native,
    GitOverlay,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OnboardingAction {
    Init,
    None,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct OnboardingFacts {
    pub git_worktree: bool,
    pub git_has_commits: bool,
    pub heddle_mode: Option<OnboardingMode>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct OnboardingPlan {
    pub state: OnboardingRepositoryState,
    pub mode: OnboardingMode,
    pub action: OnboardingAction,
}

impl OnboardingPlan {
    pub fn recommended_command(self) -> Option<&'static str> {
        match self.action {
            OnboardingAction::Init => Some("heddle init"),
            OnboardingAction::None => None,
        }
    }

    pub fn storage_summary(self) -> &'static str {
        match self.mode {
            OnboardingMode::Native => "Heddle owns source objects, refs, and worktree state",
            OnboardingMode::GitOverlay => {
                "Git owns source objects, refs, index, and worktree state; Heddle owns metadata, provenance, and projection mapping"
            }
        }
    }
}

pub fn plan_repository_onboarding(facts: OnboardingFacts) -> OnboardingPlan {
    if let Some(mode) = facts.heddle_mode {
        let state = match mode {
            OnboardingMode::Native => OnboardingRepositoryState::NativeInitialized,
            OnboardingMode::GitOverlay => OnboardingRepositoryState::GitOverlayInitialized,
        };
        return OnboardingPlan {
            state,
            mode,
            action: OnboardingAction::None,
        };
    }

    if facts.git_worktree {
        return OnboardingPlan {
            state: if facts.git_has_commits {
                OnboardingRepositoryState::PlainGitCommitted
            } else {
                OnboardingRepositoryState::PlainGitUnborn
            },
            mode: OnboardingMode::GitOverlay,
            action: OnboardingAction::Init,
        };
    }

    OnboardingPlan {
        state: OnboardingRepositoryState::NativeUninitialized,
        mode: OnboardingMode::Native,
        action: OnboardingAction::Init,
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn classifies_uninitialized_repositories() {
        let committed = plan_repository_onboarding(OnboardingFacts {
            git_worktree: true,
            git_has_commits: true,
            heddle_mode: None,
        });
        assert_eq!(
            committed.state,
            OnboardingRepositoryState::PlainGitCommitted
        );
        assert_eq!(committed.mode, OnboardingMode::GitOverlay);
        assert_eq!(committed.recommended_command(), Some("heddle init"));

        let unborn = plan_repository_onboarding(OnboardingFacts {
            git_worktree: true,
            git_has_commits: false,
            heddle_mode: None,
        });
        assert_eq!(unborn.state, OnboardingRepositoryState::PlainGitUnborn);
        assert_eq!(unborn.mode, OnboardingMode::GitOverlay);
        assert_eq!(unborn.recommended_command(), Some("heddle init"));

        let native = plan_repository_onboarding(OnboardingFacts {
            git_worktree: false,
            git_has_commits: false,
            heddle_mode: None,
        });
        assert_eq!(native.state, OnboardingRepositoryState::NativeUninitialized);
        assert_eq!(native.mode, OnboardingMode::Native);
        assert_eq!(native.recommended_command(), Some("heddle init"));
    }

    #[test]
    fn initialized_overlay_needs_no_onboarding_action() {
        let plan = plan_repository_onboarding(OnboardingFacts {
            git_worktree: true,
            git_has_commits: true,
            heddle_mode: Some(OnboardingMode::GitOverlay),
        });
        assert_eq!(plan.state, OnboardingRepositoryState::GitOverlayInitialized);
        assert_eq!(plan.action, OnboardingAction::None);
        assert_eq!(plan.recommended_command(), None);
    }
}