scraps 5.1.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
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

use std::collections::HashMap;
use std::path::Path;

use scraps_libs::model::{base_url::BaseUrl, content::Content, key::ScrapKey, scrap::Scrap};

use crate::error::ScrapsResult;
use crate::service::search::render::SearchIndexRender;
use crate::service::tera_render::RenderOutput;
use crate::usecase::build::{
    css::render::CSSRender,
    fonts::FontsRender,
    html::{
        about_render::AboutRender, index_render::IndexRender, scrap_render::ScrapRender,
        tags_index_render::TagsIndexRender,
    },
    js::JsRender,
    model::{
        backlinks_map::BacklinksMap, css::CssMetadata, html::HtmlMetadata,
        list_view_configs::ListViewConfigs, scrap_detail::ScrapDetails, site_nav::SiteNav,
    },
    renderer::{
        CssRenderer, FontsRenderer, HtmlAboutRenderer, HtmlIndexRenderer, HtmlScrapRenderer,
        HtmlTagsIndexRenderer, JsRenderer, SearchIndexJsonRenderer,
    },
};

/// Owns one render per page kind. Each carries a Tera instance whose
/// construction re-parses every template, so they are built once here rather
/// than per rendered page.
pub struct BuildRendererImpl {
    index_render: IndexRender,
    about_render: AboutRender,
    scrap_render: ScrapRender,
    tags_index_render: TagsIndexRender,
    css_render: CSSRender,
    fonts_render: FontsRender,
    js_render: JsRender,
    search_index_render: SearchIndexRender,
}

impl BuildRendererImpl {
    pub fn new(static_dir_path: &Path, output_dir_path: &Path) -> ScrapsResult<BuildRendererImpl> {
        Self::with_output(
            static_dir_path,
            &RenderOutput::Dir(output_dir_path.to_path_buf()),
        )
    }

    /// Renders every page and keeps none, for checking that a build passes.
    pub fn discarding(static_dir_path: &Path) -> ScrapsResult<BuildRendererImpl> {
        Self::with_output(static_dir_path, &RenderOutput::Discard)
    }

    fn with_output(
        static_dir_path: &Path,
        output: &RenderOutput,
    ) -> ScrapsResult<BuildRendererImpl> {
        Ok(BuildRendererImpl {
            index_render: IndexRender::new(static_dir_path, output)?,
            about_render: AboutRender::new(static_dir_path, output)?,
            scrap_render: ScrapRender::new(static_dir_path, output)?,
            tags_index_render: TagsIndexRender::new(static_dir_path, output)?,
            css_render: CSSRender::new(static_dir_path, output)?,
            fonts_render: FontsRender::new(output),
            js_render: JsRender::new(output),
            search_index_render: SearchIndexRender::new(static_dir_path, output)?,
        })
    }
}

impl HtmlIndexRenderer for BuildRendererImpl {
    fn render_index(
        &self,
        base_url: &BaseUrl,
        html_metadata: &HtmlMetadata,
        list_view_configs: &ListViewConfigs,
        scrap_details: &ScrapDetails,
        backlinks_map: &BacklinksMap,
        site_nav: &SiteNav,
    ) -> ScrapsResult<usize> {
        self.index_render.run(
            base_url,
            html_metadata,
            list_view_configs,
            scrap_details,
            backlinks_map,
            site_nav,
        )
    }
}

impl HtmlAboutRenderer for BuildRendererImpl {
    fn render_about(
        &self,
        base_url: &BaseUrl,
        html_metadata: &HtmlMetadata,
        readme_content: &Content,
        site_nav: &SiteNav,
    ) -> ScrapsResult<()> {
        self.about_render
            .run(base_url, html_metadata, readme_content, site_nav)
    }
}

impl HtmlScrapRenderer for BuildRendererImpl {
    fn render_scraps(
        &self,
        base_url: &BaseUrl,
        html_metadata: &HtmlMetadata,
        scrap_details: &ScrapDetails,
        backlinks_map: &BacklinksMap,
        scraps_by_key: &HashMap<ScrapKey, &Scrap>,
        site_nav: &SiteNav,
    ) -> ScrapsResult<()> {
        self.scrap_render.run(
            base_url,
            html_metadata,
            scrap_details,
            backlinks_map,
            scraps_by_key,
            site_nav,
        )
    }
}

impl HtmlTagsIndexRenderer for BuildRendererImpl {
    fn render_tags_index(
        &self,
        base_url: &BaseUrl,
        html_metadata: &HtmlMetadata,
        scraps: &[Scrap],
        backlinks_map: &BacklinksMap,
        site_nav: &SiteNav,
    ) -> ScrapsResult<()> {
        self.tags_index_render
            .run(base_url, html_metadata, scraps, backlinks_map, site_nav)
    }
}

impl CssRenderer for BuildRendererImpl {
    fn render_css(&self, css_metadata: &CssMetadata) -> ScrapsResult<()> {
        self.css_render.render_main(css_metadata)
    }
}

impl FontsRenderer for BuildRendererImpl {
    fn render_fonts(&self) -> ScrapsResult<()> {
        self.fonts_render.run()
    }
}

impl JsRenderer for BuildRendererImpl {
    fn render_js(&self) -> ScrapsResult<()> {
        self.js_render.run()
    }
}

impl SearchIndexJsonRenderer for BuildRendererImpl {
    fn render_search_index(&self, base_url: &BaseUrl, scraps: &[Scrap]) -> ScrapsResult<()> {
        self.search_index_render.run(base_url, scraps)
    }
}