scraps 3.3.0

Scraps is a portable CLI knowledge hub for managing interconnected Markdown documentation with Wiki-link notation.
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

use std::path::Path;

use scraps_libs::git::GitCommandImpl;

use crate::cli::config::scrap_config::ScrapConfig;
use crate::cli::path_resolver::PathResolver;
use crate::error::ScrapsResult;
use crate::ir::loader;
use crate::output::build_renderer::BuildRendererImpl;
use crate::usecase::build::usecase::BuildUsecase;
use crate::usecase::progress::{Progress, Stage};

/// The build prints what it generated; a check generates nothing to report.
struct SilentProgress;

impl Progress for SilentProgress {
    fn start_stage(&self, _stage: &Stage) {}
    fn complete_stage(&self, _stage: &Stage, _count: &usize) {}
    fn end(&self) {}
}

pub fn run(project_path: Option<&Path>) -> ScrapsResult<()> {
    let path_resolver = PathResolver::new(project_path)?;
    let config = ScrapConfig::from_path(project_path)?;
    let build_config = config.to_build_config(None)?;
    let scraps_dir_path = path_resolver.scraps_dir();
    let static_dir_path = path_resolver.static_dir();
    let output_dir_path = path_resolver.output_dir(&config);

    // Commit dates only order and label pages, so a check never reads git.
    let exclude_dirs = vec![static_dir_path.clone(), output_dir_path];
    let (scraps_with_ts, readme_text) = loader::load_scraps_with_timestamps(
        &scraps_dir_path,
        &exclude_dirs,
        None::<GitCommandImpl>,
    )?;

    let renderer = BuildRendererImpl::discarding(&static_dir_path)?;
    let scrap_count = BuildUsecase::new().execute(
        &scraps_with_ts,
        &readme_text,
        &SilentProgress,
        &renderer,
        &build_config,
    )?;
    println!("Checked {scrap_count} scraps");

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_fixtures::{TempScrapProject, temp_scrap_project};
    use rstest::rstest;

    const SSG_CONFIG: &[u8] = b"[ssg]\nbase_url = \"http://localhost:1112/\"\ntitle = \"Test\"";

    #[rstest]
    fn run_succeeds_without_writing_the_site(
        #[from(temp_scrap_project)] project: TempScrapProject,
    ) {
        project
            .add_config(SSG_CONFIG)
            .add_scrap("test1.md", b"# header1\n")
            .add_scrap("test2.md", b"[[test1]] #[[tag]]\n");

        let result = run(Some(project.project_root.as_path()));
        assert!(result.is_ok());

        let written = std::fs::read_dir(&project.output_dir).unwrap().count();
        assert_eq!(written, 0);
    }

    #[rstest]
    fn run_fails_without_config(#[from(temp_scrap_project)] project: TempScrapProject) {
        let result = run(Some(project.project_root.as_path()));
        assert!(result.is_err());
    }

    #[rstest]
    fn run_fails_without_ssg_section(#[from(temp_scrap_project)] project: TempScrapProject) {
        project
            .add_config(b"")
            .add_scrap("test1.md", b"# header1\n");

        let result = run(Some(project.project_root.as_path()));
        assert!(result.is_err());
    }

    #[rstest]
    fn run_fails_on_a_broken_user_template(#[from(temp_scrap_project)] project: TempScrapProject) {
        project
            .add_config(SSG_CONFIG)
            .add_scrap("test1.md", b"# header1\n")
            .add_static_file("index.html", b"{{ missing }}");

        let result = run(Some(project.project_root.as_path()));
        assert!(result.is_err());
    }
}