flatr 0.1.0

Prints JSON files in a flat format.
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

use colored::Colorize;
use serde_json::Value;
use strip_ansi_escapes::strip_str;

/// Returns a String vector of the flattened JSON
///
/// # Example
/// ```
/// let input = serde_json::json!({
///     "object": {
///       "nested_string": "Nested string",
///       "nested_number": 123,
///       "nested_boolean": false,
///       "nested_null_value": null,
///       "nested_array": ["a", "b", "c"]
///     }
/// });
/// let output = vec![
///     ".object.nested_string = \"Nested string\"",
///     ".object.nested_number = 123",
///     ".object.nested_boolean = false",
///     ".object.nested_null_value = null",
///     ".object.nested_array[0] = \"a\"",
///     ".object.nested_array[1] = \"b\"",
///     ".object.nested_array[2] = \"c\"",
/// ];
/// assert_eq!(flatr::flatten_json(&input), output);
/// ```
///
pub fn flatten_json(input_json: &Value) -> Vec<String> {
    let mut flattened_strings: Vec<String> = vec![];

    flattenizer(input_json, String::new(), &mut flattened_strings);

    flattened_strings
}

fn flattenizer(input_json: &Value, prefix: String, flattened_strings: &mut Vec<String>) {
    match input_json {
        Value::Object(obj) => {
            for key in obj.keys() {
                let new_prefix = format!("{}{}{}", prefix, ".".cyan(), key);
                flattenizer(&obj[key], new_prefix, flattened_strings);
            }
        }
        Value::Array(array) => {
            for (index, value) in array.iter().enumerate() {
                let new_prefix = format!("{}[{}]", prefix, index.to_string().blue());
                flattenizer(value, new_prefix, flattened_strings);
            }
        }
        _ => {
            let formatted_value = match input_json {
                Value::String(v) => format!("\"{v}\"").green(),
                Value::Number(v) => v.to_string().blue(),
                Value::Bool(v) => v.to_string().yellow(),
                Value::Null => "null".to_string().purple().italic(),
                _ => "".to_string().hidden(),
            };
            let entry = format!("{} = {}", prefix, formatted_value);
            println!("{entry}");
            flattened_strings.push(strip_str(entry));
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::flatten_json;

    #[test]
    fn test_flatten_json() {
        use serde_json::json;

        let input_json = json!({
            "string": "Hello, world!",
            "number": 42,
            "boolean": true,
            "null_value": null,
            "array": [1, 2, 3],
            "object": {
                "nested_string": "Nested string",
                "nested_number": 123,
                "nested_boolean": false,
                "nested_null_value": null,
                "nested_array": ["a", "b", "c"],
                "nested_object": {
                    "more_nested_string": "More nested string",
                    "more_nested_number": 456,
                    "more_nested_boolean": true,
                    "more_nested_null_value": null,
                    "more_nested_array": ["x", "y", "z"]
                }
            }
        });

        let expected_result = vec![
            ".string = \"Hello, world!\"",
            ".number = 42",
            ".boolean = true",
            ".null_value = null",
            ".array[0] = 1",
            ".array[1] = 2",
            ".array[2] = 3",
            ".object.nested_string = \"Nested string\"",
            ".object.nested_number = 123",
            ".object.nested_boolean = false",
            ".object.nested_null_value = null",
            ".object.nested_array[0] = \"a\"",
            ".object.nested_array[1] = \"b\"",
            ".object.nested_array[2] = \"c\"",
            ".object.nested_object.more_nested_string = \"More nested string\"",
            ".object.nested_object.more_nested_number = 456",
            ".object.nested_object.more_nested_boolean = true",
            ".object.nested_object.more_nested_null_value = null",
            ".object.nested_object.more_nested_array[0] = \"x\"",
            ".object.nested_object.more_nested_array[1] = \"y\"",
            ".object.nested_object.more_nested_array[2] = \"z\"",
        ];

        let actual_result = flatten_json(&input_json);

        assert_eq!(actual_result, expected_result);
    }
}