keyvalues-parser 0.2.3

A parser/renderer for vdf text
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

use insta::{assert_debug_snapshot, assert_snapshot};

use std::{fs, path::Path};

use keyvalues_parser::{PartialVdf, Vdf};

fn read_asset_file(file_name: &str) -> String {
    fs::read_to_string(Path::new("tests").join("assets").join(file_name)).unwrap()
}

// Snapshots both parsing and re-rendering the text from a file
fn snapshot_test_parse_and_render(snapshot_name_base: &str, file_name: &str) {
    let vdf_text = read_asset_file(file_name);
    let vdf = Vdf::parse(&vdf_text).unwrap();
    assert_debug_snapshot!(format!("parsed-{snapshot_name_base}"), vdf);
    assert_snapshot!(format!("rendered-{snapshot_name_base}"), vdf);
}

fn snapshot_test_raw_parse_render(snapshot_name_base: &str, file_name: &str) {
    let vdf_text = read_asset_file(file_name);
    let vdf = Vdf::parse_raw(&vdf_text).unwrap();
    assert_debug_snapshot!(format!("parsed-{snapshot_name_base}"), vdf);

    let mut rendered = String::new();
    vdf.render_raw(&mut rendered).unwrap();
    assert_snapshot!(format!("rendered-{snapshot_name_base}"), rendered);
}

// Snapshots both parsing and re-rendering the text from a file
fn snapshot_test_partial_parse_and_render(snapshot_name_base: &str, file_name: &str) {
    let vdf_text = read_asset_file(file_name);
    let vdf = PartialVdf::parse(&vdf_text).unwrap();
    assert_debug_snapshot!(format!("parsed-{snapshot_name_base}"), vdf);
    assert_snapshot!(format!("rendered-{snapshot_name_base}"), vdf);
}

fn snapshot_test_partial_raw_parse_render(snapshot_name_base: &str, file_name: &str) {
    let vdf_text = read_asset_file(file_name);
    let vdf = PartialVdf::parse_raw(&vdf_text).unwrap();
    assert_debug_snapshot!(format!("parsed-{snapshot_name_base}"), vdf);

    let mut rendered = String::new();
    vdf.render_raw(&mut rendered).unwrap();
    assert_snapshot!(format!("rendered-{snapshot_name_base}"), rendered);
}

// Generates tests where the `name`s indicate the unit test name and the file without an extension
macro_rules! parse_test_generator {
    ( $test_type:ident, $( $name:ident ),* ) => {
        $(
            #[test]
            fn $name() {
                let name_str = stringify!($name);
                ($test_type)(name_str, &format!("{name_str}.vdf"));
            }
        )*
    }
}

parse_test_generator!(
    snapshot_test_parse_and_render,
    basic,
    comments,
    compact,
    unquoted_strings,
    special_characters,
    null_byte
);

parse_test_generator!(snapshot_test_raw_parse_render, raw_strings);

parse_test_generator!(
    snapshot_test_partial_parse_and_render,
    base_multiple,
    base_quoted,
    base_unquoted
);

parse_test_generator!(
    snapshot_test_partial_raw_parse_render,
    base_multiple_raw_strings
);