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

#[cfg(test)]
mod tests {
    use metadata_gen::{
        self, extract_and_prepare_metadata, MetadataError,
    };

    /// Test the `extract_and_prepare_metadata` function with valid content.
    ///
    /// This test ensures that metadata extraction, keyword generation, and meta tag creation
    /// work correctly for valid input content.
    #[test]
    fn test_extract_and_prepare_metadata_valid() {
        let content = r#"---
title: "My Page"
description: "A sample page"
keywords: "rust, static site generator, metadata"
---
# Content goes here
"#;

        let result = extract_and_prepare_metadata(content);
        assert!(
            result.is_ok(),
            "Metadata extraction should succeed for valid content"
        );

        let (metadata_map, keywords, meta_tags) = result.unwrap();

        // Ensure metadata is correctly extracted
        assert_eq!(
            metadata_map.get("title"),
            Some(&"My Page".to_string()),
            "Title metadata should be extracted correctly"
        );
        assert_eq!(
            metadata_map.get("description"),
            Some(&"A sample page".to_string()),
            "Description metadata should be extracted correctly"
        );

        // Ensure keywords are correctly generated
        assert_eq!(
            keywords,
            vec!["rust", "static site generator", "metadata"],
            "Keywords should be extracted correctly"
        );

        // Ensure meta tags contain the correct description
        assert!(
            meta_tags.primary.contains("description"),
            "Primary meta tags should contain 'description'"
        );
    }

    /// Test the `extract_and_prepare_metadata` function with missing metadata.
    ///
    /// This test ensures that missing metadata fields are handled gracefully.
    #[test]
    fn test_extract_and_prepare_metadata_missing_metadata() {
        let content = r#"---
title: "No Description"
---
# Content goes here
"#;

        let result = extract_and_prepare_metadata(content);
        assert!(result.is_ok(), "Metadata extraction should succeed even with missing fields");

        let (metadata_map, keywords, meta_tags) = result.unwrap();

        // Ensure title is correctly extracted, even if description is missing
        assert_eq!(
            metadata_map.get("title"),
            Some(&"No Description".to_string()),
            "Title metadata should be extracted correctly"
        );
        assert_eq!(
            keywords.len(),
            0,
            "No keywords should be extracted if none are provided"
        );

        // Ensure the description is absent from the meta tags
        assert!(
            !meta_tags.primary.contains("description"),
            "Primary meta tags should not contain 'description'"
        );
    }

    /// Test the `extract_and_prepare_metadata` function with invalid front matter format.
    ///
    /// This test checks whether the function returns an appropriate error when the front matter is malformed.
    #[test]
    fn test_extract_and_prepare_metadata_invalid_format() {
        let content = r#"---
title My Page
description A sample page
---
# Content goes here
"#;

        let result = extract_and_prepare_metadata(content);
        assert!(
            result.is_err(),
            "Invalid front matter format should result in an error"
        );

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