licensa 0.1.9

CLI tool for seamless source code license management, supporting 65+ file types
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

// Copyright 2024 Nelson Dominguez
// SPDX-License-Identifier: MIT OR Apache-2.0

use serde::{Deserialize, Serialize};

/// Represents a simple SPDX copyright notice.
pub const SPDX_COPYRIGHT_NOTICE: &str = r#"Copyright{{#if year}} {{year}}{{/if}} {{owner}}
SPDX-License-Identifier: {{license}}"#;

/// Holds information for a simple SPDX copyright notice.
#[derive(Debug, Deserialize, Serialize, Default)]
pub struct SpdxCopyrightNotice {
    /// The full name of the copyright holder.
    pub owner: String,

    /// The type of license governing the use of the source code.
    pub license: String,

    /// The year(s) to be included in the copyright notice.
    pub year: Option<u16>,
}

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

    #[test]
    fn test_spdx_template_without_year() {
        let reg = handlebars::Handlebars::new();

        let data = json!({
            "owner": "Bilbo Baggins",
            "license": "MIT"
        });

        let expected_template = "Copyright Bilbo Baggins\nSPDX-License-Identifier: MIT";

        let template = reg.render_template(SPDX_COPYRIGHT_NOTICE, &data);

        assert!(template.is_ok());
        assert_eq!(template.unwrap(), expected_template.to_string());
    }

    #[test]
    fn test_spdx_template_with_year() {
        let reg = handlebars::Handlebars::new();

        let data = json!({
            "owner": "Gandalf",
            "license": "MIT OR Apache-2.0",
            "year": 2012
        });

        let expected_template =
            "Copyright 2012 Gandalf\nSPDX-License-Identifier: MIT OR Apache-2.0";

        let template = reg.render_template(SPDX_COPYRIGHT_NOTICE, &data);

        assert!(template.is_ok());
        assert_eq!(template.unwrap(), expected_template.to_string());
    }
}