kcl-lib 0.2.147

KittyCAD Language implementation and tools
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

use std::path::Path;
use std::path::PathBuf;

pub const RENDERED_MODEL_NAME: &str = "rendered_model.png";

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum RenderArtifactKind {
    RenderedModel,
    V1RenderedModel,
    V2RenderedModel,
    Diff,
}

pub fn render_artifact_file_name(stem: Option<&str>, kind: RenderArtifactKind) -> String {
    let base_name = match kind {
        RenderArtifactKind::RenderedModel => RENDERED_MODEL_NAME.to_owned(),
        RenderArtifactKind::V1RenderedModel => format!("v1-{RENDERED_MODEL_NAME}"),
        RenderArtifactKind::V2RenderedModel => format!("v2-{RENDERED_MODEL_NAME}"),
        RenderArtifactKind::Diff => "diff.png".to_owned(),
    };

    match stem {
        Some(stem) => format!("{stem}-{base_name}"),
        None => base_name,
    }
}

pub fn render_artifact_path(out_dir: &Path, stem: Option<&str>, kind: RenderArtifactKind) -> PathBuf {
    out_dir.join(render_artifact_file_name(stem, kind))
}

#[cfg(test)]
mod tests {
    use std::path::Path;
    use std::path::PathBuf;

    use super::RENDERED_MODEL_NAME;
    use super::RenderArtifactKind;
    use super::render_artifact_file_name;
    use super::render_artifact_path;

    #[test]
    fn artifact_names_without_stem_match_expected_defaults() {
        assert_eq!(
            render_artifact_file_name(None, RenderArtifactKind::RenderedModel),
            RENDERED_MODEL_NAME
        );
        assert_eq!(
            render_artifact_file_name(None, RenderArtifactKind::V1RenderedModel),
            "v1-rendered_model.png"
        );
        assert_eq!(
            render_artifact_file_name(None, RenderArtifactKind::V2RenderedModel),
            "v2-rendered_model.png"
        );
        assert_eq!(render_artifact_file_name(None, RenderArtifactKind::Diff), "diff.png");
    }

    #[test]
    fn artifact_names_with_stem_are_prefixed() {
        assert_eq!(
            render_artifact_file_name(Some("main"), RenderArtifactKind::RenderedModel),
            "main-rendered_model.png"
        );
        assert_eq!(
            render_artifact_file_name(Some("main"), RenderArtifactKind::V1RenderedModel),
            "main-v1-rendered_model.png"
        );
        assert_eq!(
            render_artifact_file_name(Some("main"), RenderArtifactKind::V2RenderedModel),
            "main-v2-rendered_model.png"
        );
        assert_eq!(
            render_artifact_file_name(Some("main"), RenderArtifactKind::Diff),
            "main-diff.png"
        );
    }

    #[test]
    fn artifact_path_joins_output_directory_and_generated_name() {
        assert_eq!(
            render_artifact_path(
                Path::new("/tmp/output"),
                Some("main"),
                RenderArtifactKind::RenderedModel
            ),
            PathBuf::from("/tmp/output/main-rendered_model.png")
        );
    }
}