ito-common 0.1.28

Common utilities and error types for Ito
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

//! Canonical Ito path builders.
//!
//! These helpers consistently build paths under an Ito root directory.

use std::path::{Path, PathBuf};

/// Canonical `.ito/` path builders.
///
/// These helpers intentionally take a `ito_path` (the configured ito root directory)
/// so callers do not duplicate `.join("changes")`, `.join("modules")`, or ad-hoc
/// string-based path formatting.
pub fn default_ito_root(workspace_root: &Path) -> PathBuf {
    workspace_root.join(".ito")
}

/// Return the `changes/` directory under the Ito root.
pub fn changes_dir(ito_path: &Path) -> PathBuf {
    ito_path.join("changes")
}

/// Return the on-disk directory for a specific change.
pub fn change_dir(ito_path: &Path, change_id: &str) -> PathBuf {
    changes_dir(ito_path).join(change_id)
}

/// Return the path to a change's metadata file.
pub fn change_meta_path(ito_path: &Path, change_id: &str) -> PathBuf {
    change_dir(ito_path, change_id).join(".ito.yaml")
}

/// Return the `specs/` directory within a change directory.
pub fn change_specs_dir(ito_path: &Path, change_id: &str) -> PathBuf {
    change_dir(ito_path, change_id).join("specs")
}

/// Return the archive directory for changes (`changes/archive/`).
pub fn changes_archive_dir(ito_path: &Path) -> PathBuf {
    changes_dir(ito_path).join("archive")
}

/// Return the directory used by `ito archive` for archived change artifacts.
pub fn archive_changes_dir(ito_path: &Path) -> PathBuf {
    ito_path.join("archive").join("changes")
}

/// Return the `modules/` directory under the Ito root.
pub fn modules_dir(ito_path: &Path) -> PathBuf {
    ito_path.join("modules")
}

/// Return the `specs/` directory under the Ito root.
pub fn specs_dir(ito_path: &Path) -> PathBuf {
    ito_path.join("specs")
}

/// Return the canonical path to a spec's markdown file (`spec.md`).
pub fn spec_markdown_path(ito_path: &Path, spec_id: &str) -> PathBuf {
    specs_dir(ito_path).join(spec_id).join("spec.md")
}

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

    #[test]
    fn default_ito_root_is_dot_ito() {
        let root = PathBuf::from("/repo");
        assert_eq!(default_ito_root(&root), PathBuf::from("/repo/.ito"));
    }

    #[test]
    fn builders_join_expected_paths() {
        let ito = PathBuf::from("/repo/.ito");

        assert_eq!(changes_dir(&ito), PathBuf::from("/repo/.ito/changes"));
        assert_eq!(
            change_dir(&ito, "001-01_test"),
            PathBuf::from("/repo/.ito/changes/001-01_test")
        );
        assert_eq!(
            change_meta_path(&ito, "001-01_test"),
            PathBuf::from("/repo/.ito/changes/001-01_test/.ito.yaml")
        );
        assert_eq!(
            change_specs_dir(&ito, "001-01_test"),
            PathBuf::from("/repo/.ito/changes/001-01_test/specs")
        );
        assert_eq!(
            changes_archive_dir(&ito),
            PathBuf::from("/repo/.ito/changes/archive")
        );
        assert_eq!(
            archive_changes_dir(&ito),
            PathBuf::from("/repo/.ito/archive/changes")
        );
        assert_eq!(modules_dir(&ito), PathBuf::from("/repo/.ito/modules"));
        assert_eq!(specs_dir(&ito), PathBuf::from("/repo/.ito/specs"));
        assert_eq!(
            spec_markdown_path(&ito, "cli-tasks"),
            PathBuf::from("/repo/.ito/specs/cli-tasks/spec.md")
        );
    }
}