scraps 2.3.1

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
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

use clap_verbosity_flag::{log, Verbosity, WarnLevel};
use std::path::Path;
use std::time::Instant;
use tracing::{span, Level};
use tracing_subscriber::fmt::format::FmtSpan;

use crate::cli::progress::ProgressImpl;
use crate::error::ScrapsResult;
use crate::input::file::read_scraps;
use crate::output::build_renderer::BuildRendererImpl;
use crate::usecase::build::usecase::BuildUsecase;

use crate::cli::config::scrap_config::ScrapConfig;
use crate::cli::path_resolver::PathResolver;
use crate::usecase::progress::Progress;
use scraps_libs::git::GitCommandImpl;

pub fn run(
    verbose: Verbosity<WarnLevel>,
    git: bool,
    project_path: Option<&Path>,
) -> ScrapsResult<()> {
    let log_level = match verbose.log_level() {
        Some(log::Level::Error) => Level::ERROR,
        Some(log::Level::Warn) => Level::WARN,
        Some(log::Level::Info) => Level::INFO,
        Some(log::Level::Debug) => Level::DEBUG,
        Some(log::Level::Trace) => Level::TRACE,
        None => Level::WARN,
    };
    tracing_subscriber::fmt()
        .with_span_events(FmtSpan::CLOSE)
        .with_max_level(log_level)
        .init();
    let span_run = span!(Level::INFO, "run").entered();
    let result = execute(git, project_path);
    span_run.exit();
    result
}

fn execute(git: bool, 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);

    // Input: read scraps (with git timestamps if --git is set) and README.
    // The wiki root is the project root, so skip `static/` and the configured
    // output directory at the top level.
    let git_command = git.then(GitCommandImpl::new);
    let exclude_dirs = vec![static_dir_path.clone(), output_dir_path.clone()];
    let (scraps_with_ts, readme_text) =
        read_scraps::to_all_scraps_with_timestamps(&scraps_dir_path, &exclude_dirs, git_command)?;

    let renderer = BuildRendererImpl::new(&static_dir_path, &output_dir_path)?;
    let usecase = BuildUsecase::new();
    let progress = ProgressImpl::init(Instant::now());

    usecase.execute(
        &scraps_with_ts,
        &readme_text,
        &progress,
        &renderer,
        &build_config,
    )?;
    progress.end();

    Ok(())
}

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

    #[rstest]
    fn run_generates_html_and_css(#[from(temp_scrap_project)] project: TempScrapProject) {
        project
            .add_config(b"[ssg]\nbase_url = \"http://localhost:1112/\"\ntitle = \"Test\"")
            .add_scrap("test1.md", b"# header1\n## header2\n")
            .add_scrap("test2.md", b"[[test1]]\n");

        let result = execute(false, Some(project.project_root.as_path()));
        assert!(result.is_ok());

        // Verify scrap HTMLs generated
        let html1 = fs::read_to_string(project.output_path("scraps/test1.html")).unwrap();
        assert!(!html1.is_empty());
        let html2 = fs::read_to_string(project.output_path("scraps/test2.html")).unwrap();
        assert!(!html2.is_empty());

        // Verify index.html generated
        let index = fs::read_to_string(project.output_path("index.html")).unwrap();
        assert!(!index.is_empty());

        // Verify CSS generated
        let css = fs::read_to_string(project.output_path("main.css")).unwrap();
        assert!(!css.is_empty());

        // Verify search index JSON generated (default: true)
        let json = fs::read_to_string(project.output_path("search_index.json")).unwrap();
        assert!(!json.is_empty());
    }

    #[rstest]
    fn run_skips_search_index_when_disabled(#[from(temp_scrap_project)] project: TempScrapProject) {
        project
            .add_config(
                b"[ssg]\nbase_url = \"http://localhost:1112/\"\ntitle = \"Test\"\nbuild_search_index = false",
            )
            .add_scrap("test1.md", b"# header1\n")
            .add_scrap("test2.md", b"[[test1]]\n");

        let result = execute(false, Some(project.project_root.as_path()));
        assert!(result.is_ok());

        // Verify search index JSON not generated
        let json = fs::read_to_string(project.output_path("search_index.json"));
        assert!(json.is_err());
    }

    #[rstest]
    fn run_renders_tag_links_and_embeds(#[from(temp_scrap_project)] project: TempScrapProject) {
        project
            .add_config(b"[ssg]\nbase_url = \"http://localhost:1112/\"\ntitle = \"Test\"")
            .add_scrap(
                "source.md",
                b"Tagged #[[ai/ml]]\n\nEmbed: ![[target#Notes]]",
            )
            .add_scrap(
                "target.md",
                b"# Target\n\n## Notes\n\nembedded body\n\n## Other\n\nhidden body\n",
            );

        let result = execute(false, Some(project.project_root.as_path()));
        assert!(result.is_ok());

        let html = fs::read_to_string(project.output_path("scraps/source.html")).unwrap();
        assert!(html.contains("http://localhost:1112/tags/ai/ml.html"));
        assert!(html.contains("embedded body"));
        assert!(!html.contains("hidden body"));
    }

    #[rstest]
    fn run_generates_tag_links_with_tags_path(
        #[from(temp_scrap_project)] project: TempScrapProject,
    ) {
        project
            .add_config(b"[ssg]\nbase_url = \"http://localhost:1112/\"\ntitle = \"Test\"")
            .add_scrap("source.md", b"#[[ai]]");

        let result = execute(false, Some(project.project_root.as_path()));
        assert!(result.is_ok());

        let index = fs::read_to_string(project.output_path("index.html")).unwrap();
        assert!(index.contains("tags/ai.html"));
    }

    #[rstest]
    fn run_with_git_flag_includes_commited_date_block(
        #[from(temp_scrap_project)] project: TempScrapProject,
    ) {
        project
            .add_config(b"[ssg]\nbase_url = \"http://localhost:1112/\"\ntitle = \"Test\"")
            .add_scrap("test1.md", b"# header1\n");

        let result = execute(true, Some(project.project_root.as_path()));
        assert!(result.is_ok());

        // Outside a git repo `commited_ts` is None so the conditional block
        // is omitted; this test just asserts that --git does not error out.
        let html = fs::read_to_string(project.output_path("scraps/test1.html")).unwrap();
        assert!(!html.is_empty());
    }
}