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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
/*!
Improved YAML Hash

If the YAML data you're working with is well-defined and you want to write the necessary types, you
should use [`serde`] and [`serde_yaml`].

Otherwise, [`yaml_rust2`] provides a foundation for working with varied YAML data or when you don't
want to write the necessary types.

This crate provides the [`YamlHash`] struct, which is a wrapper for [`yaml_rust2::yaml::Hash`], and
supports some additional capabilities:

* Convert from [`&str`] via `impl From<&str>`
* Convert to [`String`] via `impl Display`
* Get a value for a dotted key as a [`YamlHash`] or [`yaml_rust2::Yaml`] via
  [`get`][`YamlHash::get`] and [`get_yaml`][`YamlHash::get_yaml`]; return the root hash if the key
  is `""`.
* Merge a [`YamlHash`] with another [`YamlHash`], YAML hash string, or YAML hash file to create a
  new [`YamlHash`] via [`merge`][`YamlHash::merge`], [`merge_str`][`YamlHash::merge_str`], or
  [`merge_file`][`YamlHash::merge_file`]

[`serde`]: https://docs.rs/serde
[`serde_yaml`]: https://docs.rs/serde_yaml
*/

//--------------------------------------------------------------------------------------------------

use anyhow::{anyhow, Result};
use yaml_rust2::{yaml::Hash, YamlEmitter, YamlLoader};

pub use yaml_rust2::Yaml;

//--------------------------------------------------------------------------------------------------

/**
Improved YAML Hash

* Convert from [`&str`] via `impl From<&str>`
* Convert to [`String`] via `impl Display`
* Get a value for a dotted key as a [`YamlHash`] or [`yaml_rust2::Yaml`] via
  [`get`][`YamlHash::get`] and [`get_yaml`][`YamlHash::get_yaml`]
* Merge a [`YamlHash`] with another [`YamlHash`], YAML hash string, or YAML hash file to create a
  new [`YamlHash`] via [`merge`][`YamlHash::merge`], [`merge_str`][`YamlHash::merge_str`], or
  [`merge_file`][`YamlHash::merge_file`]

*/
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct YamlHash {
    data: Hash,
}

impl YamlHash {
    /// Create a new empty [`YamlHash`]
    pub fn new() -> YamlHash {
        YamlHash::default()
    }

    /**
    Merge this [`YamlHash`] with another [`YamlHash`] to create a new [`YamlHash`]

    ```
    use yaml_hash::YamlHash;

    let hash = YamlHash::from("\
    fruit:
      apple: 1
      banana: 2\
    ");

    let other = YamlHash::from("\
    fruit:
      cherry:
        sweet: 1
        tart: 2\
    ");

    assert_eq!(
        hash.merge(&other).unwrap().to_string(),
        "\
    fruit:
      apple: 1
      banana: 2
      cherry:
        sweet: 1
        tart: 2\
        ",
    );
    ```
    */
    pub fn merge(&self, other: &YamlHash) -> Result<YamlHash> {
        let mut r = self.clone();
        r.data = merge(&r.data, &other.data);
        Ok(r)
    }

    /**
    Merge this [`YamlHash`] with a YAML hash [`&str`] to create a new [`YamlHash`]

    ```
    use yaml_hash::YamlHash;

    let hash = YamlHash::from("\
    fruit:
      apple: 1
      banana: 2\
    ");

    let hash = hash.merge_str("\
    fruit:
      cherry:
        sweet: 1
        tart: 2\
    ").unwrap();

    assert_eq!(
        hash.to_string(),
        "\
    fruit:
      apple: 1
      banana: 2
      cherry:
        sweet: 1
        tart: 2\
        ",
    );
    ```
    */
    pub fn merge_str(&self, s: &str) -> Result<YamlHash> {
        let mut r = self.clone();

        for doc in YamlLoader::load_from_str(s)? {
            if let Yaml::Hash(h) = doc {
                r.data = merge(&r.data, &h);
            } else {
                return Err(anyhow!("YAML string is not a hash: {doc:?}"));
            }
        }

        Ok(r)
    }

