kellnr-docs 6.2.0

Kellnr is a self-hosted registry for Rust crates with support for rustdocs and crates.io caching.
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
95
96
97
98
99

use kellnr_common::original_name::OriginalName;
use kellnr_common::version::Version;
use serde::{Deserialize, Serialize};
use utoipa::ToSchema;

use crate::compute_doc_url;

/// Response after successfully uploading documentation
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, ToSchema)]
pub struct DocUploadResponse {
    /// Status message
    pub message: String,
    /// URL to access the uploaded documentation
    pub url: String,
    /// Name of the crate
    pub crate_name: String,
    /// Version of the crate
    pub crate_version: String,
}

impl DocUploadResponse {
    pub fn new(
        message: String,
        crate_name: &OriginalName,
        crate_version: &Version,
        path_prefix: &str,
    ) -> Self {
        Self {
            message,
            crate_name: crate_name.to_string(),
            crate_version: crate_version.to_string(),
            url: compute_doc_url(&crate_name.to_string(), crate_version, path_prefix),
        }
    }
}

#[cfg(test)]
mod tests {
    use std::convert::TryFrom;

    use super::*;

    #[test]
    fn create_new_doc_upload_response_works() {
        let name = OriginalName::try_from("mycrate").unwrap();
        let version = Version::try_from("1.0.0-beta2").unwrap();
        let msg = "Hello, this is the message.".to_string();

        let dur = DocUploadResponse::new(msg, &name, &version, "");

        assert_eq!(
            DocUploadResponse {
                message: "Hello, this is the message.".to_string(),
                url: "/docs/mycrate/1.0.0-beta2/doc/mycrate/index.html".to_string(),
                crate_name: "mycrate".to_string(),
                crate_version: "1.0.0-beta2".to_string()
            },
            dur
        );
    }

    #[test]
    fn create_new_doc_upload_replace_hyphen_with_underscore() {
        let name = OriginalName::try_from("my-crate").unwrap();
        let version = Version::try_from("1.0.0").unwrap();
        let msg = "Hello, this is the message.".to_string();

        let dur = DocUploadResponse::new(msg, &name, &version, "");

        assert_eq!(
            DocUploadResponse {
                message: "Hello, this is the message.".to_string(),
                url: "/docs/my-crate/1.0.0/doc/my_crate/index.html".to_string(),
                crate_name: "my-crate".to_string(),
                crate_version: "1.0.0".to_string()
            },
            dur
        );
    }

    #[test]
    fn create_new_doc_upload_with_path_prefix() {
        let name = OriginalName::try_from("mycrate").unwrap();
        let version = Version::try_from("1.0.0").unwrap();
        let msg = "Hello, this is the message.".to_string();

        let dur = DocUploadResponse::new(msg, &name, &version, "/kellnr");

        assert_eq!(
            DocUploadResponse {
                message: "Hello, this is the message.".to_string(),
                url: "/kellnr/docs/mycrate/1.0.0/doc/mycrate/index.html".to_string(),
                crate_name: "mycrate".to_string(),
                crate_version: "1.0.0".to_string()
            },
            dur
        );
    }
}