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

use scraps_libs::model::source::Source;
use url::Url;

#[derive(serde::Serialize, Clone, PartialEq, Debug)]
pub struct SourceTera {
    resource: String,
    title: Option<String>,
    /// What a reader sees: the title, or the resource when there is none.
    label: String,
    /// The resource itself when a browser can follow it; anything else
    /// (a path, a scope description) stays text and never links a scrap.
    href: Option<String>,
}

impl From<&Source> for SourceTera {
    fn from(source: &Source) -> Self {
        let href = Url::parse(&source.resource)
            .ok()
            .filter(|url| matches!(url.scheme(), "http" | "https"))
            .map(|_| source.resource.clone());
        SourceTera {
            resource: source.resource.clone(),
            title: source.title.clone(),
            label: source.title.clone().unwrap_or(source.resource.clone()),
            href,
        }
    }
}

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

    fn source(resource: &str) -> Source {
        Source {
            resource: resource.to_string(),
            id: None,
            title: None,
            author: None,
            last_modified: None,
        }
    }

    #[test]
    fn it_labels_a_source_by_its_title_or_else_its_resource() {
        let titled = Source {
            title: Some("Handbook".to_string()),
            ..source("https://example.com")
        };
        assert_eq!(SourceTera::from(&titled).label, "Handbook");
        assert_eq!(
            SourceTera::from(&source("https://example.com")).label,
            "https://example.com"
        );
    }

    #[rstest]
    #[case::https("https://example.com/handbook")]
    #[case::http("http://example.com")]
    fn it_links_a_web_url(#[case] resource: &str) {
        assert_eq!(
            SourceTera::from(&source(resource)).href.as_deref(),
            Some(resource)
        );
    }

    #[rstest]
    #[case::relative_path("references/ga4-schema.md")]
    #[case::scrap_key("Book/Domain-Driven Design")]
    #[case::description("all queries in BigQuery project X")]
    #[case::script("javascript:alert(1)")]
    fn it_keeps_anything_else_as_text(#[case] resource: &str) {
        assert_eq!(SourceTera::from(&source(resource)).href, None);
    }
}