    /**
    Merge this [`YamlHash`] with a YAML hash file to create a new [`YamlHash`]

    ```
    use yaml_hash::YamlHash;

    let hash = YamlHash::from("\
    fruit:
      apple: 1
      banana: 2\
    ");

    let hash = hash.merge_file("tests/b.yaml").unwrap();

    assert_eq!(
        hash.to_string(),
        "\
    fruit:
      apple: 1
      banana: 2
      cherry: 3\
        ",
    );
    ```
    */
    pub fn merge_file(&self, s: &str) -> Result<YamlHash> {
        let path = std::path::Path::new(s);
        let yaml = std::fs::read_to_string(path)?;
        self.merge_str(&yaml)
    }

    /**
    Get the value for a dotted key as a [`Yaml`]

    ```
    use yaml_hash::{Yaml, YamlHash};

    let hash = YamlHash::from("\
    fruit:
      apple: 1
      banana: 2
      cherry:
        sweet: 1
        tart: 2\
    ");

    assert_eq!(
        hash.get_yaml("fruit.cherry.tart").unwrap(),
        Yaml::Integer(2),
    );
    ```
    */
    pub fn get_yaml(&self, key: &str) -> Result<Yaml> {
        get_yaml(key, ".", &Yaml::Hash(self.data.clone()), "")
    }

    /**
    Get a value for a dotted key as a [`YamlHash`]

    ```
    use yaml_hash::YamlHash;

    let hash = YamlHash::from("\
    fruit:
      apple: 1
      banana: 2
      cherry:
        sweet: 1
        tart: 2\
    ");

    assert_eq!(
        hash.get("fruit.cherry").unwrap(),
        YamlHash::from("\
    sweet: 1
    tart: 2\
        "),
    );
    ```
    */
    pub fn get(&self, key: &str) -> Result<YamlHash> {
        match self.get_yaml(key)?.into_hash() {
            Some(data) => Ok(YamlHash { data }),
            None => Err(anyhow!("Value for {key:?} is not a hash")),
        }
    }
}

impl std::fmt::Display for YamlHash {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        let mut r = String::new();
        let mut emitter = YamlEmitter::new(&mut r);
        emitter.dump(&Yaml::Hash(self.data.clone())).unwrap();
        r.replace_range(..4, ""); // remove "---\n" at beginning
        write!(f, "{r}")
    }
}

impl From<&str> for YamlHash {
    /// Create a [`YamlHash`] from a YAML hash string
    fn from(s: &str) -> YamlHash {
        YamlHash::default().merge_str(s).unwrap()
    }
}

//--------------------------------------------------------------------------------------------------

fn merge(a: &Hash, b: &Hash) -> Hash {
    let mut r = a.clone();
    for (k, v) in b.iter() {
        if let Yaml::Hash(bh) = v {
            if let linked_hash_map::Entry::Occupied(e) = r.entry(k.clone()) {
                if let Yaml::Hash(rh) = e.get().clone() {
                    r.entry(k.clone())
                        .and_modify(|e| *e = Yaml::Hash(merge(&rh, bh)))
                        .or_insert_with(|| Yaml::Hash(merge(&rh, bh)));
                    continue;
                }
            }
        }
        r.entry(k.clone())
            .and_modify(|e| *e = v.clone())
            .or_insert_with(|| v.clone());
    }
    r
}

fn get_yaml(key: &str, sep: &str, yaml: &Yaml, full: &str) -> Result<Yaml> {
    if key.is_empty() {
        return Ok(yaml.clone());
    }

    let mut s = key.split(sep);
    let this = s.next().unwrap();
    let next = s.collect::<Vec<&str>>().join(sep);

    match yaml {
        Yaml::Hash(hash) => match hash.get(&Yaml::String(this.to_string())) {
            Some(v) => {
                if next.is_empty() {
                    Ok(v.clone())
                } else {
                    let full = if full.is_empty() {
                        key.to_string()
                    } else {
                        format!("{full}.{this}")
                    };
                    get_yaml(&next, sep, v, &full)
                }
            }
            None => Err(anyhow!("Invalid key: {full:?}")),
        },
        _ => Err(anyhow!("Value for key {full:?} is not a hash")),
    }
}