odict 3.3.0

A blazingly-fast dictionary file format for human languages
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
124
125
126
127
128

use std::path::Path;
use std::time::SystemTime;

use serde::{Deserialize, Serialize};

use crate::error::{Error, Result};

/// Metadata for tracking etags and file information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DictionaryMetadata {
    /// The etag value from the server
    pub etag: String,
    /// Last modified timestamp
    pub last_modified: SystemTime,
    /// URL that was downloaded
    pub url: String,
}

const METADATA_EXTENSION: &str = "meta.json";

pub fn get_metadata<P: AsRef<Path>>(local_path: P) -> Result<Option<DictionaryMetadata>> {
    let metadata = local_path.as_ref().with_extension(METADATA_EXTENSION);

    if !metadata.exists() {
        return Ok(None);
    }

    let content = std::fs::read_to_string(&metadata)
        .map_err(|e| Error::Other(format!("Failed to read metadata json: {e}")))?;

    serde_json::from_str(&content)
        .map_err(|e| Error::Other(format!("Failed to parse metadata json: {e}")))
}

/// Save etag cache to disk
pub fn set_metadata<P: AsRef<Path>>(local_path: P, metadata: DictionaryMetadata) -> Result<()> {
    let metadata_path = local_path.as_ref().with_extension(METADATA_EXTENSION);

    let content = serde_json::to_string_pretty(&metadata)
        .map_err(|e| Error::Other(format!("Failed to serialize metadata json: {e}")))?;

    std::fs::write(&metadata_path, content)
        .map_err(|e| Error::Other(format!("Failed to write metadata json: {e}")))
}

/// Delete metadata file to clear ETAG cache
pub fn delete_metadata<P: AsRef<Path>>(local_path: P) -> Result<()> {
    let metadata_path = local_path.as_ref().with_extension(METADATA_EXTENSION);

    if metadata_path.exists() {
        std::fs::remove_file(&metadata_path)
            .map_err(|e| Error::Other(format!("Failed to delete metadata json: {e}")))?;
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    #[test]
    fn test_get_metadata_no_file() {
        let temp_dir = TempDir::new().unwrap();
        let file_path = temp_dir.path().join("test.odict");

        let result = get_metadata(&file_path).unwrap();
        assert!(result.is_none());
    }

    #[test]
    fn test_set_and_get_metadata() {
        let temp_dir = TempDir::new().unwrap();
        let file_path = temp_dir.path().join("test.odict");

        let metadata = DictionaryMetadata {
            etag: "test-etag".to_string(),
            last_modified: SystemTime::now(),
            url: "https://example.com/test".to_string(),
        };

        set_metadata(&file_path, metadata.clone()).unwrap();

        // Verify metadata file was created
        let metadata_path = file_path.with_extension(METADATA_EXTENSION);
        assert!(metadata_path.exists());

        // Verify we can read back the metadata
        let loaded_metadata = get_metadata(&file_path).unwrap().unwrap();

        assert_eq!(loaded_metadata.etag, metadata.etag);
        assert_eq!(loaded_metadata.url, metadata.url);
    }

    #[test]
    fn test_get_metadata_existing() {
        let temp_dir = TempDir::new().unwrap();
        let file_path = temp_dir.path().join("test.odict");
        let metadata_path = file_path.with_extension(METADATA_EXTENSION);

        let metadata = DictionaryMetadata {
            etag: "existing-etag".to_string(),
            last_modified: SystemTime::now(),
            url: "https://example.com/existing".to_string(),
        };

        let content = serde_json::to_string_pretty(&metadata).unwrap();
        fs::write(&metadata_path, content).unwrap();

        let loaded_metadata = get_metadata(&file_path).unwrap().unwrap();
        assert_eq!(loaded_metadata.etag, "existing-etag");
        assert_eq!(loaded_metadata.url, "https://example.com/existing");
    }

    #[test]
    fn test_get_metadata_invalid_json() {
        let temp_dir = TempDir::new().unwrap();
        let file_path = temp_dir.path().join("test.odict");
        let metadata_path = file_path.with_extension(METADATA_EXTENSION);

        fs::write(&metadata_path, "invalid json").unwrap();

        let result = get_metadata(&file_path);
        assert!(result.is_err());
    }
}