mdcat-ng 0.2.1

cat for markdown: show markdown documents in terminals
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
91
92
93
94

// Copyright 2018-2020 Sebastian Wiesner <sebastian@swsnr.de>

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

//! Provide utilities for references.

use crate::Environment;
use tracing::{event, Level};
use url::Url;

/// A base to resolve references with.
pub trait UrlBase {
    /// Resolve the given `reference` against self.
    fn resolve_reference(&self, reference: &str) -> Option<Url>;
}

impl UrlBase for Url {
    /// Resolve a reference against this URL.
    fn resolve_reference(&self, reference: &str) -> Option<Url> {
        match Url::parse(reference).or_else(|_| self.join(reference)) {
            Ok(url) => {
                event!(Level::TRACE, baseurl = %self, reference, %url, "reference resolved");
                Some(url)
            }
            Err(error) => {
                event!(Level::TRACE, baseurl = %self, reference, ?error, "failed to resolve reference");
                None
            }
        }
    }
}

impl UrlBase for Environment {
    /// Resolve a reference against the `base_url` of this environment.
    fn resolve_reference(&self, reference: &str) -> Option<Url> {
        self.base_url.resolve_reference(reference)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use similar_asserts::assert_eq;
    use url::Url;

    #[test]
    fn absolute_url() {
        let url = Url::parse("file:///some/root/")
            .unwrap()
            .resolve_reference("http://www.example.com/reference");
        assert_eq!(
            url.as_ref().map_or("", |u| u.as_str()),
            "http://www.example.com/reference"
        );
    }

    #[test]
    fn relative_path() {
        let url = Url::parse("file:///some/root/")
            .unwrap()
            .resolve_reference("./foo.md");

        assert_eq!(
            url.as_ref().map_or("", |u| u.as_str()),
            "file:///some/root/foo.md"
        );
    }

    #[test]
    fn absolute_path() {
        let url = Url::parse("file:///some/root/")
            .unwrap()
            .resolve_reference("/foo.md");
        assert_eq!(url.as_ref().map_or("", |u| u.as_str()), "file:///foo.md");
    }

    #[test]
    fn base_with_drive_letter_and_absolute_path() {
        let url = Url::parse("file:///d:/some/folder")
            .unwrap()
            .resolve_reference("/foo");
        assert_eq!(url.as_ref().map_or("", |u| u.as_str()), "file:///d:/foo");
    }

    #[test]
    fn base_with_drive_letter_and_root_path() {
        let url = Url::parse("file:///d:/some/folder")
            .unwrap()
            .resolve_reference("/");
        assert_eq!(url.as_ref().map_or("", |u| u.as_str()), "file:///d:/");
    }
}