mdsf 0.12.1

Format, and lint, markdown code snippets using your favorite tools
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use core::hash::{Hash, Hasher};
use std::hash::DefaultHasher;

use crate::{config::MdsfConfig, get_project_dir};

pub const CACHE_DIR: &str = "caches/";

pub struct CacheEntry {
    config: String,

    file_path: String,

    file_content: String,
}

impl CacheEntry {
    #[inline]
    pub fn new(config_hash: String, file_path: &std::path::Path, file_content: &str) -> Self {
        Self {
            config: config_hash,
            file_path: hash_text_block(&file_path.to_string_lossy()),
            file_content: hash_text_block(file_content),
        }
    }

    #[inline]
    fn to_path(&self) -> std::path::PathBuf {
        get_project_dir().join(CACHE_DIR).join(format!(
            "{}/{}/{}/{}",
            env!("CARGO_PKG_VERSION"),
            self.config,
            self.file_path,
            self.file_content
        ))
    }

    #[inline]
    pub fn get(&self) -> Option<String> {
        std::fs::read_to_string(self.to_path()).ok()
    }

    #[inline]
    pub fn set(&self, content: &str) -> Result<(), std::io::Error> {
        let p = self.to_path();

        if let Some(parent) = p.parent() {
            std::fs::create_dir_all(parent)?;
        }

        std::fs::write(p, content)
    }

    #[cfg(test)]
    pub fn delete(&self) -> Result<(), std::io::Error> {
        let p = self.to_path();

        let exists = p.try_exists()?;

        if exists {
            std::fs::remove_file(p)
        } else {
            Ok(())
        }
    }
}

#[cfg(test)]
mod test_cache_entry {
    use super::{CacheEntry, hash_config};
    use crate::config::MdsfConfig;

    #[test]
    fn it_should_work() -> Result<(), std::io::Error> {
        let config = MdsfConfig::default();
        let file_path = std::path::Path::new("mdsf");

        let original_content = "Mads was here";

        let cache_entry = CacheEntry::new(hash_config(&config), file_path, original_content);

        cache_entry.delete()?;

        assert_eq!(None, cache_entry.get());

        let updated_content = "This is the content after being set";

        cache_entry.set(updated_content)?;

        let cached_content = cache_entry.get();

        assert_eq!(Some(updated_content.to_string()), cached_content);

        Ok(())
    }
}

#[inline]
pub fn hash_config(config: &MdsfConfig) -> String {
    serde_json::to_string(config).map_or_else(
        |_error| {
            let mut hasher = DefaultHasher::new();

            config.hash(&mut hasher);

            format!("{}", hasher.finish())
        },
        |config_str| hash_text_block(&config_str),
    )
}

#[cfg(test)]
mod test_hash_config {
    use crate::{caching::hash_config, config::MdsfConfig};

    #[test]
    fn it_should_be_deterministic() {
        assert_eq!(
            hash_config(&MdsfConfig::default()),
            hash_config(&MdsfConfig::default()),
        );
    }
}

#[inline]
pub fn hash_text_block(text: &str) -> String {
    use sha2::Digest;

    sha2::Sha256::digest(text)
        .as_slice()
        .iter()
        .map(|value| format!("{value:x}"))
        .collect::<String>()
}

#[cfg(test)]
mod test_hash_text_block {
    use crate::caching::hash_text_block;

    #[test]
    fn it_should_be_deterministic() {
        assert_eq!(
            hash_text_block("mads was here"),
            hash_text_block("mads was here"),
        );

        assert_eq!(
            hash_text_block("mads was here"),
            "3c90fa2a85f0d72142cea6ea8a5c1f8139e66160cb7737ab2c64e35e9555907d"
        );
    }
}