metadata-gen 0.0.2

A powerful Rust library for extracting, validating, and processing metadata in YAML, TOML, and JSON formats from any content or data file.
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! Unit tests for the `metadata` module.
//!
//! This module contains tests for metadata extraction and manipulation.

#[cfg(test)]
mod tests {
    use metadata_gen::metadata::extract_metadata;
    use metadata_gen::MetadataError;

    /// Test metadata extraction from a valid YAML source.
    ///
    /// This test ensures that metadata is correctly extracted from valid YAML input.
    #[test]
    fn test_yaml_metadata_extraction() {
        let yaml = r#"---
title: "Test Title"
description: "Test description"
---
Content here
"#;

        let metadata = extract_metadata(yaml).unwrap();
        assert_eq!(
            metadata.get("title"),
            Some(&"Test Title".to_string())
        );
        assert_eq!(
            metadata.get("description"),
            Some(&"Test description".to_string())
        );
    }

    /// Test metadata extraction from a valid TOML source.
    ///
    /// This test ensures that metadata is correctly extracted from valid TOML input.
    /// Test metadata extraction from a valid TOML source.
    #[test]
    fn test_toml_metadata_extraction() {
        let toml = r#"
+++
title = "Test Title"
description = "Test description"
+++
Content here
"#;

        let metadata = extract_metadata(toml).unwrap();
        assert_eq!(
            metadata.get("title"),
            Some(&"Test Title".to_string())
        );
        assert_eq!(
            metadata.get("description"),
            Some(&"Test description".to_string())
        );
    }

    /// Test metadata extraction from a valid JSON source.
    #[test]
    fn test_json_metadata_extraction() {
        let json = r#"
{
    "title": "Test Title",
    "description": "Test description"
}
Content here
"#;

        let metadata = extract_metadata(json).unwrap();
        assert_eq!(
            metadata.get("title"),
            Some(&"Test Title".to_string())
        );
        assert_eq!(
            metadata.get("description"),
            Some(&"Test description".to_string())
        );
    }

    /// Test metadata extraction with missing fields.
    ///
    /// This test checks how the module handles cases where certain metadata fields are absent.
    #[test]
    fn test_missing_metadata() {
        let yaml = r#"---
title: "Test Title"
---
Content here
"#;

        let metadata = extract_metadata(yaml).unwrap();
        assert_eq!(
            metadata.get("title"),
            Some(&"Test Title".to_string())
        );
        assert!(metadata.get("description").is_none());
    }

    /// Test metadata extraction with invalid front matter format.
    ///
    /// This test checks if the function returns an appropriate error when the front matter is malformed.
    #[test]
    fn test_invalid_metadata_format() {
        let invalid_yaml = r#"---
title: Test Title
description: Test description
Content here
"#;

        let result = extract_metadata(invalid_yaml);
        assert!(
            result.is_err(),
            "Invalid YAML front matter should result in an error"
        );

        if let Err(MetadataError::ExtractionError { message }) = result
        {
            assert!(message.contains("No valid front matter found"));
        } else {
            panic!("Expected ExtractionError, got {:?}", result);
        }
    }
}